| Package | fl.controls |
| Classe | public class List |
| Héritage | List  SelectableList BaseScrollPane UIComponent Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implémente | IFocusManagerComponent |
| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flash CS3 |
| Versions du moteur d’exécution: | Flash Player 9.0.28.0, AIR 1.0 |
Le composant List inclut des éléments, des lignes et un fournisseur de données, qui sont décrits ci-dessous :
- Elément : un objet ActionScript qui contient généralement une propriété
labeldescriptive et une propriétédataqui stocke les données associées à cet élément. - Ligne : composant permettant d’afficher l’élément.
- Fournisseur de données : composant qui fournit les éléments affichés par le composant List.
Par défaut, le composant List exploite la classe CellRenderer pour fournir les lignes dans lesquelles les éléments de liste s’affichent. Vous pouvez créer ces lignes par l’intermédiaire du programme en ajoutant une sous-classe à la classe CellRenderer. La classe CellRenderer met en œuvre l’interface ICellRenderer, qui fournit l’ensemble de propriétés et de méthodes que le composant List utilise pour manipuler ses lignes et envoyer des données et des informations sur l’état à chaque ligne pour affichage. Ceci inclut des informations sur le dimensionnement des données et de la sélection.
Le composant List fournit des méthodes qui agissent sur son fournisseur de données (par exemple les méthodes addItem() et removeItem()). Vous pouvez utiliser ces méthodes, entre autres, pour manipuler les données de tout tableau qui existe dans la même image qu’un composant List, puis diffuser les modifications vers différentes vues. En l’absence de composant List avec le fournisseur de données externe, ces méthodes créent automatiquement une occurrence de fournisseur de données et l’exposent par l’intermédiaire de la propriété List.dataProvider. Le composant List procède au rendu de chaque ligne à l’aide d’un objet Sprite qui met en œuvre l’interface ICellRenderer. Pour spécifier cette option de rendu, appliquez la propriété List.cellRenderer. Vous pouvez également 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 les listes multiples, les listes déroulantes, les grilles de données, etc.
Propriétés publiques
Masquer les propriétés publiques héritées
Afficher les propriétés publiques héritées| Propriété | Défini par | ||
|---|---|---|---|
 | accessibilityImplementation : AccessibilityImplementation
