ListCollectionView  - AS3 Flex

Fonction que la vue utilisera pour éliminer les éléments qui ne correspondent pas aux critères de la fonction. Une fonction filterFunction doit présenter la signature suivante :

f(item:Object):Boolean

Si un filtre n’est pas pris en charge, Flex renvoie une erreur lors de l’accès à cette propriété. Pour que la vue soit mise à jour, vous devez appeler la méthode refresh() après avoir défini la propriété filterFunction.

Remarque : les implémentations Flex de l’interface ICollectionView extraient tous les éléments d’un emplacement distant avant d’exécuter la fonction de filtrage. Si vous utilisez la pagination, appliquez le filtre à la collection distante avant d’extraire les données.

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 filterFunctionChanged .

Eléments de l’API associés

Nombre d’éléments présents dans cette vue. 0 signifie qu’elle ne contient aucun élément et -1 signifie que la longueur 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 .

Interface IList enveloppée par cette vue de collection.

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 .

Lorsque la vue est triée ou filtrée, la propriété localIndex contient un tableau d’éléments dans la vue triée ou filtrée (ordonnée ou réduite), dans l’ordre de tri. La classe ListCollectionView utilise cette propriété pour accéder aux éléments de la vue. La propriété localIndex ne doit pas contenir d’élément non présent dans la source, mais elle ne doit pas obligatoirement contenir tous les éléments de la source. La valeur de cette propriété est null lorsqu’aucun tri n’est réalisé.

L’objet ISort qui sera appliqué à l’interface ICollectionView. Le fait de définir le tri n’actualise pas automatiquement la vue. Par conséquent, vous devez appeler la méthode refresh() après avoir défini cette propriété. Si un tri n’est pas pris en charge, une erreur est renvoyée lors de l’accès à cette propriété.

Remarque : les implémentations Flex de l’interface ICollectionView extraient tous les éléments d’un emplacement distant avant de procéder au tri. Si vous utilisez la pagination avec une liste triée, appliquez le tri à la collection distante avant d’extraire les données.

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 sortChanged .

Eléments de l’API associés

Constructeur ListCollectionView.

Ajoute une liste d’éléments à la liste actuelle, en les plaçant à la fin de la liste, dans l’ordre dans lequel ils sont transmis.

Paramètres

Ajoute une liste d’éléments à la liste actuelle, en les plaçant à l’index de position transmis à la fonction. Les éléments sont placés à l’emplacement de l’index, dans l’ordre dans lequel ils sont reçus.

Paramètres

Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement. Vous pouvez enregistrer les écouteurs d’événement dans tous les nœuds de la liste d’affichage pour un type spécifique d’événement, de phase et de priorité.

Après l’enregistrement d’un écouteur d’événement, vous ne pouvez plus modifier sa priorité par d’autres appels de addEventListener(). Pour modifier la priorité d’un écouteur, vous devez d’abord appeler removeEventListener(). Vous pouvez ensuite réenregistrer l’écouteur avec le nouveau niveau de priorité.

Après l’enregistrement de l’écouteur, tous les futurs appels de addEventListener() avec une valeur type ou useCapture différente entraîneront la création d’un autre enregistrement d’écouteur. Si, par exemple, vous enregistrez un écouteur dans lequel la propriété useCapture est définie sur true, il écoute uniquement pendant la phase de capture. Si vous appelez addEventListener() à l’aide du même objet écouteur, mais en définissant useCapture sur false, vous obtenez deux écouteurs distincts : l’un qui écoute pendant la phase de capture et l’autre qui écoute pendant les phases cible et de propagation vers le haut.

Il est impossible d’enregistrer un écouteur d’événement uniquement pour la phase cible ou la phase de propagation vers le haut. Ces deux phases sont associées pendant l’enregistrement car la propagation vers le haut s’applique uniquement aux ancêtres du nœud cible.

Si vous n’avez plus besoin d’un écouteur d’événement, supprimez-le en appelant EventDispatcher.removeEventListener(), pour éviter tout problème de mémoire. Les objets associés à des écouteurs d’événement enregistrés ne sont pas automatiquement supprimés de la mémoire, car le nettoyeur de mémoire n’efface pas les objets auxquels il est toujours fait référence.

Lors de la copie d’une occurrence d’EventDispatcher, les écouteurs d’événement qui lui sont associés ne sont pas pris en compte (si le nouveau nœud nécessite un écouteur d’événement, vous devez associer celui-ci après la création du nœud). Toutefois, si vous déplacez une occurrence d’EventDispatcher, les écouteurs d’événement qui lui sont associés la suivent.

Si un écouteur d’événement est enregistré sur un nœud alors qu’un événement est en cours de traitement sur ce nœud, l’écouteur n’est pas déclenché pendant la phase actuelle, mais il peut l’être pendant une phase ultérieure du flux d’événements, telle que la phase de propagation vers le haut.

