ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.consulting.pst.vo 

Letter  - AS3 Asset Composer
Packagecom.adobe.consulting.pst.vo
Classpublic class Letter
InheritanceLetter Inheritance Object
Implements IManaged

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Value object for a letter. This object is also known as a letter or correspondence template.


Public Properties
 PropertyDefined By
  activeEndDate : Date
Letter
  activeStartDate : Date
Letter
  comment : String
Specifies the comment associated with the last change or update to the letter template.
Letter
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  crxVersion : String
Version of the letter in repository
Letter
  dataDictionaryElementRefs : ArrayCollection
Letter
  dataDictionaryRef : String
Data Dictionary Reference
Letter
  dataDictionaryRefs : ArrayCollection
Letter
  desc : String
Specifies the description for the letter template.
Letter
  extendedProperties : Object
Extended Properties Map for AssetManager Backend use case.
Letter
  fieldAssignments : ArrayCollection
Unique list of FieldAssignment objects
Letter
  form : Form
Specifies the base layout associated with the Letter
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; false otherwise.
Letter
  id : String
unique ID (GUID) which identifies the letter and its revision
Letter
  lastChangeBy : String
Specifies the last user who completed a change.
Letter
  lastPublishDate : Date
Specifies the last publish date of the letter
Letter
  lastUpdateDate : Date
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
the letter name
Letter
  postProcess : String
ID of the post process
Letter
  serverTestDataFilePath : String
Temporary XML/XDP test data file path returned from HTTP upload servlet after uploading the file (used only on create/update).
Letter
  state : int
One of the LetterState enum codes.
Letter
  targetAreaAssignments : ArrayCollection
Unique list of TargetAreaAssignment objects
Letter
  testdata : ByteArray
Specifies the byte stream of the test data used in letter
Letter
  testDataFileName : String
original XML/XDP test data file name ("friendly name") from user's local system (no path included)
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
  updatedBy : String
Specifies the constant string indicating the letter was updated by UPDATED_BY_NONE The asset has not been updated after publishing. UPDATED_BY_USER The asset has been updated by only user. UPDATED_BY_SYSTEM The asset has been updated by only system. UPDATED_BY_USER_AND_SYSTEM The asset has been updated by both user and system.
Letter
  variableAssignments : ArrayCollection
Unique list of VariableAssignment objects
Letter
  version : int
Letter
Public Methods
 MethodDefined 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
  
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
Letter
  
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
Letter
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
Letter
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
  
toString():String
Specifies the string representation of this object.
Letter
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
  
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.
Letter
Property Detail

activeEndDate

property
activeEndDate:Date



Implementation
    public function get activeEndDate():Date
    public function set activeEndDate(value:Date):void

activeStartDate

property 
activeStartDate:Date



Implementation
    public function get activeStartDate():Date
    public function set activeStartDate(value:Date):void

comment

property 
comment:String

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), 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):void

crxVersion

property 
crxVersion:String

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Version of the letter in repository

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 crxVersion():String
    public function set crxVersion(value:String):void

dataDictionaryElementRefs

property 
dataDictionaryElementRefs:ArrayCollection



Implementation
    public function get dataDictionaryElementRefs():ArrayCollection
    public function set dataDictionaryElementRefs(value:ArrayCollection):void

dataDictionaryRef

property 
dataDictionaryRef:String

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Data Dictionary Reference

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):void

dataDictionaryRefs

property 
dataDictionaryRefs:ArrayCollection



Implementation
    public function get dataDictionaryRefs():ArrayCollection
    public function set dataDictionaryRefs(value:ArrayCollection):void

desc

property 
desc:String

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), 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):void

extendedProperties

property 
extendedProperties:Object

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Extended Properties Map for AssetManager Backend use case.

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):void

fieldAssignments

property 
fieldAssignments:ArrayCollection

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

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):void

form

property 
form:Form

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Specifies the base layout associated with 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 form():Form
    public function set form(value:Form):void

formName

property 
formName:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the name of the form or layout associated with the template.



Implementation
    public function get formName():String

hasTestData

property 
hasTestData:Boolean  [read-only]

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Returns true if this letter has test data; false otherwise.



Implementation
    public function get hasTestData():Boolean

id

property 
id:String

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

unique ID (GUID) which identifies 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):void

lastChangeBy

property 
lastChangeBy:String

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), 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):void

lastPublishDate

property 
lastPublishDate:Date

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Specifies the last publish date 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 lastPublishDate():Date
    public function set lastPublishDate(value:Date):void

lastUpdateDate

property 
lastUpdateDate:Date



Implementation
    public function get lastUpdateDate():Date
    public function set lastUpdateDate(value:Date):void

lcat

property 
lcat:Category

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), 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):void

lcatName

property 
lcatName:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the name of the subcategory of the letter template.



Implementation
    public function get lcatName():String

name

property 
name:String

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

the letter 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 name():String
    public function set name(value:String):void

postProcess

property 
postProcess:String

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

ID of the post process

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):void

serverTestDataFilePath

property 
serverTestDataFilePath:String

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Temporary XML/XDP test data file path returned from HTTP upload servlet after uploading the file (used only on create/update). Set this to a file path received from the server in order to associate a newly-selected/uploaded test data file with this letter. Otherwise, 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):void

state

property 
state:int

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

One of the LetterState enum 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):void

Related API Elements

com.adobe.icc.enum.LetterState

targetAreaAssignments

property 
targetAreaAssignments:ArrayCollection

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

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):void

testdata

property 
testdata:ByteArray

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the byte stream of the test data used in 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 testdata():ByteArray
    public function set testdata(value:ByteArray):void

testDataFileName

property 
testDataFileName:String

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

original XML/XDP test data file name ("friendly name") from user's local system (no path included)

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):void

ucat

property 
ucat:Category

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), 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):void

ucatName

property 
ucatName:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the name of the main category of the letter template.



Implementation
    public function get ucatName():String

updatedBy

property 
updatedBy:String

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Specifies the constant string indicating the letter was updated by

  • UPDATED_BY_NONE The asset has not been updated after publishing.
  • UPDATED_BY_USER The asset has been updated by only user.
  • UPDATED_BY_SYSTEM The asset has been updated by only system.
  • UPDATED_BY_USER_AND_SYSTEM The asset has been updated by both user and system.

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 updatedBy():String
    public function set updatedBy(value:String):void

variableAssignments

property 
variableAssignments:ArrayCollection

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

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):void

version

property 
version:int



Implementation
    public function get version():int
    public function set version(value:int):void
Constructor Detail

Letter

()Constructor
public function Letter()

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Constructor

Method Detail

addEventListener

()method
public function 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. 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:

function(evt:Event):void

The function can have any name.
 
useCapture:Boolean (default = false) — Determines whether the listener works in the capture phase or the target and bubbling phases. If 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) — The priority level of the event listener. Priorities are designated by a 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.
 
weakRef:Boolean (default = false) — Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not.

Class-level member functions are not subject to garbage collection, so you can set useWeakReference to true for class-level member functions without subjecting them to garbage collection. If you set useWeakReference to true for a listener that is a nested inner function, the function will be garbge-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent.

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.

Returns
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.

Returns
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):void

Removes 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) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to removeEventListener() are required to remove both: one call with useCapture set to true, and another call with useCapture set to false.

toString

()method 
public function toString():String

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the string representation of this object.

Returns
String — String representation of this object.

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.

Returns
Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy