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.vo 

Table  - AS3 Asset Composer

Packagecom.adobe.icc.vo
Classpublic class Table
InheritanceTable Inheritance Object
Implements IManaged

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

Represents a table in layout. Will contain all the target areas and fields in the table.



Public Properties
 PropertyDefined By
  additionalTableColumns : IList
Table column details for all the columns inside the table.
Table
  bodyRows : IList
Collection of body rows of the Table
Table
  configuredBodyRowCount : int
The body row count after customization
Table
  configuredColumnCount : int
The column count after customization
Table
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  containerFieldPosition : int
Table
  containerTargetAreaPosition : int
Table
  customizable : Boolean
The flag indicating if the table is customizable.
Table
  dynamicTable : Boolean
The boolean value representing if the table is dynamic or static
Table
  footerRow : com.adobe.icc.vo:TableRow
The footer row of the Table
Table
  headerRow : com.adobe.icc.vo:TableRow
The header row of the Table
Table
  id : String
Identifier of the table
Table
  originalBodyRowCount : int
The body row count before customization
Table
  originalColumnCount : int
The column count before customization
Table
  placeHolderTable : Boolean
The flag indicating if the place holder table contains only single draw element.
Table
  position : int
Position of the table within container layout
Table
  showFooterRow : Boolean
A flag indicating whether to show the footer row in final correspondence.
Table
  showHeaderRow : Boolean
A flag indicating whether to show the header row in final correspondence.
Table
  tableName : String
The string representing name of the table
Table
  tableSOMExpression : String
Table's SOM expression
Table
Public Methods
 MethodDefined By
  
Constructor
Table
  
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.
Table
  
Dispatches an event into the event flow.
Table
  
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
Table
 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
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
Table
 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
  
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
Table
Property Detail

additionalTableColumns

property
additionalTableColumns:IList

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

Table column details for all the columns inside the table.

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

bodyRows

property 
bodyRows:IList

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

Collection of body rows of the Table

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

configuredBodyRowCount

property 
configuredBodyRowCount:int

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

The body row count after customization

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

configuredColumnCount

property 
configuredColumnCount:int

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

The column count after customization

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

containerFieldPosition

property 
containerFieldPosition:int



Implementation
    public function get containerFieldPosition():int
    public function set containerFieldPosition(value:int):void

containerTargetAreaPosition

property 
containerTargetAreaPosition:int



Implementation
    public function get containerTargetAreaPosition():int
    public function set containerTargetAreaPosition(value:int):void

customizable

property 
customizable:Boolean

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

The flag indicating if the table is customizable.

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

dynamicTable

property 
dynamicTable:Boolean

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

The boolean value representing if the table is dynamic or static

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

footerRow

property 
footerRow:com.adobe.icc.vo:TableRow

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

The footer row of the Table

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 footerRow():com.adobe.icc.vo:TableRow
    public function set footerRow(value:com.adobe.icc.vo:TableRow):void

headerRow

property 
headerRow:com.adobe.icc.vo:TableRow

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

The header row of the Table

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 headerRow():com.adobe.icc.vo:TableRow
    public function set headerRow(value:com.adobe.icc.vo:TableRow):void

id

property 
id:String

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

Identifier of the table

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

originalBodyRowCount

property 
originalBodyRowCount:int

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

The body row count before customization

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

originalColumnCount

property 
originalColumnCount:int

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

The column count before customization

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

placeHolderTable

property 
placeHolderTable:Boolean

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

The flag indicating if the place holder table contains only single draw element.

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

position

property 
position:int

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

Position of the table within container layout

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

showFooterRow

property 
showFooterRow:Boolean

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

A flag indicating whether to show the footer row in final correspondence.

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

showHeaderRow

property 
showHeaderRow:Boolean

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

A flag indicating whether to show the header row in final correspondence.

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

tableName

property 
tableName:String

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

The string representing name of the table

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

tableSOMExpression

property 
tableSOMExpression:String

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

Table's 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 tableSOMExpression():String
    public function set tableSOMExpression(value:String):void
Constructor Detail

Table

()Constructor
public function Table()

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

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.

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.