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.editors.model 

VariableModel  - AS3 Asset Composer
Packagecom.adobe.icc.editors.model
Classpublic class VariableModel
InheritanceVariableModel Inheritance EventDispatcher Inheritance Object
Subclasses LetterVariableModel

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

The domain class for the variables.

Variables are defined by modules as a provision to replace a part of the content with a dynamically fetched value.


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  dataType : String
The data-type of the variable
VariableModel
  id : String
[read-only] The GUID of the underlying variable value object.
VariableModel
  module : ModuleModel
The module to which this variables belongs.
VariableModel
  name : String
The name of the underlying variable value object.
VariableModel
  protect : Boolean
The protect property of the underlying variable value object.
VariableModel
  subType : String
The sub type of the variable.
VariableModel
  type : String
The type of the variable.
VariableModel
  valueSet : IList
The set of values for the enum type variable.
VariableModel
  vo : Variable
The underlying value object corresponding to this variable.
VariableModel
Public Methods
 MethodDefined By
 Inherited
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
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
  
equals(obj:VariableModel):Boolean
Compares two Variable domain objects for equality.
VariableModel
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 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
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 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
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
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
Events
Click for more information on events
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Public Constants
 ConstantDefined By
  TYPE_DDE : String = "DDE"
[static] The constant corresponding to the data dictionary variables.
VariableModel
  TYPE_PLACEHOLDER : String = "PLACEHOLDER"
[static] The constant corresponding to the placeholder variables.
VariableModel
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

The data-type of the variable



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

id

property 
id: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 GUID of the underlying variable value object.



Implementation
    public function get id():String

module

property 
module:ModuleModel

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

The module to which this variables belongs. The actual value of this property is a concrete module type e.g. TextModel

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 module():ModuleModel
    public function set module(value:ModuleModel):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

The name of the underlying variable value object.



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

The protect property of the underlying variable value object.



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

The sub type of the variable. The possible values are defined by the class constant SUBTYPE_ENUM



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

The type of the variable. The possible values are defined by the class constants TYPE_PLACEHOLDER and TYPE_DDE



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

The set of values for the enum type variable.



Implementation
    public function get valueSet():IList
    public function set valueSet(value:IList):void

vo

property 
vo:Variable

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

The underlying value object corresponding to this variable.



Implementation
    public function get vo():Variable
    public function set vo(value:Variable):void
Method Detail

equals

()method
public function equals(obj:VariableModel):Boolean

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

Compares two Variable domain objects for equality.

Parameters

obj:VariableModel — The variable domain object this object should be compared with.

Returns
Boolean — true, if the two domain objects are logically equal.
Constant Detail

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

The constant corresponding to the data dictionary variables.

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

The constant corresponding to the placeholder variables.




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

 

Legal Notices | Online Privacy Policy