Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.collections 
IHierarchicalData 
Packagemx.collections
Interfacepublic interface IHierarchicalData extends IEventDispatcher
Implementors HierarchicalData

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

The IHierarchicalData interface defines the interface used to represent hierarchical data as the data provider for a Flex component. Hierarchical data is data in a structure of parent and child data items.

See also



Public Methods
 MethodDefined By
 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.
IEventDispatcher
  
Returns true if the node can contain children.
IHierarchicalData
 Inherited
Dispatches an event into the event flow.
IEventDispatcher
  
Returns an Object representing the node's children.
IHierarchicalData
  
Returns data from a node.
IHierarchicalData
  
Returns the root data item.
IHierarchicalData
  
Returns true if the node has children.
IHierarchicalData
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
IEventDispatcher
Method Detail

canHaveChildren

()method
public function canHaveChildren(node:Object):Boolean

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

Returns true if the node can contain children.

Nodes do not have to contain children for the method to return true. This method is useful in determining whether other nodes can be appended as children to the specified node.

Parameters

node:Object — The Object that defines the node.

Returns
Booleantrue if the node can contain children.

getChildren

()method 
public function getChildren(node:Object):Object

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

Returns an Object representing the node's children.

Parameters

node:Object — The Object that defines the node. If null, return a collection of top-level nodes.

Returns
Object — An Object containing the children nodes.

getData

()method 
public function getData(node:Object):Object

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

Returns data from a node.

Parameters

node:Object — The node Object from which to get the data.

Returns
Object — The requested data.

getRoot

()method 
public function getRoot():Object

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

Returns the root data item.

Returns
Object — The Object containing the root data item.

hasChildren

()method 
public function hasChildren(node:Object):Boolean

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

Returns true if the node has children.

Parameters

node:Object — The Object that defines the node.

Returns
Booleantrue if the node has children.