| Package | com.adobe.mosaic.mxml |
| Class | public class Catalog |
| Inheritance | Catalog  FrameworkInitializer |
| Implements | ICatalogSpecifier, IMXMLObject |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Related API Elements
com.adobe.mosaic.mxml.ServerSession
com.adobe.mosaic.mxml.Application
com.adobe.mosaic.mxml.Catalog
com.adobe.mosaic.mxml.Tile
com.adobe.mosaic.mxml.Shell
com.adobe.mosaic.mxml.Service
| Property | Defined By | ||
|---|---|---|---|
| catalogNode : ICatalog [read-only]
The underlying Composite Application Framework SDK ICatalog. | Catalog | ||
| loaded : Boolean [read-only]
Checks if the underlying ICatalog is instantiated. | Catalog | ||
| name : String
The name set of the composite application catalog. | Catalog | ||
| serverSession : ServerSession
The ServerSession associated with this composite application catalog. | Catalog | ||
| session : ISession [read-only]
The ISession associated with this composite application catalog from the Experience Server. | Catalog | ||
| Method | Defined By | ||
|---|---|---|---|
Catalog()
Constructor. | Catalog | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override]
Overridden EventDispatcher addEventListener. | Catalog | ||
Implementation of IMXMLObject initialized. | Catalog | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| The catalogLoadEventFailure defines a failure notification of an attempt to load an Catalog | Catalog | |||
| The catalogLoadEventSuccess defines a successful notification of loading a Catalog | Catalog | |||
catalogNode | property |
catalogNode:ICatalog [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The underlying Composite Application Framework SDK ICatalog.
Implementation
public function get catalogNode():ICatalogRelated API Elements
loaded | property |
loaded:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Checks if the underlying ICatalog is instantiated.
Implementation
public function get loaded():Booleanname | property |
name:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The name set of the composite application catalog.
Implementation
public function get name():String public function set name(value:String):voidserverSession | property |
serverSession:ServerSession| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The ServerSession associated with this composite application catalog.
Implementation
public function get serverSession():ServerSession public function set serverSession(value:ServerSession):voidRelated API Elements
session | property |
session:ISession [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The ISession associated with this composite application catalog from the Experience Server.
Implementation
public function get session():ISessionRelated API Elements
Catalog | () | Constructor |
public function Catalog()| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Constructor.
addEventListener | () | method |
override public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Overridden EventDispatcher addEventListener. Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.
After you successfully register an event listener, you cannot change its priority
through additional calls to addEventListener(). To change a listener's
priority, you must first call removeListener(). Then you can register the
listener again with the new priority level.
Keep in mind that after the listener is registered, subsequent calls to
addEventListener() with a different type or
useCapture value result in the creation of a separate listener registration.
For example, if you first register a listener with useCapture set to
true, it listens only during the capture phase. If you call
addEventListener() again using the same listener object, but with
useCapture set to false, you have two separate listeners: one
that listens during the capture phase and another that listens during the target and
bubbling phases.
You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.
If you no longer need an event listener, remove it by calling
removeEventListener(), or memory problems could result. Event listeners are not automatically
removed from memory because the garbage
collector does not remove the listener as long as the dispatching object exists (unless the useWeakReference
parameter is set to true).
Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.
If the event listener is being registered on a node while an event is being processed on this node, the event listener is not triggered during the current phase but can be triggered during a later phase in the event flow, such as the bubbling phase.
If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless registered again for future processing).
Parameters
type:String — The type of event.
| |
listener:Function — The listener function that processes the event. This function must accept
an Event object as its only parameter and must return nothing, as this example shows:
function(evt:Event):void The function can have any name. | |
useCapture:Boolean (default = false)useCapture is set to true,
the listener processes the event only during the capture phase and not in the
target or bubbling phase. If useCapture is false, the
listener processes the event only during the target or bubbling phase. To listen for
the event in all three phases, call addEventListener twice, once with
useCapture set to true, then again with
useCapture set to false.
| |
priority:int (default = 0) | |
useWeakReference:Boolean (default = false)Class-level member functions are not subject to garbage
collection, so you can set |
initialized | () | method |
public function initialized(document:Object, id:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Implementation of IMXMLObject initialized.
Parameters
document:Object — Specifies the document object.
| |
id:String — Specifies the MXML ID of the string.
|
catalogLoadEventFailure | Event |
com.adobe.mosaic.om.events.CatalogLoadEventproperty CatalogLoadEvent.type =
com.adobe.mosaic.om.events.CatalogLoadEvent.FAILURE| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The catalogLoadEventFailure defines a failure notification of an attempt to load an Catalog
The message type sent when a catalog fails to load.catalogLoadEventSuccess | Event |
com.adobe.mosaic.om.events.CatalogLoadEventproperty CatalogLoadEvent.type =
com.adobe.mosaic.om.events.CatalogLoadEvent.SUCCESS| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
The catalogLoadEventSuccess defines a successful notification of loading a Catalog
The message type sent when a catalog is loaded successfully.
<fx:Declarations>
<mosaic:ServerSession id="myServer"
openSessionEventSuccess="myServer_connectedHandler(event)"
openSessionEventFailure="myServer_faultHandler(event)"
url="{_serverUrl}" />
<mosaic:Application id="myApp"
loadApplicationEventSuccess="myApp_loadApplicationEventSuccessHandler(event)"
loadApplicationEventFailure="myApp_loadApplicationEventFailureHandler(event)">
<mosaic:catalogs>
<mosaic:Catalog id="sampleCatalog"
name="sample_catalog"
catalogLoadEventSuccess="myCatalogSuccess(event)"
catalogLoadEventFailure="myCatalogFail(event)"
serverSession="{myServer}"/>
</mosaic:catalogs>
</mosaic:Application>
</fx:Declarations>
Thu Dec 6 2018, 01:12 PM -08:00