Implémentation d’accessibilité (AccessibilityImplementation) actuelle pour cette occurrence d’InteractiveObject. | InteractiveObject | |
| accessibilityProperties : AccessibilityProperties
Options d’accessibilité actuelles de l’objet d’affichage. | DisplayObject | |
| allowMultipleSelection : Boolean
Lit une valeur booléenne qui indique si plusieurs éléments de la liste peuvent être sélectionnés en même temps. | SelectableList | |
| alpha : Number
Indique la valeur de transparence alpha de l’objet spécifié. | DisplayObject | |
| blendMode : String
Valeur de la classe BlendMode qui spécifie le mode de fusion à utiliser. | DisplayObject | |
| blendShader : Shader [écriture seule]
Définit un shader utilisé pour la fusion de l’arrière-plan et du premier plan. | DisplayObject | |
| buttonMode : Boolean
Spécifie le mode de bouton du sprite. | Sprite | |
| cacheAsBitmap : Boolean
Si la valeur true est définie, les moteurs d’exécution de Flash placent en mémoire cache une version bitmap interne de l’objet d’affichage. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
S’il n’est pas nul, cet objet Matrix définit le mode de rendu d’un objet d’affichage lorsque cacheAsBitmap est définie sur true. | DisplayObject | |
| constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | |
| contextMenu : NativeMenu
Spécifie le menu contextuel associé à l’objet. | InteractiveObject | |
| dataProvider : DataProvider
Lit ou définit le modèle de données de la liste d’éléments à afficher. | SelectableList | |
| doubleClickEnabled : Boolean
Spécifie si l’objet reçoit les événements doubleClick. | InteractiveObject | |
| dropTarget : DisplayObject [lecture seule]
Spécifie l’objet d’affichage sur lequel le sprite est glissé ou sur lequel il a été déposé. | Sprite | |
| enabled : Boolean
Récupère ou définit une valeur indiquant si le composant peut accepter une interaction de l’utilisateur. | UIComponent | |
| filters : Array
Tableau indexé contenant tous les objets filtre actuellement associés à l’objet d’affichage. | DisplayObject | |
| focusEnabled : Boolean
Récupère ou définit une valeur booléenne indiquant si le composant peut recevoir le focus après un clic de l’utilisateur sur son entrée. | UIComponent | |
| focusManager : IFocusManager
Récupère ou définit le FocusManager qui contrôle le focus pour ce composant et ses homologues. | UIComponent | |
| focusRect : Object
Spécifie si l’objet affiche un rectangle de focus. | InteractiveObject | |
| graphics : Graphics [lecture seule]
Spécifie l’objet Graphics appartenant au sprite qui prend en charge les commandes de dessin vectoriel. | Sprite | |
| height : Number [override]
Récupère ou définit la hauteur du composant, en pixels. | UIComponent | |
| hitArea : Sprite
Désigne un autre sprite qui fera office de zone active d’un sprite. | Sprite | |
| horizontalLineScrollSize : Number
Récupère ou définit une valeur décrivant la quantité de contenu à faire défiler horizontalement lorsque l’utilisateur clique sur un bouton fléché. | BaseScrollPane | |
| horizontalPageScrollSize : Number
Récupère ou définit le nombre de pixels selon lequel le curseur de la barre de défilement horizontal se déplace lorsque l’utilisateur clique sur le rail de la barre de défilement. | BaseScrollPane | |
| horizontalScrollBar : ScrollBar [lecture seule]
Lit une référence à la barre de défilement horizontale. | BaseScrollPane | |
| horizontalScrollPolicy : String
Récupère ou définit une valeur indiquant l’état de la barre de défilement horizontale. | BaseScrollPane | |
| horizontalScrollPosition : Number
Récupère ou définit une valeur décrivant la position horizontale de la barre de défilement horizontale dans le panneau défilant, en pixels. | BaseScrollPane | |
| iconField : String
Lit ou définit le champ d’élément qui fournit l’icône de l’élément. | List | ||
| iconFunction : Function
Lit ou définit la fonction à utiliser pour obtenir l’icône de l’élément. | List | ||
| labelField : String
Lit ou définit le nom du champ dans l’objet dataProvider à afficher en tant qu’étiquette dans le champ TextInput et dans la liste déroulante. | List | ||
| labelFunction : Function
Lit ou définit la fonction à utiliser pour obtenir l’étiquette de l’élément. | List | ||
| length : uint [lecture seule]
Lit le nombre d’éléments présents dans le fournisseur de données. | SelectableList | |
| loaderInfo : LoaderInfo [lecture seule]
Renvoie un objet LoaderInfo qui contient des informations relatives au chargement du fichier auquel appartient cet objet d’affichage. | DisplayObject | |
| mask : DisplayObject
L’objet d’affichage appelant est masqué par l’objet mask spécifié. | DisplayObject | |
| maxHorizontalScrollPosition : Number [override]
Lit ou définit le nombre de pixels jusqu’où la liste peut défiler vers la droite, lorsque la propriété horizontalScrollPolicy est définie sur ScrollPolicy.ON. | SelectableList | |
| maxVerticalScrollPosition : Number [lecture seule]
Obtient la position de défilement vertical maximale pour le contenu actif, en pixels. | BaseScrollPane | |
| metaData : Object
Obtient les données d’objet de métadonnées de l’occurrence DisplayObject si les données d’meta a été stockée près de la l’occurrence de cette DisplayObject dans le fichier SWF à l’aide d’une balise de4 PlaceObject. | DisplayObject | |
| mouseChildren : Boolean
Détermine si les enfants de l’objet prennent en charge la souris ou les périphériques de saisie utilisateur. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Spécifie si l’objet reçoit des messages de la souris ou d’un autre périphérique de saisie utilisateur. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Récupère ou définit une valeur indiquant si le composant peut recevoir le focus après un clic de l’utilisateur sur son entrée. | UIComponent | |
| mouseX : Number [lecture seule]
Indique la coordonnée x de la souris ou ou la position du périphérique de saisie utilisateur, en pixels. | DisplayObject | |
| mouseY : Number [lecture seule]
Indique la coordonnée y de la souris ou la position du périphérique de saisie utilisateur, en pixels. | DisplayObject | |
| name : String
Indique le nom d’occurrence de DisplayObject. | DisplayObject | |
| needsSoftKeyboard : Boolean
Indique si un clavier virtuel (clavier logiciel à l’écran) doit s’afficher lorsque cette occurrence d’InteractiveObject reçoit le focus. | InteractiveObject | |
| numChildren : int [lecture seule]
Renvoie le nombre d’enfants de l’objet. | DisplayObjectContainer | |
| opaqueBackground : Object
Indique si l’objet d’affichage est opaque avec une couleur d’arrière-plan spécifique. | DisplayObject | |
| parent : DisplayObjectContainer [lecture seule]
Indique l’objet DisplayObjectContainer qui contient l’objet d’affichage. | DisplayObject | |
| root : DisplayObject [lecture seule]
Pour un objet d’affichage résidant dans un fichier SWF chargé, la propriété root correspond à l’objet d’affichage de premier niveau dans la partie de la structure arborescente de la liste d’affichage représentée par ce fichier. | DisplayObject | |
| rotation : Number
Indique la rotation de l’occurrence de DisplayObject, en degrés, à partir de son orientation d’origine. | DisplayObject | |
| rotationX : Number
Indique la rotation de l’axe des x de l’occurrence DisplayObject, en degrés, à partir de son orientation d’origine par rapport au conteneur 3D parent. | DisplayObject | |
| rotationY : Number
Indique la rotation de l’axe des y de l’occurrence DisplayObject, en degrés, à partir de son orientation d’origine par rapport au conteneur 3D parent. | DisplayObject | |
| rotationZ : Number
Indique la rotation de l’axe des z de l’occurrence DisplayObject, en degrés, à partir de son orientation d’origine par rapport au conteneur 3D parent. | DisplayObject | |
| rowCount : uint [override]
Lit ou définit le nombre de lignes au moins partiellement visibles dans la liste. | List | ||
| rowHeight : Number
Lit ou définit la hauteur de chaque ligne de la liste, en pixels. | List | ||
| scale9Grid : Rectangle
Grille de mise à l’échelle en vigueur. | DisplayObject | |
| scaleX : Number [override]
Multiplie la largeur actuelle du composant par un facteur de redimensionnement. | UIComponent | |
| scaleY : Number [override]
Multiplie la hauteur actuelle du composant par un facteur de redimensionnement. | UIComponent | |
| scaleZ : Number
Indique l’échelle de profondeur (pourcentage) de l’objet tel qu’elle est appliquée à partir du point d’alignement. | DisplayObject | |
| scrollRect : Rectangle
Cadre de sélection du défilement de l’objet d’affichage. | DisplayObject | |
| selectable : Boolean
Lit ou définit une valeur booléenne qui indique si les éléments de la liste peuvent être sélectionnés. | SelectableList | |
| selectedIndex : int
Lit ou définit l’index de l’élément qui est sélectionné dans une liste à sélection unique. | SelectableList | |
| selectedIndices : Array
Lit ou définit un tableau qui contient les articles qui ont été sélectionnés à partir d’une liste à sélections multiples. | SelectableList | |
| selectedItem : Object
Lit ou définit l’élément qui a été sélectionné à partir d’une liste à sélection unique. | SelectableList | |
| selectedItems : Array
Lit ou définit un tableau qui contient les objets qui ont été sélectionnés à partir d’une liste à sélections multiples. | SelectableList | |
| softKeyboard : String
Contrôle l’aspect du clavier logiciel. | InteractiveObject | |
| softKeyboardInputAreaOfInterest : Rectangle
Définit la zone qui doit rester à l’écran lorsqu’un clavier logiciel s’affiche (non disponible sur iOS) | InteractiveObject | |
| soundTransform : flash.media:SoundTransform
Contrôle le son à l’intérieur du sprite. | Sprite | |
| stage : Stage [lecture seule]
Scène de l’objet d’affichage. | DisplayObject | |
| tabChildren : Boolean
Détermine si les enfants de l’objet prennent ou non en charge la tabulation. | DisplayObjectContainer | |
| tabEnabled : Boolean
Indique si cet objet est spécifié dans l’ordre de tabulation. | InteractiveObject | |
| tabIndex : int
Spécifie l’ordre de tabulation des objets dans un fichier SWF. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [lecture seule]
Renvoie un objet TextSnapshot pour l’occurrence de DisplayObjectContainer. | DisplayObjectContainer | |
| transform : flash.geom:Transform
Objet dont les propriétés se rapportent à la matrice, à la transformation des couleurs et aux limites des pixels d’un objet d’affichage. | DisplayObject | |
| useBitmapScrolling : Boolean
Si définie sur true, la valeur de la propriété cacheAsBitmap du contenu de défilement est true ; si définie sur false, cette valeur est désactivée. | BaseScrollPane | |
| useHandCursor : Boolean
Valeur booléenne indiquant si le curseur en forme de main apparaît lorsque le pointeur survole un sprite dont la propriété buttonMode est définie sur true. | Sprite | |
| verticalLineScrollSize : Number
Récupère ou définit une valeur décrivant la quantité de pixels à faire défiler verticalement lorsque l’utilisateur clique sur un bouton fléché. | BaseScrollPane | |
| verticalPageScrollSize : Number
Récupère ou définit le nombre de pixels selon lequel le curseur de la barre de défilement vertical se déplace lorsque l’utilisateur clique sur le rail de la barre de défilement. | BaseScrollPane | |
| verticalScrollBar : ScrollBar [lecture seule]
Récupère une référence à la barre de défilement vertical. | BaseScrollPane | |
| verticalScrollPolicy : String
Récupère ou définit une valeur indiquant l’état de la barre de défilement verticale. | BaseScrollPane | |
| verticalScrollPosition : Number
Récupère ou définit une valeur décrivant la position verticale de la barre de défilement verticale dans le panneau défilant, en pixels. | BaseScrollPane | |
| visible : Boolean [override]
Récupère ou définit une valeur indiquant si l’occurrence du composant actif est visible. | UIComponent | |
| width : Number [override]
Récupère ou définit la largeur du composant, en pixels. | UIComponent | |
| x : Number [override]
Récupère ou définit la coordonnée x représentant la position du composant le long de l’axe x au sein de son conteneur parent. | UIComponent | |
| y : Number [override]
Récupère ou définit la coordonnée y représentant la position du composant le long de l’axe y au sein de son conteneur parent. | UIComponent | |
| z : Number
Indique la position de coordonnée z le long de l’axe des z de l’occurrence DisplayObject par rapport au conteneur 3D parent. | DisplayObject | |
Méthodes publiques
| Méthode | Défini par | ||
|---|---|---|---|
List()
Crée une nouvelle occurrence du composant List. | List | ||
|
Ajoute une occurrence DisplayObject enfant à cette occurrence DisplayObjectContainer. | DisplayObjectContainer | |
|
Ajoute une occurrence DisplayObject enfant à cette occurrence DisplayObjectContainer. | DisplayObjectContainer | |
| 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. | EventDispatcher | |
|
Ajoute un élément à la fin de la liste d’éléments. | SelectableList | |
|
Insère un élément dans la liste, à l’index spécifié. | SelectableList | |
|
Indique si les restrictions de sécurité entraîneraient l’omission des objets d’affichage de la liste renvoyée en appelant la méthode DisplayObjectContainer.getObjectsUnderPoint() avec le point « point » spécifié. | DisplayObjectContainer | |
|
Supprime un style qui est défini sur les fonctionnalités de rendu de la liste. | SelectableList | |
|
Efface l’élément actuellement sélectionné dans la liste et définit la propriété selectedIndex sur -1. | SelectableList | |
|
Définit une propriété de style depuis cette occurrence de composant. | UIComponent | |
|
Détermine si l’objet d’affichage spécifié est un enfant de l’occurrence de DisplayObjectContainer ou l’occurrence en tant que telle. | DisplayObjectContainer | |
|
Distribue un événement dans le flux d’événements. | EventDispatcher | |
|
Affiche ou masque l’indicateur de focus dans ce composant. | UIComponent | |
|
Déclenche une opération de dessin immédiate, sans tout annuler comme le fait invalidateNow. | UIComponent | |
|
Renvoie un rectangle qui définit la zone de l’objet d’affichage relativement au système de coordonnées de l’objet targetCoordinateSpace. | DisplayObject | |
|
Renvoie l’occurrence enfant de l’objet d’affichage associée à l’index spécifié. | DisplayObjectContainer | |
|
Renvoie l’objet d’affichage enfant portant le nom spécifié. | DisplayObjectContainer | |
|
Renvoie la position d’index d’une occurrence enfant de DisplayObject. | DisplayObjectContainer | |
|
Récupère l’objet qui détient actuellement le focus. | UIComponent | |
|
Récupère l’élément à l’index spécifié. | SelectableList | |
|
Renvoie l’index du prochain élément du dataProvider dans lequel le premier caractère de l’étiquette correspond à un caractère de chaîne spécifié. | SelectableList | |
|
Renvoie un tableau d’objets de niveau inférieur au point spécifié et qui sont les enfants (ou les petits-enfants, etc.) de l’occurrence de DisplayObjectContainer. | DisplayObjectContainer | |
|
Renvoie un rectangle qui définit les limites de l’objet d’affichage, en se basant sur le système de coordonnées défini par le paramètre targetCoordinateSpace, moins tout trait appliqué aux formes. | DisplayObject | |
|
Récupère un style qui est défini sur les fonctionnalités de rendu de la liste. | SelectableList | |
|
Extrait une propriété de style définie dans la chaîne de recherche de style du composant. | UIComponent | |
[statique]
Récupère la texture de style par défaut du composant actif. | List | ||
|
Convertit l’objet point des coordonnées de scène (globales) vers les coordonnées de l’objet d’affichage (locales). | DisplayObject | |
|
Convertit un point bidimensionnel à partir des coordonnées de scène (globales) vers les coordonnées d’un objet d’affichage tridimensionnel (locales). | DisplayObject | |
|
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | EventDispatcher | |
|
Indique si la propriété spécifiée d’un objet est définie. | Object | |
|
Evalue le cadre de sélection de l’objet d’affichage pour savoir s’il recouvre ou recoupe le cadre de sélection de l’objet d’affichage obj. | DisplayObject | |
|
Evalue l’objet d’affichage pour savoir s’il recouvre ou recoupe le point spécifié par les paramètres x et y. | DisplayObject | |
|
Marque une propriété comme non valide, puis redessine le composant dans la prochaine image, sauf spécification contraire. | UIComponent | |
|
Invalide un rendu d’élément spécifique. | SelectableList | |
|
Invalide le rendu de l’élément présent à l’index spécifié. | SelectableList | |
|
Invalide l’ensemble de la liste et impose un nouveau dessin de tous les éléments. | SelectableList | |
|
Vérifie si l’élément spécifié est sélectionné dans la liste. | SelectableList | |
|
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 | |
|
Renvoie ICellRenderer pour un objet d’élément donné, le cas échéant. | SelectableList | |
[override]
Extrait la chaîne normalement affichée par l’objet de rendu pour l’objet de données fourni en fonction des propriétés labelField et labelFunction. | List | ||
|
Convertit un point tridimensionnel des coordonnées de l’objet d’affichage tridimensionnel (locales) vers un point bidimensionnel dans les coordonnées de scène (globales). | DisplayObject | |
|
Convertit l’objet point des coordonnées de l’objet d’affichage (locales) vers les coordonnées de la scène (globales). | DisplayObject | |
| [statique]
Fusionne les styles de plusieurs classes en un seul objet. | UIComponent | |
|
Déplace le composant à la position spécifiée dans son parent. | UIComponent | |
|
Indique si la propriété spécifiée existe et est énumérable. | Object | |
|
Supprime tous les éléments de la liste. | SelectableList | |
|
Supprime l’occurrence enfant de DisplayObject spécifiée de la liste d’enfants de l’occurrence de DisplayObjectContainer. | DisplayObjectContainer | |
|
Supprime une occurrence enfant de DisplayObject de la position d’index spécifiée dans la liste d’enfants de DisplayObjectContainer. | DisplayObjectContainer | |
|
Supprime toutes les occurrences enfants de DisplayObject de la liste d’enfants de l’occurrence de DisplayObjectContainer. | DisplayObjectContainer | |
|
Supprime un écouteur de l’objet EventDispatcher. | EventDispatcher | |
|
Supprime l’élément spécifié de la liste. | SelectableList | |
|
Supprime l’élément présent à l’emplacement d’index spécifié. | SelectableList | |
|
Remplace l’élément, à l’index spécifié, par un autre élément. | SelectableList | |
|
Affiche un clavier virtuel. | InteractiveObject | |
[override]
Fait défiler la liste jusqu’à l’élément, à l’index spécifié. | List | ||
|
Fait défiler la liste jusqu’à l’élément, à l’emplacement indiqué par la valeur actuelle de la propriété selectedIndex. | SelectableList | |
|
Modifie la position d’un enfant existant dans le conteneur d’objet d’affichage. | DisplayObjectContainer | |
|
Définit le focus sur ce composant. | UIComponent | |
|
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | |
|
Définit un style pour les fonctionnalités de rendu dans la liste. | SelectableList | |
|
Définit le composant en fonction de la largeur et de la hauteur spécifiées. | UIComponent | |
|
Définit une propriété de style pour cette occurrence de composant. | UIComponent | |
|
Trie les éléments du fournisseur de données actuel. | SelectableList | |
|
Trie les éléments du fournisseur de données actuel en fonction d’un ou plusieurs de ses champs. | SelectableList | |
|
Permet à l’utilisateur de faire glisser le sprite spécifié. | Sprite | |
|
Permet à l’utilisateur de faire glisser le sprite spécifié sur un périphérique tactile. | Sprite | |
|
Interrompt de façon récursive l’exécution du scénario de tous les clips ayant cet objet comme racine. | DisplayObjectContainer | |
|
Met fin à la méthode startDrag(). | Sprite | |
|
Met fin à la méthode startTouchDrag() en vue d’utiliser des périphériques tactiles. | Sprite | |
|
Intervertit l’ordre de plan (ordre d’empilement du premier plan vers l’arrière-plan) des deux objets enfant spécifiés. | DisplayObjectContainer | |
|
Intervertit l’ordre de plan (ordre d’empilement du premier plan vers l’arrière-plan) des objets enfant aux deux positions d’index spécifiées dans la liste d’enfants. | DisplayObjectContainer | |
|
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | |
|
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | |
|
Valide et met à jour les propriétés et la mise en forme de cet objet, puis le redessine si nécessaire. | UIComponent | |
|
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é. | EventDispatcher | |
Méthodes protégées
Evénements
Styles
Les styles sont soit communs soit associés à un thème spécifique. Si le style est commun, il peut être utilisé avec n’importe quel thème. Si un style est associé à un thème spécifique, il ne peut être utilisé que si votre application utilise ce thème.
Styles communs
Constantes publiques
Détails de la propriété
iconField | propriété |
iconField:String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flash CS3 |
| Versions du moteur d’exécution: | Flash Player 9.0.28.0, AIR 1.0 |
Lit ou définit le champ d’élément qui fournit l’icône de l’élément.
Remarque : iconField n’est pas utilisé si la propriété iconFunction est définie sur une fonction de rappel.
La valeur par défaut est "icon".
Implémentation
public function get iconField():String public function set iconField(value:String):voidExemple ( Comment utiliser cet exemple )
L’exemple suivant crée une liste avec une icône pour chaque élément. Un symbole appelé
RedBox doit exister dans la bibliothèque et présenter l’option « Exporter pour ActionScript » activée dans ses propriétés :
import fl.data.DataProvider;
import fl.controls.List;
var dp:DataProvider = new DataProvider();
dp.addItem( { iconSource:RedBox, label:"Item 1" } );
dp.addItem( { iconSource:RedBox, label:"Item 2" } );
dp.addItem( { iconSource:RedBox, label:"Item 3" } );
var list:List = new List();
list.iconField = "iconSource";
list.dataProvider = dp;
addChild(list);
iconFunction | propriété |
iconFunction:Function| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flash CS3 |
| Versions du moteur d’exécution: | Flash Player 9.0.28.0, AIR 1.0 |
Lit ou définit la fonction à utiliser pour obtenir l’icône de l’élément.
Remarque : iconField n’est pas utilisé si la propriété iconFunction est définie sur une fonction de rappel.
La valeur par défaut est null.
Implémentation
public function get iconFunction():Function public function set iconFunction(value:Function):voidExemple ( Comment utiliser cet exemple )
L’exemple suivant utilise la propriété
iconFunction pour fournir une icône à un nombre limité d’éléments dans une liste. Pour que cet exemple fonctionne correctement, un symbole appelé RedBox doit exister dans la bibliothèque et présenter l’option « Exporter pour ActionScript » activée dans ses propriétés :
import fl.data.DataProvider;
import fl.controls.List;
var dp:DataProvider = new DataProvider();
dp.addItem( { label:"Item 1" } );
dp.addItem( { label:"Item 2" } );
dp.addItem( { label:"Item 3" } );
var list:List = new List();
list.iconFunction = determineIcon;
list.dataProvider = dp;
addChild(list);
function determineIcon(item:Object):String {
if(item.label == "Item 2") {
return "RedBox";
}
else {
return null;
}
}
labelField | propriété |
labelField:String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flash CS3 |
| Versions du moteur d’exécution: | Flash Player 9.0.28.0, AIR 1.0 |
Lit ou définit le nom du champ dans l’objet dataProvider à afficher en tant qu’étiquette dans le champ TextInput et dans la liste déroulante.
Par défaut, le composant affiche la propriété label de chaque élément dataProvider. Si les éléments dataProvider ne contiennent pas de propriété label, vous pouvez définir la propriété labelField pour qu’elle utilise une autre propriété.
Remarque : la propriété labelField n’est pas utilisée lorsque la propriété labelFunction est définie sur une fonction de rappel.
La valeur par défaut est "label".
Implémentation
public function get labelField():String public function set labelField(value:String):voidEléments de l’API associés
Exemple ( Comment utiliser cet exemple )
L’exemple suivant affiche chaque élément d’une liste avec la propriété
abbreviatedLabel plutôt qu’avec la propriété label par défaut :
import fl.data.DataProvider;
import fl.controls.List;
var dp:DataProvider = new DataProvider();
dp.addItem( { abbreviatedLabel:"NY", label:"New York" } );
dp.addItem( { abbreviatedLabel:"CA", label:"California" } );
dp.addItem( { abbreviatedLabel:"WA", label:"Washington" } );
dp.addItem( { abbreviatedLabel:"CT", label:"Connecticut" } );
dp.addItem( { abbreviatedLabel:"VT", label:"Vermont" } );
var list:List = new List();
list.setSize(40,100);
list.labelField = "abbreviatedLabel"
list.dataProvider = dp;
addChild(list);
labelFunction | propriété |
labelFunction:Function| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flash CS3 |
| Versions du moteur d’exécution: | Flash Player 9.0.28.0, AIR 1.0 |
Lit ou définit la fonction à utiliser pour obtenir l’étiquette de l’élément.
Par défaut, le composant affiche la propriété label d’un élément dataProvider. Certains ensembles de données peuvent ne pas disposer d’un champ label ou ne pas avoir de champ dont la valeur peut être utilisée en tant qu’étiquette sans modification. Par exemple, un ensemble de données spécifique peut stocker des noms complets et les gérer à l’aide des champs lastName et firstName. Dans ce cas, cette propriété permettrait de définir une fonction de rappel qui concatène les valeurs des champs lastName et firstName pour former le nom complet à afficher.
Remarque : la propriété labelField n’est pas utilisée lorsque la propriété labelFunction est définie sur une fonction de rappel.
La valeur par défaut est null.
Implémentation
public function get labelFunction():Function public function set labelFunction(value:Function):voidExemple ( Comment utiliser cet exemple )
Cet exemple définit la propriété
labelFunction d’une liste sur une fonction qui formate la chaîne à afficher dans chaque cellule :
import fl.data.DataProvider;
import fl.controls.List;
var myDataProvider:DataProvider = new DataProvider();
myDataProvider.addItem({name:"User A", price:0.43});
myDataProvider.addItem({name:"User B", price:0.34});
var users:List = new List();
users.dataProvider = myDataProvider;
users.labelFunction = myLabelFunction;
addChild(users);
function myLabelFunction(item:Object):String {
return item.name + " ($" + item.price.toFixed(2) + ")";
}
rowCount | propriété |
rowCount:uint[override] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Flash CS3 |
| Versions du moteur d’exécution: | Flash Player 9.0.28.0, AIR 1.0 |
Lit ou définit le nombre de lignes au moins partiellement visibles dans la liste.
Implémentation
override public function get rowCount():uint override public function set rowCount(value:uint):voidExemple ( Comment utiliser cet exemple )
Cet exemple définit la taille d’une liste et détermine le nombre de lignes potentiellement visibles en recherchant la propriété
rowCount :
import fl.data.DataProvider;
import fl.controls.List;
var dp:DataProvider = new DataProvider();
var i:uint;
for(i=0; i<100; i++) {
dp.addItem( { label: "Item " + i } );
}
var list:List = new List();
list.setSize(100,300);
list.dataProvider = dp;
addChild(list);
trace(list.rowCount); // 15
L’exemple suivant définit la taille d’un composant List à l’aide de la propriété
rowCount basée sur la valeur actuelle d’un curseur :
import fl.controls.Slider;
import fl.controls.List;
import fl.data.DataProvider;
import fl.events.SliderEvent;
var dp:DataProvider = new DataProvider();
var i:int;
for (i=0; i<8; i++) {
dp.addItem({label:"Item " + i});
}
var mySlider:Slider = new Slider();
mySlider.move(10, 10);
mySlider.tickInterval = 1;
mySlider.snapInterval = 1;
mySlider.minimum = 2;
mySlider.maximum = 9;
mySlider.liveDragging = true;
mySlider.addEventListener(SliderEvent.CHANGE, changeHandler);
addChild(mySlider);
var myList:List = new List();
myList.dataProvider = dp;
myList.move(mySlider.x, mySlider.y + 20);
myList.setSize(100, 50);
addChild(myList);
function changeHandler(event:SliderEvent):void {
myList.rowCount = event.value;
}
rowHeight | propriété |
rowHeight:Number| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flash CS3 |
| Versions du moteur d’exécution: | Flash Player 9.0.28.0, AIR 1.0 |
Lit ou définit la hauteur de chaque ligne de la liste, en pixels.
La valeur par défaut est 20.
Implémentation
public function get rowHeight():Number public function set rowHeight(value:Number):voidDétails du constructeur
List | () | Constructeur |
public function List()| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flash CS3 |
| Versions du moteur d’exécution: | Flash Player 9.0.28.0, AIR 1.0 |
Crée une nouvelle occurrence du composant List.
Détails de la méthode
getStyleDefinition | () | méthode |
public static function getStyleDefinition():Object| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flash CS3 |
| Versions du moteur d’exécution: | Flash Player 9.0.28.0, AIR 1.0 |
Récupère la texture de style par défaut du composant actif. La texture de style contient le type adapté au composant, qui dépend du style utilisé par ce dernier. Par exemple, le style disabledTextFormat contient la valeur null ou un objet TextFormat. Vous pouvez utiliser ces styles et appeler setStyle() pour le composant actif. Le code suivant ignore le style par défaut disabledTextFormat dans le composant spécifié :
componentInstance.setStyle("disabledTextFormat", new TextFormat());Object — Objet de styles par défaut.
|
Eléments de l’API associés
Exemple ( Comment utiliser cet exemple )
L’exemple suivant crée un navigateur de styles pour différentes classes de composant :
import fl.controls.*;
import fl.containers.*;
import fl.controls.listClasses.*;
import fl.controls.dataGridClasses.*;
import fl.controls.progressBarClasses.*;
import fl.core.UIComponent;
import fl.data.DataProvider;
var dp:DataProvider = new DataProvider();
dp.addItem( { label: "BaseScrollPane", data:BaseScrollPane } );
dp.addItem( { label: "Button", data:Button } );
dp.addItem( { label: "CellRenderer", data:CellRenderer } );
dp.addItem( { label: "CheckBox", data:CheckBox } );
dp.addItem( { label: "ColorPicker", data:ColorPicker } );
dp.addItem( { label: "ComboBox", data:ComboBox } );
dp.addItem( { label: "DataGrid", data:DataGrid } );
dp.addItem( { label: "HeaderRenderer", data:HeaderRenderer } );
dp.addItem( { label: "ImageCell", data:ImageCell } );
dp.addItem( { label: "IndeterminateBar",data:IndeterminateBar } );
dp.addItem( { label: "Label", data:Label } );
dp.addItem( { label: "List", data:List } );
dp.addItem( { label: "NumericStepper", data:NumericStepper } );
dp.addItem( { label: "ProgressBar", data:ProgressBar } );
dp.addItem( { label: "RadioButton", data:RadioButton } );
dp.addItem( { label: "ScrollPane", data:ScrollPane } );
dp.addItem( { label: "Slider", data:Slider } );
dp.addItem( { label: "TextArea", data:TextArea } );
dp.addItem( { label: "TextInput", data:TextInput } );
dp.addItem( { label: "TileList", data:TileList } );
dp.addItem( { label: "UILoader", data:UILoader } );
dp.addItem( { label: "UIComponent", data:UIComponent } );
var cb:ComboBox = new ComboBox();
cb.move(10,10);
cb.setSize(300,25);
cb.prompt = "Select a component to view its styles";
cb.rowCount = 12;
cb.dataProvider = dp;
cb.addEventListener(Event.CHANGE, showStyleDefinition);
addChild(cb);
var dg:DataGrid = new DataGrid();
dg.setSize(425,300);
dg.move(10,50);
dg.columns = [ new DataGridColumn("StyleName"), new DataGridColumn("DefaultValue") ];
addChild(dg);
function showStyleDefinition(e:Event):void {
var componentClass:Class = e.target.selectedItem.data as Class;
var styles:Object = componentClass["getStyleDefinition"].call(this);
trace(styles.toString());
var styleData:DataProvider = new DataProvider();
for(var i:* in styles) {
trace(i + " : " + styles[i]);
styleData.addItem( { StyleName:i, DefaultValue:styles[i] } );
}
styleData.sortOn("StyleName");
dg.dataProvider = styleData;
}
itemToLabel | () | méthode |
override public function itemToLabel(item:Object):String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flash CS3 |
| Versions du moteur d’exécution: | Flash Player 9.0.28.0, AIR 1.0 |
Extrait la chaîne normalement affichée par l’objet de rendu pour l’objet de données fourni en fonction des propriétés labelField et labelFunction.
Remarque : labelField n’est pas utilisé lorsque la propriété labelFunction est définie sur une fonction de rappel.
Paramètres
item:Object — Objet à restituer.
|
String — Chaîne à afficher en fonction des données.
|
Exemple ( Comment utiliser cet exemple )
L’exemple suivant montre comment identifier l’étiquette d’une entrée de liste lorsque l’utilisateur la survole avec le curseur de sa souris :
import fl.controls.List;
import fl.data.DataProvider;
import fl.events.ListEvent;
var myDataProvider:DataProvider = new DataProvider();
myDataProvider.addItem({label:"Carrot", price:0.43});
myDataProvider.addItem({label:"Tomato", price:0.34});
myDataProvider.addItem({label:"Blueberry", price:0.72});
myDataProvider.addItem({label:"Turnip", price:0.24});
var myList:List = new List();
myList.setSize(300,80);
myList.dataProvider = myDataProvider;
myList.labelFunction = myLabelFunction;
myList.addEventListener(ListEvent.ITEM_ROLL_OVER, announceLabel);
addChild(myList);
function myLabelFunction(item:Object):String {
return item.label + " - Current price: ($" + item.price.toFixed(2) + ")";
}
function announceLabel(e:ListEvent):void {
var list:List = e.target as List;
var item:Object = e.item;
trace("Label: " + item.label);
trace("Label displayed: " + list.itemToLabel(item));
}
scrollToIndex | () | méthode |
override public function scrollToIndex(newCaretIndex:int):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flash CS3 |
| Versions du moteur d’exécution: | Flash Player 9.0.28.0, AIR 1.0 |
Fait féfiler la liste jusqu’à l’élément, à l’index spécifié. Lorsque l’index est hors de portée, la position de défilement ne change pas.
Paramètres
newCaretIndex:int — L’index auquel le défilement doit s’arrêter.
|
Exemples Comment utiliser cet exemple
ListExample.as
L’exemple suivant indique comment créer un composant List et remplir les autres occurrences du composant List en fonction de ses sélections.
- Ajoutez les classes List, Button et Label dans la bibliothèque.
- Enregistrez ce code sous le nom ListExample.as dans le même répertoire que votre fichier FLA.
- Dans le fichier FLA, définissez DocumentClass sur ListExample.
package
{
import flash.display.Sprite
public class ListExample extends Sprite
{
import flash.events.*;
import fl.data.DataProvider;
import fl.controls.List
import fl.controls.Label
import fl.controls.Button
private var clearButton:Button;
private var availableItems:List;
private var selectedItemList:List;
private var selectedItemsList:List;
public function ListExample() {
createComponents();
setupComponents();
}
private function setupComponents():void {
var dp:Array = new Array();
var i:uint;
var count:uint = availableItems.rowCount * 2;
for (i = 0; i < count; i++) {
dp.push({label:"Item " + i});
}
availableItems.allowMultipleSelection = true;
availableItems.dataProvider = new DataProvider(dp);
availableItems.addEventListener(Event.CHANGE, updateLists);
clearButton.addEventListener(MouseEvent.CLICK, clearHandler);
}
private function clearHandler(event:MouseEvent):void {
availableItems.clearSelection();
// clear data providers
selectedItemList.dataProvider = new DataProvider();
selectedItemsList.dataProvider = new DataProvider();
}
private function updateLists(e:Event):void {
selectedItemList.dataProvider = availableItems.selectedItem ? new DataProvider([availableItems.selectedItem]) : new DataProvider();
selectedItemsList.dataProvider = new DataProvider(availableItems.selectedItems);
}
private function createComponents():void {
clearButton = new Button();
availableItems = new List();
selectedItemList = new List();
selectedItemsList = new List();
var availableItemsLabel:Label = new Label();
var selectedItemListLabel:Label = new Label();
var selectedItemsListLabel:Label = new Label();
clearButton.move(10,142);
availableItems.move(10,32);
selectedItemList.move(120,32);
selectedItemsList.move(230,32);
availableItemsLabel.move(10,10);
selectedItemListLabel.move(120,10);
selectedItemsListLabel.move(230,10);
clearButton.label = "Clear Selection"
availableItemsLabel.text = "Available Items";
selectedItemListLabel.text = "Selected Item";
selectedItemsListLabel.text = "All Selected Items";
addChild(clearButton);
addChild(availableItems);
addChild(selectedItemList);
addChild(selectedItemsList);
addChild(availableItemsLabel);
addChild(selectedItemListLabel);
addChild(selectedItemsListLabel);
}
}
}
Tue Jun 12 2018, 09:30 AM Z