Classe List

Héritage MovieClip > Classe UIObject > Classe UIComponent > View > ScrollView > ScrollSelectList > List

Nom de classe ActionScript mx.controls.List

Le composant List comprend trois parties : des éléments, des lignes et un fournisseur de données.

Un élément est un objet ActionScript utilisé pour stocker les unités d'informations dans la liste. Une liste peut être considérée comme un tableau ; chaque espace indexé du tableau constitue un élément. Un élément est un objet qui dispose, en règle générale, d'une propriété label affichée et d'une propriété data utilisée pour stocker des données.

Une ligne est un composant utilisé pour afficher un élément. Les lignes sont fournies par défaut par la liste (avec la classe SelectableRow), mais vous pouvez également les fournir sous forme de sous-classes de la classe SelectableRow. La classe SelectableRow implémente l'API CellRenderer, ensemble des propriétés et méthodes qui permettent à la liste de manipuler toutes les lignes et d'envoyer des données et des informations d'état (par exemple, taille, sélections, etc.) à la ligne pour l'affichage.

Le fournisseur de données correspond au modèle de données des éléments d'une liste.
Un tableau situé dans la même image qu'une liste reçoit automatiquement des méthodes qui permettent de manipuler les données et de diffuser les changements vers plusieurs affichages. Vous pouvez créer une occurrence de tableau ou en obtenir une auprès d'un serveur et l'utiliser comme modèle de données pour plusieurs composants List, ComboBox, DataGrid, etc. Le composant List dispose de méthodes agissant comme proxy pour son fournisseur de données (par exemple addItem() et removeItem()). Si vous ne fournissez aucun fournisseur de données externe à la liste, ces méthodes créent automatiquement une occurrence DataProvider, exposée par le biais de List.dataProvider.

Pour ajouter un composant List à l'ordre des tabulations d'une application, définissez sa propriété tabIndex (voir UIComponent.tabIndex). Le composant List utilise le gestionnaire de focus pour remplacer le rectangle de focus par défaut de Flash Player et tracer un rectangle de focus personnalisé aux coins arrondis. Pour plus d'informations, consultez Création de la navigation personnalisée du focus dans Utilisation des composants ActionScript 2.0.

Toutes les classes de composants ont une propriété version qui correspond à une propriété de classe. Les propriétés de classe ne sont disponibles que dans la classe elle-même. La propriété version renvoie une chaîne qui indique la version du composant. Pour accéder à cette propriété, utilisez le code suivant :

trace(mx.controls.List.version);

REMARQUE

Le code trace(myListInstance.version); renvoie undefined.

Méthodes de la classe List

Le tableau suivant présente les méthodes de la classe List.

Méthode	Description
List.addItem()	Ajoute un élément à la fin de la liste.
List.addItemAt()	Ajoute un élément à la liste, à l'index spécifié.
List.getItemAt()	Renvoie l'élément à l'emplacement d'index spécifié.
List.removeAll()	Supprime tous les éléments de la liste.
List.removeItemAt()	Supprime l'élément à l'index spécifié.
List.replaceItemAt()	Remplace l'élément par un autre, à l'index spécifié.
List.setPropertiesAt()	Applique les propriétés spécifiées à l'élément donné.
List.sortItems()	Trie les éléments de la liste à l'aide de la fonction de comparaison spécifiée.
List.sortItemsBy()	Trie les éléments de la liste à l'aide d'une propriété donnée.

Méthodes héritées de la classe UIObject

Le tableau suivant énumère les méthodes de la classe List héritées de la classe UIObject. Pour appeler ces méthodes, utilisez le formulaire listInstance.methodName.

Méthode	Description
UIObject.createClassObject()	Crée un objet dans la classe spécifiée.
UIObject.createObject()	Crée un sous-objet dans un objet.
UIObject.destroyObject()	Détruit une occurrence de composant.
UIObject.doLater()	Appelle une fonction lorsque les paramètres ont été définis dans les inspecteurs des propriétés et des composants.
UIObject.getStyle()	Obtient la propriété de style de l'objet ou de la déclaration de style.
UIObject.invalidate()	Marque l'objet de sorte qu'il soit redessiné dans le prochain intervalle d'image.
UIObject.move()	Déplace l'objet à l'emplacement demandé.
UIObject.redraw()	Force la validation de l'objet pour qu'il soit dessiné dans l'image actuelle.
UIObject.setSize()	Redimensionne l'objet à la taille demandée.
UIObject.setSkin()	Définit une enveloppe dans l'objet.
UIObject.setStyle()	Définit la propriété de style sur l'objet ou la déclaration de style.

Méthodes héritées de la classe UIComponent

Le tableau suivant énumère les méthodes de la classe List héritées de la classe UIComponent. Pour appeler ces méthodes, utilisez le formulaire listInstance.methodName.

Méthode	Description
UIComponent.getFocus()	Renvoie une référence à l'objet ayant le focus.
UIComponent.setFocus()	Attribue le focus à l'occurrence de composant.

Propriétés de la classe List

Le tableau suivant présente les propriétés de la classe List.

