Variable

Package	com.adobe.icc.vo
Class	public class Variable
Inheritance	Variable Object
Implements	IEventDispatcher

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 a variable.

Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		dataType : String DATATYPE for the variable	Variable
		ddeReference : String [read-only] The Data Dictionary Element reference if this variable's type is TYPE_DDE; null otherwise.	Variable
		id : String Specifies the unique identifier for the variable.	Variable
		name : String Specifies the unique name for the variable.	Variable
		occurence : int	Variable
		protect : Boolean Specifies whether the variable is protected.	Variable
		subType : String One of SUBTYPEconst value.	Variable
		type : String One of TYPEconst value.	Variable
		valueSet : IList ValueSet for the variable	Variable

Public Methods

	Method		Defined By
		Variable() Constructor.	Variable
		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.	Variable
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	Variable
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	Variable
		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.	Variable
		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 a string representation of this object.	Variable
		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.	Variable

Public Constants

	Constant		Defined By
		DATATYPE_BOOLEAN : String = "BOOLEAN" [static] Data type: BOOLEAN - for boolean values.	Variable
		DATATYPE_DATE : String = "DATE" [static] Data type: DATE - for date/time values.	Variable
		DATATYPE_NUMBER : String = "NUMBER" [static] Data type: NUMBER - for numerical values.	Variable
		DATATYPE_STRING : String = "STRING" [static] Data type: STRING - for String values.	Variable
		DD_DELIMITER : String = "_" [static] The Data Dictionary name delimiting character.	Variable
		DD_PREFIX : String = "DD_" [static] Prefix for the Data Dictionary name in a Data Dictionary Element variable token ({DD_PREFIX}{DD name}.{DDE path}).	Variable
		SUBTYPE_ENUM : String = "ENUM" [static] Variable subType: ENUM	Variable
		TYPE_DDE : String = "DDE" [static] Variable type: Data Dictionary Element (reference).	Variable
		TYPE_PLACEHOLDER : String = "PLACEHOLDER" [static] Variable type: Placeholder.	Variable

Property Detail

dataType

property

dataType:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

DATATYPE for the variable

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

ddeReference

property

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

The Data Dictionary Element reference if this variable's type is TYPE_DDE; null otherwise.

Implementation
public function get ddeReference():String

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

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

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

Specifies the unique name for the variable.

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

occurence

property

occurence:int

Implementation
public function get occurence():int
public function set occurence(value:int):void

protect

property

protect: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 variable is protected.

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

subType

property

subType:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

One of SUBTYPEconst 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 subType():String
public function set subType(value:String):void

type

property

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

valueSet

property

valueSet:IList

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

ValueSet for the variable

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

Constructor Detail

Variable

()

Constructor

public function Variable()

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

DATATYPE_BOOLEAN

Constant

public static const DATATYPE_BOOLEAN:String = "BOOLEAN"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Data type: BOOLEAN - for boolean values.

DATATYPE_DATE

Constant

public static const DATATYPE_DATE:String = "DATE"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Data type: DATE - for date/time values.

DATATYPE_NUMBER

Constant

public static const DATATYPE_NUMBER:String = "NUMBER"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Data type: NUMBER - for numerical values.

DATATYPE_STRING

Constant

public static const DATATYPE_STRING:String = "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 type: STRING - for String values.

DD_DELIMITER

Constant

public static const DD_DELIMITER: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 Data Dictionary name delimiting character.

DD_PREFIX

Constant

public static const DD_PREFIX:String = "DD_"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Prefix for the Data Dictionary name in a Data Dictionary Element variable token ({DD_PREFIX}{DD name}.{DDE path}).

SUBTYPE_ENUM

Constant

public static const SUBTYPE_ENUM:String = "ENUM"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Variable subType: ENUM

TYPE_DDE

Constant

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

Variable type: Data Dictionary Element (reference). In this case, the name property is the DDE reference.

TYPE_PLACEHOLDER

Constant

public static const TYPE_PLACEHOLDER:String = "PLACEHOLDER"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Variable type: Placeholder.

Legal Notices | Online Privacy Policy

Variable - AS3 Asset Composer

Classes x

dataType

ddeReference

id

name

occurence

protect

subType

type

valueSet

Variable

addEventListener

dispatchEvent

hasEventListener

removeEventListener

toString

willTrigger

DATATYPE_BOOLEAN

DATATYPE_DATE

DATATYPE_NUMBER

DATATYPE_STRING

DD_DELIMITER

DD_PREFIX

SUBTYPE_ENUM

TYPE_DDE

TYPE_PLACEHOLDER