Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.collections 
IHierarchicalCollectionViewCursor 
Packagemx.collections
Interfacepublic interface IHierarchicalCollectionViewCursor extends IViewCursor , IEventDispatcher
Implementors HierarchicalCollectionViewCursor

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

The IHierarchicalCollectionViewCursor interface defines the interface for enumerating a hierarchical collection view bidirectionally. This cursor provides capabilities to find the current depth of an item.

See also

mx.collections.IViewCursor
mx.controls.IHierarchicalCollectionView


Public Properties
 PropertyDefined By
 InheritedafterLast : Boolean
[read-only] If the cursor is located after the last item in the view, this property is true .
IViewCursor
 InheritedbeforeFirst : Boolean
[read-only] If the cursor is located before the first item in the view, this property is true.
IViewCursor
 Inheritedbookmark : CursorBookmark
[read-only] Provides access to a bookmark that corresponds to the item returned by the current property.
IViewCursor
 Inheritedcurrent : Object
[read-only] Provides access the object at the location in the source collection referenced by this cursor.
IViewCursor
  currentDepth : int
[read-only] Contains the depth of the node at the location in the source collection referenced by this cursor.
IHierarchicalCollectionViewCursor
 Inheritedview : ICollectionView
[read-only] A reference to the ICollectionView with which this cursor is associated.
IViewCursor
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
 Inherited
Dispatches an event into the event flow.
IEventDispatcher
 Inherited
Finds an item with the specified properties within the collection and positions the cursor to that item.
IViewCursor
 Inherited
Finds the first item with the specified properties within the collection and positions the cursor to that item.
IViewCursor
 Inherited
Finds the last item with the specified properties within the collection and positions the cursor on that item.
IViewCursor
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
 Inherited
Inserts the specified item before the cursor's current position.
IViewCursor
 Inherited
Moves the cursor to the next item within the collection.
IViewCursor
 Inherited
Moves the cursor to the previous item within the collection.
IViewCursor
 Inherited
Removes the current item and returns it.
IViewCursor
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
 Inherited
seek(bookmark:CursorBookmark, offset:int = 0, prefetch:int = 0):void
Moves the cursor to a location at an offset from the specified bookmark.
IViewCursor
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
IEventDispatcher
Property Detail

currentDepth

property
currentDepth:int  [read-only]

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

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