com.adobe.icc.vo

# Field - AS3 Asset Composer

Package | com.adobe.icc.vo
Class | public class Field
Inheritance | Field Object
Implements | IManaged

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

A value object for a field in a form or layout. That is, in XDP.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | displayName : String Friendly name for UI purposes. | Field
|  | id : String Field's GUID. | Field
|  | isImage : Boolean [read-only] True if the field's data type is image. | Field
|  | isText : Boolean [read-only] True if the field's data type is text (plain or rich). | Field
|  | path : String Field's SOM expression in the letter's layout. | Field
|  | position : int | Field
|  | type : String Field's data type. | Field

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | Field() Constructor | Field
|  | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. | Field
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | Field
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | Field
|  | 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
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | Field
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Specifies a string representation of this object. | Field
|  | 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. | Field

Public Constants

| Constant | Defined By
--- | --- | ---
|  | TYPE_CHECKBOX : String = "CHECKBOX" [static] Specifies the constant for a checkbox field type. | Field
|  | TYPE_DATE : String = "DATE" [static] Specifies the constant for a date field type. | Field
|  | TYPE_DATETIME : String = "DATETIME" [static] Specifies the constant for a date and time field type. | Field
|  | TYPE_FLOAT : String = "FLOAT" [static] Specifies the constant for a Float field type. | Field
|  | TYPE_IMAGE : String = "IMAGE" [static] Specifies the constant for an image field type. | Field
|  | TYPE_INTEGER : String = "INTEGER" [static] Specifies the constant for an Integer field type. | Field
|  | TYPE_PLAINTEXT : String = "PLAINTEXT" [static] Specifies the constant for a plain text field type. | Field
|  | TYPE_RADIOBUTTON : String = "RADIOBUTTON" [static] Specifies the constant for a radio button field type. | Field
|  | TYPE_RICHTEXT : String = "RICHTEXT" [static] Specifies the constant for a rich text field type. | Field
|  | TYPE_TIME : String = "TIME" [static] Specifies the constant for a time field type. | Field

Property Detail

### displayName

property

`displayName:String`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

Friendly name for UI purposes.

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 displayName():String`
`public function set displayName(value:String):void`

### id

property

`id:String`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

Field's GUID.

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 id():String`
`public function set id(value:String):void`

### isImage

property

`isImage: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

True if the field's data type is image.

Implementation
`public function get isImage():Boolean`

### isText

property

`isText: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

True if the field's data type is text (plain or rich).

Implementation
`public function get isText():Boolean`

### path

property

`path:String`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

Field's SOM expression in the letter's layout. Since this SOM is determined at design-time, it's expected to be in the Template DOM which means it will always start with 'xfa[0].template[0]'. Furthermore, it is expected to be an absolute (i.e. fully-qualified) SOM expression.

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 path():String`
`public function set path(value:String):void`

### position

property

`position:int`

Implementation
`public function get position():int`
`public function set position(value:int):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

