| Package | com.adobe.icc.dc.domain |
| Class | public class LetterInstance |
| Inheritance | LetterInstance  EventDispatcher Object |
| Implements | IValidation |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| data : String [read-only]
Bindable/Read-only. | LetterInstance | ||
| dataDictionaryRef : String [read-only]
Returns name of the data dictionary used in this letter instance. | LetterInstance | ||
| description : String [read-only]
Description of the underlying object. | LetterInstance | ||
| fieldInstances : IList [read-only]
Collection of FieldInstance objects that represent the domain model for Letter fields
| LetterInstance | ||
| formName : String [read-only]
Returns name of the form associated with this letter instance. | LetterInstance | ||
| id : String [read-only]
Unique identification of this instance of letter. | LetterInstance | ||
| letter : Letter [read-only]
The letter loaded and being filled. | LetterInstance | ||
| name : String [read-only]
Name of the underlying object. | LetterInstance | ||
| state : int [read-only]
Returns state of this letter instance. | LetterInstance | ||
| targetInstances : IList [read-only]
Collection of TargetInstance objects that represent the current state of content selection as well as optional content
for each content target in the current letter. | LetterInstance | ||
| useLatest : Boolean [read-only]
True if the letter uses latest asset while reload of the letter. | LetterInstance | ||
| valid : Boolean [read-only]
Boolean indicating whether the content is valid
| LetterInstance | ||
| variableInstances : IList [read-only]
Collection of VariableInstance objects that represent Variables used in currently
Selected Content. | LetterInstance | ||
| version : int [read-only]
Returns version of this letter instance. | LetterInstance | ||
| xmlData : XML [read-only]
Bindable/Read-only. | LetterInstance | ||
| Method | Defined By | ||
|---|---|---|---|
LetterInstance(letter:Letter, ddi:DataDictionaryInstanceModel, initialXmlData:XML, params:Map = null)
Constructor. | LetterInstance | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
The function that performs the initialization of the Letter instance.This should be called after form bridge has connected. | LetterInstance | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
Refresh should be called when item is selected. | LetterInstance | ||
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
Function which checks if any of the target area or field instance associated with this Letter instance are invalid. | LetterInstance | ||
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Constant | Defined By | ||
|---|---|---|---|
| EVENT_LETTER_INITIALIZATION_COMPLETE : String = "letterInitializationComplete" [static]
The constant defining the letter initialization complete event. | LetterInstance | ||
| EVENT_LETTER_INITIALIZATION_ERROR : String = "letterInitializationError" [static]
The constant defining the letter initialization error event. | LetterInstance | ||
| PARAM_USELATEST : * = useLatest [static]
The constant indicating that letter uses latest asset on previewing the letter. | LetterInstance | ||
data | property |
data:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Bindable/Read-only. Get the raw ICC Data to merge with a letter.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get data():StringRelated API Elements
dataDictionaryRef | property |
dataDictionaryRef:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Returns name of the data dictionary used in this letter instance.
Implementation
public function get dataDictionaryRef():Stringdescription | property |
fieldInstances | property |
fieldInstances:IList [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Collection of FieldInstance objects that represent the domain model for Letter fields
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get fieldInstances():IListformName | property |
id | property |
letter | property |
name | property |
state | property |
targetInstances | property |
targetInstances:IList [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Collection of TargetInstance objects that represent the current state of content selection as well as optional content
for each content target in the current letter.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get targetInstances():IListuseLatest | property |
valid | property |
valid:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Boolean indicating whether the content is valid
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get valid():BooleanvariableInstances | property |
variableInstances:IList [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Collection of VariableInstance objects that represent Variables used in currently
Selected Content.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get variableInstances():IListversion | property |
xmlData | property |
xmlData:XML [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Bindable/Read-only. Get the ICC Data to merge with a letter.
Warning: Be careful when serializing this to a string as XML.toXMLString() will not respect XFA's use of space runs in XHTML.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get xmlData():XMLRelated API Elements
LetterInstance | () | Constructor |
public function LetterInstance(letter:Letter, ddi:DataDictionaryInstanceModel, initialXmlData:XML, params:Map = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Constructor.
Parametersletter:Letter — Fully populated Letter object
| |
ddi:DataDictionaryInstanceModel — data Dictionary Instance
| |
initialXmlData:XML — initialXml Data containing Icc Control Data if any. This XML is owned by LetterInstance
| |
params:Map (default = null) |
initialize | () | method |
public function initialize():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
The function that performs the initialization of the Letter instance.This should be called after form bridge has connected.
refresh | () | method |
public function refresh():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Refresh should be called when item is selected. This is useful in case when the the item is deselcted. In that case, if there is any change in variable value/ field value etc., those changes may not be propagated to module.
validate | () | method |
public function validate():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Function which checks if any of the target area or field instance associated with this Letter instance are invalid.
EVENT_LETTER_INITIALIZATION_COMPLETE | Constant |
public static const EVENT_LETTER_INITIALIZATION_COMPLETE:String = "letterInitializationComplete"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
The constant defining the letter initialization complete event.
EVENT_LETTER_INITIALIZATION_ERROR | Constant |
public static const EVENT_LETTER_INITIALIZATION_ERROR:String = "letterInitializationError"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
The constant defining the letter initialization error event.
PARAM_USELATEST | Constant |
public static const PARAM_USELATEST:* = useLatest| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
The constant indicating that letter uses latest asset on previewing the letter.
Thu Dec 6 2018, 01:12 PM -08:00