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

FieldAssignment  - AS3 Asset Composer
Packagecom.adobe.icc.vo
Classpublic class FieldAssignment
InheritanceFieldAssignment 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

A value object that represents properties of a field that are assigned in a letter template.


Public Properties
 PropertyDefined By
  binding : String
One of BINDINGconst value.
FieldAssignment
  bindingReference : String
Gets the binding reference for the assignment.
FieldAssignment
  caption : String
Specifies the caption text for the assignment.
FieldAssignment
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  dataModule : DataModule
Valid only when the field's binding is BINDING_DATAMODULE and the bindingReference contains the ID of the module to which the field is related.
FieldAssignment
  description : String
Specifies the description text for the assignment.
FieldAssignment
  editable : Boolean
Specifies whether the assignment can be edited when correspondence is being generated.
FieldAssignment
  field : Field
Specifies the Field associated with this assignment.
FieldAssignment
  _fieldId : String
FieldAssignment
  id : String
Specifies the unique identifier for this assignment.
FieldAssignment
  optional : Boolean
Specifies whether the assignment is optional when correspondence is being generated.
FieldAssignment
  order : int
Zero-based order in which the field is to appear in the letter (based on top-down, depth-first search of the letter's layout).
FieldAssignment
  toolTip : String
Specifies the tooltip text that is shown for this assignment.
FieldAssignment
Public Methods
 MethodDefined By
  
FieldAssignment()
Constructor
FieldAssignment
  
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.
FieldAssignment
  
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
FieldAssignment
  
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
FieldAssignment
 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.
FieldAssignment
 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 a string representation of this object.
FieldAssignment
 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.
FieldAssignment
Public Constants
 ConstantDefined By
  BINDING_CALCULATION : String = "CALCULATION"
[static] Specifies a calculation binding.
FieldAssignment
  BINDING_CONST : String = "CONST"
[static] Specifies a literal binding.
FieldAssignment
  BINDING_DATAMODULE : String = "DATAMODULE"
[static] Specifies a content binding.
FieldAssignment
  BINDING_DDE : String = "DDE"
[static] Specifies a data dictionary element binding.
FieldAssignment
  BINDING_IGNORE : String = "IGNORE"
[static] Specifies the constant for the ignore binding type.
FieldAssignment
  BINDING_SYSTEM : String = "SYSTEM"
[static] Specifies a system binding.
FieldAssignment
  BINDING_USER : String = "USER"
[static] Specifies a user binding.
FieldAssignment
Property Detail

_fieldId

property
_fieldId:String



Implementation
    public function get _fieldId():String
    public function set _fieldId(value:String):void

binding

property 
binding:String

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 BINDINGconst value.

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

bindingReference

property 
bindingReference:String

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

Gets the binding reference for the assignment. If the binding is DDE, then bindingReference is the data dictionary element name reference. If the binding is CONST, then bindingReference is a constant value. If the binding is DATAMODULE, then bindingReference is the identifier of the data module. If the binding is USER, then bindingReference is the default value.

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

caption

property 
caption: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 caption text for the assignment.

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

dataModule

property 
dataModule:DataModule

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

Valid only when the field's binding is BINDING_DATAMODULE and the bindingReference contains the ID of the module to which the field is related.

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

description

property 
description: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 text for the assignment.

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

editable

property 
editable:Boolean

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

Specifies whether the assignment can be edited when correspondence is being generated.

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

field

property 
field:Field

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 Field associated with this assignment.

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

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

Specifies the unique identifier for this assignment.

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

optional

property 
optional:Boolean

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

Specifies whether the assignment is optional when correspondence is being generated.

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

order

property 
order:int

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

Zero-based order in which the field is to appear in the letter (based on top-down, depth-first search of the letter's layout).

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

toolTip

property 
toolTip: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 tooltip text that is shown for this assignment.

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

FieldAssignment

()Constructor
public function FieldAssignment()

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 a string representation of this object.

Returns
String — A 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.
Constant Detail

BINDING_CALCULATION

Constant
public static const BINDING_CALCULATION:String = "CALCULATION"

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

Specifies a calculation binding.

BINDING_CONST

Constant 
public static const BINDING_CONST:String = "CONST"

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

Specifies a literal binding.

BINDING_DATAMODULE

Constant 
public static const BINDING_DATAMODULE:String = "DATAMODULE"

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

Specifies a content binding.

BINDING_DDE

Constant 
public static const BINDING_DDE:String = "DDE"

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

Specifies a data dictionary element binding.

BINDING_IGNORE

Constant 
public static const BINDING_IGNORE:String = "IGNORE"

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 constant for the ignore binding type.

BINDING_SYSTEM

Constant 
public static const BINDING_SYSTEM:String = "SYSTEM"

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

Specifies a system binding.

BINDING_USER

Constant 
public static const BINDING_USER:String = "USER"

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

Specifies a user binding.




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

 

Legal Notices | Online Privacy Policy