Package | mx.messaging.events |
Class | public class MessageEvent |
Inheritance | MessageEvent Event Object |
Subclasses | AbstractEvent, MessageAckEvent |
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Property | Defined By | ||
---|---|---|---|
bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | ||
cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | ||
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | ||
eventPhase : uint [read-only]
The current phase in the event flow. | Event | ||
message : IMessage
The Message associated with this event. | MessageEvent | ||
target : Object [read-only]
The event target. | Event | ||
type : String [read-only]
The type of event. | Event |
Method | Defined By | ||
---|---|---|---|
MessageEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, message:IMessage = null)
Constructs an instance of this event with the specified type and
message. | MessageEvent | ||
[override]
Clones the MessageEvent. | MessageEvent | ||
[static]
Utility method to create a new MessageEvent that doesn't bubble and
is not cancelable. | MessageEvent | ||
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | ||
Indicates whether an object has a specified property defined. | Object | ||
Checks whether the preventDefault() method has been called on the event. | Event | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Cancels an event's default behavior if that behavior can be canceled. | Event | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | ||
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
[override]
Returns a string representation of the MessageEvent. | MessageEvent | ||
Returns the primitive value of the specified object. | Object |
Constant | Defined By | ||
---|---|---|---|
MESSAGE : String = "message" [static]
The MESSAGE event type; dispatched upon receipt of a message. | MessageEvent | ||
RESULT : String = "result" [static]
The RESULT event type; dispatched when an RPC agent receives a result from
a remote service destination. | MessageEvent |
message | property |
public var message:IMessage
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The Message associated with this event.
MessageEvent | () | Constructor |
public function MessageEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, message:IMessage = null)
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructs an instance of this event with the specified type and message.
Parameterstype:String — The type for the MessageEvent.
| |
bubbles:Boolean (default = false ) — Specifies whether the event can bubble up the display
list hierarchy.
| |
cancelable:Boolean (default = false ) — Indicates whether the behavior associated with the
event can be prevented; used by the RPC subclasses.
| |
message:IMessage (default = null ) — The associated message.
|
clone | () | method |
createEvent | () | method |
public static function createEvent(type:String, msg:IMessage):MessageEvent
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Utility method to create a new MessageEvent that doesn't bubble and is not cancelable.
Parameters
type:String — The type for the MessageEvent.
| |
msg:IMessage — The associated message.
|
MessageEvent — New MessageEvent.
|
toString | () | method |
override public function toString():String
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns a string representation of the MessageEvent.
ReturnsString — String representation of the MessageEvent.
|
MESSAGE | Constant |
public static const MESSAGE:String = "message"
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The MESSAGE event type; dispatched upon receipt of a message.
The value of this constant is "message"
.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
message | The message associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
RESULT | Constant |
public static const RESULT:String = "result"
Language Version: | ActionScript 3.0 |
Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
The RESULT event type; dispatched when an RPC agent receives a result from a remote service destination.
The value of this constant is "result"
.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
message | The message associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
Thu Dec 6 2018, 01:12 PM -08:00