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.dc.domain 

FieldInstance  - AS3 Asset Composer
Packagecom.adobe.icc.dc.domain
Classpublic class FieldInstance
InheritanceFieldInstance Inheritance EventDispatcher Inheritance 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 fields present in the letter's layout or fragment.


Public Properties
 PropertyDefined By
  caption : String
[read-only] The caption property of the underlying value object.
FieldInstance
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  dataType : String
[read-only] Return the field type
FieldInstance
  dataTypeValid : Boolean
True if the field's value filled by the user fits in well as per the data type of the field.
FieldInstance
  editable : Boolean
[read-only] True if the underlying object is editable.
FieldInstance
  formSomExpression : String
[read-only] The SOM Expression of the target.
FieldInstance
  isNewField : Boolean
[Applicable during reload] True if this is a new Field, that did not exist when the Letter was submitted.
FieldInstance
  isRemoved : Boolean
[Applicable during reload] True if this Field has been removed from the latest version of the layout.
FieldInstance
  name : String
[read-only] The name property of the underlying value object.
FieldInstance
  optional : Boolean
[read-only] True if the underlying object is optional.
FieldInstance
  order : int
[read-only] The order of a field represents the order in which it is laid out in the layout or fragment of a letter.
FieldInstance
  subType : String
[read-only] The sub type of the data element in case when type of data element specified is ENUM.
FieldInstance
  toolTip : String
[read-only] The toolTip property of the underlying value object.
FieldInstance
  valid : Boolean
[read-only] Boolean indicating whether the content is valid
FieldInstance
  value : *
The value of the data element(variable or field) associated with the letter instance.
FieldInstance
  valueSet : IList
[read-only] The list of value of the data element in case when type of data element specified is ENUM.
FieldInstance
Public Methods
 MethodDefined By
  
FieldInstance(value:FieldData)
Constructor.
FieldInstance
 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
 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
  
refresh():void
Refresh should be called when item is selected.
FieldInstance
 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
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

Related API Elements

for supported types

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 field's value filled by the user fits in well as per the data type of the field. for e.g dataTypeValid attribute is false when a string is filled in for a Number-type 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 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

formSomExpression

property 
formSomExpression: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 SOM Expression of the target.



Implementation
    public function get formSomExpression():String

isNewField

property 
isNewField:Boolean

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10.0
Runtime Versions: AIR (unsupported), Flash Player 10.2

[Applicable during reload] True if this is a new Field, that did not exist when the Letter was submitted.

The default value is false.

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

isRemoved

property 
isRemoved:Boolean

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10.0
Runtime Versions: AIR (unsupported), Flash Player 10.2

[Applicable during reload] True if this Field has been removed from the latest version of the layout.

The default value is false.

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

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

order

property 
order:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10.0
Runtime Versions: AIR (unsupported), Flash Player 10.2

The order of a field represents the order in which it is laid out in the layout or fragment of a letter.



Implementation
    public function get order():int

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

FieldInstance

()Constructor
public function FieldInstance(value:FieldData)

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10.0
Runtime Versions: AIR (unsupported), Flash Player 10.2

Constructor.

Parameters
value:FieldData — The FieldData object represented by FieldInstance.
Method Detail

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.




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

 

Legal Notices | Online Privacy Policy