(Flex Data Visualization components only)
Packagemx.collections
Classpublic class HierarchicalCollectionView
InheritanceHierarchicalCollectionView Inheritance EventDispatcher Inheritance Object
Implements IHierarchicalCollectionView

The HierarchicalCollectionView class provides a hierarchical view of a standard collection.

MXML SyntaxexpandedHide MXML Syntax
The <mx.HierarchicalCollectionView> inherits all the tag attributes of its superclass, and defines the following tag attributes:

  <mx:HierarchicalCollectionView
  Properties 
    showRoot="true|false"
    source="No default"
  />

Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  hasRoot : Boolean
[read-only] A flag that, if true, indicates that the current data provider has a root node; for example, a single top-level node in a hierarchical structure.
HierarchicalCollectionView
  length : int
[read-only] The length of the currently parsed collection.
HierarchicalCollectionView
  openNodes : Object
An Array of Objects containing the data provider element for all the open branch nodes of the data.
HierarchicalCollectionView
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  showRoot : Boolean
A Boolean flag that specifies whether to display the data provider's root node.
HierarchicalCollectionView
  source : IHierarchicalData
The source data of the IHierarchicalCollectionView.
HierarchicalCollectionView
Public Methods
 MethodDefined By
  
HierarchicalCollectionView(hierarchicalData:IHierarchicalData = null, argOpenNodes:Object = null)
Constructor.
HierarchicalCollectionView
  
addChild(parent:Object, newChild:Object):Boolean
Adds a child node to a node of the data.
HierarchicalCollectionView
  
addChildAt(parent:Object, newChild:Object, index:int):Boolean
Add a child node to a node at the specified index.
HierarchicalCollectionView
 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
  
closeNode(node:Object):void
Closes a node to hide its children.
HierarchicalCollectionView
  
contains(item:Object):Boolean
Checks the collection for the data item using standard equality test.
HierarchicalCollectionView
  
createCursor():IViewCursor
Returns a new instance of a view iterator over the items in this view.
HierarchicalCollectionView
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
  
getNodeDepth(node:Object):int
Returns the depth of the node in the collection.
HierarchicalCollectionView
  
getParentItem(node:Object):*
Returns the parent of a node.
HierarchicalCollectionView
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
  
openNode(node:Object):void
Opens a node to display its children.
HierarchicalCollectionView
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
  
removeChild(parent:Object, child:Object):Boolean
Removes the child node from the parent node.
HierarchicalCollectionView
  
removeChildAt(parent:Object, index:int):Boolean
Removes the child node from a node at the specified index.
HierarchicalCollectionView
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
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.
EventDispatcher
  
xmlNotification(currentTarget:Object, type:String, target:Object, value:Object, detail:Object):void
Called whenever an XML object contained in our list is updated in some way.
HierarchicalCollectionView
Events
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Property Detail
hasRootproperty
hasRoot:Boolean  [read-only]

A flag that, if true, indicates that the current data provider has a root node; for example, a single top-level node in a hierarchical structure. XML and Object are examples of data types that have a root node, while Lists and Arrays do not.



Implementation
    public function get hasRoot():Boolean
lengthproperty 
length:int  [read-only]

The length of the currently parsed collection.



Implementation
    public function get length():int
openNodesproperty 
openNodes:Object

An Array of Objects containing the data provider element for all the open branch nodes of the data.



Implementation
    public function get openNodes():Object
    public function set openNodes(value:Object):void
showRootproperty 
showRoot:Boolean

A Boolean flag that specifies whether to display the data provider's root node. If the source data has a root node, and this property is set to false, the collection will not include the root item. Only the descendants of the root item will be included in the collection.

This property has no effect on a source with no root node, such as List and Array objects.

The default value is true.

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



Implementation
    public function get showRoot():Boolean
    public function set showRoot(value:Boolean):void
sourceproperty 
source:IHierarchicalData

The source data of the IHierarchicalCollectionView.



Implementation
    public function get source():IHierarchicalData
    public function set source(value:IHierarchicalData):void
Constructor Detail
HierarchicalCollectionView()Constructor
public function HierarchicalCollectionView(hierarchicalData:IHierarchicalData = null, argOpenNodes:Object = null)

Constructor.

Parameters
hierarchicalData:IHierarchicalData (default = null) — The data structure containing the hierarchical data.
 
argOpenNodes:Object (default = null) — The Object that defines a node to appear as open.
Method Detail
addChild()method
public function addChild(parent:Object, newChild:Object):Boolean

Adds a child node to a node of the data.

Parameters

parent:Object — The Object that defines the parent node.
 
newChild:Object — The Object that defines the new node.

Returns
Boolean — true if the node is added successfully.
addChildAt()method 
public function addChildAt(parent:Object, newChild:Object, index:int):Boolean

Add a child node to a node at the specified index. This implementation does the following:

Parameters

parent:Object — The Object that defines the parent node.
 
newChild:Object — The Object that defines the child node.
 
index:int — The 0-based index of where to insert the child node.

Returns
Boolean — true if the child is added successfully.
closeNode()method 
public function closeNode(node:Object):void

Closes a node to hide its children.

Parameters

node:Object — The Object that defines the node.

contains()method 
public function contains(item:Object):Boolean

Checks the collection for the data item using standard equality test.

Parameters

item:Object — The Object that defines the node to look for.

Returns
Boolean — true if the data item is in the collection, and false if not.
createCursor()method 
public function createCursor():IViewCursor

Returns a new instance of a view iterator over the items in this view.

Returns
IViewCursor — IViewCursor instance.

See also

mx.utils.IViewCursor
getNodeDepth()method 
public function getNodeDepth(node:Object):int

Returns the depth of the node in the collection.

Parameters

node:Object — The Object that defines the node.

Returns
int — The depth of the node.
getParentItem()method 
public function getParentItem(node:Object):*

Returns the parent of a node. The parent of a top-level node is null.

Parameters

node:Object — The Object that defines the node.

Returns
* — The parent node containing the node, null for a top-level node, and undefined if the parent cannot be determined.
openNode()method 
public function openNode(node:Object):void

Opens a node to display its children.

Parameters

node:Object — The Object that defines the node.

removeChild()method 
public function removeChild(parent:Object, child:Object):Boolean

Removes the child node from the parent node.

Parameters

parent:Object — The Object that defines the parent node, and null for top-level nodes.
 
child:Object — The Object that defines the child node to be removed.

Returns
Boolean — true if the node is removed successfully.
removeChildAt()method 
public function removeChildAt(parent:Object, index:int):Boolean

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

Parameters

parent:Object — The Object that defines the parent node.
 
index:int — The 0-based index of the child node to remove relative to the parent.

Returns
Boolean — true if the child is removed successfully.
xmlNotification()method 
public function xmlNotification(currentTarget:Object, type:String, target:Object, value:Object, detail:Object):void

Called whenever an XML object contained in our list is updated in some way. The initial implementation stab is very lenient, any changeType will cause an update no matter how much further down in a hierarchy.

Parameters

currentTarget:Object
 
type:String
 
target:Object
 
value:Object
 
detail:Object




© 2009 Adobe Systems Incorporated. All rights reserved.
Thu Aug 13 2009, 03:11 AM -07:00