Packagemx.controls.treeClasses
Classpublic class TreeListData
InheritanceTreeListData Inheritance BaseListData Inheritance flash.events.EventDispatcher

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

mx.controls.listClasses.IDropInListItemRenderer


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
  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
 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
Property Detail
depthproperty
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.

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

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

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

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

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

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

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.