Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.controls.treeClasses 
TreeListData 
Packagemx.controls.treeClasses
Classpublic class TreeListData
InheritanceTreeListData Inheritance BaseListData Inheritance EventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The TreeListData class defines the data type of the listData property implemented by drop-in item renderers or drop-in item editors for the Tree control. All drop-in item renderers and drop-in item editors must implement the IDropInListItemRenderer interface, which defines the listData property.

While the properties of this class are writable, you should considered them to be read only. They are initialized by the Tree class, and read by an item renderer or item editor. Changing these values can lead to unexpected results.

See also



Public Properties
 PropertyDefined By
 InheritedcolumnIndex : int
The index of the column of the List-based control relative to the currently visible columns of the control, where the first column is at an index of 1.
BaseListData
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  depth : int
The level of the item in the tree.
TreeListData
  disclosureIcon : Class
A Class representing the disclosure icon for the item in the Tree control.
TreeListData
  hasChildren : Boolean
Contains true if the node has children.
TreeListData
  icon : Class
A Class representing the icon for the item in the Tree control.
TreeListData
  indent : int
The default indentation for this row of the Tree control.
TreeListData
  item : Object
The data for this item in the Tree control.
TreeListData
 Inheritedlabel : String
The textual representation of the item data, based on the list class's itemToLabel() method.
BaseListData
  open : Boolean
Contains true if the node is open.
TreeListData
 Inheritedowner : IUIComponent
A reference to the list object that owns this item.
BaseListData
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrowIndex : int
The index of the row of the DataGrid, List, or Tree control relative to the currently visible rows of the control, where the first row is at an index of 1.
BaseListData
 Inheriteduid : String
The unique identifier for this item.
BaseListData
Public Methods
 MethodDefined By
  
TreeListData(text:String, uid:String, owner:ListBase, rowIndex:int = 0, columnIndex:int = 0)
Constructor.
TreeListData
 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

depth

property
public var depth:int

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The level of the item in the tree. The top level is 1.

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

disclosureIcon

property 
public var disclosureIcon:Class

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

A Class representing the disclosure icon for the item in the Tree control.

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

hasChildren

property 
public var hasChildren:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Contains true if the node has children.

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

icon

property 
public var icon:Class

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

A Class representing the icon for the item in the Tree control.

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

indent

property 
public var indent:int

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The default indentation for this row of the Tree control.

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

item

property 
public var item:Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The data for this item in the Tree control.

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

open

property 
public var open:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Contains true if the node is open.

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

Constructor Detail

TreeListData

()Constructor
public function TreeListData(text:String, uid:String, owner:ListBase, rowIndex:int = 0, columnIndex:int = 0)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Parameters
text:String — Text representation of the item data.
 
uid:String — A unique identifier for the item.
 
owner:ListBase — A reference to the Tree control.
 
rowIndex:int (default = 0) — The index of the item in the data provider for the Tree control.
 
columnIndex:int (default = 0) — The index of the column in the currently visible columns of the control.