| Pakket | com.adobe.icc.editors.model |
| Klasse | public class LetterModel |
| Overerving | LetterModel  AssetModel EventDispatcher Object |
| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Overerfde openbare eigenschappen verbergen
Overerfde openbare eigenschappen weergeven| Eigenschap | Gedefinieerd door | ||
|---|---|---|---|
 | 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
Verwijzing naar het klasseobject of de constructorfunctie van een bepaalde objectinstantie. | 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 [alleen-lezen]
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 [alleen-lezen]
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] [alleen-lezen] | 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 | Gedefinieerd door | ||
|---|---|---|---|
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registreert een gebeurtenislistenerobject bij een object EventDispatcher, zodat de listener een melding van een gebeurtenis ontvangt. | EventDispatcher | |
Creates a copy of the domain object. | LetterModel | ||
[statisch]
Creates the domain object from the corresponding value object. | LetterModel | ||
|
Verzendt een gebeurtenis naar de gebeurtenisstroom. | 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 | ||
|
Controleert of het object EventDispatcher listeners heeft geregistreerd voor een specifiek type gebeurtenis. | EventDispatcher | |
|
Geeft aan of voor een object een opgegeven eigenschap is gedefinieerd. | 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 | ||
|
Geeft aan of een instantie van de klasse Object zich in de prototypeketen van het object bevindt dat als parameter is opgegeven. | Object | |
|
Geeft aan of de opgegeven eigenschap bestaat en kan worden opgesomd. | Object | |
|
Verwijdert een listener uit het object EventDispatcher. | EventDispatcher | |
Resets all the assignment lists in this Letter. | LetterModel | ||
[overschrijven]
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 | ||
|
Stelt de beschikbaarheid van een dynamische eigenschap voor lusbewerkingen in. | Object | |
|
Geeft de tekenreeksweergave van dit object weer, geformatteerd volgens de locatiespecifieke conventies. | Object | |
|
Retourneert een tekenreeksrepresentatie van het opgegeven object. | Object | |
|
Retourneert de primitieve waarde van het opgegeven object. | Object | |
|
Controleert of een gebeurtenislistener is geregistreerd bij dit object EventDispatcher of een van de voorouders voor het opgegeven type gebeurtenis. | EventDispatcher | |
| Methode | Gedefinieerd door | ||
|---|---|---|---|
Fetches the data dictionary corresponding to the name specified. | LetterModel | ||
| Gebeurtenis | Overzicht | Gedefinieerd door | ||
|---|---|---|---|---|
| [uitgezonden gebeurtenis] Wordt verzonden wanneer Flash Player of de AIR-toepassing de besturingssysteemfocus krijgt en actief wordt. | EventDispatcher | ||
| [uitgezonden gebeurtenis] Wordt verzonden wanneer Flash Player of de AIR-toepassing de systeemfocus verliest en inactief wordt. | 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 | eigenschap |
assignments:IList| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The consolidated list of variable and field assignments of this letter.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis assignmentsChange verzonden.
Implementatie
public function get assignments():IList public function set assignments(value:IList):voiddataDictionary | eigenschap |
dataDictionary:DataDictionary| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | 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.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis ddChange verzonden.
Implementatie
public function get dataDictionary():DataDictionary public function set dataDictionary(value:DataDictionary):voiddataDictionaryName | eigenschap |
dataDictionaryName:String| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | 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.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis ddNameChange verzonden.
Implementatie
public function get dataDictionaryName():String public function set dataDictionaryName(value:String):voidVerwante API-elementen
dataDictRegistryService | eigenschap |
dataDictRegistryService:DataDictionaryRegistryService| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The infrastructure service for data dictionary mainly used internally for fetching data dictionary objects.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis propertyChange verzonden.
Implementatie
public static function get dataDictRegistryService():DataDictionaryRegistryService public static function set dataDictRegistryService(value:DataDictionaryRegistryService):voidfields | eigenschap |
fields:IList [alleen-lezen] | Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 10 |
| Runtimeversies: | AIR (unsupported), Flash Player 10.2 |
Returns the list of fields in the base layout and all the container layouts.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis fieldAssignmentsChange verzonden.
Implementatie
public function get fields():IListlayout | eigenschap |
layout:LayoutModel| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The domain object of the layout associated with this letter.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis propertyChange verzonden.
Implementatie
public function get layout():LayoutModel public function set layout(value:LayoutModel):voidmodules | eigenschap |
postProcess | eigenschap |
service | eigenschap |
service:ILetterService| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | 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.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis propertyChange verzonden.
Implementatie
public static function get service():ILetterService public static function set service(value:ILetterService):voidstaticEventDispatcher | eigenschap |
staticEventDispatcher:IEventDispatcher [alleen-lezen] Implementatie
public static function get staticEventDispatcher():IEventDispatchertargetAreaAssignments | eigenschap |
targetAreaAssignments:IList| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The list of target area assignments in this Letter.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis targetAreaAssignmentsChange verzonden.
Implementatie
public function get targetAreaAssignments():IList public function set targetAreaAssignments(value:IList):voidtestDataFile | eigenschap |
testDataFile:FileModel| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The test data file that supplies the preview data.
Implementatie
public function get testDataFile():FileModel public function set testDataFile(value:FileModel):voidcopy | () | methode |
public function copy():LetterModel| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | 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.
Geretourneerde waardeLetterModel — A copy of current domain object.
|
createFromVO | () | methode |
public static function createFromVO(letterVO:Letter, fetchFromServer:Boolean = true):LetterModel| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | 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.
Parameters
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| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | 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| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Returns the target area assignment domain object for the passed target area.
Parameters
area:* — The target area
|
com.adobe.icc.editors.model:TargetAreaAssignmentModel — The target area assignment domain object
|
getVariables | () | methode |
public function getVariables():IList| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | 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.
Geretourneerde waardeIList — The list of variables being referred in this letter
|
isDDReferenced | () | methode |
public function isDDReferenced():Boolean| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | 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.
Geretourneerde waardeBoolean — true, if the data dictionary is referred. false, otherwise.
|
isDDReferencedInNestedLayouts | () | methode |
public function isDDReferencedInNestedLayouts(targetAreaAssignments:IList):Boolean| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 10.0 |
| Runtimeversies: | AIR (unsupported), Flash Player 10.2 |
The function indicates whether data dictionary is referenced in the nested layout.
Parameters
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| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Resets all the assignment lists in this Letter.
Parameters
layout:LayoutModel — Layout Model
|
save | () | methode |
override public function save():void| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | 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| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | 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.
Parameters
ddName:String — Name of the data dictionary
| |
fetchDataDictionary:Boolean (default = true) |
setDataDictRegistryService | () | methode |
public static function setDataDictRegistryService(value:DataDictionaryRegistryService):void| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | 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.
Parameters
value:DataDictionaryRegistryService — An implementation for DataDictionaryRegistryService.
|
setLayout | () | methode |
public function setLayout(layout:LayoutModel, resetAssignments:Boolean = true):void| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Sets the layout for this letter.
Parameters
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| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | 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.
Parameters
value:ILetterService — An implementation for ILetterService.
|
fetchComplete | Gebeurtenis |
flash.events.Eventeigenschap Event.type =
flash.events.Event| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when the letter has been completely fetched from the server.
moduleAssignmentAdd | Gebeurtenis |
flash.events.Eventeigenschap Event.type =
flash.events.Event| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when a module assignment is added to any of the target area assignments.
moduleAssignmentRemove | Gebeurtenis |
flash.events.Eventeigenschap Event.type =
flash.events.Event| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Dispatched when a module assignment is removed from any of the target area assignments.
saveComplete | Gebeurtenis |
com.adobe.icc.editors.events.AssetEventeigenschap AssetEvent.type =
com.adobe.icc.editors.events.AssetEvent.SAVE_COMPLETE| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | 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 | Gebeurtenis |
com.adobe.icc.editors.events.AssetEventeigenschap AssetEvent.type =
com.adobe.icc.editors.events.AssetEvent.SAVE_FAULT| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | 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 | Gebeurtenis |
com.adobe.icc.editors.events.AssetEventeigenschap AssetEvent.type =
com.adobe.icc.editors.events.AssetEvent.SAVING| Taalversie: | ActionScript 3.0 |
| Productversie: | Asset Composer Building Block 9.5 |
| Runtimeversies: | 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".
Wed Jun 13 2018, 11:42 AM Z