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.icc.editors.model 

FragmentLayoutModel  - AS3 Asset Composer

Pacotecom.adobe.icc.editors.model
Classepublic class FragmentLayoutModel
HerançaFragmentLayoutModel Inheritance AssetModel Inheritance EventDispatcher Inheritance Object

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10
Versões de runtime: AIR (unsupported), Flash Player 10.2

The FragmentLayoutModel class represents the domain object for the assets of type FragmentLayout. Domain objects can be leveraged to build presentation on top of them. They ease the process of coding views by abstracting all the service calls and maintaining meaningful states.



Propriedades públicas
 PropriedadeDefinido por
 InheritedactiveEndDate : Date
The activeEndDate of the underlying value object.
AssetModel
 InheritedactiveStartDate : Date
The activeStartDate date of the underlying value object.
AssetModel
 Inheritedcategory : Category
The Category of the underlying value object.
AssetModel
 Inheritedcomment : String
The comment of the underlying value object.
AssetModel
 Inheritedconstructor : Object
Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto.
Object
 InheritedcrxVersion : String
The crx version of the underlying value object.
AssetModel
  cutsomizedLayout : Boolean
The tables of the underlying value object.
FragmentLayoutModel
 Inheriteddescription : String
The description of the underlying value object.
AssetModel
 InheritedextendedProperties : Object
The extended properties of the underlying value object.
AssetModel
  fields : IList
The fields of the underlying value object.
FragmentLayoutModel
  file : FileModel
The file domain object associated with this fragmentLayout.
FragmentLayoutModel
  flowedLayout : Boolean
whether underlying value object is a flowed layout or not
FragmentLayoutModel
 Inheritedid : String
The GUID of the underlying value object.
AssetModel
 InheritedisNew : Boolean
Indicates if this Asset is new.
AssetModel
 InheritedlastChangeBy : String
The lastChangeBy property of the underlying value object.
AssetModel
 Inheritedname : String
The name of the underlying value object.
AssetModel
  shallow : Boolean
Flag to indicate if the underlying value object is shallow.
FragmentLayoutModel
 Inheritedstate : int
The state of the underlying value object.
AssetModel
 InheritedsubCategory : Category
The Sub-Category of the underlying value object.
AssetModel
  tables : IList
The tables of the underlying value object.
FragmentLayoutModel
  targetAreas : IList
The target areas of the underlying value object.
FragmentLayoutModel
 Inheritedversion : int
The version of the underlying value object.
AssetModel
 Inheritedvo : *
The value object which this asset domain object is built atop.
AssetModel
Propriedades protegidas
 PropriedadeDefinido por
 InheritedisCopy : Boolean
Indicates that the object is a copy of an existing Asset.
AssetModel
 InheritedoldId : String
Id of the Asset which was cloned to create this copy.
AssetModel
 InheritedpreferencesManager : PreferencesManager
To manage user preferences for category, subcategory and data dictionary.
AssetModel
Métodos públicos
 MétodoDefinido por
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento.
EventDispatcher
  
Creates a copy of the domain object.
FragmentLayoutModel
  
createFromVO(fragmentLayoutVO:FragmentLayout, fetchFromServer:Boolean = true):FragmentLayoutModel
[estático] Creates the domain object from the corresponding value object.
FragmentLayoutModel
 Inherited
Envia um evento para o fluxo de eventos.
EventDispatcher
  
Fetches the complete value object via remoting call.
FragmentLayoutModel
  
Fetches the complete value object via remoting call.
FragmentLayoutModel
 Inherited
Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento.
EventDispatcher
 Inherited
Indica se um objeto tem uma propriedade especificada definida.
Object
 Inherited
Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro.
Object
  
Indicates if the underlying value object is shallow.
FragmentLayoutModel
 Inherited
Indica se a propriedade especificada existe e é enumerável.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Remove um ouvinte do objeto EventDispatcher.
EventDispatcher
  
[substituir] Saves the underlying value object on the server.
FragmentLayoutModel
  
[estático] This method lets you inject a custom implementation of the infrastructure fragmentLayout service.
FragmentLayoutModel
 Inherited
Define a disponibilidade de uma propriedade dinâmica para operações de repetição.
Object
 Inherited
Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade.
Object
 Inherited
Retorna a representação de string do objeto especificado.
Object
 Inherited
