| Pacote | mx.collections |
| Classe | public class HierarchicalCollectionViewCursor |
| Herança | HierarchicalCollectionViewCursor  EventDispatcher Object |
| Implementações | IHierarchicalCollectionViewCursor |
| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Elementos da API relacionados
Ocultar propriedades públicas herdadas
Mostrar propriedades públicas herdadas| Propriedade | Definido por | ||
|---|---|---|---|
| afterLast : Boolean [somente leitura]
If the cursor is located after the last item in the view,
this property is true . | HierarchicalCollectionViewCursor | ||
| beforeFirst : Boolean [somente leitura]
If the cursor is located before the first item in the view,
this property is true. | HierarchicalCollectionViewCursor | ||
| bookmark : CursorBookmark [somente leitura]
Provides access to a bookmark that corresponds to the item
returned by the current property. | HierarchicalCollectionViewCursor | ||
 | constructor : Object
Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto. | Object | |
| current : Object [somente leitura]
Provides access the object at the location
in the source collection referenced by this cursor. | HierarchicalCollectionViewCursor | ||
| currentDepth : int [somente leitura]
Contains the depth of the node at the location
in the source collection referenced by this cursor. | HierarchicalCollectionViewCursor | ||
| view : ICollectionView [somente leitura]
A reference to the ICollectionView with which this cursor is associated. | HierarchicalCollectionViewCursor | ||
| Método | Definido por | ||
|---|---|---|---|
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 um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento. | EventDispatcher | |
|
Envia um evento para o fluxo de eventos. | 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 o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento. | EventDispatcher | |
|
Indica se um objeto tem uma propriedade especificada definida. | Object | |
Inserts the specified item before the cursor's current position. | HierarchicalCollectionViewCursor | ||
|
Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro. | 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 a propriedade especificada existe e é enumerável. | Object | |
Removes the current item and returns it. | HierarchicalCollectionViewCursor | ||
|
Remove um ouvinte do objeto EventDispatcher. | EventDispatcher | |
Moves the cursor to a location at an offset from the specified
bookmark. | HierarchicalCollectionViewCursor | ||
|
Define a disponibilidade de uma propriedade dinâmica para operações de repetição. | Object | |
|
Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade. | Object | |
|
Retorna a representação de string do objeto especificado. | Object | |
|
Retorna o valor primitivo do objeto especificado. | Object | |
|
Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado. | EventDispatcher | |
afterLast | propriedade |
afterLast:Boolean [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de 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.
Implementação
public function get afterLast():BooleanbeforeFirst | propriedade |
beforeFirst:Boolean [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de 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.
Implementação
public function get beforeFirst():Booleanbookmark | propriedade |
bookmark:CursorBookmark [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de 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.)
Implementação
public function get bookmark():CursorBookmarkcurrent | propriedade |
current:Object [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de 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.
Implementação
public function get current():ObjectcurrentDepth | propriedade |
currentDepth:int [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de 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.
Implementação
public function get currentDepth():intview | propriedade |
view:ICollectionView [somente leitura] | Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
A reference to the ICollectionView with which this cursor is associated.
Implementação
public function get view():ICollectionViewHierarchicalCollectionViewCursor | () | Construtor |
public function HierarchicalCollectionViewCursor(collection:HierarchicalCollectionView, model:ICollectionView, hierarchicalData:IHierarchicalData)| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de runtime: | Flash Player 9, AIR 1.1 |
Constructor.
Parâmetroscollection: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 | () | método |
public function findAny(values:Object):Boolean| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de 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.
Parâmetros
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 | () | método |
public function findFirst(values:Object):Boolean| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de 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.
Parâmetros
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 | () | método |
public function findLast(values:Object):Boolean| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de 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.
Parâmetros
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 | () | método |
public function insert(item:Object):void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de 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.
Parâmetros
item:Object — The item to insert before the cursor's current position.
|
moveNext | () | método |
public function moveNext():Boolean| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de 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.
RetornaBoolean — true if still in the list,
false if the current value initially was
or now is afterLast.
|
movePrevious | () | método |
public function movePrevious():Boolean| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de 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.
RetornaBoolean — 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 | () | método |
public function remove():Object| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de 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.
RetornaObject — The item that was removed.
|
seek | () | método |
public function seek(bookmark:CursorBookmark, offset:int = 0, prefetch:int = 0):void| Versão da linguagem: | ActionScript 3.0 |
| Versão de produto: | Flex 3 |
| Versões de 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.
Parâmetros
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) |
Wed Jun 13 2018, 11:10 AM Z