Package | mx.collections |
Interface | public interface IList extends IEventDispatcher |
Implémenteurs | ArrayList, AsyncListView, ListCollectionView, NumericDataProvider |
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Une interface IList
peut être une vue contenant des données extraites à partir d’un emplacement distant. Lorsque vous écrivez une collection susceptible d’être distante, vous devez envisager les situations où les données ne sont pas encore disponibles, signalées par l’erreur ItemPendingError
.
L’interface ICollectionView
constitue une alternative à l’interface IList
.
Eléments de l’API associés
mx.collections.ICollectionView
mx.collections.ListCollectionView
Propriété | Défini par | ||
---|---|---|---|
length : int [lecture seule]
Nombre d’éléments dans cette collection. | IList |
Méthode | Défini par | ||
---|---|---|---|
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. | IEventDispatcher | ||
Ajoute l’élément spécifié à la fin de la liste. | IList | ||
Ajoute l’élément à l’index spécifié. | IList | ||
Distribue un événement dans le flux d’événements. | IEventDispatcher | ||
Obtient l’élément qui se trouve à l’index spécifié. | IList | ||
Renvoie l’index de l’élément s’il se trouve dans la liste, de sorte que getItemAt(index) == élément. | IList | ||
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | IEventDispatcher | ||
itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
Signale à la vue qu’un élément a été mis à jour. | IList | ||
Supprime tous les éléments de la liste. | IList | ||
Supprime un écouteur de l’objet EventDispatcher. | IEventDispatcher | ||
Supprime l’élément qui se trouve à l’index spécifié et le renvoie. | IList | ||
Place l’élément à l’index spécifié. | IList | ||
Renvoie un tableau rempli dans le même ordre en tant que qu’implémentation IList. | IList | ||
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é. | IEventDispatcher |
Evénement | Synthèse | Défini par | ||
---|---|---|---|---|
Distribué lorsque l’interface IList a été mise à jour. | IList |
length | propriété |
length: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 |
Nombre d’éléments dans cette collection. 0 signifie que la collection ne contient aucun élément. -1 signifie que la longueur de la collection est inconnue.
Implémentation
public function get length():int
addItem | () | méthode |
addItemAt | () | méthode |
public function addItemAt(item:Object, index:int):void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Ajoute l’élément à l’index spécifié. L’index de tout élément supérieur à l’index de l’élément ajouté est augmenté d’une unité. Si l’index spécifié est inférieur à zéro ou supérieur à la longueur de la liste, une erreur RangeError est renvoyée.
Paramètres
item:Object — Elément à placer à l’index.
| |
index:int — Index auquel placer l’élément.
|
Valeur émise
RangeError — Erreur renvoyée lorsque l’index est inférieur à 0 ou supérieur à la longueur de la liste.
|
getItemAt | () | méthode |
public function getItemAt(index:int, prefetch:int = 0):Object
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Obtient l’élément qui se trouve à l’index spécifié.
Paramètres
index:int — Index de la liste à partir duquel extraire l’élément.
| |
prefetch:int (default = 0 ) — Valeur int indiquant le nombre d’éléments à récupérer au cours de la demande si l’élément n’est pas local, ainsi que leur direction.
|
Object — Elément qui se trouve à cet index ou null si aucun élément n’est retrouvé.
|
Valeur émise
ItemPendingError — Erreur renvoyée lorsque les données de cet index doivent être chargées à partir d’un emplacement distant.
| |
RangeError — Erreur renvoyée lorsque index < 0 ou index >= length .
|
getItemIndex | () | méthode |
public function getItemIndex(item:Object):int
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Renvoie l’index de l’élément s’il se trouve dans la liste, de sorte que getItemAt(index) == élément.
Remarque : contrairement aux méthodes IViewCursor.findxxx()
, la méthode getItemIndex()
n’accepte pas les paramètres contenant uniquement un sous-ensemble des champs de l’élément recherché. Cette méthode recherche toujours un élément qui correspond exactement au paramètre d’entrée.
Paramètres
item:Object — Elément à retrouver.
|
int — Index de l’élément ou -1 s’il ne se trouve pas dans la liste.
|
itemUpdated | () | méthode |
public function itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Signale à la vue qu’un élément a été mis à jour. Cette méthode est utile lorsque le contenu de la vue n’implémente pas l’interface IEventDispatcher
et distribue un événement PropertyChangeEvent
. Si une propriété est spécifiée, il est possible que la vue puisse optimiser son mécanisme de notification. Dans le cas contraire, elle peut simplement choisir d’actualiser l’ensemble de la vue.
Paramètres
item:Object — Elément mis à jour dans la vue.
| |
property:Object (default = null ) — Nom de la propriété mise à jour.
| |
oldValue:Object (default = null ) — Ancienne valeur de cette propriété (si la valeur de la propriété était null, il peut s’agir de l’ancienne valeur de l’élément).
| |
newValue:Object (default = null ) — Nouvelle valeur de cette propriété (si la valeur de la propriété était null, il n’est pas nécessaire de la spécifier, car l’élément est supposé correspondre à la nouvelle valeur).
|
Eléments de l’API associés
removeAll | () | méthode |
public function removeAll():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Supprime tous les éléments de la liste.
Si un é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.
removeItemAt | () | méthode |
public function removeItemAt(index:int):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 qui se trouve à l’index spécifié et le renvoie. Tous les éléments qui se trouvent après cet index se trouvent désormais avancés d’un index.
Paramètres
index:int — Index auquel l’élément doit être supprimé.
|
Object — Elément qui a été supprimé.
|
Valeur émise
RangeError — Erreur renvoyée lorsque l’index est inférieur à 0 ou supérieur à la longueur.
|
setItemAt | () | méthode |
public function setItemAt(item:Object, index:int):Object
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Place l’élément à l’index spécifié. Si un élément se trouvait déjà à cet index, le nouvel élément le remplace et il est renvoyé.
Paramètres
item:Object — Nouvel élément à placer à l’index spécifié.
| |
index:int — Index auquel placer l’élément.
|
Object — Elément remplacé ou null si aucun élément n’a été remplacé.
|
Valeur émise
RangeError — Erreur renvoyée lorsque l’index est inférieur à 0 ou supérieur à la longueur.
|
toArray | () | méthode |
public function toArray():Array
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Renvoie un tableau rempli dans le même ordre en tant que qu’implémentation IList. Cette méthode peut renvoyer une erreur ItemPendingError.
Valeur renvoyéeArray — Tableau.
|
Valeur émise
ItemPendingError — Erreur renvoyée lorsque les données n’ont pas encore été entièrement chargées à partir d’un emplacement distant.
|
collectionChange | Evénement |
mx.events.CollectionEvent
propriété CollectionEvent.type =
mx.events.CollectionEvent.COLLECTION_CHANGE
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Distribué lorsque l’interface IList a été mise à jour.
La constante CollectionEvent.COLLECTION_CHANGE définit la valeur de la propriététype
de l’objet d’événement d’un événement distribué lorsqu’une collection a changé.
Les valeurs des propriétés de l’objet d’événement sont les suivantes : Toutes les propriétés ne sont pas pertinentes pour chaque catégorie d’événements. Pour plus d’informations, voir les descriptions détaillées des propriétés.
Propriété | Valeur |
---|---|
bubbles | false |
cancelable | false |
currentTarget | Objet définissant l’écouteur d’événement qui traite l’événement. Par exemple, si vous utilisez myButton.addEventListener() pour enregistrer un écouteur d’événement, myButton est la valeur de currentTarget . |
items | Tableau d’objets contenant des informations sur les éléments affectés par l’événement. Le contenu de ce champ dépend du type d’événement. Pour plus d’informations, voir la propriété items . |
kind | Type d’événement. Les valeurs possibles sont définies dans la classe CollectionEventKind sous forme de constantes. |
location | Emplacement dans la collection cible du ou des éléments spécifiés dans la propriété items . |
oldLocation | Ancien emplacement dans la collection de l’élément spécifié dans la propriété items . |
target | Objet qui a distribué l’événement (il ne s’agit pas toujours de l’objet qui écoute l’événement). Pour accéder systématiquement à l’objet qui écoute l’événement, utilisez la propriété currentTarget . |
type | CollectionEvent.COLLECTION_CHANGE |
Tue Jun 12 2018, 09:30 AM Z