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 

VariableAssignmentModel  - AS3 Asset Composer

Packagecom.adobe.icc.editors.model
Classpublic class VariableAssignmentModel
InheritanceVariableAssignmentModel Inheritance EventDispatcher Inheritance Object
Implements IAssignmentModel

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

This domain class represents the variable assignments of a Letter.

Related API Elements

com.adobe.icc.editors.model.LetterModel.assignments
com.adobe.icc.editors.model.LetterModel.fieldAssignments


Public Properties
 PropertyDefined By
  binding : Object
This property holds the typed object that is bound to the field that this field assignment is associated with.
VariableAssignmentModel
  bindingType : String
The type of binding between the field and its assignment.
VariableAssignmentModel
  caption : String
The caption property of the underlying value object.
VariableAssignmentModel
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  dataModel : ModuleModel
The parent data module of the variable associated with this assignment
VariableAssignmentModel
  editable : Boolean
The editable property of the underlying value object.
VariableAssignmentModel
  isEditableEnabled : Boolean
[read-only] Specifies whether this assignement model is editable
VariableAssignmentModel
  isOptionalEnabled : Boolean
[read-only] Specifies whether this assignement model is optional
VariableAssignmentModel
  letterModel : LetterModel
The domain object of the letter that this assignment belongs to.
VariableAssignmentModel
  optional : Boolean
The optional property of the underlying value object.
VariableAssignmentModel
  target : *
The field associated with this assignment.
VariableAssignmentModel
  toolTip : String
The toolTip property of the underlying value object.
VariableAssignmentModel
  type : String
[read-only] Specifies the type of this assignment.
VariableAssignmentModel
  vo : VariableAssignment
The underlying variable assignment value object
VariableAssignmentModel
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
Dispatches an event into the event flow.
EventDispatcher
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
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
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Property Detail

binding

property
binding:Object

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

This property holds the typed object that is bound to the field that this field assignment is associated with.

The type of this object varies as per the bindingType. The following table describes the 'type' of this property for all the possible cases.

Binding TypeThe object type of this property value
DDEcom.adobe.dct.transfer.DataDictionaryElement
CONSTString
DATAMODULEcom.adobe.icc.editors.model.ModuleModel
USERString
VARIABLEcom.adobe.icc.editors.model.VariableModel
FIELDcom.adobe.icc.vo.Field

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

bindingType

property 
bindingType: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 binding between the field and its 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 bindingType():String
    public function set bindingType(value:String):void

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

The caption property of the underlying value object.

This property can be used as the source for data binding. When this property is modified, it dispatches the captionChange event.



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

dataModel

property 
dataModel: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 parent data module of 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 dataModel():ModuleModel
    public function set dataModel(value:ModuleModel):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

The editable property of the underlying value object.

This property can be used as the source for data binding. When this property is modified, it dispatches the editableChange event.



Implementation
    public function get editable():Boolean
    public function set editable(value:Boolean):void

isEditableEnabled

property 
isEditableEnabled:Boolean  [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

Specifies whether this assignement model is editable



Implementation
    public function get isEditableEnabled():Boolean

isOptionalEnabled

property 
isOptionalEnabled:Boolean  [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

Specifies whether this assignement model is optional



Implementation
    public function get isOptionalEnabled():Boolean

letterModel

property 
letterModel:LetterModel

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 object of the letter that this assignment belongs to.

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 letterModel():LetterModel
    public function set letterModel(value:LetterModel):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

The optional property of the underlying value object.

This property can be used as the source for data binding. When this property is modified, it dispatches the optionalChange event.



Implementation
    public function get optional():Boolean
    public function set optional(value:Boolean):void

target

property 
target:*

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

The field associated with this assignment. This is of the type com.adobe.icc.vo.Variable

This property can be used as the source for data binding. When this property is modified, it dispatches the targetChange event.



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

The toolTip property of the underlying value object.

This property can be used as the source for data binding. When this property is modified, it dispatches the targetChange event.



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

type

property 
type: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

Specifies the type of this assignment.



Implementation
    public function get type():String

vo

property 
vo:VariableAssignment

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 variable assignment value object



Implementation
    public function get vo():VariableAssignment
    public function set vo(value:VariableAssignment):void