com.adobe.mosaic.mxml

# Application - AS3 ADEP Composite Application

Package | com.adobe.mosaic.mxml
Class | public class Application
Inheritance | Application FrameworkInitializer
Implements | 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

The Application mxml component represents a composite application that can placed onto the Flex Display List using the composite application shell MXML component. An Application contains a reference to a composite application's IApplication using the `applicationNode` property. This underlying IApplication can be considered either:

- A Transient Application: An Application that has an Ad-hoc nature and does not reside server side.
- A CADL Application: An Application loaded by name and in the form of CADL markup (Composite Application Description Language) which is contained in a descriptor file that resides on the Experience Server.

The Application component is strictly for loading an IApplication and its "DOM", not for rendering. The Shell and Tile components are meant for rendering composite application display components on the Flex Display List.

When setting up an Application component: The `serverSession` property is not required, and should not be set when generating a "Transient" Application DOM. The `name` property is only required when the serverSession property has been set. The `name` property represents the CADL name of the Application in residence on the Experience Server. Use the composite application shell component for rendering the DOM of a CADL Application loaded by name. Use the composite application tile component for rendering individual Tiles for a Transient Application.

View the examples

Related API Elements

com.adobe.mosaic.om.interfaces.IApplication
com.adobe.mosaic.mxml.ServerSession
com.adobe.mosaic.mxml.Catalog
com.adobe.mosaic.mxml.Shell
com.adobe.mosaic.mxml.Tile
com.adobe.mosaic.mxml.Service

Public Properties

| Property | Defined By
--- | --- | ---
|  | applicationNode : IApplication [read-only] Returns the underlying Composite Application Framework SDK IApplication. | Application
|  | catalogs : Vector.<ICatalogSpecifier> Returns all of the catalogs that this Application has been given reference to. | Application
|  | context : IContext [read-only] Returns the underlying IApplication's IContext. | Application
|  | loaded : Boolean [read-only] Checks if the underlying IApplication is instantiated. | Application
|  | messageBus : IMessageBus [read-only] Returns the IApplication as the IMessageBus. | Application
|  | name : String Returns the set name of the Application (not required for "Transient" Applications) | Application
|  | serverSession : ServerSession Returns the ServerSession instance associated to this Application. | Application
|  | shell : IShell [read-only] Returns the IShell instance associated with the underlying IApplication. | Application
|  | state : String [read-only] Returns the state of this Application mxml component only. | Application

Public Methods

| Method | Defined By
--- | --- | ---
|  | Application() Constructor. | Application
|  | initializeApplication():void Initializes either a "Transient" or "CADL" Application. | Application
|  | initialized(document:Object, id:String):void Implementation of IMXMLObject initialized, makes a call to initializeApplication | Application
|  | loadCatalog(specifier:ICatalogSpecifier, onSuccess:Function = null, onFailure:Function = null):void Loads a Catalog specified in the passed in ICatalogSpecifier via the underlying IApplication. | Application
|  | loadCatalogs():void Makes a request to load all of the ICatalog's that this Application has in its catalogs collection (of ICatalogSpecifier). | Application
|  | requestApplication(name:String):void Makes a request to load an IApplication by the name passed in if the ServerSession is not null and it is in a ServerConstants.STATE_CONNECTED state. | Application

Events
Click for more information on events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | catalogLoadEventFailure | The catalogLoadEventFailure defines a failure notification of an attempt to load a Catalog | Application
|  | catalogLoadEventSuccess | The catalogLoadEventSuccess defines a successful notification of loading a Catalog | Application
|  | loadApplicationEventFailure | The loadApplicationEventFailure defines a failure notification of an attempt to load an Application | Application
|  | loadApplicationEventSuccess | The loadApplicationEventSuccess defines a successful notification of loading an Application | Application

Property Detail

### applicationNode

property

