(Beta)
Package | com.adobe.mosaic.core.events |
Class | public class DisplayMessage |
Inheritance | DisplayMessage Event Object |
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
Runtime Versions: | AIR 2.0.2, Flash Player 10.1 |
DisplayMessage
event provides a notification that one or more
Mosaic nodes (view, panel, or tiles) have been displayed in the application.
DisplayMessage
objects are not retained or stored after all their listeners have been processed.
DisplayMessage
objects are used to communicate information and do not need to be
persisted or referenced.
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 | ||
revealedNodes : Array
Returns an array of nodes (IMosaicNode objects) that were displayed after another node was displayed. | DisplayMessage | ||
target : Object [read-only]
The event target. | Event | ||
type : String [read-only]
The type of event. | Event |
Public Methods
Public Constants
Constant | Defined By | ||
---|---|---|---|
DISPLAY_EVENT_CHANGE : String = "DisplayEvent.CHANGE" [static]
The message type sent when the navigation state of the an application is changed. | DisplayMessage | ||
NAMESPACE : String = "com.adobe.mosaic.core" [static]
The namespace for messages of this type. | DisplayMessage |
Property Detail
revealedNodes | property |
revealedNodes:Array
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
Runtime Versions: | AIR 2.0.2, Flash Player 10.1 |
Returns an array of nodes (IMosaicNode objects) that were displayed after another node was displayed.
Implementation
public function get revealedNodes():Array
public function set revealedNodes(value:Array):void
Related API Elements
Constant Detail
DISPLAY_EVENT_CHANGE | Constant |
public static const DISPLAY_EVENT_CHANGE:String = "DisplayEvent.CHANGE"
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
Runtime Versions: | AIR 2.0.2, Flash Player 10.1 |
The message type sent when the navigation state of the an application is changed. This can occur through user interaction or API calls.
NAMESPACE | Constant |
public static const NAMESPACE:String = "com.adobe.mosaic.core"
Language Version: | ActionScript 3.0 |
Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
Runtime Versions: | AIR 2.0.2, Flash Player 10.1 |
The namespace for messages of this type.
Examples How to use this example
DisplayMessage_example.mxml
<?xml version="1.0" encoding="utf-8"?> <mc:Tile xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:s="library://ns.adobe.com/flex/spark" xmlns:mc="com.adobe.mosaic.core.*" layout="absolute" applicationComplete="{addDisplayListener()}"> <fx:Script> <![CDATA[ import com.adobe.mosaic.core.events.DisplayMessage; import com.adobe.mosaic.core.events.Message; import com.adobe.mosaic.om.interfaces.IDisplayable; import com.adobe.mosaic.om.interfaces.IMosaicNode; private var m_nDisplayCounter:int = 0; private function addDisplayListener():void { mosaicApp.addMessageListener(DisplayMessage.NAMESPACE, DisplayMessage.DISPLAY_EVENT_CHANGE, onDisplayMessage); } // addDisplayListener private function removeDisplayListener():void { mosaicApp.removeMessageListener(DisplayMessage.NAMESPACE, DisplayMessage.DISPLAY_EVENT_CHANGE, onDisplayMessage); } // removeDisplayListener private function onDisplayMessage(message:Message):void { for each (var node:IMosaicNode in message.payload.revealedNodes) { m_nDisplayCounter++; textareaDisplay.text += m_nDisplayCounter + "\t" + node.nodeType + "\t" + node.nodeLabel + "\n"; } } // onDisplayMessage private function clearDisplayList():void { m_nDisplayCounter = 0; textareaDisplay.text = ""; } // clearDisplayList ]]> </fx:Script> <s:Button x="10" y="10" label="Add display listener" click="addDisplayListener()"/> <s:Button x="144" y="10" label="Remove display listener" click="removeDisplayListener()"/> <s:Button x="302" y="10" label="Clear display list" click="clearDisplayList()"/> <s:TextArea x="10" y="40" id="textareaDisplay" text="" width="400" height="400"/> </mc:Tile>
Wed Nov 21 2018, 06:34 AM -08:00