| Package | mx.collections |
| Classe | public class AsyncListView |
| Héritage | AsyncListView  OnDemandEventDispatcher Object |
| Implémente | IList |
| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 4 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
méthode getItemAt(), méthode additem() et toArray().
La méthode getItemAt() gère les erreurs ItemPendingErrors en renvoyant un élément « en attente » provisoire jusqu’à ce que la demande sous-jacente aboutisse ou échoue. L’élément provisoire est produit par l’appel de la fonction spécifiée par la propriété createPendingItemFunction. Si la demande aboutit, l’élément réel remplace celui provisoire. Si elle échoue, l’élément provisoire est remplacé par l’élément renvoyé en appelant la fonction spécifiée par la propriété createFailedItemFunction.
Cette classe délègue les méthodes et les propriétés IList à sa list. Si aucune liste n’est spécifiée, les méthodes qui font muter la collection ne sont pas opératoires et les méthodes qui interrogent la collection renvoient une valeur vide comme null ou zéro, selon le cas.
Cette classe est conçue pour être utilisée avec les composants Spark basés sur la classe DataGroup, tels que List et ComboBox. Les classes Spark ne fournissent pas de prise en charge intrinsèque de la gestion des erreurs ItemPendingError.
AsyncListView ne prend pas en charge la réinsertion d’éléments qui sont en attente ou qui ont échoué. Dès qu’un élément qui a échoué ou qui est en attente est supprimé, sa connexion à une demande en attente de données est perdue. L’utilisation de Glisser-déposer pour déplacer un élément en attente dans une ASyncListView ou le tri d’une ASyncListView contenant des éléments qui sont en attente ou qui ont échoué n’est pas pris en charge car ces opérations suppriment puis réinsèrent des éléments de liste.
Syntaxe MXML
Afficher la syntaxe MXML
Masquer la syntaxe MXMLThe <mx:AsyncListView> tag inherits all the attributes of its
superclass, and adds the following attributes:
<mx:AsyncListView
Properties
createFailedItemFunction="null"
createPendingItemFunction="null"
list="null"
/>
| Propriété | Défini par | ||
|---|---|---|---|
 | constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | |
