Referência do ActionScript® 3.0 para Adobe® Flash® Platform
Início  |  Ocultar listas de Pacotes e Classes |  Pacotes  |  Classes  |  Novidades  |  Índice  |  Apêndices  |  Por que inglês?
Filtros: Recuperando dados do servidor...
Recuperando dados do servidor...
com.adobe.mosaic.om.interfaces 

IApplication  - AS3 ADEP Composite Application

Pacotecom.adobe.mosaic.om.interfaces
Interfacepublic interface IApplication extends IMosaicNode , IMessageBus , IMetadataAvailable , IContextProvider

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: 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.



Propriedades públicas
 PropriedadeDefinido por
 InheritedchildrenNodes : Array
[somente leitura] Returns an array of child nodes (IMosaicNode objects) of the node.
IMosaicNode
 Inheritedcontext : IContext
[somente leitura] Returns the context interface for the application.
IContextProvider
  defaultPanels : Array
[somente leitura] An array of panels that are defined as defaults for the application.
IApplication
  defaultViews : Array
[somente leitura] An array of views that are defined as defaults for the application.
IApplication
  loadedCatalogs : Array
[somente leitura] Returns an array representing the catalogs loaded by the application.
IApplication
 Inheritedmetadata : IMetadata
[somente leitura] Returns the metadata if any of the node.
IMetadataAvailable
 InheritednodeID : String
[somente leitura] Returns the ID of the node.
IMosaicNode
 InheritednodeLabel : String
Returns the label of the tile.
IMosaicNode
 InheritednodeName : String
[somente leitura] Returns the name of the node.
IMosaicNode
 InheritednodeType : String
[somente leitura] Returns the type value of the node.
IMosaicNode
 InheritedparentNode : IMosaicNode
[somente leitura] Returns the direct parent node of the current node within the application.
IMosaicNode
  session : ISession
[somente leitura] The current ISession associated with this application.
IApplication
  shell : IShell
[somente leitura] Returns the shell interface for the application.
IApplication
  stylesheets : Array
[somente leitura] Returns an array of URLs representing each stylesheet the application references.
IApplication
 InheriteduniqueID : String
[somente leitura] Returns the generated unique ID of the node.
IMosaicNode
  url : String
[somente leitura] The current URL for this application's descriptor.
IApplication
  userViews : Array
[somente leitura] Returns the list of views that a user has saved for this application.
IApplication
Métodos públicos
 MétodoDefinido por
  
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
Detalhes da propriedade

defaultPanels

propriedade
defaultPanels:Array  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: AIR 2.6, Flash Player 10.2

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



Implementação
    public function get defaultPanels():Array

defaultViews

propriedade 
defaultViews:Array  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: AIR 2.6, Flash Player 10.2

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



Implementação
    public function get defaultViews():Array

loadedCatalogs

propriedade 
loadedCatalogs:Array  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: AIR 2.6, Flash Player 10.2

Returns an array representing the catalogs loaded by the application.



Implementação
    public function get loadedCatalogs():Array

Elementos da API relacionados

session

propriedade 
session:ISession  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: AIR 2.6, Flash Player 10.2

The current ISession associated with this application.



Implementação
    public function get session():ISession

Elementos da API relacionados

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

shell

propriedade 
shell:IShell  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: AIR 2.6, Flash Player 10.2

Returns the shell interface for the application.



Implementação
    public function get shell():IShell

Elementos da API relacionados

stylesheets

propriedade 
stylesheets:Array  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: 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.



Implementação
    public function get stylesheets():Array

Elementos da API relacionados

url

propriedade 
url:String  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: AIR 2.6, Flash Player 10.2

The current URL for this application's descriptor.



Implementação
    public function get url():String

userViews

propriedade 
userViews:Array  [somente leitura]

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: AIR 2.6, Flash Player 10.2

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



Implementação
    public function get userViews():Array
Detalhes do método

acquireContextByName

()método
public function acquireContextByName(name:String):IContext

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: 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.

Parâmetros

name:String — Specifies the name of the context.

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

Elementos da API relacionados

createBlankPanel

()método 
public function createBlankPanel(l:ILayout = null):IPanel

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: AIR 2.6, Flash Player 10.2

Creates a new blank panel in the application.

Parâmetros

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

Retorna
IPanel — A new panel.

Elementos da API relacionados

createBlankView

()método 
public function createBlankView(l:ILayout = null):IView

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: AIR 2.6, Flash Player 10.2

Creates a new blank view in the application.

Parâmetros

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

Retorna
IView — A new view.

Elementos da API relacionados

createBlankViewManager

()método 
public function createBlankViewManager(l:ILayout = null):IViewManager

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: AIR 2.6, Flash Player 10.2

Creates a new blank viewManager in the application.

Parâmetros

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

Retorna
IViewManager — A new viewManager.

Elementos da API relacionados

createLayout

()método 
public function createLayout(name:String):ILayout

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: AIR 2.6, Flash Player 10.2

Creates a new layout in the application.

Parâmetros

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

Retorna
ILayout — A new layout.

Elementos da API relacionados

deleteUserView

()método 
public function deleteUserView(view:IView, onSuccess:Function = null, onFailure:Function = null):void

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: 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.

Parâmetros

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

()método 
public function findNode(id:String):IMosaicNode

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: AIR 2.6, Flash Player 10.2

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

Parâmetros

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

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

Elementos da API relacionados

getUserViews

()método 
public function getUserViews(jcrQueryString:String = null, onSuccess:Function = null, onFailure:Function = null):void

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: 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)

Parâmetros

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

()método 
public function loadCatalog(specifier:ICatalogSpecifier, onSuccess:Function = null, onFailure:Function = null):void

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: 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.

Parâmetros

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.

Elementos da API relacionados


Exemplo
Como usar este exemplo
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

()método 
public function loadService(service:IService, onSuccess:Function, onFailure:Function):void

Versão da linguagem: ActionScript 3.0
Versão de produto: NOT IMPLEMENTED
Versões de runtime: 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.

Parâmetros

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.

Elementos da API relacionados

searchCatalog

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

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: 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.

Parâmetros

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.

Elementos da API relacionados


Exemplo
Como usar este exemplo
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

()método 
public function unloadCatalog(catalog:ICatalog):void

Versão da linguagem: ActionScript 3.0
Versão de produto: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Versões de runtime: AIR 2.6, Flash Player 10.2

Unloads a catalog from memory cache.

This allows you to free memory by unloaded a catalog.

Parâmetros

catalog:ICatalog — Specifies the ICatalog to be unloaded.

Elementos da API relacionados





[ X ]Por que inglês?
O conteúdo na Referência do ActionScript 3.0 aparece em inglês

Nem todas as partes da Referência do ActionScript 3.0 estão traduzidas em todos os idiomas. Quando um elemento de um idioma não está traduzido, ele é exibido em inglês. Por exemplo, a classe ga.controls.HelpBox não está traduzida em nenhum idioma. Por isso, na versão da referência em português do Brasil, a classe ga.controls.HelpBox é exibida em inglês.