| Package | com.adobe.mosaic.om.interfaces |
| Interface | public interface IApplication extends IMosaicNode , IMessageBus , IMetadataAvailable , IContextProvider |
| 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 |
IApplication interface provides access to the DOM for an application, and provides methods
for adding views, panels, and tiles, as well as querying aspects of the application's environment.
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | childrenNodes : Array [read-only]
Returns an array of child nodes (IMosaicNode objects) of the node. | IMosaicNode | |
| context : IContext [read-only]
Returns the context interface for the application. | IContextProvider | |
| defaultPanels : Array [read-only]
An array of panels that are defined as defaults for the application. | IApplication | ||
| defaultViews : Array [read-only]
An array of views that are defined as defaults for the application. | IApplication | ||
| loadedCatalogs : Array [read-only]
Returns an array representing the catalogs loaded by the application. | IApplication | ||
| metadata : IMetadata [read-only]
Returns the metadata if any of the node. | IMetadataAvailable | |
| nodeID : String [read-only]
Returns the ID of the node. | IMosaicNode | |
| nodeLabel : String
Returns the label of the tile. | IMosaicNode | |
| nodeName : String [read-only]
Returns the name of the node. | IMosaicNode | |
| nodeType : String [read-only]
Returns the type value of the node. | IMosaicNode | |
| parentNode : IMosaicNode [read-only]
Returns the direct parent node of the current node within the application. | IMosaicNode | |
| session : ISession [read-only]
The current ISession associated with this application. | IApplication | ||
| shell : IShell [read-only]
Returns the shell interface for the application. | IApplication | ||
| stylesheets : Array [read-only]
Returns an array of URLs representing each stylesheet the application references. | IApplication | ||
| uniqueID : String [read-only]
Returns the generated unique ID of the node. | IMosaicNode | |
| url : String [read-only]
The current URL for this application's descriptor. | IApplication | ||
| userViews : Array [read-only]
Returns the list of views that a user has saved for this application. | IApplication | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Returns the context interface with the given name for the application. | IApplication | ||
|
Adds a listener for a namespace and name combination. | IMessageBus | |
|
Clones an IMosaicNode. | IMosaicNode | |
Creates a new blank panel in the application. | IApplication | ||
Creates a new blank view in the application. | IApplication | ||
Creates a new blank viewManager in the application. | IApplication | ||
Creates a new layout in the application. | IApplication | ||
Deletes a view saved by a user. | IApplication | ||
Locates a particular node in the DOM based on the node's unique identifier. | IApplication | ||
getUserViews(jcrQueryString:String = null, onSuccess:Function = null, onFailure:Function = null):void
Returns the list of views that a user has saved for this application and satisfies the
Content Repository query criteria. | IApplication | ||
Returns a catalog that has been deployed to the Experience Server. | IApplication | ||
NOT IMPLEMENTED
Loads a service for an application. | IApplication | ||
|
Removes a listener for a namespace and name combination. | IMessageBus | |
|
Resolves any reference elements that may be in the View, Panel, or Tile. | IMosaicNode | |
searchCatalog(specifier:ICatalogSpecifier, jcrQueryString:String = null, onSuccess:Function = null, onFailure:Function = null):void
Returns a partial catalog that has been deployed to the server which satisfies the Content Repository query string. | IApplication | ||
|
Sends a message to all the tiles in a composite application. | IMessageBus | |
Unloads a catalog from memory cache. | IApplication | ||
Property Detail
defaultPanels | property |
defaultPanels:Array [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 |
An array of panels that are defined as defaults for the application.
Implementation
public function get defaultPanels():ArraydefaultViews | property |
defaultViews:Array [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 |
An array of views that are defined as defaults for the application.
Implementation
public function get defaultViews():ArrayloadedCatalogs | property |
loadedCatalogs:Array [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 an array representing the catalogs loaded by the application.
Implementation
public function get loadedCatalogs():ArrayRelated 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 current ISession associated with this application.
Implementation
public function get session():ISessionRelated API Elements
com.adobe.mosaic.om.interfaces.ISession.
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 shell interface for the application.
Implementation
public function get shell():IShellRelated API Elements
stylesheets | property |
stylesheets:Array [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 an array of URLs representing each stylesheet the application references.
The stylesheets can be referenced by tiles to allow you to create consistent styling between tiles and the containing applications.
Implementation
public function get stylesheets():ArrayRelated API Elements
url | property |
url: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 |
The current URL for this application's descriptor.
Implementation
public function get url():StringuserViews | property |
userViews:Array [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 list of views that a user has saved for this application.
Implementation
public function get userViews():ArrayMethod Detail
acquireContextByName | () | method |
public function acquireContextByName(name:String):IContext| 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 context interface with the given name for the application. When a given name does not exist, it is created.
Note: The named application context is seperate the general application context.
Parameters
name:String — Specifies the name of the context.
|
IContext — The context for sharing data between tiles in the same application.
|
Related API Elements
createBlankPanel | () | method |
public function createBlankPanel(l:ILayout = null):IPanel| 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 |
Creates a new blank panel in the application.
Parameters
l:ILayout (default = null)ILayout for the new blank panel.
|
IPanel — A new panel.
|
Related API Elements
createBlankView | () | method |
public function createBlankView(l:ILayout = null):IView| 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 |
Creates a new blank view in the application.
Parameters
l:ILayout (default = null)ILayout for the new blank view.
|
IView — A new view.
|
Related API Elements
createBlankViewManager | () | method |
public function createBlankViewManager(l:ILayout = null):IViewManager| 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 |
Creates a new blank viewManager in the application.
Parameters
l:ILayout (default = null)ILayout for the new blank viewManager.
|
IViewManager — A new viewManager.
|
Related API Elements
createLayout | () | method |
public function createLayout(name:String):ILayout| 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 |
Creates a new layout in the application.
Parameters
name:String — Specifies either a short-cut name for a provided layout or a fully-qualified class name.
|
ILayout — A new layout.
|
Related API Elements
deleteUserView | () | method |
public function deleteUserView(view:IView, 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 |
Deletes a view saved by a user. The resulting DeleteViewEvent indicating success or failure is returned
in the callback function and also dispatched to the MessageListeners.
Parameters
view:IView — Specifies the user's saved view to remove.
| |
onSuccess:Function (default = null)DeleteViewEvent when the operation succeeded.
| |
onFailure:Function (default = null)DeleteViewEvent when the operation failed.
|
findNode | () | method |
public function findNode(id:String):IMosaicNode| 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 |
Locates a particular node in the DOM based on the node's unique identifier.
Parameters
id:String — Specifies the unique ID of the node.
|
IMosaicNode — The node, or null if a node with the ID cannot be located.
|
Related API Elements
getUserViews | () | method |
public function getUserViews(jcrQueryString:String = null, 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 |
Returns the list of views that a user has saved for this application and satisfies the
Content Repository query criteria. The resulting UserViewsLoadEvent indicating success or failure is returned
in the callback function and also dispatched to the MessageListeners.
Example - Query to get all the views created before March 3rd: [jcr:created] < cast('+2011-03-03T11:03:03.000Z' as date)
Parameters
jcrQueryString:String (default = null) | |
onSuccess:Function (default = null)UserViewsLoadEvent when the operation succeeded
| |
onFailure:Function (default = null)UserViewsLoadEvent when the operation failed
|
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 |
Returns a catalog that has been deployed to the Experience Server. When a catalog is deployed to the server, the catalog is loaded into the client memory cache.
This allows you to access tiles, views, etc. from the catalog to add to the application.
Parameters
specifier:ICatalogSpecifier — Specifies the ICatalogSpecifier for the catalog to retrieve.
| |
onSuccess:Function (default = null)CatalogLoadEvent when the operation succeeded.
| |
onFailure:Function (default = null)CatalogLoadEvent when the operation failed.
The onSuccess callback will be called if the loadCatalog call is successful. If the catalog was not already
loaded, the catalog will be loaded into the client cache. The cached copy is returned in the CatalogLoadEvent.
The onFailure callback with occur if the catalog was not available.
|
Related API Elements
Example
How to use this example
This example retrieves a catalog named "sample_catalog":
mosaicApp.addMessageListener(CatalogLoadEvent.NAMESPACE, CatalogLoadEvent.SUCCESS, onCatLoadEvent);
mosaicApp.addMessageListener(CatalogLoadEvent.NAMESPACE, CatalogLoadEvent.FAILURE, onCatLoadEvent);
mosaicApp.loadCatalog(new CatalogSpecifier("sample_catalog"), onLoadSuccess, onLoadFailure);
//functions to manage success or failure callbacks
private function onLoadSuccess(evt:CatalogLoadEvent):void {}
private function onLoadFailure(evt:CatalogLoadEvent):void {}
//functions to manage success or failure events
private function onCatLoadEvent(message:Message):void {
var catalogLoadEvent:CatalogLoadEvent = message.payload as CatalogLoadEvent;
var catalog:ICatalog = catalogLoadEvent.catalog;
//custom processing
}
loadService | () | method |
public function loadService(service:IService, onSuccess:Function, onFailure:Function):void| Language Version: | ActionScript 3.0 |
| Product Version: | NOT IMPLEMENTED |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
NOT IMPLEMENTED Loads a service for an application. The service will not be injected into any variables until a tile is loaded with a reference to the service.
Parameters
service:IService — Specifies the IService instance to load.
| |
onSuccess:Function — Specifies a function callback that takes in one parameter of type Event when the operation succeeded.
| |
onFailure:Function — Specifies a function callback that takes in one parameter of type Event when the operation failed.
|
Related API Elements
searchCatalog | () | method |
public function searchCatalog(specifier:ICatalogSpecifier, jcrQueryString:String = null, 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 |
Returns a partial catalog that has been deployed to the server which satisfies the Content Repository query string. The partial catalog contains only assets which matches the query criteria. This catalog is not cached and fetched from the server everytime.
The returned catalog allows users to access catalog assets from the catalog to add to the application if they are present in the catalog.
Parameters
specifier:ICatalogSpecifier — Specifies the ICatalogSpecifier for the catalog to retrieve.
| |
jcrQueryString:String (default = null) | |
onSuccess:Function (default = null)SearchCatalogEvent when the operation succeeded.
| |
onFailure:Function (default = null)SearchCatalogEvent when the operation failed.
The onSuccess callback will be called if the searchCatalog call is successful. A catalog, containing the assets
that match the jcrQueryString parameter criteria, is returned in the SearchCatalogEvent.
The onFailure callback with occur if the catalog was not available or the jcrQueryString parameter is not valid.
|
Related API Elements
Example
How to use this example
This example searches a catalog named "sample_catalog":
mosaicApp.addMessageListener(SearchCatalogEvent.NAMESPACE, SearchCatalogEvent.SUCCESS, onCatSearchEvent);
mosaicApp.addMessageListener(SearchCatalogEvent.NAMESPACE, SearchCatalogEvent.FAILURE, onCatSearchEvent);
mosaicApp.searchCatalog(new CatalogSpecifier("sample_catalog"), queryString, onSearchSuccess, onSearchFailure);
//functions to manage success or failure callbacks
private function onLoadSuccess(evt:SearchCatalogEvent):void {}
private function onLoadFailure(evt:SearchCatalogEvent):void {}
//functions to manage success or failure events
private function onCatSearchEvent(message:Message):void {
var searchCatalogEvent:SearchCatalogEvent = message.payload as SearchCatalogEvent;
var catalog:ICatalog = searchCatalogEvent.catalog;
//custom processing
}
unloadCatalog | () | method |
public function unloadCatalog(catalog:ICatalog):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 |
Unloads a catalog from memory cache.
This allows you to free memory by unloaded a catalog.
Parameters
catalog:ICatalog — Specifies the ICatalog to be unloaded.
|
Related API Elements
Thu Dec 6 2018, 01:12 PM -08:00