| createFailedItemFunction : Function
Une fonction de rappel utilisée pour créer un élément de substitution lorsqu’une demande ayant entraîné le renvoi d’une erreur ItemPendingError échoue. | AsyncListView | ||
| createPendingItemFunction : Function
Une fonction de rappel utilisée pour créer un élément provisoire lorsque la demande initiale provoque le renvoi d’une erreur ItemPendingError. | AsyncListView | ||
| length : int [lecture seule]
Nombre d’éléments dans cette collection. | AsyncListView | ||
| list : IList
Objet IList enveloppé par cette collection. | AsyncListView | ||
| Méthode | Défini par | ||
|---|---|---|---|
AsyncListView(list:IList = null)
Constructeur. | AsyncListView | ||
| 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. | OnDemandEventDispatcher | |
Ajoute l’élément spécifié à la fin de la liste. | AsyncListView | ||
Ajoute l’élément à l’index spécifié. | AsyncListView | ||
|
Distribue un événement dans le flux d’événements. | OnDemandEventDispatcher | |
Renvoie la valeur list.getItemAt(index) | AsyncListView | ||
Renvoie l’index de l’élément s’il se trouve dans la liste, de sorte que getItemAt(index) == élément. | AsyncListView | ||
|
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | OnDemandEventDispatcher | |
|
Indique si la propriété spécifiée d’un objet est définie. | Object | |
|
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 | |
itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
Signale à la vue qu’un élément a été mis à jour. | AsyncListView | ||
|
Indique si la propriété spécifiée existe et est énumérable. | Object | |
Supprime tous les éléments de la liste. | AsyncListView | ||
|
Supprime un écouteur de l’objet EventDispatcher. | OnDemandEventDispatcher | |
Supprime l’élément actuel ou en attente qui se trouve à l’index spécifié et le renvoie. | AsyncListView | ||
Place l’élément à l’index spécifié. | AsyncListView | ||
|
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | |
Renvoie un tableau contenant les mêmes éléments que cette AsyncListView. | AsyncListView | ||
|
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | |
Renvoie une chaîne qui contient la longueur de la liste et le nombre de requêtes d’éléments en attente. | AsyncListView | ||
|
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é. | OnDemandEventDispatcher | |
| Evénement | Synthèse | Défini par | ||
|---|---|---|---|---|
| Distribué lorsque la longueur de la liste a été modifiée ou qu’un élément list est remplacé. | AsyncListView | |||
createFailedItemFunction | propriété |
createFailedItemFunction:Function| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 4 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Une fonction de rappel utilisée pour créer un élément de substitution lorsqu’une demande ayant entraîné le renvoi d’une erreur ItemPendingError échoue. L’élément existant, généralement un élément en attente créé par la fonction de rappel spécifiée par la propriété createPendingItemFunction(), est remplacé par l’élément ayant échoué.
La valeur de cette propriété doit être une fonction à deux paramètres, l’index de l’élément demandé et l’objet « info » d’échec, qui est transmis à partir de la méthode IResponder fault(). Dans la plupart des cas, vous pouvez ignorer le second paramètre. Vous trouverez ci-dessous un exemple d’implémentation de la fonction callback :
function createFailedItem(index:int, info:Object):Object
{
return "[" + index + "request failed]";
}
La définition de cette propriété n’affecte pas les éléments en échec qui ont déjà été créés. La définition de cette propriété sur null empêche la création des éléments en échec.
La valeur par défaut est A function that unconditionally returns null..
Implémentation
public function get createFailedItemFunction():Function public function set createFailedItemFunction(value:Function):voidEléments de l’API associés
createPendingItemFunction | propriété |
createPendingItemFunction:Function| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 4 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Une fonction de rappel utilisée pour créer un élément provisoire lorsque la demande initiale provoque le renvoi d’une erreur ItemPendingError. Si la demande aboutit, l’élément provisoire est automatiquement remplacé par l’élément actuel. Si la demande échoue, l’élément est remplacé par un autre élément créé avec la fonction de rappel spécifiée par la propriété createFailedItemFunction.
La valeur de cette propriété doit être une fonction à deux paramètres, l’index de l’élément de fournisseur de données demandé et ItemPendingError. Dans la plupart des cas, le second paramètre peut être ignoré. L’exemple suivant illustre une implémentation de la fonction de rappel :
function createPendingItem(index:int, ipe:ItemPendingError):Object
{
return "[" + index + "request is pending...]";
}
La définition de cette propriété n’affecte pas les éléments en attente provisoires qui ont déjà été créés. La définition de cette propriété sur null empêche la création d’éléments en attente provisoires.
La valeur par défaut est A function that unconditionally returns null..
Implémentation
public function get createPendingItemFunction():Function public function set createPendingItemFunction(value:Function):voidEléments de l’API associés
length | propriété |
length:int [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 4 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
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.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement collectionChange .
Implémentation
public function get length():intlist | propriété |
list:IList| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 4 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Objet IList enveloppé par cette collection. C’est-à-dire l’objet auquel l’ensemble des méthodes IList sont déléguées.
Si cette propriété est null, les méthodes de mutation IList, telles que setItemAt(), ne sont pas opératoires. Les méthodes de requête IList, par exemple getItemAt(), renvoient la valeur null ou zéro (-1 pour getItemIndex()), selon le cas.
La valeur par défaut est null.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement listChanged .
Implémentation
public function get list():IList public function set list(value:IList):voidAsyncListView | () | Constructeur |
addItem | () | méthode |
addItemAt | () | méthode |
public function addItemAt(item:Object, index:int):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 4 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
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.
|
getItemAt | () | méthode |
public function getItemAt(index:int, prefetch:int = 0):Object| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 4 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Renvoie la valeur de List.getItemAt(index).
Cette méthode intercepte les erreurs ItemPendingErrors (IPE) générées suite à l’appel de la méthode getItemAt(). Si une IPE est renvoyée, un IResponder est ajouté à l’IPE et un élément « en attente » provisoire, créé à l’aide de createPendingItemFunction est renvoyé. Si la demande sous-jacente réussit, l’élément en attente est remplacé par le véritable élément. Dans le cas contraire, l’élément en attente est remplacé par une valeur produite par un l’appel de createFailedItemFunction.
Paramètres
index:int — Index de liste à partir duquel l’élément doit être récupéré.
| |
prefetch:int (default = 0)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 de liste présent à l’index spécifié.
|
Valeur émise
RangeError — Erreur renvoyée lorsque index < 0 ou index >= length.
|
Eléments de l’API associés
getItemIndex | () | méthode |
public function getItemIndex(item:Object):int| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 4 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
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 4 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
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) | |
oldValue:Object (default = null) | |
newValue:Object (default = null) |
removeAll | () | méthode |
public function removeAll():void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 4 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
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 4 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Supprime l’élément actuel ou en attente qui se trouve à l’index spécifié et le renvoie. L’index de tous les éléments dont l’index est supérieur à celui spécifié est réduit de 1.
En l’absence d’élément actuel ou en attente à l’index spécifié, par exemple si un appel de la méthode getItemAt(index) n’a pas provoqué la pagination des données, la list sous-jacente peut renvoyer une erreur ItemPendingError. L’implémentation ignore l’erreur ItemPendingError et renvoie null.
Paramètres
index:int — Index de liste à partir duquel l’élément doit être récupéré.
|
Object — Elément qui a été supprimé ou qui est null.
|
Valeur émise
RangeError — Erreur renvoyée lorsque index < 0 ou index >= length.
|
setItemAt | () | méthode |
public function setItemAt(item:Object, index:int):Object| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 4 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
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é.
|
toArray | () | méthode |
public function toArray():Array| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 4 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Renvoie un tableau contenant les mêmes éléments que cette AsyncListView. Le tableau est initialisé en récupérant chaque élément avec getItemAt(), de manière à ce que les éléments en attente soient substitués là où des valeurs réelles se sont pas encore disponibles. Le tableau ne sera pas mis à jour lorsque la classe ASyncListView remplace les éléments en attente par des valeurs réelles (ou qui ont échoué).
Array — tableau contenant les mêmes éléments que cette AsyncListView.
|
toString | () | méthode |
public function toString():String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 4 |
| Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Renvoie une chaîne qui contient la longueur de la liste et le nombre de requêtes d’éléments en attente. Il ne déclenche pas de demandes en attente.
Valeur renvoyéeString — Brève description de la liste.
|
collectionChange | Evénement |
mx.events.CollectionEventproprié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 la longueur de la liste a été modifiée ou qu’un élément list est remplacé.
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