VariableInstance

Package	com.adobe.icc.dc.domain
Class	public class VariableInstance
Inheritance	VariableInstance EventDispatcher Object
Implements	IDataInstance

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

This class is the runtime representation of the variable present in the letter.

Public Properties

	Property		Defined By
		caption : String [read-only] The caption property of the underlying value object.	VariableInstance
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		dataType : String [read-only] Return the field type	VariableInstance
		dataTypeValid : Boolean True if the variable's value filled by the user fits in well as per the data type of the variable.	VariableInstance
		editable : Boolean [read-only] True if the underlying object is editable.	VariableInstance
		name : String [read-only] The name property of the underlying value object.	VariableInstance
		optional : Boolean [read-only] True if the underlying object is optional.	VariableInstance
		subType : String [read-only] The sub type of the data element in case when type of data element specified is ENUM.	VariableInstance
		toolTip : String [read-only] The toolTip property of the underlying value object.	VariableInstance
		valid : Boolean [read-only] Boolean indicating whether the content is valid	VariableInstance
		value : * The value of the data element(variable or field) associated with the letter instance.	VariableInstance
		valueSet : IList [read-only] The list of value of the data element in case when type of data element specified is ENUM.	VariableInstance

Public Methods

	Method		Defined By
		VariableInstance(value:VariableData) Constructor.	VariableInstance
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		addModuleInstance(moduleInstance:IModuleInstance):void Add the given moduleInstance to this VariableInstance, as a source of the associated Variable.	VariableInstance
		destroy():void The function called when the Variable instance is no longer required.It does the clean up like removing event listeners from the dependencies.	VariableInstance
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		getModuleInstance():IList Get the List of IModuleInstances for all modules that this VariableInstance's Variable is derived from.	VariableInstance
		getVariable():Variable Returns the instance of Variable associated with this underlying object.	VariableInstance
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		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
		refresh():void Refresh should be called when item is selected.	VariableInstance
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setup():void The function to prepare the Variable instance for use.	VariableInstance
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		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.	EventDispatcher

Protected Methods

	Method		Defined By
		variableDataChangeHandler(event:VariableDataEvent):void Called when the variable's value changes (which could be the result of a linked variable/field).	VariableInstance

Events

Click for more information on events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Property Detail

caption

property

caption:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The caption property of the underlying value object.

Implementation
public function get caption():String

dataType

property

dataType:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Return the field type

Implementation
public function get dataType():String

dataTypeValid

property

dataTypeValid:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

True if the variable's value filled by the user fits in well as per the data type of the variable. for e.g dataTypeValid attribute is false when a string is filled in for a Number-type 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 dataTypeValid():Boolean
public function set dataTypeValid(value:Boolean):void

editable

property

editable:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

True if the underlying object is editable.

Implementation
public function get editable():Boolean

name

property

name:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The name property of the underlying value object.

Implementation
public function get name():String

optional

property

optional:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

True if the underlying object is optional.

Implementation
public function get optional():Boolean

subType

property

subType:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The sub type of the data element in case when type of data element specified is ENUM.

Implementation
public function get subType():String

toolTip

property

toolTip:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The toolTip property of the underlying value object.

Implementation
public function get toolTip():String

valid

property

valid:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Boolean indicating whether the content is valid

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 valid():Boolean

value

property

value:*

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The value of the data element(variable or field) associated with the letter instance.

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

valueSet

property

valueSet:IList [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The list of value of the data element in case when type of data element specified is ENUM.

Implementation
public function get valueSet():IList

Constructor Detail

VariableInstance

()

Constructor

public function VariableInstance(value:VariableData)

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Constructor.

Parameters

value:VariableData — The VariableData object associated with VariableInstance.

Method Detail

addModuleInstance

()

method

public function addModuleInstance(moduleInstance:IModuleInstance):void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Add the given moduleInstance to this VariableInstance, as a source of the associated Variable.

Parameters

moduleInstance:IModuleInstance — The IModuleInstance object to be added to this VariableInstance.

destroy

()

method

public function destroy():void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The function called when the Variable instance is no longer required.It does the clean up like removing event listeners from the dependencies.

getModuleInstance

()

method

public function getModuleInstance():IList

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Get the List of IModuleInstances for all modules that this VariableInstance's Variable is derived from.

Returns

IList —

getVariable

()

method

public function getVariable():Variable

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Returns the instance of Variable associated with this underlying object.

Returns

Variable —

refresh

()

method

public function refresh():void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Refresh should be called when item is selected. This is useful in case when the the item is deselcted. In that case, if there is any change in variable value/ field value etc., those changes may not be propagated to module.

setup

()

method

public function setup():void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The function to prepare the Variable instance for use.

variableDataChangeHandler

()

method

protected function variableDataChangeHandler(event:VariableDataEvent):void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Called when the variable's value changes (which could be the result of a linked variable/field).

Parameters

event:VariableDataEvent — The VariableDataEvent event dispatched on variable data change.

Legal Notices | Online Privacy Policy

VariableInstance - AS3 Asset Composer

Classes x

caption

dataType

dataTypeValid

editable

name

optional

subType

toolTip

valid

value

valueSet

VariableInstance

addModuleInstance

destroy

getModuleInstance

getVariable

refresh

setup

variableDataChangeHandler