Packagemx.collections
Classpublic class CursorBookmark

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

See also

mx.collections.IViewCursor.bookmark
mx.collections.IViewCursor.seek()


Public Properties
 PropertyDefined by
  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
  value : Object
[read-only] The underlying marker representation of the bookmark.
CursorBookmark
Public Methods
 MethodDefined by
  
CursorBookmark(value:Object)
Creates a new instance of a bookmark with the specified value.
CursorBookmark
  
Gets the approximate index of the item represented by this bookmark in its view.
CursorBookmark
Property detail
CURRENTproperty
CURRENT:CursorBookmark  [read-only]

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

Implementation
    public static function get CURRENT():CursorBookmark
FIRSTproperty 
FIRST:CursorBookmark  [read-only]

A bookmark for the first item in an ICollectionView.

Implementation
    public static function get FIRST():CursorBookmark
LASTproperty 
LAST:CursorBookmark  [read-only]

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
valueproperty 
value:Object  [read-only]

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)

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

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.