Packagemx.collections
Interfacepublic interface IHierarchicalCollectionViewCursor extends IViewCursor, flash.events.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
findAny(values:Object):Boolean
Finds an item with the specified properties within the collection and positions the cursor to that item.
IViewCursor
 Inherited
findFirst(values:Object):Boolean
Finds the first item with the specified properties within the collection and positions the cursor to that item.
IViewCursor
 Inherited
findLast(values:Object):Boolean
Finds the last item with the specified properties within the collection and positions the cursor on that item.
IViewCursor
 Inherited
insert(item:Object):void
Inserts the specified item before the cursor's current position.
IViewCursor
 Inherited
moveNext():Boolean
Moves the cursor to the next item within the collection.
IViewCursor
 Inherited
movePrevious():Boolean
Moves the cursor to the previous item within the collection.
IViewCursor
 Inherited
remove():Object
Removes the current item and returns it.
IViewCursor
 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
Property Detail
currentDepthproperty
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