| Package | com.adobe.mosaic.om.interfaces |
| Interface | public interface IApplication extends IMosaicNode , IMessageBus , IMetadataAvailable , IContextProvider |
| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | 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.
Propriétés publiques
Masquer les propriétés publiques héritées
Afficher les propriétés publiques héritées| Propriété | Défini par | ||
|---|---|---|---|
 | childrenNodes : Array [lecture seule]
Returns an array of child nodes (IMosaicNode objects) of the node. | IMosaicNode | |
| context : IContext [lecture seule]
Returns the context interface for the application. | IContextProvider | |
| defaultPanels : Array [lecture seule]
An array of panels that are defined as defaults for the application. | IApplication | ||
| defaultViews : Array [lecture seule]
An array of views that are defined as defaults for the application. | IApplication | ||
| loadedCatalogs : Array [lecture seule]
Returns an array representing the catalogs loaded by the application. | IApplication | ||
| metadata : IMetadata [lecture seule]
Returns the metadata if any of the node. | IMetadataAvailable | |
| nodeID : String [lecture seule]
Returns the ID of the node. | IMosaicNode | |
| nodeLabel : String
Returns the label of the tile. | IMosaicNode | |
| nodeName : String [lecture seule]
Returns the name of the node. | IMosaicNode | |
| nodeType : String [lecture seule]
Returns the type value of the node. | IMosaicNode | |
| parentNode : IMosaicNode [lecture seule]
Returns the direct parent node of the current node within the application. | IMosaicNode | |
| session : ISession [lecture seule]
The current ISession associated with this application. | IApplication | ||
| shell : IShell [lecture seule]
Returns the shell interface for the application. | IApplication | ||
| stylesheets : Array [lecture seule]
Returns an array of URLs representing each stylesheet the application references. | IApplication | ||
| uniqueID : String [lecture seule]
Returns the generated unique ID of the node. | IMosaicNode | |
| url : String [lecture seule]
The current URL for this application's descriptor. | IApplication | ||
| userViews : Array [lecture seule]
Returns the list of views that a user has saved for this application. | IApplication | ||
Méthodes publiques
| Méthode | Défini par | ||
|---|---|---|---|
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 | ||
Détails de la propriété
defaultPanels | propriété |
defaultPanels:Array [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | AIR 2.6, Flash Player 10.2 |
An array of panels that are defined as defaults for the application.
Implémentation
public function get defaultPanels():ArraydefaultViews | propriété |
defaultViews:Array [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | AIR 2.6, Flash Player 10.2 |
An array of views that are defined as defaults for the application.
Implémentation
public function get defaultViews():ArrayloadedCatalogs | propriété |
loadedCatalogs:Array [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | AIR 2.6, Flash Player 10.2 |
Returns an array representing the catalogs loaded by the application.
Implémentation
public function get loadedCatalogs():ArrayEléments de l’API associés
session | propriété |
session:ISession [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | AIR 2.6, Flash Player 10.2 |
The current ISession associated with this application.
Implémentation
public function get session():ISessionEléments de l’API associés
com.adobe.mosaic.om.interfaces.ISession.
shell | propriété |
shell:IShell [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | AIR 2.6, Flash Player 10.2 |
Returns the shell interface for the application.
Implémentation
public function get shell():IShellEléments de l’API associés
stylesheets | propriété |
stylesheets:Array [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | 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.
Implémentation
public function get stylesheets():ArrayEléments de l’API associés
url | propriété |
url:String [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | AIR 2.6, Flash Player 10.2 |
The current URL for this application's descriptor.
Implémentation
public function get url():StringuserViews | propriété |
userViews:Array [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | AIR 2.6, Flash Player 10.2 |
Returns the list of views that a user has saved for this application.
Implémentation
public function get userViews():ArrayDétails de la méthode
acquireContextByName | () | méthode |
public function acquireContextByName(name:String):IContext| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | 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.
Paramètres
name:String — Specifies the name of the context.
|
IContext — The context for sharing data between tiles in the same application.
|
Eléments de l’API associés
createBlankPanel | () | méthode |
public function createBlankPanel(l:ILayout = null):IPanel| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | AIR 2.6, Flash Player 10.2 |
Creates a new blank panel in the application.
Paramètres
l:ILayout (default = null)ILayout for the new blank panel.
|
IPanel — A new panel.
|
Eléments de l’API associés
createBlankView | () | méthode |
public function createBlankView(l:ILayout = null):IView| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | AIR 2.6, Flash Player 10.2 |
Creates a new blank view in the application.
Paramètres
l:ILayout (default = null)ILayout for the new blank view.
|
IView — A new view.
|
Eléments de l’API associés
createBlankViewManager | () | méthode |
public function createBlankViewManager(l:ILayout = null):IViewManager| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | AIR 2.6, Flash Player 10.2 |
Creates a new blank viewManager in the application.
Paramètres
l:ILayout (default = null)ILayout for the new blank viewManager.
|
IViewManager — A new viewManager.
|
Eléments de l’API associés
createLayout | () | méthode |
public function createLayout(name:String):ILayout| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | AIR 2.6, Flash Player 10.2 |
Creates a new layout in the application.
Paramètres
name:String — Specifies either a short-cut name for a provided layout or a fully-qualified class name.
|
ILayout — A new layout.
|
Eléments de l’API associés
deleteUserView | () | méthode |
public function deleteUserView(view:IView, onSuccess:Function = null, onFailure:Function = null):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | 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.
Paramètres
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 | () | méthode |
public function findNode(id:String):IMosaicNode| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | AIR 2.6, Flash Player 10.2 |
Locates a particular node in the DOM based on the node's unique identifier.
Paramètres
id:String — Specifies the unique ID of the node.
|
IMosaicNode — The node, or null if a node with the ID cannot be located.
|
Eléments de l’API associés
getUserViews | () | méthode |
public function getUserViews(jcrQueryString:String = null, onSuccess:Function = null, onFailure:Function = null):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | 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)
Paramètres
jcrQueryString:String (default = null) | |
onSuccess:Function (default = null)UserViewsLoadEvent when the operation succeeded
| |
onFailure:Function (default = null)UserViewsLoadEvent when the operation failed
|
loadCatalog | () | méthode |
public function loadCatalog(specifier:ICatalogSpecifier, onSuccess:Function = null, onFailure:Function = null):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | 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.
Paramètres
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.
|
Eléments de l’API associés
Exemple
Comment utiliser cet exemple
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 | () | méthode |
public function loadService(service:IService, onSuccess:Function, onFailure:Function):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | NOT IMPLEMENTED |
| Versions du moteur d’exécution: | 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.
Paramètres
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.
|
Eléments de l’API associés
searchCatalog | () | méthode |
public function searchCatalog(specifier:ICatalogSpecifier, jcrQueryString:String = null, onSuccess:Function = null, onFailure:Function = null):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | 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.
Paramètres
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.
|
Eléments de l’API associés
Exemple
Comment utiliser cet exemple
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 | () | méthode |
public function unloadCatalog(catalog:ICatalog):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Versions du moteur d’exécution: | AIR 2.6, Flash Player 10.2 |
Unloads a catalog from memory cache.
This allows you to free memory by unloaded a catalog.
Paramètres
catalog:ICatalog — Specifies the ICatalog to be unloaded.
|
Eléments de l’API associés
Tue Jun 12 2018, 09:30 AM Z