Si un écouteur d’événement est supprimé d’un nœud sur lequel un événement est en cours de traitement, il est cependant déclenché par les actions en cours. Une fois supprimé, l’écouteur d’événement n’est plus jamais appelé (à moins d’être réenregistré à des fins de traitement ultérieur).

Paramètres

Ajoute l’élément spécifié à la fin de la liste. Equivaut à addItemAt(élément, longueur).

Paramètres

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

Indique en retour si la vue contient l’objet spécifié. Contrairement aux méthodes IViewCursor.findxxx, cette recherche aboutit uniquement si un élément correspondant exactement au paramètre est trouvé. Si un filtre est appliqué à la vue, cette méthode peut renvoyer false, même si la collection sous-jacente contient bien l’élément.

Paramètres

Eléments de l’API associés

Crée une nouvelle interface IViewCursor fonctionnant avec cette vue.

Empêche la vue de distribuer les modifications apportées à la collection et aux éléments de la collection. Empêche également la vue de mettre à jour les positions des éléments si les positions au sein de la collection changent. Les modifications sont mises en file d’attente et distribuées de façon appropriée après l’appel de la méthode enableAutoUpdate. S’il y a plus d’événements de que mises à jour réalisées sur un élément unique, il se peut que la vue soit réinitialisée. La méthode disableAutoUpdate fonctionne de manière cumulative : pour que la vue distribue les événements et soit actualisée, le nombre d’appels doit être identique au nombre d’appels de la méthode enableAutoUpdate. Sachez que la méthode disableAutoUpdate affecte uniquement les vues individuelles. Les modifications peuvent être détectées au coup par coup par les autres vues.

Eléments de l’API associés

Distribue un événement dans le flux d’événements. La cible de l’événement est l’objet EventDispatcher sur lequel la méthode dispatchEvent() est appelée.

Paramètres

Active la mise à jour automatique. Pour plus d’informations, voir disableAutoUpdate.

Eléments de l’API associés

Obtient l’élément qui se trouve à l’index spécifié.

Paramètres

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

Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. Vous pouvez ainsi déterminer précisément où un objet EventDispatcher a modifié la gestion d’un type d’événement dans la hiérarchie du flux d’événements. Pour savoir si un type d’événement spécifique déclenche réellement un écouteur d’événement, utilisez IEventDispatcher.willTrigger().

La différence entre les méthodes hasEventListener() et willTrigger() est la suivante : hasEventListener() examine uniquement l’objet auquel elle appartient, tandis que willTrigger() recherche dans la totalité du flux d’événements l’événement spécifié par le paramètre type.

Paramètres

Appelée automatiquement par le compilateur MXML lorsqu’une instance ListCollectionView est créée en utilisant une balise MXML. Si vous créez l’instance ListCollectionView par le biais d’ActionScript, vous devez appeler cette méthode en transmettant le document MXML et la valeur null pour la propriété id.

Paramètres

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 IPropertyChangeNotifier. Si l’appel de cette méthode inclut un paramètre property, 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

Eléments de l’API associés

Applique le tri et le filtre à la vue. L’interface ICollectionView ne détecte pas automatiquement les modifications apportées à un tri ou à un filtre. Par conséquent, vous devez appeler la méthode refresh() pour actualiser la vue après avoir défini la propriété sort ou filterFunction. Si l’implémentation ICollectionView implémente également l’interface IMXMLObject, vous devez appeler la méthode refresh() à partir de la méthode initialized().

Renvoie true si l’actualisation aboutit et false si le tri n’est pas encore terminé (c’est-à-dire si des éléments sont toujours en attente). Un client de la vue doit attendre un événement CollectionEvent dont la propriété CollectionEventKind.REFRESH est définie sur kind pour faire en sorte que l’opération refresh() aboutisse.

Supprime tous les éléments de la liste.

Supprime un écouteur de l’objet EventDispatcher. Si aucun écouteur correspondant n’est enregistré auprès de l’objet EventDispatcher, l’appel de cette méthode n’a aucun effet.

Paramètres

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

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

Renvoie un tableau rempli dans le même ordre en tant que qu’implémentation IList. Cette méthode peut renvoyer une erreur ItemPendingError.

Imprime le contenu de cette vue dans une chaîne et la renvoie.

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é. Cette méthode renvoie true si un écouteur d’événement est déclenché pendant toute phase du flux d’événements lorsqu’un événement du type spécifié est distribué à cet objet EventDispatcher ou à l’un de ses descendants.

La différence entre les méthodes hasEventListener() et willTrigger() est la suivante : hasEventListener() examine uniquement l’objet auquel elle appartient, tandis que willTrigger() recherche dans la totalité du flux d’événements l’événement spécifié par le paramètre type.

Paramètres

Distribué lorsque l’interface ICollectionView a été mise à jour.

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.