| Package | com.adobe.mosaic.om.events |
| Class | public class Message |
| Inheritance | Message  Event Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Message class defines a transient notification including a namespace, a name, and a valid payload.
Messages are not retained or stored after all their listeners have been processed, so messages should only be used for communicating information that never needs to be persisted or recalled.
Hide Inherited Public Properties
Show Inherited Public Properties| 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 | |
| name : String [read-only]
Returns the name of this message. | Message | ||
| nameSpace : String [read-only]
Returns the namespace of this message. | Message | ||
| payload : * [read-only]
Returns the payload of this message. | Message | ||
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | Message | ||
[override]
Clones this Message instance. | Message | ||
|
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 | |
|
Returns a string containing all the properties of the Event object. | Event | |
|
Returns the primitive value of the specified object. | Object | |
name | property |
nameSpace | property |
nameSpace:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Returns the namespace of this message.
Implementation
public function get nameSpace():Stringpayload | property |
Message | () | Constructor |
public function Message(ns:String, name:String, payload:*)| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Constructor.
The constructor builds a Message object containing a namespace, name, and payload
to deliver to other tiles using their event listeners.
ns:String — The namespace of the message.
| |
name:String — The name of the message.
| |
payload:* — Any object that is allowed to be serialized. The object will be sent to every listener.
|
clone | () | method |
override public function clone():Event| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Clones this Message instance. Duplicates an instance of an Event subclass.
Returns a new Event object that is a copy of the original instance of the Event object.
You do not normally call clone(); the EventDispatcher class calls it automatically
when you redispatch an event—that is, when you call dispatchEvent(event) from a handler
that is handling event.
The new Event object includes all the properties of the original.
When creating your own custom Event class, you must override the
inherited Event.clone() method in order for it to duplicate the
properties of your custom class. If you do not set all the properties that you add
in your event subclass, those properties will not have the correct values when listeners
handle the redispatched event.
In this example, PingEvent is a subclass of Event
and therefore implements its own version of clone().
class PingEvent extends Event {
var URL:String;
public override function clone():Event {
return new PingEvent(type, bubbles, cancelable, URL);
}
}
Event — cloned Message
|
Mon Apr 10 2017, 12:28 PM -07:00