| 包 | com.adobe.mosaic.om.interfaces |
| 接口 | public interface IApplication extends IMosaicNode , IMessageBus , IMetadataAvailable , IContextProvider |
| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| 运行时版本: | 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.
公共属性
隐藏继承的公共属性
显示继承的公共属性| 属性 | 由以下参数定义 | ||
|---|---|---|---|
 | childrenNodes : Array [只读]
Returns an array of child nodes (IMosaicNode objects) of the node. | IMosaicNode | |
| context : IContext [只读]
Returns the context interface for the application. | IContextProvider | |
| defaultPanels : Array [只读]
An array of panels that are defined as defaults for the application. | IApplication | ||
| defaultViews : Array [只读]
An array of views that are defined as defaults for the application. | IApplication | ||
| loadedCatalogs : Array [只读]
Returns an array representing the catalogs loaded by the application. | IApplication | ||
| metadata : IMetadata [只读]
Returns the metadata if any of the node. | IMetadataAvailable | |
| nodeID : String [只读]
Returns the ID of the node. | IMosaicNode | |
| nodeLabel : String
Returns the label of the tile. | IMosaicNode | |
| nodeName : String [只读]
Returns the name of the node. | IMosaicNode | |
| nodeType : String [只读]
Returns the type value of the node. | IMosaicNode | |
| parentNode : IMosaicNode [只读]
Returns the direct parent node of the current node within the application. | IMosaicNode | |
| session : ISession [只读]
The current ISession associated with this application. | IApplication | ||
| shell : IShell [只读]
Returns the shell interface for the application. | IApplication | ||
| stylesheets : Array [只读]
Returns an array of URLs representing each stylesheet the application references. | IApplication | ||
| uniqueID : String [只读]
Returns the generated unique ID of the node. | IMosaicNode | |
| url : String [只读]
The current URL for this application's descriptor. | IApplication | ||
| userViews : Array [只读]
Returns the list of views that a user has saved for this application. | IApplication | ||
公共方法
| 方法 | 由以下参数定义 | ||
|---|---|---|---|
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 | ||
属性详细信息
defaultPanels | 属性 |
defaultViews | 属性 |
loadedCatalogs | 属性 |
loadedCatalogs:Array [只读] | 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| 运行时版本: | AIR 2.6, Flash Player 10.2 |
Returns an array representing the catalogs loaded by the application.
实现
public function get loadedCatalogs():Array相关 API 元素
session | 属性 |
session:ISession [只读] | 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| 运行时版本: | AIR 2.6, Flash Player 10.2 |
The current ISession associated with this application.
实现
public function get session():ISession相关 API 元素
com.adobe.mosaic.om.interfaces.ISession.
shell | 属性 |
stylesheets | 属性 |
stylesheets:Array [只读] | 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| 运行时版本: | 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.
实现
public function get stylesheets():Array相关 API 元素
url | 属性 |
userViews | 属性 |
方法详细信息
acquireContextByName | () | 方法 |
public function acquireContextByName(name:String):IContext| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| 运行时版本: | 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.
参数
name:String — Specifies the name of the context.
|
IContext — The context for sharing data between tiles in the same application.
|
相关 API 元素
createBlankPanel | () | 方法 |
public function createBlankPanel(l:ILayout = null):IPanel| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| 运行时版本: | AIR 2.6, Flash Player 10.2 |
Creates a new blank panel in the application.
参数
l:ILayout (default = null)ILayout for the new blank panel.
|
IPanel — A new panel.
|
相关 API 元素
createBlankView | () | 方法 |
public function createBlankView(l:ILayout = null):IView| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| 运行时版本: | AIR 2.6, Flash Player 10.2 |
Creates a new blank view in the application.
参数
l:ILayout (default = null)ILayout for the new blank view.
|
IView — A new view.
|
相关 API 元素
createBlankViewManager | () | 方法 |
public function createBlankViewManager(l:ILayout = null):IViewManager| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| 运行时版本: | AIR 2.6, Flash Player 10.2 |
Creates a new blank viewManager in the application.
参数
l:ILayout (default = null)ILayout for the new blank viewManager.
|
IViewManager — A new viewManager.
|
相关 API 元素
createLayout | () | 方法 |
public function createLayout(name:String):ILayout| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| 运行时版本: | AIR 2.6, Flash Player 10.2 |
Creates a new layout in the application.
参数
name:String — Specifies either a short-cut name for a provided layout or a fully-qualified class name.
|
ILayout — A new layout.
|
相关 API 元素
deleteUserView | () | 方法 |
public function deleteUserView(view:IView, onSuccess:Function = null, onFailure:Function = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| 运行时版本: | 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.
参数
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 | () | 方法 |
public function findNode(id:String):IMosaicNode| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| 运行时版本: | AIR 2.6, Flash Player 10.2 |
Locates a particular node in the DOM based on the node's unique identifier.
参数
id:String — Specifies the unique ID of the node.
|
IMosaicNode — The node, or null if a node with the ID cannot be located.
|
相关 API 元素
getUserViews | () | 方法 |
public function getUserViews(jcrQueryString:String = null, onSuccess:Function = null, onFailure:Function = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| 运行时版本: | 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)
参数
jcrQueryString:String (default = null) | |
onSuccess:Function (default = null)UserViewsLoadEvent when the operation succeeded
| |
onFailure:Function (default = null)UserViewsLoadEvent when the operation failed
|
loadCatalog | () | 方法 |
public function loadCatalog(specifier:ICatalogSpecifier, onSuccess:Function = null, onFailure:Function = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| 运行时版本: | 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.
参数
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.
|
相关 API 元素
示例
如何使用本示例
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 | () | 方法 |
public function loadService(service:IService, onSuccess:Function, onFailure:Function):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | NOT IMPLEMENTED |
| 运行时版本: | 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.
参数
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.
|
相关 API 元素
searchCatalog | () | 方法 |
public function searchCatalog(specifier:ICatalogSpecifier, jcrQueryString:String = null, onSuccess:Function = null, onFailure:Function = null):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| 运行时版本: | 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.
参数
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.
|
相关 API 元素
示例
如何使用本示例
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 | () | 方法 |
public function unloadCatalog(catalog:ICatalog):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| 运行时版本: | AIR 2.6, Flash Player 10.2 |
Unloads a catalog from memory cache.
This allows you to free memory by unloaded a catalog.
参数
catalog:ICatalog — Specifies the ICatalog to be unloaded.
|
相关 API 元素
Tue Jun 12 2018, 11:04 AM Z