ActionScript® 3.0 Referenzhandbuch für die Adobe® Flash®-Plattform
Home  |  Liste der Pakete und Klassen ausblenden |  Pakete  |  Klassen  |  Neue Funktionen  |  Stichwortverzeichnis  |  Anhänge  |  Warum auf Englisch?
Filter: Daten werden vom Server abgerufen...
Daten werden vom Server abgerufen...
com.adobe.mosaic.om.interfaces 

IApplication  - AS3 ADEP Composite Application

Paketcom.adobe.mosaic.om.interfaces
Schnittstellepublic interface IApplication extends IMosaicNode , IMessageBus , IMetadataAvailable , IContextProvider

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: 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.



Öffentliche Eigenschaften
 EigenschaftDefiniert von
 InheritedchildrenNodes : Array
[schreibgeschützt] Returns an array of child nodes (IMosaicNode objects) of the node.
IMosaicNode
 Inheritedcontext : IContext
[schreibgeschützt] Returns the context interface for the application.
IContextProvider
  defaultPanels : Array
[schreibgeschützt] An array of panels that are defined as defaults for the application.
IApplication
  defaultViews : Array
[schreibgeschützt] An array of views that are defined as defaults for the application.
IApplication
  loadedCatalogs : Array
[schreibgeschützt] Returns an array representing the catalogs loaded by the application.
IApplication
 Inheritedmetadata : IMetadata
[schreibgeschützt] Returns the metadata if any of the node.
IMetadataAvailable
 InheritednodeID : String
[schreibgeschützt] Returns the ID of the node.
IMosaicNode
 InheritednodeLabel : String
Returns the label of the tile.
IMosaicNode
 InheritednodeName : String
[schreibgeschützt] Returns the name of the node.
IMosaicNode
 InheritednodeType : String
[schreibgeschützt] Returns the type value of the node.
IMosaicNode
 InheritedparentNode : IMosaicNode
[schreibgeschützt] Returns the direct parent node of the current node within the application.
IMosaicNode
  session : ISession
[schreibgeschützt] The current ISession associated with this application.
IApplication
  shell : IShell
[schreibgeschützt] Returns the shell interface for the application.
IApplication
  stylesheets : Array
[schreibgeschützt] Returns an array of URLs representing each stylesheet the application references.
IApplication
 InheriteduniqueID : String
[schreibgeschützt] Returns the generated unique ID of the node.
IMosaicNode
  url : String
[schreibgeschützt] The current URL for this application's descriptor.
IApplication
  userViews : Array
[schreibgeschützt] Returns the list of views that a user has saved for this application.
IApplication
Öffentliche Methoden
 MethodeDefiniert von
  
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
Eigenschaftendetails

defaultPanels

Eigenschaft
defaultPanels:Array  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: AIR 2.6, Flash Player 10.2

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



Implementierung
    public function get defaultPanels():Array

defaultViews

Eigenschaft 
defaultViews:Array  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: AIR 2.6, Flash Player 10.2

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



Implementierung
    public function get defaultViews():Array

loadedCatalogs

Eigenschaft 
loadedCatalogs:Array  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: AIR 2.6, Flash Player 10.2

Returns an array representing the catalogs loaded by the application.



Implementierung
    public function get loadedCatalogs():Array

Verwandte API-Elemente

session

Eigenschaft 
session:ISession  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: AIR 2.6, Flash Player 10.2

The current ISession associated with this application.



Implementierung
    public function get session():ISession

Verwandte API-Elemente

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

shell

Eigenschaft 
shell:IShell  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: AIR 2.6, Flash Player 10.2

Returns the shell interface for the application.



Implementierung
    public function get shell():IShell

Verwandte API-Elemente

stylesheets

Eigenschaft 
stylesheets:Array  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: 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.



Implementierung
    public function get stylesheets():Array

Verwandte API-Elemente

url

Eigenschaft 
url:String  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: AIR 2.6, Flash Player 10.2

The current URL for this application's descriptor.



Implementierung
    public function get url():String

userViews

Eigenschaft 
userViews:Array  [schreibgeschützt]

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: AIR 2.6, Flash Player 10.2

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



Implementierung
    public function get userViews():Array
Methodendetails

acquireContextByName

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

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: 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.

Parameter

name:String — Specifies the name of the context.

Rückgabewerte
IContext — The context for sharing data between tiles in the same application.

Verwandte API-Elemente

createBlankPanel

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

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: AIR 2.6, Flash Player 10.2

Creates a new blank panel in the application.

Parameter

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

Rückgabewerte
IPanel — A new panel.

Verwandte API-Elemente

createBlankView

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

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: AIR 2.6, Flash Player 10.2

Creates a new blank view in the application.

Parameter

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

Rückgabewerte
IView — A new view.

Verwandte API-Elemente

createBlankViewManager

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

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: AIR 2.6, Flash Player 10.2

Creates a new blank viewManager in the application.

Parameter

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

Rückgabewerte
IViewManager — A new viewManager.

Verwandte API-Elemente

createLayout

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

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: AIR 2.6, Flash Player 10.2

Creates a new layout in the application.

Parameter

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

Rückgabewerte
ILayout — A new layout.

Verwandte API-Elemente

deleteUserView

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

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: 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.

Parameter

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

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

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: AIR 2.6, Flash Player 10.2

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

Parameter

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

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

Verwandte API-Elemente

getUserViews

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

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: 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)

Parameter

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

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

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: 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.

Parameter

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.

Verwandte API-Elemente


Beispiel
Verwendung dieses Beispiels
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

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

Sprachversion: ActionScript 3.0
Produktversion: NOT IMPLEMENTED
Laufzeitversionen: 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.

Parameter

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.

Verwandte API-Elemente

searchCatalog

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

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: 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.

Parameter

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.

Verwandte API-Elemente


Beispiel
Verwendung dieses Beispiels
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

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

Sprachversion: ActionScript 3.0
Produktversion: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Laufzeitversionen: AIR 2.6, Flash Player 10.2

Unloads a catalog from memory cache.

This allows you to free memory by unloaded a catalog.

Parameter

catalog:ICatalog — Specifies the ICatalog to be unloaded.

Verwandte API-Elemente





[ X ]Warum auf Englisch?
Inhalt des ActionScript 3.0-Referenzhandbuchs wird in englischer Sprache angezeigt

Nicht alle Teile des ActionScript 3.0-Referenzhandbuchs wurden in alle Sprachen übersetzt. Wenn der Text zu einem Sprachelement nicht übersetzt wurde, wird er auf Englisch angezeigt. Zum Beispiel wurden die Informationen zur ga.controls.HelpBox-Klasse nicht in andere Sprachen übersetzt. In der deutschen Version des Referenzhandbuchs erscheint der Abschnitt zur ga.controls.HelpBox-Klasse deshalb auf Englisch.