| Paket | com.adobe.icc.editors.model |
| Klasse | public class LetterModel |
| Vererbung | LetterModel  AssetModel EventDispatcher Object |
| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Vererbte öffentliche Eigenschaften ausblenden
Vererbte öffentliche Eigenschaften anzeigen| Eigenschaft | Definiert von | ||
|---|---|---|---|
 | 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
Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz. | 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 [statisch]
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 [schreibgeschützt]
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 [schreibgeschützt]
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 [statisch]
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 [statisch] [schreibgeschützt] | 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 | |
| Methode | Definiert von | ||
|---|---|---|---|
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registriert ein Ereignis-Listener-Objekt bei einem EventDispatcher-Objekt, sodass der Listener über ein Ereignis benachrichtigt wird. | EventDispatcher | |
Creates a copy of the domain object. | LetterModel | ||
[statisch]
Creates the domain object from the corresponding value object. | LetterModel | ||
|
Sendet ein Ereignis in den Ereignisablauf. | 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 | ||
|
Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat. | EventDispatcher | |
|
Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde. | 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 | ||
|
Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde. | Object | |
|
Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann. | Object | |
|
Entfernt einen Listener aus dem EventDispatcher-Objekt. | 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 | ||
[statisch]
This method lets you inject a custom implementation of the infrastructure data dictionary service. | LetterModel | ||
Sets the layout for this letter. | LetterModel | ||
[statisch]
This method lets you inject a custom implementation of the infrastructure letter service. | LetterModel | ||
|
Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest. | Object | |
|
Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas. | Object | |
|
Gibt das angegebene Objekt als String zurück. | Object | |
|
Gibt den Grundwert des angegebenen Objekts zurück. | Object | |
|
Überprüft, ob bei diesem EventDispatcher-Objekt oder bei einem seiner Vorgänger ein Ereignis-Listener für einen bestimmten Ereignistyp registriert ist. | EventDispatcher | |
| Methode | Definiert von | ||
|---|---|---|---|
Fetches the data dictionary corresponding to the name specified. | LetterModel | ||
| Ereignis | Übersicht | Definiert von | ||
|---|---|---|---|---|
| [broadcast event] Wird ausgelöst, wenn Flash Player oder eine AIR-Anwendung den Betriebssystemfokus erhält und aktiv wird. | EventDispatcher | ||
| [broadcast event] Wird ausgelöst, wenn Flash Player- oder die AIR-Anwendung den Fokus verliert und inaktiv wird. | 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 | Eigenschaft |
assignments:IList| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The consolidated list of variable and field assignments of this letter.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das assignmentsChange -Ereignis ausgelöst.
Implementierung
public function get assignments():IList public function set assignments(value:IList):voiddataDictionary | Eigenschaft |
dataDictionary:DataDictionary| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | 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.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das ddChange -Ereignis ausgelöst.
Implementierung
public function get dataDictionary():DataDictionary public function set dataDictionary(value:DataDictionary):voiddataDictionaryName | Eigenschaft |
dataDictionaryName:String| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | 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.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das ddNameChange -Ereignis ausgelöst.
Implementierung
public function get dataDictionaryName():String public function set dataDictionaryName(value:String):voidVerwandte API-Elemente
dataDictRegistryService | Eigenschaft |
dataDictRegistryService:DataDictionaryRegistryService| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The infrastructure service for data dictionary mainly used internally for fetching data dictionary objects.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.
Implementierung
public static function get dataDictRegistryService():DataDictionaryRegistryService public static function set dataDictRegistryService(value:DataDictionaryRegistryService):voidfields | Eigenschaft |
fields:IList [schreibgeschützt] | Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 10 |
| Laufzeitversionen: | AIR (unsupported), Flash Player 10.2 |
Returns the list of fields in the base layout and all the container layouts.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das fieldAssignmentsChange -Ereignis ausgelöst.
Implementierung
public function get fields():IListlayout | Eigenschaft |
layout:LayoutModel| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The domain object of the layout associated with this letter.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.
Implementierung
public function get layout():LayoutModel public function set layout(value:LayoutModel):voidmodules | Eigenschaft |
postProcess | Eigenschaft |
postProcess:String| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The postprocess to be executed.
Implementierung
public function get postProcess():String public function set postProcess(value:String):voidservice | Eigenschaft |
service:ILetterService| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | 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.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das propertyChange -Ereignis ausgelöst.
Implementierung
public static function get service():ILetterService public static function set service(value:ILetterService):voidstaticEventDispatcher | Eigenschaft |
staticEventDispatcher:IEventDispatcher [schreibgeschützt] Implementierung
public static function get staticEventDispatcher():IEventDispatchertargetAreaAssignments | Eigenschaft |
targetAreaAssignments:IList| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The list of target area assignments in this Letter.
Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das targetAreaAssignmentsChange -Ereignis ausgelöst.
Implementierung
public function get targetAreaAssignments():IList public function set targetAreaAssignments(value:IList):voidtestDataFile | Eigenschaft |
testDataFile:FileModel| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The test data file that supplies the preview data.
Implementierung
public function get testDataFile():FileModel public function set testDataFile(value:FileModel):voidcopy | () | Methode |
public function copy():LetterModel| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | 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.
RückgabewerteLetterModel — A copy of current domain object.
|
createFromVO | () | Methode |
public static function createFromVO(letterVO:Letter, fetchFromServer:Boolean = true):LetterModel| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | 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.
Parameter
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 | () | Methode |
protected function fetchDataDictionary():void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Fetches the data dictionary corresponding to the name specified.
getTargetAreaAssignment | () | Methode |
public function getTargetAreaAssignment(area:*):com.adobe.icc.editors.model:TargetAreaAssignmentModel| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Returns the target area assignment domain object for the passed target area.
Parameter
area:* — The target area
|
com.adobe.icc.editors.model:TargetAreaAssignmentModel — The target area assignment domain object
|
getVariables | () | Methode |
public function getVariables():IList| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | 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.
RückgabewerteIList — The list of variables being referred in this letter
|
isDDReferenced | () | Methode |
public function isDDReferenced():Boolean| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | 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.
RückgabewerteBoolean — true, if the data dictionary is referred. false, otherwise.
|
isDDReferencedInNestedLayouts | () | Methode |
public function isDDReferencedInNestedLayouts(targetAreaAssignments:IList):Boolean| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 10.0 |
| Laufzeitversionen: | AIR (unsupported), Flash Player 10.2 |
The function indicates whether data dictionary is referenced in the nested layout.
Parameter
targetAreaAssignments:IList — list of target area assignments
|
Boolean — flag indicating whether data dictionary is referenced in the nested layout.
|
resetAssignmentLists | () | Methode |
public function resetAssignmentLists(layout:LayoutModel):void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Resets all the assignment lists in this Letter.
Parameter
layout:LayoutModel — Layout Model
|
save | () | Methode |
override public function save():void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | 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 | () | Methode |
public function setDataDictionaryName(ddName:String, fetchDataDictionary:Boolean = true):void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | 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.
Parameter
ddName:String — Name of the data dictionary
| |
fetchDataDictionary:Boolean (default = true) |
setDataDictRegistryService | () | Methode |
public static function setDataDictRegistryService(value:DataDictionaryRegistryService):void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | 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.
Parameter
value:DataDictionaryRegistryService — An implementation for DataDictionaryRegistryService.
|
setLayout | () | Methode |
public function setLayout(layout:LayoutModel, resetAssignments:Boolean = true):void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Sets the layout for this letter.
Parameter
layout:LayoutModel — The domain object of the layout that needs to be associated with this Letter
| |
resetAssignments:Boolean (default = true) |
setLetterService | () | Methode |
public static function setLetterService(value:ILetterService):void| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | 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.
Parameter
value:ILetterService — An implementation for ILetterService.
|
fetchComplete | Ereignis |
flash.events.EventEigenschaft Event.type =
flash.events.Event| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when the letter has been completely fetched from the server.
moduleAssignmentAdd | Ereignis |
flash.events.EventEigenschaft Event.type =
flash.events.Event| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when a module assignment is added to any of the target area assignments.
moduleAssignmentRemove | Ereignis |
flash.events.EventEigenschaft Event.type =
flash.events.Event| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when a module assignment is removed from any of the target area assignments.
saveComplete | Ereignis |
com.adobe.icc.editors.events.AssetEventEigenschaft AssetEvent.type =
com.adobe.icc.editors.events.AssetEvent.SAVE_COMPLETE| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | 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 | Ereignis |
com.adobe.icc.editors.events.AssetEventEigenschaft AssetEvent.type =
com.adobe.icc.editors.events.AssetEvent.SAVE_FAULT| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | 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 | Ereignis |
com.adobe.icc.editors.events.AssetEventEigenschaft AssetEvent.type =
com.adobe.icc.editors.events.AssetEvent.SAVING| Sprachversion: | ActionScript 3.0 |
| Produktversion: | Baustein „Asset Composer“ 9.5 |
| Laufzeitversionen: | 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, 10:04 AM Z