Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.controls.treeClasses 
ITreeDataDescriptor 
Packagemx.controls.treeClasses
Interfacepublic interface ITreeDataDescriptor

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

Interface providing methods for parsing and adding nodes to a collection of data that is displayed by a Tree control.

See also



Public Methods
 MethodDefined By
  
addChildAt(parent:Object, newChild:Object, index:int, model:Object = null):Boolean
Adds a child node to a node at the specified index.
ITreeDataDescriptor
  
Provides access to a node's children, returning a collection view of children if they exist.
ITreeDataDescriptor
  
getData(node:Object, model:Object = null):Object
Gets the data from a node.
ITreeDataDescriptor
  
hasChildren(node:Object, model:Object = null):Boolean
Tests for the existence of children in a non-terminating node.
ITreeDataDescriptor
  
isBranch(node:Object, model:Object = null):Boolean
Tests a node for termination.
ITreeDataDescriptor
  
removeChildAt(parent:Object, child:Object, index:int, model:Object = null):Boolean
Removes a child node to a node at the specified index.
ITreeDataDescriptor
Method Detail

addChildAt

()method
public function addChildAt(parent:Object, newChild:Object, index:int, model:Object = null):Boolean

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

Adds a child node to a node at the specified index.

Parameters

parent:Object — The node object that will parent the child.
 
newChild:Object — The node object that will be parented by the node.
 
index:int — The 0-based index of where to put the child node.
 
model:Object (default = null) — The entire collection that this node is a part of.

Returns
Booleantrue if successful.

getChildren

()method 
public function getChildren(node:Object, model:Object = null):ICollectionView

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

Provides access to a node's children, returning a collection view of children if they exist. A node can return any object in the collection as its children; children need not be nested. It is best-practice to return the same collection view for a given node.

Parameters

node:Object — The node object currently being evaluated.
 
model:Object (default = null) — The entire collection that this node is a part of.

Returns
ICollectionView — An collection view containing the child nodes.

getData

()method 
public function getData(node:Object, model:Object = null):Object

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

Gets the data from a node.

Parameters

node:Object — The node object from which to get the data.
 
model:Object (default = null) — The collection that contains the node.

Returns
Object — The requested data.

hasChildren

()method 
public function hasChildren(node:Object, model:Object = null):Boolean

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

Tests for the existence of children in a non-terminating node.

Parameters

node:Object — The current node.
 
model:Object (default = null) — The entire collection that this node is a part of.

Returns
Booleantrue if the node has at least one child.

isBranch

()method 
public function isBranch(node:Object, model:Object = null):Boolean

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

Tests a node for termination. Branches are non-terminating but are not required to have any leaf nodes.

Parameters

node:Object — The node object currently being evaluated.
 
model:Object (default = null) — The entire collection that this node is a part of.

Returns
Boolean — A Boolean indicating if this node is non-terminating.

removeChildAt

()method 
public function removeChildAt(parent:Object, child:Object, index:int, model:Object = null):Boolean

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

Removes a child node to a node at the specified index.

Parameters

parent:Object — The node object that is the parent of the child.
 
child:Object — The node object that will be removed.
 
index:int — The 0-based index of the soon to be deleted node.
 
model:Object (default = null) — The entire collection that this node is a part of.

Returns
Booleantrue if successful.