IHierarchicalCollectionViewCursor - Adobe ActionScript® 3 (AS3 Flex) API Reference

Package	mx.collections
Interface	public 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.

Related API Elements

mx.collections.IViewCursor
mx.controls.IHierarchicalCollectionView

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		afterLast : Boolean [read-only] If the cursor is located after the last item in the view, this property is true .	IViewCursor
		beforeFirst : Boolean [read-only] If the cursor is located before the first item in the view, this property is true.	IViewCursor
		bookmark : CursorBookmark [read-only] Provides access to a bookmark that corresponds to the item returned by the current property.	IViewCursor
		current : 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
		view : ICollectionView [read-only] A reference to the ICollectionView with which this cursor is associated.	IViewCursor

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		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
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	IEventDispatcher
		findAny(values:Object):Boolean Finds an item with the specified properties within the collection and positions the cursor to that item.	IViewCursor
		findFirst(values:Object):Boolean Finds the first item with the specified properties within the collection and positions the cursor to that item.	IViewCursor
		findLast(values:Object):Boolean Finds the last item with the specified properties within the collection and positions the cursor on that item.	IViewCursor
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	IEventDispatcher
		insert(item:Object):void Inserts the specified item before the cursor's current position.	IViewCursor
		moveNext():Boolean Moves the cursor to the next item within the collection.	IViewCursor
		movePrevious():Boolean Moves the cursor to the previous item within the collection.	IViewCursor
		remove():Object Removes the current item and returns it.	IViewCursor
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	IEventDispatcher
		seek(bookmark:CursorBookmark, offset:int = 0, prefetch:int = 0):void Moves the cursor to a location at an offset from the specified bookmark.	IViewCursor
		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.	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

IHierarchicalCollectionViewCursor - AS3 Flex

Classes x

currentDepth

mx.collections IHierarchicalCollectionViewCursor - AS3 Flex		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples