| Package | mx.collections |
| Classe | public class HierarchicalCollectionViewCursor |
| Héritage | HierarchicalCollectionViewCursor  EventDispatcher Object |
| Implémente | IHierarchicalCollectionViewCursor |
| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Eléments de l’API associés
Masquer les propriétés publiques héritées
Afficher les propriétés publiques héritées| Propriété | Défini par | ||
|---|---|---|---|
| afterLast : Boolean [lecture seule]
Si le curseur se trouve après le dernier élément de la vue, la valeur de cette propriété est true. | HierarchicalCollectionViewCursor | ||
| beforeFirst : Boolean [lecture seule]
Si le curseur se trouve avant le premier élément de la vue, la valeur de cette propriété est true. | HierarchicalCollectionViewCursor | ||
| bookmark : CursorBookmark [lecture seule]
Permet d’accéder à un signet correspondant à l’élément renvoyé par la propriété current. | HierarchicalCollectionViewCursor | ||
 | constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | |
| current : Object [lecture seule]
Permet d’accéder à l’objet qui se trouve à l’emplacement référencé par le curseur dans la collection source. | HierarchicalCollectionViewCursor | ||
| currentDepth : int [lecture seule]
Contient la profondeur du nœud à l’emplacement référencé par le curseur dans la collection source. | HierarchicalCollectionViewCursor | ||
| view : ICollectionView [lecture seule]
Référence à l’interface ICollectionView à laquelle ce curseur est associé. | HierarchicalCollectionViewCursor | ||
| Méthode | Défini par | ||
|---|---|---|---|
HierarchicalCollectionViewCursor(collection:HierarchicalCollectionView, model:ICollectionView, hierarchicalData:IHierarchicalData)
Constructeur. | HierarchicalCollectionViewCursor | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement. | EventDispatcher | |
|
Distribue un événement dans le flux d’événements. | EventDispatcher | |
Retrouve dans la collection un élément correspondant aux propriétés spécifiées et place le curseur sur cet élément. | HierarchicalCollectionViewCursor | ||
Retrouve dans la collection le premier élément correspondant aux propriétés spécifiées et place le curseur sur cet élément. | HierarchicalCollectionViewCursor | ||
Retrouve dans la collection le dernier élément correspondant aux propriétés spécifiées et place le curseur sur cet élément. | HierarchicalCollectionViewCursor | ||
|
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | EventDispatcher | |
|
Indique si la propriété spécifiée d’un objet est définie. | Object | |
Insère l’élément spécifié avant la position actuelle du curseur. | HierarchicalCollectionViewCursor | ||
|
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre. | Object | |
Déplace le curseur sur l’élément suivant dans la collection. | HierarchicalCollectionViewCursor | ||
Déplace le curseur sur l’élément précédent dans la collection. | HierarchicalCollectionViewCursor | ||
|
Indique si la propriété spécifiée existe et est énumérable. | Object | |
Supprime l’élément actuel et le renvoie. | HierarchicalCollectionViewCursor | ||
|
Supprime un écouteur de l’objet EventDispatcher. | EventDispatcher | |
Déplace le curseur sur une position décalée par rapport au signet spécifié. | HierarchicalCollectionViewCursor | ||
|
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | |
|
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | |
|
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | |
|
Renvoie la valeur primitive de l’objet spécifié. | Object | |
|
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié. | EventDispatcher | |
afterLast | propriété |
afterLast:Boolean [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Si le curseur se trouve après le dernier élément de la vue, la valeur de cette propriété est true. Si l’interface ICollectionView est vide (longueur == 0), la valeur de cette propriété est true.
Implémentation
public function get afterLast():BooleanbeforeFirst | propriété |
beforeFirst:Boolean [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Si le curseur se trouve avant le premier élément de la vue, la valeur de cette propriété est true. Si l’interface ICollectionView est vide (longueur == 0), la valeur de cette propriété est true.
Implémentation
public function get beforeFirst():Booleanbookmark | propriété |
bookmark:CursorBookmark [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Permet d’accéder à un signet correspondant à l’élément renvoyé par la propriété current. Le signet peut être utilisé pour déplacer le curseur sur un élément précédemment visité ou sur une position relative à cet élément (pour plus d’informations, voir la méthode seek()).
Implémentation
public function get bookmark():CursorBookmarkcurrent | propriété |
current:Object [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Permet d’accéder à l’objet qui se trouve à l’emplacement référencé par le curseur dans la collection source. Si le curseur est au-delà des limites de la collection (en position beforeFirst ou afterLast), la valeur renvoyée est null.
Implémentation
public function get current():ObjectcurrentDepth | propriété |
currentDepth:int [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Contient la profondeur du nœud à l’emplacement référencé par le curseur dans la collection source. Si le curseur est au-delà des limites de la collection, cette propriété contient la valeur 0.
Implémentation
public function get currentDepth():intview | propriété |
view:ICollectionView [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Référence à l’interface ICollectionView à laquelle ce curseur est associé.
Implémentation
public function get view():ICollectionViewHierarchicalCollectionViewCursor | () | Constructeur |
public function HierarchicalCollectionViewCursor(collection:HierarchicalCollectionView, model:ICollectionView, hierarchicalData:IHierarchicalData)| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Constructeur.
Paramètrescollection:HierarchicalCollectionView — Instance HierarchicalCollectionView à laquelle ce curseur fait référence.
| |
model:ICollectionView — Collection de données source.
| |
hierarchicalData:IHierarchicalData — Données utilisées pour créer l’instance HierarchicalCollectionView.
|
findAny | () | méthode |
public function findAny(values:Object):Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Retrouve dans la collection un élément correspondant aux propriétés spécifiées et place le curseur sur cet élément. Si l’élément est introuvable, l’emplacement du curseur ne change pas.
La méthode findAny() peut uniquement être appelée sur des vues triées. Si la vue n’est pas triée, une erreur CursorError est renvoyée.
Si la collection associée est distante et que tous les éléments n’ont pas été mis en cache localement, cette méthode procède à une récupération asynchrone à partir de la collection distante. Si une demande de récupération est déjà en cours, cette méthode attend qu’elle soit terminée avant de procéder à une nouvelle demande de récupération.
Si plusieurs éléments correspondent aux critères de recherche, l’élément retrouvé est non déterministe. S’il s’avère indispensable de retrouver la première ou la dernière instance d’un élément dans un index non unique, utilisez la méthode findFirst() ou findLast().
Si les données ne sont pas locales et qu’une opération asynchrone doit être réalisée, une erreur ItemPendingError est renvoyée.
Paramètres
values:Object — Critères de recherche. Les valeurs de l’objet doivent être configurées comme paires nom-valeur, comme dans un tableau associatif, ou correspondre à l’objet réel à rechercher. Les valeurs des noms spécifiés doivent correspondre aux propriétés spécifiées dans le tri. Par exemple, si les propriétés x, y et z sont définies dans le tri actuel, les valeurs spécifiées doivent être {x: x-value, y: y-value, z: z-value}.
|
Boolean — Lorsque toutes les données sont locales, cette méthode renvoie true si l’élément est retrouvé, false dans le cas contraire.
|
findFirst | () | méthode |
public function findFirst(values:Object):Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Retrouve dans la collection le premier élément correspondant aux propriétés spécifiées et place le curseur sur cet élément. Si l’élément est introuvable, l’emplacement du curseur ne change pas.
La méthode findFirst() peut uniquement être appelée sur des vues triées. Si la vue n’est pas triée, une erreur CursorError est renvoyée.
Si la collection associée est distante et que tous les éléments n’ont pas été mis en cache localement, cette méthode procède à une récupération asynchrone à partir de la collection distante. Si une demande de récupération est déjà en cours, cette méthode attend qu’elle soit terminée avant de procéder à une nouvelle demande de récupération.
S’il n’est pas nécessaire de retrouver la première instance d’un élément dans un index non unique, utilisez la méthode findAny(), qui est parfois plus rapide que la méthode findFirst.
Si les données ne sont pas locales et qu’une opération asynchrone doit être réalisée, une erreur ItemPendingError est renvoyée.
Paramètres
values:Object — Critères de recherche. Les valeurs de l’objet doivent être configurées comme paires nom-valeur, comme dans un tableau associatif, ou correspondre à l’objet réel à rechercher. Les valeurs des noms spécifiés doivent correspondre aux propriétés spécifiées dans le tri. Par exemple, si les propriétés x, y et z sont définies dans le tri actuel, les valeurs spécifiées doivent être {x: x-value, y: y-value, z: z-value}.
|
Boolean — Lorsque toutes les données sont locales, cette méthode renvoie true si l’élément est retrouvé, false dans le cas contraire.
|
findLast | () | méthode |
public function findLast(values:Object):Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Retrouve dans la collection le dernier élément correspondant aux propriétés spécifiées et place le curseur sur cet élément. Si l’élément est introuvable, l’emplacement du curseur ne change pas.
La méthode findLast() peut uniquement être appelée sur des vues triées. Si la vue n’est pas triée, une erreur CursorError est renvoyée.
Si la collection associée est distante et que tous les éléments n’ont pas été mis en cache localement, cette méthode procède à une récupération asynchrone à partir de la collection distante. Si une demande de récupération est déjà en cours, cette méthode attend qu’elle soit terminée avant de procéder à une nouvelle demande de récupération.
S’il n’est pas indispensable de retrouver la dernière instance d’un élément dans un index non unique, utilisez la méthode findAny(), qui sera peut-être plus rapide.
Si les données ne sont pas locales et qu’une opération asynchrone doit être réalisée, une erreur ItemPendingError est renvoyée.
Paramètres
values:Object — Critères de recherche. Les valeurs de l’objet doivent être configurées comme paires nom-valeur, comme dans un tableau associatif, ou correspondre à l’objet réel à rechercher. Les valeurs des noms spécifiés doivent correspondre aux propriétés spécifiées dans le tri. Par exemple, si les propriétés x, y et z sont définies dans le tri actuel, les valeurs spécifiées doivent être {x: x-value, y: y-value, z: z-value}.
|
Boolean — Lorsque toutes les données sont locales, cette méthode renvoie true si l’élément est retrouvé, false dans le cas contraire.
|
insert | () | méthode |
public function insert(item:Object):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Insère l’élément spécifié avant la position actuelle du curseur. Si le curseur se trouve en position afterLast, l’insertion est réalisée à la fin de la vue. Si le curseur se trouve en position beforeFirst dans une vue non vide, une erreur est renvoyée.
Paramètres
item:Object — Elément à insérer avant la position actuelle du curseur.
|
moveNext | () | méthode |
public function moveNext():Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Déplace le curseur sur l’élément suivant dans la collection. Si l’opération aboutit, la propriété current est mise à jour de manière à faire référence à l’objet, à son nouvel emplacement. Renvoie true si la propriété current résultante est valide ou false dans le cas contraire (la valeur de la propriété est afterLast).
Si les données ne sont pas locales et qu’une opération asynchrone doit être réalisée, une erreur ItemPendingError est renvoyée. Pour plus d’informations sur l’utilisation de la classe ItemPendingError, voir la documentation relative à ItemPendingError et aux collections.
Valeur renvoyéeBoolean — true si la valeur est toujours dans la liste, false si la valeur de la propriété current était initialement afterLast ou si elle a depuis pris cette valeur.
|
movePrevious | () | méthode |
public function movePrevious():Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Déplace le curseur sur l’élément précédent dans la collection. Si l’opération aboutit, la propriété current est mise à jour de manière à faire référence à l’objet, à son nouvel emplacement. Renvoie true si la propriété current résultante est valide ou false dans le cas contraire (la valeur de la propriété est beforeFirst).
Si les données ne sont pas locales et qu’une opération asynchrone doit être réalisée, une erreur ItemPendingError est renvoyée. Pour plus d’informations sur l’utilisation de la classe ItemPendingError, voir la documentation relative à ItemPendingError et aux collections.
Valeur renvoyéeBoolean — true si la valeur est toujours dans la liste, false si la valeur de la propriété current était initialement beforeFirst ou si elle a depuis pris cette valeur. Par exemple :
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éthode |
public function remove():Object| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Supprime l’élément actuel et le renvoie. Si la position du curseur est beforeFirst ou afterLast, renvoie une erreur CursorError. Si vous supprimez un élément autre que le dernier élément, le curseur passe à l’élément suivant. Si vous supprimez le dernier élément, le curseur est placé au niveau du signet AFTER_LAST.
Si après la suppression de l’élément, l’élément n’est pas local et qu’une opération asynchrone doit être réalisée, une erreur ItemPendingError est renvoyée. Pour plus d’informations sur l’utilisation de la classe ItemPendingError, voir la documentation relative à ItemPendingError et aux collections.
Valeur renvoyéeObject — Elément qui a été supprimé.
|
seek | () | méthode |
public function seek(bookmark:CursorBookmark, offset:int = 0, prefetch:int = 0):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Déplace le curseur sur une position décalée par rapport au signet spécifié. Le décalage peut être négatif, auquel cas le curseur est placé devant le signet spécifié, la valeur offset désignant le nombre d’éléments entre le curseur et ce signet.
Si la collection associée est distante et que tous les éléments n’ont pas été mis en cache localement, cette méthode procède à une récupération asynchrone à partir de la collection distante.
Si les données ne sont pas locales et qu’une opération asynchrone doit être réalisée, une erreur ItemPendingError est renvoyée. Pour plus d’informations sur l’utilisation de la classe ItemPendingError, voir la documentation relative à ItemPendingError et aux collections.
Paramètres
bookmark:CursorBookmark — Référence CursorBookmark aux informations de marqueur permettant de replacer le curseur sur une position spécifique. Vous pouvez définir ce paramètre sur la valeur renvoyée par la propriété bookmark ou sur l’une des valeurs de constante de signet suivantes :
| |
offset:int (default = 0)beforeFirst ou afterLast.
| |
prefetch:int (default = 0) |
Tue Jun 12 2018, 09:30 AM Z