Classe ComboBox

Héritage MovieClip > Classe UIObject > Classe UIComponent > ComboBase > ComboBox

Nom de classe ActionScript mx.controls.ComboBox

Le composant ComboBox associe trois sous-composants distincts : Button, TextInput et List. La plupart des méthodes, propriétés et événements de chaque sous-composant sont disponibles directement depuis le composant ComboBox et énumérés dans les tableaux de la classe ComboBox.

La liste déroulante du composant ComboBox prend la forme d'un tableau ou d'un fournisseur de données. Si vous utilisez un fournisseur de données, la liste change lors de l'exécution. Vous pouvez modifier la source des données du composant ComboBox dynamiquement en basculant sur un nouveau tableau ou fournisseur de données.

Les éléments d'une liste déroulante sont indexés par position, en commençant par le chiffre 0. Les éléments peuvent être les suivants :

Un type de données de base.
Un objet contenant une propriété label et une propriété data.

REMARQUE

Un objet peut utiliser la propriété ComboBox.labelFunction ou ComboBox.labelField pour déterminer la propriété label.

Si le type de données de base de l'élément n'est pas une chaîne, il est converti en chaîne.
Si l'élément est un objet, la propriété label doit être une chaîne, et la propriété data peut avoir n'importe quelle valeur ActionScript.

Les méthodes du composant ComboBox auxquelles vous fournissez des éléments ont deux paramètres, label et data, qui se réfèrent aux propriétés ci-dessus. Les méthodes qui renvoient un élément le renvoient en tant qu'objet.

Le composant ComboBox reporte l'instanciation de sa liste déroulante jusqu'à la prochaine interaction d'un utilisateur. De ce fait, la liste déroulante peut sembler lente à la première utilisation.

Pour accéder à la liste déroulante du composant ComboBox par programmation et annuler ce retard, servez-vous du code suivant :

var foo = myComboBox.dropdown;

L'accès à la liste déroulante peut entraîner une pause dans l'application. lorsque l'utilisateur utilise la liste déroulante pour la première fois ou lorsque le code ci-dessus s'exécute.

Méthodes de la classe ComboBox

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

Méthode	Description
ComboBox.addItem()	Ajoute un élément à la fin de la liste.
ComboBox.addItemAt()	Ajoute un élément à l'emplacement d'index spécifié.
ComboBox.close()	Ferme la liste déroulante.
ComboBox.getItemAt()	Renvoie l'élément à l'emplacement d'index spécifié.
ComboBox.open()	Ouvre la liste déroulante.
ComboBox.removeAll()	Supprime tous les éléments de la liste.
ComboBox.removeItemAt()	Supprime un élément de la liste à l'emplacement spécifié.
ComboBox.replaceItemAt()	Remplace le contenu de l'élément à l'index spécifié.
ComboBox.sortItems()	Trie la liste à l'aide d'une fonction de comparaison.
ComboBox.sortItemsBy()	Trie la liste à l'aide d'un champ de chaque élément.

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

Le tableau suivant énumère les méthodes de la classe ComboBox héritées de la classe UIObject. Pour appeler ces méthodes à partir de l'objet ComboBox, utilisez le formulaire comboBoxInstance.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 ComboBox héritées de la classe UIComponent. Pour appeler ces méthodes à partir de l'objet ComboBox, utilisez le formulaire comboBoxInstance.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 ComboBox

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

Propriété	Description
ComboBox.dataProvider	Modèle de données pour les éléments de la liste.
ComboBox.dropdown	Renvoie une référence au composant List contenu dans ComboBox.
ComboBox.dropdownWidth	Largeur de la liste déroulante, en pixels.
ComboBox.editable	Indique si le composant ComboBox est modifiable.
ComboBox.labelField	Indique le champ de données à utiliser en tant qu'étiquette pour la liste déroulante.
ComboBox.labelFunction	Spécifie la fonction de calcul du champ de l'étiquette pour la liste déroulante.
ComboBox.length	Lecture seule : longueur de la liste déroulante.
ComboBox.restrict	Jeu de caractères qu'un utilisateur peut saisir dans le champ de texte d'une liste déroulante.
ComboBox.rowCount	Nombre maximal d'éléments de la liste à afficher en même temps.
ComboBox.selectedIndex	Index de l'élément sélectionné dans la liste déroulante.
ComboBox.selectedItem	Valeur de l'élément sélectionné dans la liste déroulante.
ComboBox.text	Chaîne de texte dans la zone de texte.
ComboBox.textField	Référence au composant TextInput dans la liste déroulante.
ComboBox.value	Valeur du champ de texte (modifiable) ou de la liste déroulante (statique).

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

Le tableau suivant énumère les propriétés de la classe ComboBox héritées de la classe UIObject. Lors de l'accès à ces propriétés à partir de l'objet ComboBox, utilisez le formulaire comboBoxInstance.propertyName.

Propriété	Description
UIObject.bottom	Lecture seule ; position du bord inférieur de l'objet par rapport au bord inférieur de son parent.
UIObject.height	Lecture seule ; hauteur de l'objet, en pixels.
UIObject.left	Lecture seule ; bord gauche de l'objet, en pixels.
UIObject.right	Lecture seule. Position du bord droit de l'objet par rapport au bord droit de son parent.
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	Lecture seule ; renvoie la position du bord supérieur de l'objet par rapport à son parent.
UIObject.visible	Valeur booléenne indiquant si l'objet est visible (`true`) ou non (`false`).
UIObject.width	Lecture seule ; largeur de l'objet, en pixels.
UIObject.x	Lecture seule ; bord gauche de l'objet, en pixels.
UIObject.y	Lecture seule ; bord supérieur de l'objet, en pixels.

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

Le tableau suivant énumère les propriétés de la classe ComboBox héritées de la classe UIComponent. Lors de l'accès à ces propriétés à partir de l'objet ComboBox, utilisez le formulaire comboBoxInstance.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 ComboBox

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

Evénement	Description
ComboBox.change	Diffusé lorsque la valeur de la liste déroulante change suite à l'interaction d'un utilisateur.
ComboBox.close	Diffusé lorsque la liste du composant ComboBox commence à se rétracter.
ComboBox.enter	Diffusé lorsque la touche Entrée est enfoncée.
ComboBox.itemRollOut	Diffusé lorsque le pointeur quitte un élément d'une liste déroulante.
ComboBox.itemRollOver	Diffusé lorsqu'un élément de liste déroulante est survolé.
ComboBox.open	Diffusé lorsque la liste déroulante commence à s'ouvrir.
ComboBox.scroll	Diffusé lorsque la liste déroulante est parcourue par l'utilisateur.

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

Le tableau suivant énumère les événements de la classe ComboBox 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 ComboBox 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 ComboBox

Méthodes de la classe ComboBox

Propriétés de la classe ComboBox

Evénements de la classe ComboBox