ActionScript® 3.0 — dokumentacja dla platformy Adobe® Flash®
Strona główna  |  Ukryj listę pakietów i klas |  Pakiety  |  Klasy  |  Nowości  |  Indeks  |  Dodatki  |  Dlaczego język angielski?
Filtry: Pobieranie danych z serwera...
Pobieranie danych z serwera...
com.adobe.mosaic.om.interfaces 

IApplication  - AS3 ADEP Composite Application

Pakietcom.adobe.mosaic.om.interfaces
Interfejspublic interface IApplication extends IMosaicNode , IMessageBus , IMetadataAvailable , IContextProvider

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: 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.



Właściwości publiczne
 WłaściwośćZdefiniowane przez
 InheritedchildrenNodes : Array
[tylko do odczytu] Returns an array of child nodes (IMosaicNode objects) of the node.
IMosaicNode
 Inheritedcontext : IContext
[tylko do odczytu] Returns the context interface for the application.
IContextProvider
  defaultPanels : Array
[tylko do odczytu] An array of panels that are defined as defaults for the application.
IApplication
  defaultViews : Array
[tylko do odczytu] An array of views that are defined as defaults for the application.
IApplication
  loadedCatalogs : Array
[tylko do odczytu] Returns an array representing the catalogs loaded by the application.
IApplication
 Inheritedmetadata : IMetadata
[tylko do odczytu] Returns the metadata if any of the node.
IMetadataAvailable
 InheritednodeID : String
[tylko do odczytu] Returns the ID of the node.
IMosaicNode
 InheritednodeLabel : String
Returns the label of the tile.
IMosaicNode
 InheritednodeName : String
[tylko do odczytu] Returns the name of the node.
IMosaicNode
 InheritednodeType : String
[tylko do odczytu] Returns the type value of the node.
IMosaicNode
 InheritedparentNode : IMosaicNode
[tylko do odczytu] Returns the direct parent node of the current node within the application.
IMosaicNode
  session : ISession
[tylko do odczytu] The current ISession associated with this application.
IApplication
  shell : IShell
[tylko do odczytu] Returns the shell interface for the application.
IApplication
  stylesheets : Array
[tylko do odczytu] Returns an array of URLs representing each stylesheet the application references.
IApplication
 InheriteduniqueID : String
[tylko do odczytu] Returns the generated unique ID of the node.
IMosaicNode
  url : String
[tylko do odczytu] The current URL for this application's descriptor.
IApplication
  userViews : Array
[tylko do odczytu] Returns the list of views that a user has saved for this application.
IApplication
Metody publiczne
 MetodaZdefiniowane przez
  
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
Szczegół właściwości

defaultPanels

właściwość
defaultPanels:Array  [tylko do odczytu]

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: AIR 2.6, Flash Player 10.2

An array of panels that are defined as defaults for the application.



Implementacja
    public function get defaultPanels():Array

defaultViews

właściwość 
defaultViews:Array  [tylko do odczytu]

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: AIR 2.6, Flash Player 10.2

An array of views that are defined as defaults for the application.



Implementacja
    public function get defaultViews():Array

loadedCatalogs

właściwość 
loadedCatalogs:Array  [tylko do odczytu]

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: AIR 2.6, Flash Player 10.2

Returns an array representing the catalogs loaded by the application.



Implementacja
    public function get loadedCatalogs():Array

Powiązane elementy interfejsu API

session

właściwość 
session:ISession  [tylko do odczytu]

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: AIR 2.6, Flash Player 10.2

The current ISession associated with this application.



Implementacja
    public function get session():ISession

Powiązane elementy interfejsu API

com.adobe.mosaic.om.interfaces.ISession.

shell

właściwość 
shell:IShell  [tylko do odczytu]

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: AIR 2.6, Flash Player 10.2

Returns the shell interface for the application.



Implementacja
    public function get shell():IShell

Powiązane elementy interfejsu API

stylesheets

właściwość 
stylesheets:Array  [tylko do odczytu]

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: 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.



Implementacja
    public function get stylesheets():Array

Powiązane elementy interfejsu API

url

właściwość 
url:String  [tylko do odczytu]

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: AIR 2.6, Flash Player 10.2

The current URL for this application's descriptor.



Implementacja
    public function get url():String

userViews

