| Pakket | mx.collections |
| Interface | public interface IViewCursor extends IEventDispatcher |
| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
createCursor() method) the value of the
current property should be the first
item in the view, unless the view is empty.
| Eigenschap | Gedefinieerd door | ||
|---|---|---|---|
| afterLast : Boolean [alleen-lezen]
If the cursor is located after the last item in the view,
this property is true . | IViewCursor | ||
| beforeFirst : Boolean [alleen-lezen]
If the cursor is located before the first item in the view,
this property is true. | IViewCursor | ||
| bookmark : CursorBookmark [alleen-lezen]
Provides access to a bookmark that corresponds to the item
returned by the current property. | IViewCursor | ||
| current : Object [alleen-lezen]
Provides access the object at the location
in the source collection referenced by this cursor. | IViewCursor | ||
| view : ICollectionView [alleen-lezen]
A reference to the ICollectionView with which this cursor is associated. | IViewCursor | ||
Overerfde openbare methoden verbergen
Overerfde openbare methoden weergeven| Methode | Gedefinieerd door | ||
|---|---|---|---|
 | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registreert een gebeurtenislistenerobject bij een object EventDispatcher, zodat de listener een melding van een gebeurtenis ontvangt. | IEventDispatcher | |
|
Verzendt een gebeurtenis naar de gebeurtenisstroom. | IEventDispatcher | |
Finds an item with the specified properties within the collection
and positions the cursor to that item. | IViewCursor | ||
Finds the first item with the specified properties within the collection
and positions the cursor to that item. | IViewCursor | ||
Finds the last item with the specified properties within the collection
and positions the cursor on that item. | IViewCursor | ||
|
Controleert of het object EventDispatcher listeners heeft geregistreerd voor een specifiek type gebeurtenis. | IEventDispatcher | |
Inserts the specified item before the cursor's current position. | IViewCursor | ||
Moves the cursor to the next item within the collection. | IViewCursor | ||
Moves the cursor to the previous item within the collection. | IViewCursor | ||
Removes the current item and returns it. | IViewCursor | ||
|
Verwijdert een listener uit het object EventDispatcher. | IEventDispatcher | |
Moves the cursor to a location at an offset from the specified
bookmark. | IViewCursor | ||
|
Controleert of een gebeurtenislistener is geregistreerd bij dit object EventDispatcher of een van de voorouders voor het opgegeven type gebeurtenis. | IEventDispatcher | |
| Gebeurtenis | Overzicht | Gedefinieerd door | ||
|---|---|---|---|---|
| Dispatched whenever the cursor position is updated. | IViewCursor | |||
afterLast | eigenschap |
afterLast:Boolean [alleen-lezen] | Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
If the cursor is located after the last item in the view,
this property is true .
If the ICollectionView is empty (length == 0),
this property is true.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis cursorUpdate verzonden.
Implementatie
public function get afterLast():BooleanbeforeFirst | eigenschap |
beforeFirst:Boolean [alleen-lezen] | Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
If the cursor is located before the first item in the view,
this property is true.
If the ICollectionView is empty (length == 0),
this property is true.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis cursorUpdate verzonden.
Implementatie
public function get beforeFirst():Booleanbookmark | eigenschap |
bookmark:CursorBookmark [alleen-lezen] | Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Provides access to a bookmark that corresponds to the item
returned by the current property.
The bookmark can be used to move the cursor
to a previously visited item, or to a position relative to that item.
(See the seek() method for more information.)
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis cursorUpdate verzonden.
Implementatie
public function get bookmark():CursorBookmarkVerwante API-elementen
current | eigenschap |
current:Object [alleen-lezen] | Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Provides access the object at the location
in the source collection referenced by this cursor.
If the cursor is beyond the ends of the collection
(beforeFirst, afterLast)
this will return null.
Deze eigenschap kan als de bron voor gegevensbinding worden gebruikt. Wanneer deze eigenschap wordt gewijzigd, wordt de gebeurtenis cursorUpdate verzonden.
Implementatie
public function get current():ObjectVerwante API-elementen
view | eigenschap |
view:ICollectionView [alleen-lezen] | Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
A reference to the ICollectionView with which this cursor is associated.
Implementatie
public function get view():ICollectionViewfindAny | () | methode |
public function findAny(values:Object):Boolean| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Finds an item with the specified properties within the collection and positions the cursor to that item. If the item can not be found, the cursor location does not change.
The findAny() method can only be called on sorted views;
if the view isn't sorted, a CursorError is thrown.
If the associated collection is remote, and not all of the items have been cached locally, this method begins an asynchronous fetch from the remote collection. If one is already in progress, this method waits for it to complete before making another fetch request.
If multiple items can match the search criteria then the item found
is non-deterministic.
If it is important to find the first or last occurrence of an item
in a non-unique index, use the findFirst() or
findLast() method.
If the data is not local and an asynchronous operation must be performed, an ItemPendingError is thrown.
Parameters
values:Object — The search criteria. The values in the Object must be configured as name-value pairs,
as in an associative array (or be the actual object to search for). The values of the names specified must match properties
specified in the sort. For example, if properties x, y, and
z are in the current sort, the values specified should be
{x: x-value, y: y-value, z: z-value}.
|
Boolean — When all of the data is local this method returns
true if the item can be found and false
otherwise.
|
Verwante API-elementen
findFirst | () | methode |
public function findFirst(values:Object):Boolean| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Finds the first item with the specified properties within the collection and positions the cursor to that item. If the item can not be found, no cursor location does not change.
The findFirst() method can only be called on sorted views;
if the view isn't sorted, a CursorError is thrown.
If the associated collection is remote, and not all of the items have been cached locally, this method begins an asynchronous fetch from the remote collection. If one is already in progress, this method waits for it to complete before making another fetch request.
If it is not important to find the first occurrence of an item
in a non-unique index, use findAny(), which may be
a little faster than the findFirst() method.
If the data is not local and an asynchronous operation must be performed, an ItemPendingError is thrown.
Parameters
values:Object — The search criteria. The values in the Object must be configured as name-value pairs,
as in an associative array (or be the actual object to search for). The values of the names specified must match properties
specified in the sort. For example, if properties x, y, and
z are in the current sort, the values specified should be
{x: x-value, y: y-value, z: z-value}.
|
Boolean — When all of the data is local this method returns
true if the item can be found and false
otherwise.
|
Verwante API-elementen
findLast | () | methode |
public function findLast(values:Object):Boolean| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Finds the last item with the specified properties within the collection and positions the cursor on that item. If the item can not be found, the cursor location does not chanage.
The findLast() method can only be called on sorted views;
if the view isn't sorted, a CursorError is thrown.
If the associated collection is remote, and not all of the items have been cached locally, this method begins an asynchronous fetch from the remote collection. If one is already in progress, this method waits for it to complete before making another fetch request.
If it is not important to find the last occurrence of an item
in a non-unique index, use the findAny() method, which
may be a little faster.
If the data is not local and an asynchronous operation must be performed, an ItemPendingError is thrown.
Parameters
values:Object — The search criteria. The values in the Object must be configured as name-value pairs,
as in an associative array (or be the actual object to search for). The values of the names specified must match properties
specified in the sort. For example, if properties x, y, and
z are in the current sort, the values specified should be
{x: x-value, y: y-value, z: z-value}.
|
Boolean — When all of the data is local this method returns
true if the item can be found and false
otherwise.
|
Verwante API-elementen
insert | () | methode |
public function insert(item:Object):void| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Inserts the specified item before the cursor's current position.
If the cursor is afterLast,
the insertion occurs at the end of the view.
If the cursor is beforeFirst on a non-empty view,
an error is thrown.
Parameters
item:Object — The item to insert before the cursor's current position.
|
moveNext | () | methode |
public function moveNext():Boolean| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Moves the cursor to the next item within the collection.
On success the current property is updated
to reference the object at this new location.
Returns true if the resulting current
property is valid, or false if not
(the property value is afterLast).
If the data is not local and an asynchronous operation must be performed, an ItemPendingError is thrown. See the ItemPendingError documentation and the collections documentation for more information on using the ItemPendingError.
Geretourneerde waardeBoolean — true if still in the list,
false if the current value initially was
or now is afterLast.
|
Verwante API-elementen
Voorbeeld
Hoe dit voorbeeld te gebruiken
var myArrayCollection:ICollectionView = new ArrayCollection([ "Bobby", "Mark", "Trevor", "Jacey", "Tyler" ]);
var cursor:IViewCursor = myArrayCollection.createCursor();
while (!cursor.afterLast)
{
trace(cursor.current);
cursor.moveNext();
}
movePrevious | () | methode |
public function movePrevious():Boolean| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Moves the cursor to the previous item within the collection.
On success the current property is updated
to reference the object at this new location.
Returns true if the resulting current
property is valid, or false if not
(the property value is beforeFirst).
If the data is not local and an asynchronous operation must be performed, an ItemPendingError is thrown. See the ItemPendingError documentation and the collections documentation for more information on using the ItemPendingError.
Geretourneerde waardeBoolean — true if still in the list,
false if the current value initially was or
now is beforeFirst.
For example:
var myArrayCollection:ICollectionView = new ArrayCollection([ "Bobby", "Mark", "Trevor", "Jacey", "Tyler" ]);
var cursor:IViewCursor = myArrayCollection.createCursor();
cursor.seek(CursorBookmark.last);
while (!cursor.beforeFirst)
{
trace(current);
cursor.movePrevious();
}
|
Verwante API-elementen
remove | () | methode |
public function remove():Object| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Removes the current item and returns it.
If the cursor location is beforeFirst or
afterLast, throws a CursorError.
If you remove any item other than the last item,
the cursor moves to the next item. If you remove the last item, the
cursor is at the AFTER_LAST bookmark.
If the item after the removed item is not local and an asynchronous operation must be performed, an ItemPendingError is thrown. See the ItemPendingError documentation and the collections documentation for more information on using the ItemPendingError.
Geretourneerde waardeObject — The item that was removed.
|
Verwante API-elementen
seek | () | methode |
public function seek(bookmark:CursorBookmark, offset:int = 0, prefetch:int = 0):void| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Moves the cursor to a location at an offset from the specified
bookmark.
The offset can be negative, in which case the cursor is positioned
an offset number of items prior to the specified bookmark.
If the associated collection is remote, and not all of the items have been cached locally, this method begins an asynchronous fetch from the remote collection.
If the data is not local and an asynchronous operation must be performed, an ItemPendingError is thrown. See the ItemPendingError documentation and the collections documentation for more information on using the ItemPendingError.
Parameters
bookmark:CursorBookmark — CursorBookmark reference to marker
information that allows repositioning to a specific location.
You can set this parameter to value returned from the
bookmark property, or to one of the following constant
bookmark values:
| |
offset:int (default = 0)beforeFirst or afterLast location.
| |
prefetch:int (default = 0) |
Verwante API-elementen
cursorUpdate | Gebeurtenis |
mx.events.FlexEventeigenschap FlexEvent.type =
mx.events.FlexEvent.CURSOR_UPDATE| Taalversie: | ActionScript 3.0 |
| Productversie: | Flex 3 |
| Runtimeversies: | Flash Player 9, AIR 1.1 |
Dispatched whenever the cursor position is updated.
TheFlexEvent.CURSOR_UPDATE constant defines the value of the
type property of the event object for a cursorUpdate event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
Wed Jun 13 2018, 11:42 AM Z