(Adobe® Flex™ Data Services 2 only)
Packagemx.messaging.events
Classpublic class MessageAckEvent
InheritanceMessageAckEvent Inheritance MessageEvent Inheritance Event Inheritance Object

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


Public Properties
 PropertyDefined by
  acknowledgeMessage : AcknowledgeMessage
[read-only] Utility property to get the message property from the MessageEvent as an AcknowledgeMessage.
MessageAckEvent
 Inheritedbubbles : Boolean
Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  correlation : IMessage
The original Message correlated with this acknowledgement.
MessageAckEvent
 InheritedcurrentTarget : Object
The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
The current phase in the event flow.
Event
 Inheritedmessage : IMessage
The Message associated with this event.
MessageEvent
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedtarget : Object
The event target.
Event
 Inheritedtype : String
The type of event.
Event
Public Methods
 MethodDefined by
  
MessageAckEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, ack:AcknowledgeMessage = null, correlation:IMessage = null)
Constructs an instance of this event with the specified acknowledge message and original correlated message.
MessageAckEvent
  
clone():Event
Clones the MessageAckEvent.
MessageAckEvent
  
createEvent(ack:AcknowledgeMessage = null, correlation:IMessage = null):MessageAckEvent
[static] Utility method to create a new MessageAckEvent that doesn't bubble and is not cancelable.
MessageAckEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in your custom Event class.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether preventDefault() has been called on the event.
Event
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
  
toString():String
Returns a string representation of the MessageAckEvent.
MessageAckEvent
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined by
  ACKNOWLEDGE : String = "acknowledge"
[static] The ACKNOWLEDGE event type; dispatched upon receipt of an acknowledgement.
MessageAckEvent
 InheritedACTIVATE : String = "activate"
[static] Defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] Defines the value of the type property of an added event object.
Event
 InheritedCANCEL : String = "cancel"
[static] Defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] Defines the value of the type property of a change event object.
Event
 InheritedCLOSE : String = "close"
[static] Defines the value of the type property of a close event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] Defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] Defines the value of the type property of a connect event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] Defines the value of the type property of a deactivate event object.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] Defines the value of the type property of an enterFrame event object.
Event
 InheritedID3 : String = "id3"
[static] Defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] Defines the value of the type property of an init event object.
Event
 InheritedMESSAGE : String = "message"
[static] The MESSAGE event type; dispatched upon receipt of a message.
MessageEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] Defines the value of the type property of a mouseLeave event object.
Event
 InheritedOPEN : String = "open"
[static] Defines the value of the type property of an open event object.
Event
 InheritedREMOVED : String = "removed"
[static] Defines the value of the type property of a removed event object.
Event
 InheritedRENDER : String = "render"
[static] Defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] Defines the value of the type property of a resize event object.
Event
 InheritedRESULT : String = "result"
[static] The RESULT event type; dispatched when an RPC agent receives a result from a remote service destination.
MessageEvent
 InheritedSCROLL : String = "scroll"
[static] Defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] Defines the value of the type property of a select event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] Defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] Defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] Defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] Defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] Defines the value of the type property of an unload event object.
Event
Property detail
acknowledgeMessageproperty
acknowledgeMessage:AcknowledgeMessage  [read-only]

Utility property to get the message property from the MessageEvent as an AcknowledgeMessage.

Implementation
    public function get acknowledgeMessage():AcknowledgeMessage
correlationproperty 
public var correlation:IMessage

The original Message correlated with this acknowledgement.

Constructor detail
MessageAckEvent()constructor
public function MessageAckEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, ack:AcknowledgeMessage = null, correlation:IMessage = null)

Constructs an instance of this event with the specified acknowledge message and original correlated message.

Parameters
type:String — The type for the MessageAckEvent.
 
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.
 
ack:AcknowledgeMessage (default = null) — The AcknowledgeMessage this event should dispatch.
 
correlation:IMessage (default = null) — The message correlated with this acknowledgement.
Method detail
clone()method
public override function clone():Event

Clones the MessageAckEvent.

Returns
Event — Copy of this MessageAckEvent.
createEvent()method 
public static function createEvent(ack:AcknowledgeMessage = null, correlation:IMessage = null):MessageAckEvent

Utility method to create a new MessageAckEvent that doesn't bubble and is not cancelable.

Parameters
ack:AcknowledgeMessage (default = null) — The AcknowledgeMessage this event should dispatch.
 
correlation:IMessage (default = null) — The Message correlated with this acknowledgement.

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

Returns a string representation of the MessageAckEvent.

Returns
String — String representation of the MessageAckEvent.
Constant detail
ACKNOWLEDGEconstant
public static const ACKNOWLEDGE:String = "acknowledge"

The ACKNOWLEDGE event type; dispatched upon receipt of an acknowledgement.

The value of this constant is "acknowledge".

The properties of the event object have the following values:

PropertyValue
acknowledgeMessage Utility property to get the message property from MessageEvent as an AcknowledgeMessage.
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.
correlate The original Message correlated with this acknowledgement.
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.



© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Jun 22 2006, 10:21 PM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flex/2/langref/mx/messaging/events/MessageAckEvent.html