właściwość 
userViews:Array  [tylko do odczytu]

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: AIR 2.6, Flash Player 10.2

Returns the list of views that a user has saved for this application.



Implementacja
    public function get userViews():Array
Szczegół metody

acquireContextByName

()metoda
public function acquireContextByName(name:String):IContext

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: 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.

Parametry

name:String — Specifies the name of the context.

Zwraca
IContext — The context for sharing data between tiles in the same application.

Powiązane elementy interfejsu API

createBlankPanel

()metoda 
public function createBlankPanel(l:ILayout = null):IPanel

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: AIR 2.6, Flash Player 10.2

Creates a new blank panel in the application.

Parametry

l:ILayout (default = null) — Specifies the ILayout for the new blank panel.

Zwraca
IPanel — A new panel.

Powiązane elementy interfejsu API

createBlankView

()metoda 
public function createBlankView(l:ILayout = null):IView

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: AIR 2.6, Flash Player 10.2

Creates a new blank view in the application.

Parametry

l:ILayout (default = null) — Specifies the ILayout for the new blank view.

Zwraca
IView — A new view.

Powiązane elementy interfejsu API

createBlankViewManager

()metoda 
public function createBlankViewManager(l:ILayout = null):IViewManager

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: AIR 2.6, Flash Player 10.2

Creates a new blank viewManager in the application.

Parametry

l:ILayout (default = null) — Specifies the ILayout for the new blank viewManager.

Zwraca
IViewManager — A new viewManager.

Powiązane elementy interfejsu API

createLayout

()metoda 
public function createLayout(name:String):ILayout

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: AIR 2.6, Flash Player 10.2

Creates a new layout in the application.

Parametry

name:String — Specifies either a short-cut name for a provided layout or a fully-qualified class name.

Zwraca
ILayout — A new layout.

Powiązane elementy interfejsu API

deleteUserView

()metoda 
public function deleteUserView(view:IView, onSuccess:Function = null, onFailure:Function = null):void

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: 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.

Parametry

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

()metoda 
public function findNode(id:String):IMosaicNode

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: AIR 2.6, Flash Player 10.2

Locates a particular node in the DOM based on the node's unique identifier.

Parametry

id:String — Specifies the unique ID of the node.

Zwraca
IMosaicNode — The node, or null if a node with the ID cannot be located.

Powiązane elementy interfejsu API

getUserViews

()metoda 
public function getUserViews(jcrQueryString:String = null, onSuccess:Function = null, onFailure:Function = null):void

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: 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)

Parametry

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

()metoda 
public function loadCatalog(specifier:ICatalogSpecifier, onSuccess:Function = null, onFailure:Function = null):void

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: 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.

Parametry

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.

Powiązane elementy interfejsu API


Przykład
Sposób korzystania z tego przykładu
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

()metoda 
public function loadService(service:IService, onSuccess:Function, onFailure:Function):void

Wersja języka: ActionScript 3.0
Wersja produktu: NOT IMPLEMENTED
Wersje środowiska wykonawczego: 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.

Parametry

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.

Powiązane elementy interfejsu API

searchCatalog

()metoda 
public function searchCatalog(specifier:ICatalogSpecifier, jcrQueryString:String = null, onSuccess:Function = null, onFailure:Function = null):void

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: 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.

Parametry

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.

Powiązane elementy interfejsu API


Przykład
Sposób korzystania z tego przykładu
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

()metoda 
public function unloadCatalog(catalog:ICatalog):void

Wersja języka: ActionScript 3.0
Wersja produktu: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Wersje środowiska wykonawczego: AIR 2.6, Flash Player 10.2

Unloads a catalog from memory cache.

This allows you to free memory by unloaded a catalog.

Parametry

catalog:ICatalog — Specifies the ICatalog to be unloaded.

Powiązane elementy interfejsu API





[ X ]Dlaczego język angielski?
Treść dokumentacji języka ActionScript 3.0 wyświetlana w języku angielskim

Niektóre części dokumentacji języka ActionScript 3.0 nie są przetłumaczone na poszczególne języki. Gdy element nie jest przetłumaczony na dany język, jest wyświetlany tekst angielski. Na przykład opis klasy ga.controls.HelpBox nie jest przetłumaczony na żaden dodatkowy język. Z tego powodu polska wersja dokumentacji zawiera opis klasy ga.controls.HelpBox w języku angielskim.