(Flex Data Visualization components only)
Packagemx.collections
Classpublic class HierarchicalCollectionViewCursor
InheritanceHierarchicalCollectionViewCursor Inheritance EventDispatcher Inheritance Object
Implements IHierarchicalCollectionViewCursor

The HierarchicalCollectionViewCursor class defines a cursor for a hierarchical view of a standard collection. The collection that this cursor walks across need not be hierarchical - it may be flat. This class delegates to the IHierarchicalData for information regarding the tree structure of the data it walks across.

See also

HierarchicalCollectionView


Public Properties
 PropertyDefined By
  afterLast : Boolean
[read-only] If the cursor is located after the last item in the view, this property is true .
HierarchicalCollectionViewCursor
  beforeFirst : Boolean
[read-only] If the cursor is located before the first item in the view, this property is true.
HierarchicalCollectionViewCursor
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  currentDepth : int
[read-only] Contains the depth of the node at the location in the source collection referenced by this cursor.
HierarchicalCollectionViewCursor
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  view : ICollectionView
[read-only] A reference to the ICollectionView with which this cursor is associated.
HierarchicalCollectionViewCursor
Public Methods
 MethodDefined By
  
Constructor.
HierarchicalCollectionViewCursor
 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
afterLastproperty
afterLast:Boolean  [read-only]

If the cursor is located after the last item in the view, this property is true . If the ICollectionView is empty (length == 0), this property is true.



Implementation
    public function get afterLast():Boolean
beforeFirstproperty 
beforeFirst:Boolean  [read-only]

If the cursor is located before the first item in the view, this property is true. If the ICollectionView is empty (length == 0), this property is true.



Implementation
    public function get beforeFirst():Boolean
currentDepthproperty 
currentDepth:int  [read-only]

Contains the depth of the node at the location in the source collection referenced by this cursor. If the cursor is beyond the end of the collection, this property contains 0.



Implementation
    public function get currentDepth():int
viewproperty 
view:ICollectionView  [read-only]

A reference to the ICollectionView with which this cursor is associated.



Implementation
    public function get view():ICollectionView
Constructor Detail
HierarchicalCollectionViewCursor()Constructor
public function HierarchicalCollectionViewCursor(collection:HierarchicalCollectionView, model:ICollectionView, hierarchicalData:IHierarchicalData)

Constructor.

Parameters
collection:HierarchicalCollectionView — The HierarchicalCollectionView instance referenced by this cursor.
 
model:ICollectionView — The source data collection.
 
hierarchicalData:IHierarchicalData — The data used to create the HierarchicalCollectionView instance.