Packagemx.messaging.events
Classpublic class MessageEvent
InheritanceMessageEvent Inheritance flash.events.Event
Subclasses AbstractEvent, MessageAckEvent

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 3
Runtime Versions : Flash Player 9, AIR 1.1

The MessageEvent class is used to propagate messages within the messaging system.


Public Properties
 PropertyDefined By
  message : IMessage
The Message associated with this event.
MessageEvent
Public Methods
 MethodDefined 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
  
clone():Event
[override] Clones the MessageEvent.
MessageEvent
  
createEvent(type:String, msg:IMessage):MessageEvent
[static] Utility method to create a new MessageEvent that doesn't bubble and is not cancelable.
MessageEvent
  
toString():String
[override] Returns a string representation of the MessageEvent.
MessageEvent
Public Constants
 ConstantDefined 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
Property Detail
messageproperty
public var message:IMessage

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 3
Runtime Versions : Flash Player 9, AIR 1.1

The Message associated with this event.

Constructor Detail
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, LCDS 3
Runtime Versions : Flash Player 9, AIR 1.1

Constructs an instance of this event with the specified type and message.

Parameters
type: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.
Method Detail
clone()method
override public function clone():Event

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 3
Runtime Versions : Flash Player 9, AIR 1.1

Clones the MessageEvent.

Returns
Event — Copy of this MessageEvent.
createEvent()method 
public static function createEvent(type:String, msg:IMessage):MessageEvent

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 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.

Returns
MessageEvent — New MessageEvent.
toString()method 
override public function toString():String

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 3
Runtime Versions : Flash Player 9, AIR 1.1

Returns a string representation of the MessageEvent.

Returns
String — String representation of the MessageEvent.
Constant Detail
MESSAGEConstant
public static const MESSAGE:String = message

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
messageThe message associated with this event.
targetThe 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.

RESULTConstant 
public static const RESULT:String = result

Language Version : ActionScript 3.0
Product Versions : BlazeDS 4, LCDS 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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
messageThe message associated with this event.
targetThe 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.




The Apache Software Foundation

Wed Nov 15 2017, 09:50 AM +01:00