| Package | com.adobe.consulting.pst.vo |
| Class | public class Letter |
| Inheritance | Letter  Object |
| Implements | IManaged |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| activeEndDate : Date
Specifies the activation end date for the letter template. | Letter | ||
| activeStartDate : Date
Specifies the activation start date for the letter template. | Letter | ||
| comment : String
Specifies the comment associated with the last change or update to the letter template. | Letter | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| dataDictionaryElementRefs : ArrayCollection | Letter | ||
| dataDictionaryRef : String
Specifies the name of the data dictionary that this letter references. | Letter | ||
| desc : String
Specifies the description for the letter template. | Letter | ||
| extendedProperties : Object
Specifies the extended properties map. | Letter | ||
| fieldAssignments : ArrayCollection
Specifies the unique list of FieldAssignment objects. | Letter | ||
| form : Form
Specifies the form or layout associated with this template. | Letter | ||
| formName : String [read-only]
Specifies the name of the form or layout associated with the template. | Letter | ||
| hasTestData : Boolean [read-only] Returns true if this letter has test data. | Letter | ||
| id : String
Specifies the unique identifier for the letter and its revision. | Letter | ||
| lastChangeBy : String
Specifies the last user who completed a change. | Letter | ||
| layoutStale : Boolean
True if the Letter instance uses an older version of the layout, while a more recent version exists. | Letter | ||
| layoutUpdated : Boolean
True if the Letter's Layout has been updated with a newer version than what was originally assigned to it. | Letter | ||
| lcat : Category
Specifies the subcategory for the letter template. | Letter | ||
| lcatName : String [read-only]
Specifies the name of the subcategory of the letter template. | Letter | ||
| name : String Specifies the name of the letter. | Letter | ||
| outboxEnabled : Boolean | Letter | ||
| postProcess : String
Specifies the identifier of the process used for post-processing. | Letter | ||
| serverTestDataFilePath : String
Specifies the temporary XML or XDP test data file path returned from the HTTP upload servlet after uploading the file. | Letter | ||
| stale : Boolean
True if this is an older version of the template, while a more recent version exists. | Letter | ||
| state : int
Specifies one of the LetterState enumeration codes. | Letter | ||
| targetAreaAssignments : ArrayCollection
Specifies the unique list of TargetAreaAssignment objects. | Letter | ||
| testdata : ByteArray
Specifies the sample XML data associated with the template. | Letter | ||
| testDataFileName : String
Specifies the original XML or XDP test data file name from the user's local system. | Letter | ||
| ucat : Category
Specifies the main category for the letter template. | Letter | ||
| ucatName : String [read-only]
Specifies the name of the main category of the letter template. | Letter | ||
| updated : Boolean
If the Letter template was updated to a newer version. | Letter | ||
| variableAssignments : ArrayCollection
Specifies the unique list of VariableAssignment objects. | Letter | ||
| version : int
Specifies the version of the letter template. | Letter | ||
| Method | Defined By | ||
|---|---|---|---|
Letter()
Constructor. | Letter | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | Letter | ||
Dispatches an event into the event flow. | Letter | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | Letter | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
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 | |
Removes a listener from the EventDispatcher object. | Letter | ||
|
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 | |
Specifies the string representation of this object. | Letter | ||
|
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. | Letter | ||
activeEndDate | property |
activeEndDate:Date| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the activation end date for the letter template. That is, the date when the letter template is archived.
A letter template is archived when state is set to Archive.
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 activeEndDate():Date public function set activeEndDate(value:Date):voidactiveStartDate | property |
activeStartDate:Date| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the activation start date for the letter template. That is, the date when the letter template is activated.
A letter template is activated when state is set to Active.
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 activeStartDate():Date public function set activeStartDate(value:Date):voidcomment | property |
comment:String| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the comment associated with the last change or update to the letter template.
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 comment():String public function set comment(value:String):voiddataDictionaryElementRefs | property |
dataDictionaryElementRefs:ArrayCollectionThis property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get dataDictionaryElementRefs():ArrayCollection public function set dataDictionaryElementRefs(value:ArrayCollection):voiddataDictionaryRef | property |
dataDictionaryRef:String| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the name of the data dictionary that this letter references.
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 dataDictionaryRef():String public function set dataDictionaryRef(value:String):voiddesc | property |
desc:String| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the description for the letter template.
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 desc():String public function set desc(value:String):voidextendedProperties | property |
extendedProperties:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the extended properties map. Used with a backend Asset Manager.
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 extendedProperties():Object public function set extendedProperties(value:Object):voidfieldAssignments | property |
fieldAssignments:ArrayCollection| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the unique list of FieldAssignment objects.
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 fieldAssignments():ArrayCollection public function set fieldAssignments(value:ArrayCollection):voidform | property |
form:Form| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the form or layout associated with this template.
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 form():Form public function set form(value:Form):voidformName | property |
hasTestData | property |
hasTestData:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Returns true if this letter has test data. Returns false if the letter does not have test data.
Implementation
public function get hasTestData():Booleanid | property |
id:String| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the unique identifier for the letter and its revision.
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 id():String public function set id(value:String):voidlastChangeBy | property |
lastChangeBy:String| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the last user who completed a change.
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 lastChangeBy():String public function set lastChangeBy(value:String):voidlayoutStale | property |
layoutStale:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
True if the Letter instance uses an older version of the layout, while a more recent version exists. Client-only. (For notifications when creating correspondence)
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 layoutStale():Boolean public function set layoutStale(value:Boolean):voidlayoutUpdated | property |
layoutUpdated:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
True if the Letter's Layout has been updated with a newer version than what was originally assigned to it. This is inline with the feature of producing a Letter template with the latest versions of assets used in it.
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 layoutUpdated():Boolean public function set layoutUpdated(value:Boolean):voidlcat | property |
lcat:Category| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the subcategory for the letter template.
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 lcat():Category public function set lcat(value:Category):voidlcatName | property |
name | property |
name:String| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the name of the 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 name():String public function set name(value:String):voidoutboxEnabled | property |
postProcess | property |
postProcess:String| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the identifier of the process used for post-processing.
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 postProcess():String public function set postProcess(value:String):voidserverTestDataFilePath | property |
serverTestDataFilePath:String| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the temporary XML or XDP test data file path returned from the HTTP upload servlet after uploading the file. Used only when a file is created or updated.
Set this to a file path received from the server in order to associate a newly selected or uploaded test data file with this letter. If you are not associating a test data file with this letter, leave it null.
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 serverTestDataFilePath():String public function set serverTestDataFilePath(value:String):voidstale | property |
stale:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
True if this is an older version of the template, while a more recent version exists. Client-only. (For notifications when creating correspondence)
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 stale():Boolean public function set stale(value:Boolean):voidstate | property |
state:int| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies one of the LetterState enumeration codes.
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 state():int public function set state(value:int):voidRelated API Elements
targetAreaAssignments | property |
targetAreaAssignments:ArrayCollection| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the unique list of TargetAreaAssignment objects.
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 targetAreaAssignments():ArrayCollection public function set targetAreaAssignments(value:ArrayCollection):voidtestdata | property |
testdata:ByteArray| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the sample XML data associated with the template.
Note: This is not populated in the object directly. Use the IDownloadService to access the data bytes.
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 testdata():ByteArray public function set testdata(value:ByteArray):voidtestDataFileName | property |
testDataFileName:String| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the original XML or XDP test data file name from the user's local system. It does not include a path. The original file name is sometimes called the "friendly name".
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 testDataFileName():String public function set testDataFileName(value:String):voiducat | property |
ucat:Category| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the main category for the letter template.
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 ucat():Category public function set ucat(value:Category):voiducatName | property |
updated | property |
updated:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
If the Letter template was updated to a newer version. This is inline with the feature of producing a Letter template with the latest versions. Client-only. (For notifications when creating correspondence)
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 updated():Boolean public function set updated(value:Boolean):voidvariableAssignments | property |
variableAssignments:ArrayCollection| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the unique list of VariableAssignment objects.
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 variableAssignments():ArrayCollection public function set variableAssignments(value:ArrayCollection):voidversion | property |
version:int| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the version of the letter template.
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 version():int public function set version(value:int):voidLetter | () | Constructor |
public function Letter()| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Constructor.
addEventListener | () | method |
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):voidRegisters an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.
After you successfully register an event listener, you cannot change its priority
through additional calls to addEventListener(). To change a listener's priority, you
must first call removeEventListener(). Then you can register the listener again with the new
priority level.
After the listener is registered, subsequent calls to
addEventListener() with a different value for either type or useCapture result in the
creation of a separate listener registration. For example, if you first register a
listener with useCapture set to true, it listens only during the capture phase. If you
call addEventListener() again using the same listener object, but with useCapture set to
false, you have two separate listeners: one that listens during the capture phase, and
another that listens during the target and bubbling phases.
You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.
When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects
with registered event listeners are not automatically removed from memory because the
garbage collector does not remove objects that still have references.
Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.
If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.
If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).
Parameters
type:String — The type of event.
| |
listener:Function — The listener function that processes the event. This function must accept an event object
as its only parameter and must return nothing, as this example shows:
| |
useCapture:Boolean (default = false)useCapture is set to true, the
listener processes the event only during the capture phase and not in the target or
bubbling phase. If useCapture is false, the listener processes the event only
during the target or bubbling phase. To listen for the event in all three phases, call
addEventListener() twice, once with useCapture set to true,
then again with useCapture set to false.
| |
priority:int (default = 0) | |
weakRef:Boolean (default = false)Class-level member functions are not subject to garbage
collection, so you can set |
dispatchEvent | () | method |
public function dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow. The event target is the
EventDispatcher object upon which dispatchEvent() is called.
Parameters
event:Event — The event object dispatched into the event flow.
|
Boolean — A value of true unless preventDefault() is called on the event,
in which case it returns false.
|
hasEventListener | () | method |
public function hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether
a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().
The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.
Parameters
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type is registered; false otherwise.
|
removeEventListener | () | method |
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):voidRemoves a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.
Parameters
type:String — The type of event.
| |
listener:Function — The listener object to remove.
| |
useCapture:Boolean (default = false)removeEventListener() are required to remove both: one call with useCapture set to true, and another call with useCapture set to false.
|
toString | () | method |
willTrigger | () | method |
public function willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.
The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.
Parameters
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.
|
Wed Nov 21 2018, 06:34 AM -08:00