| Пакет | 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 | свойство |
defaultPanels:Array [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Версии среды выполнения: | AIR 2.6, Flash Player 10.2 |
An array of panels that are defined as defaults for the application.
Реализация
public function get defaultPanels():ArraydefaultViews | свойство |
defaultViews:Array [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Версии среды выполнения: | AIR 2.6, Flash Player 10.2 |
An array of views that are defined as defaults for the application.
Реализация
public function get defaultViews():ArrayloadedCatalogs | свойство |
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 | свойство |
shell:IShell [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Версии среды выполнения: | AIR 2.6, Flash Player 10.2 |
Returns the shell interface for the application.
Реализация
public function get shell():IShellСвязанные элементы API
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 | свойство |
url:String [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Версии среды выполнения: | AIR 2.6, Flash Player 10.2 |
The current URL for this application's descriptor.
Реализация
public function get url():StringuserViews | свойство |
userViews:Array [только для чтения] | Язык версии: | 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.
Реализация
public function get userViews():ArrayСведения о методе
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:34 AM Z