Retorna o valor primitivo do objeto especificado.
Object
 Inherited
Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado.
EventDispatcher
Eventos
 Evento Resumo Definido por
 Inherited[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR ganha o foco do sistema operacional e está se tornando inativo.EventDispatcher
 Inherited[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR perde o foco do sistema operacional e está se tornando inativo.EventDispatcher
  Dispatched when this Asset is completely fetched from the server.FragmentLayoutModel
  Dispatched when the fragmentLayout is successfully saved.FragmentLayoutModel
  Dispatched when a fault occurs while saving the fragmentLayout.FragmentLayoutModel
  Dispatched when the current fragmentLayout is requested for save.FragmentLayoutModel
Detalhes da propriedade

cutsomizedLayout

propriedade
cutsomizedLayout:Boolean

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10
Versões de runtime: AIR (unsupported), Flash Player 10.2

The tables of the underlying value object.

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento fetchComplete .



Implementação
    public function get cutsomizedLayout():Boolean
    public function set cutsomizedLayout(value:Boolean):void

fields

propriedade 
fields:IList

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10
Versões de runtime: AIR (unsupported), Flash Player 10.2

The fields of the underlying value object.

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento valueObjectChange .



Implementação
    public function get fields():IList
    public function set fields(value:IList):void

file

propriedade 
file:FileModel

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10
Versões de runtime: AIR (unsupported), Flash Player 10.2

The file domain object associated with this fragmentLayout.

The file domain object is a representation of the XDP file that is uploaded by the user at the time of creation or updating of this fragmentLayout.



Implementação
    public function get file():FileModel
    public function set file(value:FileModel):void

flowedLayout

propriedade 
flowedLayout:Boolean

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10
Versões de runtime: AIR (unsupported), Flash Player 10.2

whether underlying value object is a flowed layout or not

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento valueObjectChange .



Implementação
    public function get flowedLayout():Boolean
    public function set flowedLayout(value:Boolean):void

shallow

propriedade 
shallow:Boolean

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10.0
Versões de runtime: AIR (unsupported), Flash Player 10.2

Flag to indicate if the underlying value object is shallow.

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento propertyChange .



Implementação
    public function get shallow():Boolean
    public function set shallow(value:Boolean):void

tables

propriedade 
tables:IList

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10
Versões de runtime: AIR (unsupported), Flash Player 10.2

The tables of the underlying value object.

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento valueObjectChange .



Implementação
    public function get tables():IList
    public function set tables(value:IList):void

targetAreas

propriedade 
targetAreas:IList

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10
Versões de runtime: AIR (unsupported), Flash Player 10.2

The target areas of the underlying value object.

Essa propriedade pode ser usada como a origem para o vínculo de dados. Quando essa propriedade é modificada, ela despacha o evento valueObjectChange .



Implementação
    public function get targetAreas():IList
    public function set targetAreas(value:IList):void
Detalhes do método

copy

()método
public function copy():FragmentLayoutModel

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10.0
Versões de runtime: AIR (unsupported), Flash Player 10.2

Creates a copy of the domain object.

Note that this is different than cloning via ObjectUtil.copy() since a "copied" object needs to be saved via a specific server api.

Retorna
FragmentLayoutModel — A copy of current domain object.

createFromVO

()método 
public static function createFromVO(fragmentLayoutVO:FragmentLayout, fetchFromServer:Boolean = true):FragmentLayoutModel

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10.0
Versões de runtime: AIR (unsupported), Flash Player 10.2

Creates the domain object from the corresponding value object.

Value Objects are pure data entities mostly acting as parameters to the server apis. Domain objects are build atop to provide more meaningful business data and behavior thereby enabling faster and convenient UI view development. In some cases, the value objects could be shallow; for instance when obtained via Data Services. The complete value object could be requested by passing the fetchFromServer flag as true. In that case, the value object is obtained from the server via remoting call and the domain object shapes accordingly as the server response arrives.

Parâmetros

fragmentLayoutVO:FragmentLayout — The value object of the type FragmentLayout
 
fetchFromServer:Boolean (default = true) — Flag to indicate if the complete value object should be obtained from the server

Retorna
FragmentLayoutModel — The FragmentLayout domain object corresponding the passed FragmentLayout value object.

fetchComplete

()método 
public function fetchComplete():void

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10.0
Versões de runtime: AIR (unsupported), Flash Player 10.2

Fetches the complete value object via remoting call. This should be called when the underlying value object is shallow.

fetchFromServer

()método 
public function fetchFromServer():void

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10.0
Versões de runtime: AIR (unsupported), Flash Player 10.2

Fetches the complete value object via remoting call. This should be called when the underlying value object is shallow.

isShallow

()método 
public function isShallow():Boolean

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10.0
Versões de runtime: AIR (unsupported), Flash Player 10.2

Indicates if the underlying value object is shallow.

Retorna
Boolean

save

()método 
override public function save():void

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10.0
Versões de runtime: AIR (unsupported), Flash Player 10.2

Saves the underlying value object on the server.

Under the hood, separate calls are required for creating a new asset and copying or copying an existing one.

The save() method internally invokes the relevant server calls on the basis of its current state. The domain object constructed from the createFromVO() method would invoke the "update" api, the domain object starightaway instantiated on the client would inoke the "create" fragmentLayout api and the domain object obtained by the copy() method would internally call "copy api".

Invoking the save() implicitly invokes the validate() method to perform the necessary client side validations. Only when the client side validations are successful, is the actual save() call made. A save() method wouldn't proceed past the validation stage unless the object's state is made valid via user input or otherwise.

setFragmentLayoutService

()método 
public static function setFragmentLayoutService(value:IFragmentLayoutService):void

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10.0
Versões de runtime: AIR (unsupported), Flash Player 10.2

This method lets you inject a custom implementation of the infrastructure fragmentLayout service. By default, the class FragmentLayoutServiceDelegate is used as the infrastructure service.

Parâmetros

value:IFragmentLayoutService — An implementation for IFragmentLayoutService.

Detalhe do evento

fetchComplete

Evento
Tipo do objeto de evento: flash.events.Event
propriedade Event.type = flash.events.Event

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10
Versões de runtime: AIR (unsupported), Flash Player 10.2

Dispatched when this Asset is completely fetched from the server. Assets are often kept shallow in the Asset Manager and fetched completely only when necessary. The fetchComplete event is dispatched when the Asset has been retrieved completely from the server.

saveComplete

Evento  
Tipo do objeto de evento: com.adobe.icc.editors.events.AssetEvent
propriedade AssetEvent.type = com.adobe.icc.editors.events.AssetEvent.SAVE_COMPLETE

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10
Versões de runtime: AIR (unsupported), Flash Player 10.2

Dispatched when the fragmentLayout is successfully saved.

The AssetEvent.SAVE_COMPLETE constant defines the value of the type property of the event object for a saveComplete event.

The saveComplete event is dispatched when the domain object has been successfully saved on the server. Unlike the saving event, this is dispatched in an aysnchronous manner only after the server has responded with a result for the save api call.

This event can be used to stop UI animations indicating "save in progress" or to popup an info box indicating save success.

saveFault

Evento  
Tipo do objeto de evento: com.adobe.icc.editors.events.AssetEvent
propriedade AssetEvent.type = com.adobe.icc.editors.events.AssetEvent.SAVE_FAULT

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10
Versões de runtime: AIR (unsupported), Flash Player 10.2

Dispatched when a fault occurs while saving the fragmentLayout.

The AssetEvent.SAVE_FAULT constant defines the value of the type property of the event object for a saveFault event.

The saveFault event is dispatched when the server reports an error while saving the asset on the server. Unlike the saving event, this is dispatched in an aysnchronous manner only after the server has responded with a result for the save api call.

When this event is dispatched, the fault property contains the fault object encapsulating the error sent by the server. The fault property can be used to determine the faultCode and show an error message accordingly.

This event can be used to stop UI animations indicating "save in progress" or to popup an info box indicating save success.

saving

Evento  
Tipo do objeto de evento: com.adobe.icc.editors.events.AssetEvent
propriedade AssetEvent.type = com.adobe.icc.editors.events.AssetEvent.SAVING

Versão da linguagem: ActionScript 3.0
Versão de produto: Asset Composer Building Block 10
Versões de runtime: AIR (unsupported), Flash Player 10.2

Dispatched when the current fragmentLayout is requested for save. This event, being bubbling in nature, can be leveraged by the UI to display a progress bar or animation to indicate the save progress.

The AssetEvent.SAVING constant defines the value of the type property of the event object for a saving event.

The saving event is dispatched when the save() method has been called on the domain object. This event is dispatched before any server api is invoked but after the domain client validations are complete. This is because the actual save starts once the client validations are complete.

This event can be used to start a UI animation indicating "save in progress".





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