Field's data type. One of TYPEconst value.

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 type():String`
`public function set type(value:String):void`
Constructor Detail

### Field

()
Constructor

`public function Field()`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

Constructor

Method Detail

### addEventListener

()
method

`public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void`

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

After you successfully register an event listener, you cannot change its priority through additional calls to `addEventListener()`. To change a listener's priority, you must first call `removeEventListener()`. Then you can register the listener again with the new priority level.

After the listener is registered, subsequent calls to `addEventListener()` with a different value for either `type` or `useCapture` result in the creation of a separate listener registration. For example, if you first register a listener with `useCapture` set to `true`, it listens only during the capture phase. If you call `addEventListener()` again using the same listener object, but with `useCapture` set to `false`, you have two separate listeners: one that listens during the capture phase, and another that listens during the target and bubbling phases.

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

When you no longer need an event listener, remove it by calling `EventDispatcher.removeEventListener()`; otherwise, memory problems might result. Objects with registered event listeners are not automatically removed from memory because the garbage collector does not remove objects that still have references.

Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.

If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).

Parameters

| `type:String` — The type of event.
| `listener:Function` — The listener function that processes the event. This function must accept an event object as its only parameter and must return nothing, as this example shows: `function(evt:Event):void` The function can have any name.
| `useCapture:Boolean` (default = `false`)`` — Determines whether the listener works in the capture phase or the target and bubbling phases. If `useCapture` is set to `true`, the listener processes the event only during the capture phase and not in the target or bubbling phase. If `useCapture` is `false`, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call `addEventListener()` twice, once with `useCapture` set to `true`, then again with `useCapture` set to `false`.
| `priority:int` (default = `0`)`` — The priority level of the event listener. Priorities are designated by a 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.
| `weakRef:Boolean` (default = `false`)`` — Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not. Class-level member functions are not subject to garbage collection, so you can set `useWeakReference` to `true` for class-level member functions without subjecting them to garbage collection. If you set `useWeakReference` to `true` for a listener that is a nested inner function, the function will be garbge-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent.

### dispatchEvent

()
method

`public function dispatchEvent(event:Event):Boolean`

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which `dispatchEvent()` is called.

Parameters

| `event:Event` — The event object dispatched into the event flow.

Returns

| `Boolean` — A value of `true` unless `preventDefault()` is called on the event, in which case it returns `false`.

### hasEventListener

()
method

`public function hasEventListener(type:String):Boolean`

Checks whether the EventDispatcher object has any listeners registered for a specific type of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type will actually trigger an event listener, use `IEventDispatcher.willTrigger()`.

The difference between `hasEventListener()` and `willTrigger()` is that `hasEventListener()` examines only the object to which it belongs, whereas `willTrigger()` examines the entire event flow for the event specified by the `type` parameter.

Parameters

| `type:String` — The type of event.

Returns

| `Boolean` — A value of `true` if a listener of the specified type is registered; `false` otherwise.

### removeEventListener

()
method

`public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void`

Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.

Parameters

| `type:String` — The type of event.
| `listener:Function` — The listener object to remove.
| `useCapture:Boolean` (default = `false`)`` — Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to `removeEventListener()` are required to remove both: one call with `useCapture` set to `true`, and another call with `useCapture` set to `false`.

### toString

()
method

`public function toString():String`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 9.5

Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10

Specifies a string representation of this object.

Returns

| `String` — String representation of this object.

### willTrigger

()
method

`public function 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. This method returns `true` if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.

The difference between `hasEventListener()` and `willTrigger()` is that `hasEventListener()` examines only the object to which it belongs, whereas `willTrigger()` examines the entire event flow for the event specified by the `type` parameter.

Parameters

| `type:String` — The type of event.

Returns

| `Boolean` — A value of `true` if a listener of the specified type will be triggered; `false` otherwise.

Constant Detail

### TYPE_CHECKBOX

Constant

`public static const TYPE_CHECKBOX:String = "CHECKBOX"`

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 constant for a checkbox field type.

### TYPE_DATE

Constant

`public static const TYPE_DATE:String = "DATE"`

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 constant for a date field type.

### TYPE_DATETIME

Constant

`public static const TYPE_DATETIME:String = "DATETIME"`

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 constant for a date and time field type.

### TYPE_FLOAT

Constant

`public static const TYPE_FLOAT:String = "FLOAT"`

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 constant for a Float field type.

### TYPE_IMAGE

Constant

`public static const TYPE_IMAGE:String = "IMAGE"`

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 constant for an image field type.

### TYPE_INTEGER

Constant

`public static const TYPE_INTEGER:String = "INTEGER"`

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 constant for an Integer field type.

### TYPE_PLAINTEXT

Constant

`public static const TYPE_PLAINTEXT:String = "PLAINTEXT"`

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 constant for a plain text field type. That is, unformatted text.

### TYPE_RADIOBUTTON

Constant

`public static const TYPE_RADIOBUTTON:String = "RADIOBUTTON"`

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 constant for a radio button field type.

### TYPE_RICHTEXT

Constant

`public static const TYPE_RICHTEXT:String = "RICHTEXT"`

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 constant for a rich text field type.

### TYPE_TIME

Constant

`public static const TYPE_TIME:String = "TIME"`

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 constant for a time field type.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00