| 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 |
Hide Inherited Public Properties
Show Inherited 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 | ||
| 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 | |
Add the given moduleInstance to this VariableInstance, as a source of the associated Variable. | VariableInstance | ||
The function called when the Variable instance is no longer required.It does the clean up like removing event listeners from the dependencies. | VariableInstance | ||
|
Dispatches an event into the event flow. | EventDispatcher | |
Get the List of IModuleInstances for all modules that this VariableInstance's Variable is derived from. | VariableInstance | ||
Returns the instance of Variable associated with this underlying object. | VariableInstance | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
Refresh should be called when item is selected. | VariableInstance | ||
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
The function to prepare the Variable instance for use. | VariableInstance | ||
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| 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 | ||
caption | property |
dataType | property |
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):voideditable | property |
name | property |
optional | property |
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():StringtoolTip | property |
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():Booleanvalue | 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):voidvalueSet | 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():IListVariableInstance | () | 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.
Parametersvalue:VariableData — The VariableData object associated with VariableInstance.
|
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 |
getVariable | () | method |
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.
|
Mon Apr 10 2017, 12:28 PM -07:00