`applicationNode:IApplication` [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

Returns the underlying Composite Application Framework SDK IApplication.

Implementation
`public function get applicationNode():IApplication`

Related API Elements

com.adobe.mosaic.om.interfaces.IApplication.

### catalogs

property

`catalogs:Vector.<ICatalogSpecifier>`

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

Returns all of the catalogs that this Application has been given reference to.

Implementation
`public function get catalogs():Vector.<ICatalogSpecifier>`
`public function set catalogs(value:Vector.<ICatalogSpecifier>):void`

Related API Elements

com.adobe.mosaic.om.interfaces.ICatalogSpecifier
com.adobe.mosaic.om.impl.CatalogSpecifier

### context

property

`context:IContext` [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

Returns the underlying IApplication's IContext.

Implementation
`public function get context():IContext`

Related API Elements

com.adobe.mosaic.om.interfaces.IContext

### 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 IApplication is instantiated.

Implementation
`public function get loaded():Boolean`

### messageBus

property

`messageBus:IMessageBus` [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

Returns the IApplication as the IMessageBus.

Implementation
`public function get messageBus():IMessageBus`

Related API Elements

com.adobe.mosaic.om.interfaces.IMessageBus

### name

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

Returns the set name of the Application (not required for "Transient" Applications)

Implementation
`public function get name():String`
`public function set name(value:String):void`

### serverSession

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

Returns the ServerSession instance associated to this Application. Not a required field for "Transient" Applications

Implementation
`public function get serverSession():ServerSession`
`public function set serverSession(value:ServerSession):void`

Related API Elements

com.adobe.mosaic.mxml.ServerSession

### shell

property

`shell:IShell` [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

Returns the IShell instance associated with the underlying IApplication.

This property can be used as the source for data binding. When this property is modified, it dispatches the `propertyChange` event.

Implementation
`public function get shell():IShell`

Related API Elements

com.adobe.mosaic.om.interfaces.IShell

### state

property

`state:String` [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

Returns the state of this Application mxml component only.

Implementation
`public function get state():String`

Related API Elements

com.adobe.mosaic.om.constants.ApplicationConstants
Constructor Detail

### Application

()
Constructor

`public function Application()`

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.

Method Detail

### initializeApplication

()
method

`public function initializeApplication():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

Initializes either a "Transient" or "CADL" Application. If the serverSession property has been set and the Application name has been set, a call will be made to requestApplication by name.

Related API Elements

requestApplication

### 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, makes a call to initializeApplication

Parameters

| `document:Object` — The document Object
| `id:String` — The mxml id String

### loadCatalog

()
method

`public function loadCatalog(specifier:ICatalogSpecifier, onSuccess:Function = null, onFailure:Function = null):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

Loads a Catalog specified in the passed in ICatalogSpecifier via the underlying IApplication.

Parameters

| `specifier:ICatalogSpecifier` — Specifies the CatalogSpecifier for loading.
| `onSuccess:Function` (default = `null`)`` — (Optional) Specifies the function callback that takes in one parameter of type `CatalogLoadEvent` when the operation succeeded
| `onFailure:Function` (default = `null`)`` — (Optional) Specifies the function callback that takes in one parameter of type `CatalogLoadEvent` when the operation failed

Related API Elements

com.adobe.mosaic.om.interfaces.ICatalogSpecifier
com.adobe.mosaic.om.impl.CatalogSpecifier

### loadCatalogs

()
method

`public function loadCatalogs():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

Makes a request to load all of the ICatalog's that this Application has in its catalogs collection (of ICatalogSpecifier). Only performs if the SDK's IApplication has been initialized and the collection of catalogs is not empty.

### requestApplication

()
method

`public function requestApplication(name: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

Makes a request to load an IApplication by the name passed in if the ServerSession is not null and it is in a ServerConstants.STATE_CONNECTED state. If the ServerSession is not null and is in the state of ServerConstants.STATE_DISCONNECTED, then an attempt will be made to connect. If connection succeeds, the Application will attempt to load.

Parameters

| `name:String` — Specifies the Application name to load.

Related API Elements

com.adobe.mosaic.om.constants.ServerConstants
Event Detail

### catalogLoadEventFailure

Event

Event Object Type: `com.adobe.mosaic.om.events.CatalogLoadEvent`
property 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 a Catalog

The message type sent when a catalog fails to load.

### catalogLoadEventSuccess

Event

Event Object Type: `com.adobe.mosaic.om.events.CatalogLoadEvent`
property 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.

### loadApplicationEventFailure

Event

Event Object Type: `com.adobe.mosaic.om.events.LoadApplicationEvent`
property LoadApplicationEvent.type = `com.adobe.mosaic.om.events.LoadApplicationEvent.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 loadApplicationEventFailure defines a failure notification of an attempt to load an Application

This type is sent when handling failed in loading the requested IApplication

### loadApplicationEventSuccess

Event

Event Object Type: `com.adobe.mosaic.om.events.LoadApplicationEvent`
property LoadApplicationEvent.type = `com.adobe.mosaic.om.events.LoadApplicationEvent.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 loadApplicationEventSuccess defines a successful notification of loading an Application

This type is sent when handling succeeded in loading the requested IApplication
Examples How to use this example
This example demonstrates the component declaration for a Transient Application.
Copy

         <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>

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00