mx.collections.CursorBookmark - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.collections
Class	public class CursorBookmark
Inheritance	CursorBookmark Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Encapsulates the positional aspects of a cursor in an ICollectionView. Bookmarks are used to return a cursor to an absolute position within the ICollectionView.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		CURRENT : CursorBookmark [static] [read-only] A bookmark representing the current item for the IViewCursor in an ICollectionView.	CursorBookmark
		FIRST : CursorBookmark [static] [read-only] A bookmark for the first item in an ICollectionView.	CursorBookmark
		LAST : CursorBookmark [static] [read-only] A bookmark for the last item in an ICollectionView.	CursorBookmark
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		value : Object [read-only] The underlying marker representation of the bookmark.	CursorBookmark

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		CursorBookmark(value:Object) Creates a new instance of a bookmark with the specified value.	CursorBookmark
		getViewIndex():int Gets the approximate index of the item represented by this bookmark in its view.	CursorBookmark
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Property Detail

CURRENT

property

CURRENT:CursorBookmark [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

A bookmark representing the current item for the IViewCursor in an ICollectionView.

Implementation
public static function get CURRENT():CursorBookmark

FIRST

property

FIRST:CursorBookmark [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

A bookmark for the first item in an ICollectionView.

Implementation
public static function get FIRST():CursorBookmark

LAST

property

LAST:CursorBookmark [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

A bookmark for the last item in an ICollectionView. If the view has no items, the cursor is at this bookmark.

Implementation
public static function get LAST():CursorBookmark

value

property

value:Object [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The underlying marker representation of the bookmark. This value is generally understood only by the IViewCursor or ICollectionView implementation.

Implementation
public function get value():Object

Constructor Detail

CursorBookmark

()

Constructor

public function CursorBookmark(value:Object)

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Creates a new instance of a bookmark with the specified value.

Parameters

value:Object — The value of this bookmark.

Method Detail

getViewIndex

()

method

public function getViewIndex():int

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Gets the approximate index of the item represented by this bookmark in its view. If the item has been paged out, this method could throw an ItemPendingError.

Returns

int — The index of the item. If the item is not in the current view, this method returns -1. This method also returns -1 if index-based location is not possible.