VariableAssignment

Package	com.adobe.icc.vo
Class	public class VariableAssignment
Inheritance	VariableAssignment 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 for an assignment of a variable in a letter template.

Public Properties

	Property		Defined By
		caption : String Specifies the caption text for the assignment.	VariableAssignment
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		dataModule : DataModule	VariableAssignment
		description : String Specifies the description text for the assignment.	VariableAssignment
		editable : Boolean Specifies whether the assignment can be edited when correspondence is being generated.	VariableAssignment
		id : String Specifies the unique identifier for the assignment.	VariableAssignment
		optional : Boolean Specifies whether the assignment is optional when correspondence is being generated.	VariableAssignment
		source : String One of SOURCE const value.	VariableAssignment
		sourceContainerLayoutAssignment : String If the source is field in a container layout, reference of corresponding container layout assignment object will be kept here.	VariableAssignment
		sourceReference : String Identification of the referenced value.	VariableAssignment
		toolTip : String Specifies the tooltip text for this assignment.	VariableAssignment
		variable : Variable Specifies the variable associated with this assignment.	VariableAssignment

Public Methods

	Method		Defined By
		VariableAssignment() Constructor	VariableAssignment
		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.	VariableAssignment
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	VariableAssignment
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	VariableAssignment
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		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.	VariableAssignment
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		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.	VariableAssignment
		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.	VariableAssignment

Public Constants

	Constant		Defined By
		SOURCE_CALCULATION : String = "CALCULATION" [static] Not used.	VariableAssignment
		SOURCE_CONST : String = "CONST" [static] Specifies the source type when the source is a string value specified by the user.	VariableAssignment
		SOURCE_DATAMODULE : String = "DATAMODULE" [static] Specifies the source type when the source is a module.	VariableAssignment
		SOURCE_DDE : String = "DDE" [static] Specifies the source type when the source is a data dictionary element.	VariableAssignment
		SOURCE_FIELD : String = "FIELD" [static] Specifies the source type when the source is a field.	VariableAssignment
		SOURCE_SYSTEM : String = "SYSTEM" [static] Not used.	VariableAssignment
		SOURCE_USER : String = "USER" [static] Specifies the source type when the source is a string value specified by the user.	VariableAssignment
		SOURCE_VARIABLE : String = "VARIABLE" [static] Specifies the source type when the source is a variable.	VariableAssignment

Property Detail

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

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

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

source

property

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

sourceContainerLayoutAssignment

property

sourceContainerLayoutAssignment:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

If the source is field in a container layout, reference of corresponding container layout assignment object will be kept here.

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

sourceReference

property

sourceReference:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Identification of the referenced value. What is stored here depends on the source:

USER: A string value specified by the user which can be overridden during letter filling. This value is used literally.
CONST: A string value specified by the user. This value is used literally.
DDE: The DDE reference syntax, e.g. movie.title for a DD that has 'movie' as its root which contains a 'title' element. The letter, which stores this assignment holds the DD Instance reference to use in order to resolve the DDE reference specified here.
DATAMODULE: The GUID of the referenced module whose content is to be used as the value of the assigned variable.
VARIABLE: The name of the referenced variable. The assigned variable's value, at letter filling time, will reflect the referenced variable's value.
FIELD: The GUID of the referenced field. The assigned variable's value, at letter filling time, will reflect the referenced field's value.
SYSTEM: Not used at this time.
CALCULATION: Not used at this time.

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

variable

property

variable:Variable

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

Constructor Detail

VariableAssignment

()

Constructor

public function VariableAssignment()

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 — The 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.

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

SOURCE_CALCULATION

Constant

public static const SOURCE_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

Not used.

SOURCE_CONST

Constant

public static const SOURCE_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 the source type when the source is a string value specified by the user.

SOURCE_DATAMODULE

Constant

public static const SOURCE_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 the source type when the source is a module. The content of the module is used as the value of the assigned variable.

SOURCE_DDE

Constant

public static const SOURCE_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 the source type when the source is a data dictionary element.

SOURCE_FIELD

Constant

public static const SOURCE_FIELD:String = "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 source type when the source is a field.

SOURCE_SYSTEM

Constant

public static const SOURCE_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

Not used.

SOURCE_USER

Constant

public static const SOURCE_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 the source type when the source is a string value specified by the user. This value can be overridden when a letter is being filled.

SOURCE_VARIABLE

Constant

public static const SOURCE_VARIABLE:String = "VARIABLE"

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 source type when the source is a variable.

Legal Notices | Online Privacy Policy

VariableAssignment - AS3 Asset Composer

Classes x

caption

dataModule

description

editable

id

optional

source

sourceContainerLayoutAssignment

sourceReference

toolTip

variable

VariableAssignment

addEventListener

dispatchEvent

hasEventListener

removeEventListener

toString

willTrigger

SOURCE_CALCULATION

SOURCE_CONST

SOURCE_DATAMODULE

SOURCE_DDE

SOURCE_FIELD

SOURCE_SYSTEM

SOURCE_USER

SOURCE_VARIABLE