Package | mx.collections |
Class | public class CursorBookmark |
ICollectionView
. Bookmarks are used to return a cursor to
an absolute position within the ICollectionView
.
See also
Property | Defined 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 |
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 |
CURRENT | property |
CURRENT:CursorBookmark
[read-only]
A bookmark representing the current item for the IViewCursor
in
an ICollectionView
.
public static function get CURRENT():CursorBookmark
FIRST | property |
FIRST:CursorBookmark
[read-only]
A bookmark for the first item in an ICollectionView
.
public static function get FIRST():CursorBookmark
LAST | property |
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.
public static function get LAST():CursorBookmark
value | property |
value:Object
[read-only]
The underlying marker representation of the bookmark.
This value is generally understood only by the IViewCursor
or ICollectionView
implementation.
public function get value():Object
CursorBookmark | () | constructor |
public function CursorBookmark(value:Object)
Creates a new instance of a bookmark with the specified value.
Parametersvalue:Object — The value of this bookmark.
|
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.
Returnsint — 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.
|