Propriété	Description
List.cellRenderer	Affecte la classe ou le symbole à utiliser pour afficher chaque ligne de la liste.
List.dataProvider	Source des éléments de la liste.
List.hPosition	Position horizontale de la liste.
List.hScrollPolicy	Indique si la barre de défilement horizontale est affichée (`"on"`) ou non (`"off"`).
List.iconField	Champ situé dans chaque élément pour désigner les icônes.
List.iconFunction	Fonction qui détermine les icônes à utiliser.
List.labelField	Spécifie un champ dans chaque élément, à utiliser comme texte d'étiquette.
List.labelFunction	Fonction qui détermine les champs de chaque élément à utiliser pour le texte d'étiquette.
List.length	Nombre d'éléments de la liste. Cette propriété est en lecture seule.
List.maxHPosition	Nombre de pixels que la liste peut faire défiler à droite, lorsque List.hScrollPolicy est défini sur `"on"`.
List.multipleSelection	Indique si la sélection multiple est autorisée dans la liste (`true`) ou non (`false`).
List.rowCount	Nombre de lignes au moins partiellement visibles dans la liste.
List.rowHeight	Hauteur de chaque ligne de la liste, en pixels.
List.selectable	Indique si la liste peut être sélectionnée (`true`) ou non (`false`).
List.selectedIndex	Index d'une sélection dans une liste à sélection unique.
List.selectedIndices	Tableau des éléments sélectionnés dans une liste à sélection multiple.
List.selectedItem	Elément sélectionné dans une liste à sélection unique. Cette propriété est en lecture seule.
List.selectedItems	Objets sélectionnés dans une liste à sélection multiple. Cette propriété est en lecture seule.
List.vPosition	Premier élément visible de la liste.
List.vScrollPolicy	Indique si la barre de défilement verticale est affichée (`"on"`), ne l'est pas (`"off"`) ou est affichée si nécessaire (`"auto"`).

Propriétés héritées de la classe UIObject

Le tableau suivant énumère les propriétés de la classe List héritées de la classe UIObject. Pour accéder à ces propriétés, utilisez le formulaire listInstance.propertyName.

Propriété	Description
UIObject.bottom	Position du bord inférieur de l'objet par rapport au bord inférieur de son parent. Lecture seule.
UIObject.height	Hauteur de l'objet, en pixels. Lecture seule.
UIObject.left	Bord gauche de l'objet, en pixels. Lecture seule.
UIObject.right	Position du bord droit de l'objet par rapport au bord droit de son parent. Lecture seule.
UIObject.scaleX	Nombre indiquant le facteur de redimensionnement dans la direction x de l'objet par rapport à son parent.
UIObject.scaleY	Nombre indiquant le facteur de redimensionnement dans la direction y de l'objet par rapport à son parent.
UIObject.top	Position du bord supérieur de l'objet par rapport à son parent. Lecture seule.
UIObject.visible	Valeur booléenne indiquant si l'objet est visible (`true`) ou non (`false`).
UIObject.width	Largeur de l'objet, en pixels. Lecture seule.
UIObject.x	Bord gauche de l'objet, en pixels. Lecture seule.
UIObject.y	Bord supérieur de l'objet, en pixels. Lecture seule.

Propriétés héritées de la classe UIComponent

Le tableau suivant énumère les propriétés de la classe List héritées de la classe UIComponent. Pour accéder à ces propriétés, utilisez le formulaire listInstance.propertyName.

Propriété	Description
UIComponent.enabled	Indique si le composant peut recevoir le focus et la saisie.
UIComponent.tabIndex	Nombre indiquant l'ordre de tabulation pour un composant dans un document.

Evénements de la classe List

Le tableau suivant présente les événements de la classe List.

Evénement	Description
List.change	Diffusé chaque fois que la sélection change suite à une interaction avec l'utilisateur.
List.itemRollOut	Diffusé lorsque le pointeur survole les éléments de la liste, puis cesse de les survoler.
List.itemRollOver	Diffusé lorsque le pointeur passe au-dessus des éléments de la liste.
List.scroll	Diffusé lorsqu'une liste défile.

Evénements hérités de la classe UIObject

Le tableau suivant énumère les événements de la classe List hérités de la classe UIObject.

Evénement	Description
UIObject.draw	Diffusé lorsqu'un objet est sur le point de dessiner ses graphiques.
UIObject.hide	Diffusé lorsqu'un objet passe de l'état visible à l'état invisible.
UIObject.load	Diffusé lorsque des sous-objets sont créés.
UIObject.move	Diffusé lorsque l'objet a été déplacé.
UIObject.resize	Diffusé lorsqu'un objet a été redimensionné.
UIObject.reveal	Diffusé lorsqu'un objet passe de l'état invisible à l'état visible.
UIObject.unload	Diffusé lorsque les sous-objets sont purgés.

Evénements hérités de la classe UIComponent

Le tableau suivant énumère les événements de la classe List hérités de la classe UIComponent.

Evénement	Description
UIComponent.focusIn	Diffusé lorsqu'un objet reçoit le focus.
UIComponent.focusOut	Diffusé lorsqu'un objet perd le focus.
UIComponent.keyDown	Diffusé lorsqu'une touche est enfoncée.
UIComponent.keyUp	Diffusé lorsqu'une touche est relâchée.

Flash CS4 Professional ActionScript 2.0

Classe List

Méthodes de la classe List

Propriétés de la classe List

Evénements de la classe List