| Pacchetto | mx.collections |
| Classe | public class HierarchicalCollectionViewCursor |
| Ereditarietà | HierarchicalCollectionViewCursor  EventDispatcher Object |
| Implementa | IHierarchicalCollectionViewCursor |
| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Elementi API correlati
Nascondi proprietà pubbliche ereditate
Mostra proprietà pubbliche ereditate| Proprietà | Definito da | ||
|---|---|---|---|
| afterLast : Boolean [sola lettura]
If the cursor is located after the last item in the view,
this property is true . | HierarchicalCollectionViewCursor | ||
| beforeFirst : Boolean [sola lettura]
If the cursor is located before the first item in the view,
this property is true. | HierarchicalCollectionViewCursor | ||
| bookmark : CursorBookmark [sola lettura]
Provides access to a bookmark that corresponds to the item
returned by the current property. | HierarchicalCollectionViewCursor | ||
 | constructor : Object
Un riferimento all'oggetto classe o alla funzione di costruzione per una determinata istanza di oggetto. | Object | |
| current : Object [sola lettura]
Provides access the object at the location
in the source collection referenced by this cursor. | HierarchicalCollectionViewCursor | ||
| currentDepth : int [sola lettura]
Contains the depth of the node at the location
in the source collection referenced by this cursor. | HierarchicalCollectionViewCursor | ||
| view : ICollectionView [sola lettura]
A reference to the ICollectionView with which this cursor is associated. | HierarchicalCollectionViewCursor | ||
| Metodo | Definito da | ||
|---|---|---|---|
HierarchicalCollectionViewCursor(collection:HierarchicalCollectionView, model:ICollectionView, hierarchicalData:IHierarchicalData)
Constructor. | HierarchicalCollectionViewCursor | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registra un oggetto listener di eventi con un oggetto EventDispatcher, in modo che il listener riceva la notifica di un evento. | EventDispatcher | |
|
Invia un evento nel flusso di eventi. | EventDispatcher | |
Finds an item with the specified properties within the collection
and positions the cursor to that item. | HierarchicalCollectionViewCursor | ||
Finds the first item with the specified properties within the collection
and positions the cursor to that item. | HierarchicalCollectionViewCursor | ||
Finds the last item with the specified properties within the collection
and positions the cursor on that item. | HierarchicalCollectionViewCursor | ||
|
Verifica se per l'oggetto EventDispatcher sono presenti listener registrati per un tipo specifico di evento. | EventDispatcher | |
|
Indica se per un oggetto è definita una proprietà specifica. | Object | |
Inserts the specified item before the cursor's current position. | HierarchicalCollectionViewCursor | ||
|
Indica se un'istanza della classe Object si trova nella catena di prototipi dell'oggetto specificato come parametro. | Object | |
Moves the cursor to the next item within the collection. | HierarchicalCollectionViewCursor | ||
Moves the cursor to the previous item within the collection. | HierarchicalCollectionViewCursor | ||
|
Indica se la proprietà specificata esiste ed è enumerabile. | Object | |
Removes the current item and returns it. | HierarchicalCollectionViewCursor | ||
|
Rimuove un listener dall'oggetto EventDispatcher. | EventDispatcher | |
Moves the cursor to a location at an offset from the specified
bookmark. | HierarchicalCollectionViewCursor | ||
|
Imposta la disponibilità di una proprietà dinamica per le operazioni cicliche. | Object | |
|
Restituisce la rappresentazione in formato stringa di questo oggetto, formattato in base alle convenzioni specifiche per le versioni localizzate. | Object | |
|
Restituisce la rappresentazione in formato stringa dell'oggetto specificato. | Object | |
|
Restituisce il valore di base dell'oggetto specificato. | Object | |
|
Verifica se un listener di eventi è registrato con questo oggetto EventDispatcher o qualsiasi suo antenato per il tipo di evento specificato. | EventDispatcher | |
afterLast | proprietà |
afterLast:Boolean [sola lettura] | Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | 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.
Implementazione
public function get afterLast():BooleanbeforeFirst | proprietà |
beforeFirst:Boolean [sola lettura] | Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | 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.
Implementazione
public function get beforeFirst():Booleanbookmark | proprietà |
bookmark:CursorBookmark [sola lettura] | Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | 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.)
Implementazione
public function get bookmark():CursorBookmarkcurrent | proprietà |
current:Object [sola lettura] | Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | 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.
Implementazione
public function get current():ObjectcurrentDepth | proprietà |
currentDepth:int [sola lettura] | Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | 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.
Implementazione
public function get currentDepth():intview | proprietà |
view:ICollectionView [sola lettura] | Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
A reference to the ICollectionView with which this cursor is associated.
Implementazione
public function get view():ICollectionViewHierarchicalCollectionViewCursor | () | Funzione di costruzione |
public function HierarchicalCollectionViewCursor(collection:HierarchicalCollectionView, model:ICollectionView, hierarchicalData:IHierarchicalData)| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | Flash Player 9, AIR 1.1 |
Constructor.
Parametricollection:HierarchicalCollectionView — The HierarchicalCollectionView instance referenced by this cursor.
| |
model:ICollectionView — The source data collection.
| |
hierarchicalData:IHierarchicalData — The data used to create the HierarchicalCollectionView instance.
|
findAny | () | metodo |
public function findAny(values:Object):Boolean| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | 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.
Parametri
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.
|
findFirst | () | metodo |
public function findFirst(values:Object):Boolean| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | 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.
Parametri
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.
|
findLast | () | metodo |
public function findLast(values:Object):Boolean| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | 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.
Parametri
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.
|
insert | () | metodo |
public function insert(item:Object):void| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | 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.
Parametri
item:Object — The item to insert before the cursor's current position.
|
moveNext | () | metodo |
public function moveNext():Boolean| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | 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.
RestituisceBoolean — true if still in the list,
false if the current value initially was
or now is afterLast.
|
movePrevious | () | metodo |
public function movePrevious():Boolean| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | 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.
RestituisceBoolean — 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();
}
|
remove | () | metodo |
public function remove():Object| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | 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.
RestituisceObject — The item that was removed.
|
seek | () | metodo |
public function seek(bookmark:CursorBookmark, offset:int = 0, prefetch:int = 0):void| Versione linguaggio: | ActionScript 3.0 |
| Versione prodotto: | Flex 3 |
| Versioni runtime: | 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.
Parametri
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) |
Tue Jun 12 2018, 02:44 PM Z