適用於 Adobe® Flash® Platform 的 ActionScript® 3.0 參考
首頁  |  隱藏套件和類別清單 |  套件  |  類別  |  新增內容  |  索引  |  附錄  |  為什麼顯示英文?
篩選: 從伺服器擷取資料...
從伺服器擷取資料...
com.adobe.mosaic.om.interfaces 

IApplication  - AS3 ADEP Composite Application

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

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



公用屬性
 屬性定義自
 InheritedchildrenNodes : Array
[唯讀] Returns an array of child nodes (IMosaicNode objects) of the node.
IMosaicNode
 Inheritedcontext : 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
 Inheritedmetadata : IMetadata
[唯讀] Returns the metadata if any of the node.
IMetadataAvailable
 InheritednodeID : String
[唯讀] Returns the ID of the node.
IMosaicNode
 InheritednodeLabel : String
Returns the label of the tile.
IMosaicNode
 InheritednodeName : String
[唯讀] Returns the name of the node.
IMosaicNode
 InheritednodeType : String
[唯讀] Returns the type value of the node.
IMosaicNode
 InheritedparentNode : 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
 InheriteduniqueID : 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
 Inherited
addMessageListener(namespace:String, name:String, handler:Function):void
Adds a listener for a namespace and name combination.
IMessageBus
 Inherited
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
  
deleteUserView(view:IView, onSuccess:Function = null, onFailure:Function = null):void
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
  
loadCatalog(specifier:ICatalogSpecifier, onSuccess:Function = null, onFailure:Function = null):void
Returns a catalog that has been deployed to the Experience Server.
IApplication
  
loadService(service:IService, onSuccess:Function, onFailure:Function):void
NOT IMPLEMENTED Loads a service for an application.
IApplication
 Inherited
removeMessageListener(namespace:String, name:String, handler:Function):void
Removes a listener for a namespace and name combination.
IMessageBus
 Inherited
resolveReferences(onSuccess:Function = null, onFailure:Function = null):void
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
 Inherited
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():Array

defaultViews

屬性 
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():Array

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

屬性 
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():String

userViews

屬性 
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) — Specifies the 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) — Specifies the 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) — Specifies the 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) — Specifies a function callback that takes in one parameter of type DeleteViewEvent when the operation succeeded.
 
onFailure:Function (default = null) — Specifies a Function callback that takes in one parameter of type 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) — Specifies the query string in JCR-SQL2 format which will be used to fetch the views.
 
onSuccess:Function (default = null) — Specifies a function callback that takes in one parameter of type UserViewsLoadEvent when the operation succeeded
 
onFailure:Function (default = null) — Specifies a function callback that takes in one parameter of type 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) — Specifies a function callback that takes in one parameter of type CatalogLoadEvent when the operation succeeded.
 
onFailure:Function (default = null) — Specifies a function callback that takes in one parameter of type 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) — Specifies the query string which is in JCR-SQL2 format.
 
onSuccess:Function (default = null) — Specifies a function callback that takes in one parameter of type SearchCatalogEvent when the operation succeeded.
 
onFailure:Function (default = null) — Specifies a function callback that takes in one parameter of type 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 元素





[ X ]為什麼顯示英文?
「ActionScript 3.0 參考」的內容是以英文顯示

並非所有「ActionScript 3.0 參考」的內容都翻譯為所有語言。當語言元素未翻譯時,就會以英文顯示。例如,ga.controls.HelpBox 類別並沒有翻譯為任何語言。因此在參考的繁體中文版本中,ga.controls.HelpBox 類別就會以英文顯示。