| Paquete | com.adobe.icc.editors.model |
| Clase | public class LetterModel |
| Herencia | LetterModel  AssetModel EventDispatcher Object |
| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Ocultar propiedades públicas heredadas
Mostrar propiedades públicas heredadas| Propiedad | Definido por | ||
|---|---|---|---|
 | activeEndDate : Date
The activeEndDate of the underlying value object. | AssetModel | |
| activeStartDate : Date
The activeStartDate date of the underlying value object. | AssetModel | |
| assignments : IList
The consolidated list of variable and field assignments of this letter. | LetterModel | ||
| category : Category
The Category of the underlying value object. | AssetModel | |
| comment : String
The comment of the underlying value object. | AssetModel | |
| constructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada. | Object | |
| crxVersion : String
The crx version of the underlying value object. | AssetModel | |
| dataDictionary : DataDictionary
The typed DataDictionary object being used by this module. | LetterModel | ||
| dataDictionaryName : String
The name of the data dictionary being used by this module. | LetterModel | ||
| dataDictRegistryService : DataDictionaryRegistryService [estática]
The infrastructure service for data dictionary mainly used internally for
fetching data dictionary objects. | LetterModel | ||
| description : String
The description of the underlying value object. | AssetModel | |
| extendedProperties : Object
The extended properties of the underlying value object. | AssetModel | |
| fields : IList [solo lectura]
Returns the list of fields in the base layout and all the container layouts. | LetterModel | ||
| id : String
The GUID of the underlying value object. | AssetModel | |
| isNew : Boolean
Indicates if this Asset is new. | AssetModel | |
| lastChangeBy : String
The lastChangeBy property of the underlying value object. | AssetModel | |
| layout : LayoutModel
The domain object of the layout associated with this letter. | LetterModel | ||
| modules : IList [solo lectura]
The list of data modules being referred in this letter. | LetterModel | ||
| name : String
The name of the underlying value object. | AssetModel | |
| postProcess : String
The postprocess to be executed. | LetterModel | ||
| service : ILetterService [estática]
The letter service instance that is used for saving/retrieving the letter
on the server. | LetterModel | ||
| state : int
The state of the underlying value object. | AssetModel | |
| staticEventDispatcher : IEventDispatcher [estática] [solo lectura] | LetterModel | ||
| subCategory : Category
The Sub-Category of the underlying value object. | AssetModel | |
| targetAreaAssignments : IList
The list of target area assignments in this Letter. | LetterModel | ||
| testDataFile : FileModel
The test data file that supplies the preview data. | LetterModel | ||
| version : int
The version of the underlying value object. | AssetModel | |
| vo : *
The value object which this asset domain object is built atop. | AssetModel | |
| Método | Definido por | ||
|---|---|---|---|
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registra un objeto de detector de eventos con un objeto EventDispatcher, de modo que el detector reciba la notificación de un evento. | EventDispatcher | |
Creates a copy of the domain object. | LetterModel | ||
[estática]
Creates the domain object from the corresponding value object. | LetterModel | ||
|
Distribuye un evento en el flujo del evento. | EventDispatcher | |
Returns the target area assignment domain object for the passed target area. | LetterModel | ||
Returns the list of variables being referred in this letter. | LetterModel | ||
|
Comprueba si el objeto EventDispatcher tiene detectores registrados para un tipo concreto de evento. | EventDispatcher | |
|
Indica si un objeto tiene definida una propiedad especificada. | Object | |
Indicates whether the data dictionary defined for this letter has been referred in
any of the assignments. | LetterModel | ||
The function indicates whether data dictionary is referenced in the nested layout. | LetterModel | ||
|
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro. | Object | |
|
Indica si existe la propiedad especificada y si es enumerable. | Object | |
|
Elimina un detector del objeto EventDispatcher. | EventDispatcher | |
Resets all the assignment lists in this Letter. | LetterModel | ||
[override]
Saves the underlying value object on the server. | LetterModel | ||
Sets the data dictionary name to the one specified and also fetches the corresponding
DataDictionary object from the server. | LetterModel | ||
[estática]
This method lets you inject a custom implementation of the infrastructure data dictionary service. | LetterModel | ||
Sets the layout for this letter. | LetterModel | ||
[estática]
This method lets you inject a custom implementation of the infrastructure letter service. | LetterModel | ||
|
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle. | Object | |
|
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional. | Object | |
|
Devuelve la representación de cadena del objeto especificado. | Object | |
|
Devuelve el valor simple del objeto especificado. | Object | |
|
Comprueba si hay registrado un detector de eventos con este objeto EventDispatcher o con cualquiera de sus ascendientes para el tipo de evento concreto. | EventDispatcher | |
| Método | Definido por | ||
|---|---|---|---|
Fetches the data dictionary corresponding to the name specified. | LetterModel | ||
| Evento | Resumen | Definido por | ||
|---|---|---|---|---|
| [evento broadcast] Se distribuye cuando Flash Player o AIR pasan a estar activos. | EventDispatcher | ||
| [evento broadcast] Se distribuye cuando Flash Player o de AIR pasan a estar inactivos. | EventDispatcher | ||
| Dispatched when the letter has been completely fetched from the server. | LetterModel | |||
| Dispatched when a module assignment is added to any of the target area assignments. | LetterModel | |||
| Dispatched when a module assignment is removed from any of the target area assignments. | LetterModel | |||
| Dispatched when the letter is successfully saved. | LetterModel | |||
| Dispatched when a fault occurs while saving the letter. | LetterModel | |||
| Dispatched when the current letter is requested for save. | LetterModel | |||
assignments | propiedad |
assignments:IList| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The consolidated list of variable and field assignments of this letter.
Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento assignmentsChange .
Implementación
public function get assignments():IList public function set assignments(value:IList):voiddataDictionary | propiedad |
dataDictionary:DataDictionary| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The typed DataDictionary object being used by this module.
Assigning a value to this property updated the dataDictionaryName
as well but not the other way round.
Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento ddChange .
Implementación
public function get dataDictionary():DataDictionary public function set dataDictionary(value:DataDictionary):voiddataDictionaryName | propiedad |
dataDictionaryName:String| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The name of the data dictionary being used by this module.
Merely setting this property wouldn't cause the dataDictionary
to be retrieved. If the dataDictionary needs to be updated,
setDataDictionaryName() method must be used instead.
Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento ddNameChange .
Implementación
public function get dataDictionaryName():String public function set dataDictionaryName(value:String):voidElementos de API relacionados
dataDictRegistryService | propiedad |
dataDictRegistryService:DataDictionaryRegistryService| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The infrastructure service for data dictionary mainly used internally for fetching data dictionary objects.
Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento propertyChange .
Implementación
public static function get dataDictRegistryService():DataDictionaryRegistryService public static function set dataDictRegistryService(value:DataDictionaryRegistryService):voidfields | propiedad |
fields:IList [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 10 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 10.2 |
Returns the list of fields in the base layout and all the container layouts.
Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento fieldAssignmentsChange .
Implementación
public function get fields():IListlayout | propiedad |
layout:LayoutModel| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The domain object of the layout associated with this letter.
Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento propertyChange .
Implementación
public function get layout():LayoutModel public function set layout(value:LayoutModel):voidmodules | propiedad |
modules:IList [solo lectura] | Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The list of data modules being referred in this letter.
Implementación
public function get modules():IListpostProcess | propiedad |
postProcess:String| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The postprocess to be executed.
Implementación
public function get postProcess():String public function set postProcess(value:String):voidservice | propiedad |
service:ILetterService| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The letter service instance that is used for saving/retrieving the letter on the server. This service is internally invoked by the LetterModel class for performing CRUD operations.
Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento propertyChange .
Implementación
public static function get service():ILetterService public static function set service(value:ILetterService):voidstaticEventDispatcher | propiedad |
staticEventDispatcher:IEventDispatcher [solo lectura] Implementación
public static function get staticEventDispatcher():IEventDispatchertargetAreaAssignments | propiedad |
targetAreaAssignments:IList| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The list of target area assignments in this Letter.
Esta propiedad se puede utilizar como origen para la vinculación de datos. Cuando se modifica esta propiedad, distribuye el evento targetAreaAssignmentsChange .
Implementación
public function get targetAreaAssignments():IList public function set targetAreaAssignments(value:IList):voidtestDataFile | propiedad |
testDataFile:FileModel| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The test data file that supplies the preview data.
Implementación
public function get testDataFile():FileModel public function set testDataFile(value:FileModel):voidcopy | () | método |
public function copy():LetterModel| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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.
Valor devueltoLetterModel — A copy of current domain object.
|
createFromVO | () | método |
public static function createFromVO(letterVO:Letter, fetchFromServer:Boolean = true):LetterModel| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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
letterVO:Letter — The value object of the type Letter
| |
fetchFromServer:Boolean (default = true) |
LetterModel — The Letter domain object corresponding the passed letter value object.
|
fetchDataDictionary | () | método |
protected function fetchDataDictionary():void| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Fetches the data dictionary corresponding to the name specified.
getTargetAreaAssignment | () | método |
public function getTargetAreaAssignment(area:*):com.adobe.icc.editors.model:TargetAreaAssignmentModel| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Returns the target area assignment domain object for the passed target area.
Parámetros
area:* — The target area
|
com.adobe.icc.editors.model:TargetAreaAssignmentModel — The target area assignment domain object
|
getVariables | () | método |
public function getVariables():IList| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Returns the list of variables being referred in this letter. This is a consolidated list of all the variables from all the referred modules.
Valor devueltoIList — The list of variables being referred in this letter
|
isDDReferenced | () | método |
public function isDDReferenced():Boolean| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Indicates whether the data dictionary defined for this letter has been referred in any of the assignments.
Valor devueltoBoolean — true, if the data dictionary is referred. false, otherwise.
|
isDDReferencedInNestedLayouts | () | método |
public function isDDReferencedInNestedLayouts(targetAreaAssignments:IList):Boolean| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 10.0 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 10.2 |
The function indicates whether data dictionary is referenced in the nested layout.
Parámetros
targetAreaAssignments:IList — list of target area assignments
|
Boolean — flag indicating whether data dictionary is referenced in the nested layout.
|
resetAssignmentLists | () | método |
public function resetAssignmentLists(layout:LayoutModel):void| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Resets all the assignment lists in this Letter.
Parámetros
layout:LayoutModel — Layout Model
|
save | () | método |
override public function save():void| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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" module 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.
setDataDictionaryName | () | método |
public function setDataDictionaryName(ddName:String, fetchDataDictionary:Boolean = true):void| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Sets the data dictionary name to the one specified and also fetches the corresponding DataDictionary object from the server.
Parámetros
ddName:String — Name of the data dictionary
| |
fetchDataDictionary:Boolean (default = true) |
setDataDictRegistryService | () | método |
public static function setDataDictRegistryService(value:DataDictionaryRegistryService):void| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
This method lets you inject a custom implementation of the infrastructure data dictionary service.
By default, the class DataDictionaryRegistryServiceImpl is used as the infrastructure service.
Parámetros
value:DataDictionaryRegistryService — An implementation for DataDictionaryRegistryService.
|
setLayout | () | método |
public function setLayout(layout:LayoutModel, resetAssignments:Boolean = true):void| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Sets the layout for this letter.
Parámetros
layout:LayoutModel — The domain object of the layout that needs to be associated with this Letter
| |
resetAssignments:Boolean (default = true) |
setLetterService | () | método |
public static function setLetterService(value:ILetterService):void| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
This method lets you inject a custom implementation of the infrastructure letter service.
By default, the class LetterServiceDelegate is used as the infrastructure service.
Parámetros
value:ILetterService — An implementation for ILetterService.
|
fetchComplete | Evento |
flash.events.Eventpropiedad Event.type =
flash.events.Event| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when the letter has been completely fetched from the server.
moduleAssignmentAdd | Evento |
flash.events.Eventpropiedad Event.type =
flash.events.Event| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when a module assignment is added to any of the target area assignments.
moduleAssignmentRemove | Evento |
flash.events.Eventpropiedad Event.type =
flash.events.Event| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when a module assignment is removed from any of the target area assignments.
saveComplete | Evento |
com.adobe.icc.editors.events.AssetEventpropiedad AssetEvent.type =
com.adobe.icc.editors.events.AssetEvent.SAVE_COMPLETE| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when the letter is successfully saved.
TheAssetEvent.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 |
com.adobe.icc.editors.events.AssetEventpropiedad AssetEvent.type =
com.adobe.icc.editors.events.AssetEvent.SAVE_FAULT| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when a fault occurs while saving the letter.
TheAssetEvent.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 |
com.adobe.icc.editors.events.AssetEventpropiedad AssetEvent.type =
com.adobe.icc.editors.events.AssetEvent.SAVING| Versión del lenguaje: | ActionScript 3.0 |
| Versión de producto: | Bloque de construcción Asset Composer 9.5 |
| Versiones de motor de ejecución: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when the current letter 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.
TheAssetEvent.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".
Tue Jun 12 2018, 02:12 PM Z