Guide de référence ActionScript® 3.0 pour la plate-forme Adobe® Flash®
Accueil  |  Masquer la liste des packages et des classes |  Packages  |  Classes  |  Nouveautés  |  Index  |  Annexes  |  Pourquoi existe-t-il du contenu en anglais ?
Filtres : Récupération des données du serveur...
Récupération des données du serveur...
mx.core 

UIComponentDescriptor  - AS3 Flex

Packagemx.core
Classepublic class UIComponentDescriptor
HéritageUIComponentDescriptor Inheritance ComponentDescriptor Inheritance Object

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Une instance UIComponentDescriptor encapsule les données spécifiées dans une balise MXML pour une instance d’un composant visuel.

La plupart des balises d’un fichier MXML décrivent une arborescence d’objets UIComponent. Par exemple, la balise <mx:Application> représente un objet UIComponent et ses commandes et conteneurs enfant sont tous des objets UIComponent.

Le compilateur MXML compile chacune de ces balises MXML dans une instance UIComponentDescriptor. Pour être précis, le compilateur MXML génère automatiquement une structure de données ActionScript qui correspond à une arborescence d’objets UIComponentDescriptor.

Lors de l’exécution, la méthode createComponentsFromDescriptors() de la classe Container utilise les informations des objets UIComponentDescriptor dans le tableau childDescriptorsdu conteneur pour créer les objets UIComponent réels qui sont les enfants du conteneur, ainsi que des descendants plus éloignés. Selon la valeur de la propriété creationPolicy du conteneur, les descendants peuvent être créés au démarrage de l’application, lorsqu’une partie du composant est sur le point de devenir visible, ou lorsque le développeur de l’application appelle manuellement la méthode createComponentsFromDescriptors().

Généralement, il n’est pas nécessaire de créer les instances UIComponentDescriptor manuellement. Vous pouvez accéder à celles que le compilateur MXML génère automatiquement via le tableau childDescriptors de la classe Container.

Eléments de l’API associés



Propriétés publiques
 PropriétéDéfini par
 Inheritedconstructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.
Object
 Inheriteddocument : Object
Référence à l’objet de document dans lequel le composant doit être créé.
ComponentDescriptor
  effects : Array
Tableau contenant les effets pour le composant, tels que spécifiés dans le code MXML.
UIComponentDescriptor
 Inheritedevents : Object
Objet contenant des paires nom/valeur pour les gestionnaires d’événement du composant, tels que spécifiés dans le code MXML.
ComponentDescriptor
 Inheritedid : String
Identifiant du composant, tel que spécifié dans le code MXML.
ComponentDescriptor
 Inheritedproperties : Object
[lecture seule] Objet contenant des paires nom/valeur pour les propriétés du composant, telles que spécifiées dans le code MXML.
ComponentDescriptor
 InheritedpropertiesFactory : Function
Fonction qui renvoie un objet contenant des paires nom/valeur pour les propriétés du composant, telles que spécifiées dans le code MXML.
ComponentDescriptor
  stylesFactory : Function
Fonction qui construit un objet contenant des paires nom/valeur pour les styles hérités du composant, tels que spécifiés dans le code MXML.
UIComponentDescriptor
 Inheritedtype : Class
Classe du composant, telle que spécifiée dans le code MXML.
ComponentDescriptor
Méthodes publiques
 MéthodeDéfini par
  
UIComponentDescriptor(descriptorProperties:Object)
Constructeur.
UIComponentDescriptor
 Inherited
Indique si la propriété spécifiée d’un objet est définie.
Object
 Inherited
Invalide la propriété properties mise en cache.
ComponentDescriptor
 Inherited
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
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
 Inherited
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.
Object
 Inherited
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.
Object
 Inherited
Renvoie la chaîne « ComponentDescriptor_ » plus la valeur de la propriété id.
ComponentDescriptor
 Inherited
Renvoie la valeur primitive de l’objet spécifié.
Object
Détails de la propriété

effects

propriété
public var effects:Array

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Tableau contenant les effets pour le composant, tels que spécifiés dans le code MXML.

Si, par exemple, vous écrivez le code suivant :

	  <mx:TextInput showEffect="Fade" hideEffect="Fade"/>

La propriété effects du descripteur est le tableau [ "showEffect", "hideEffect" ].

La propriété effects a la valeur null si aucun effet MXML n’est spécifié pour le composant.

Notez que les valeurs des attributs d’effet ne sont pas spécifiées dans cette propriété. Au lieu de cela, les effets sont traités comme des styles et sont donc inclus dans la propriété stylesFactory. Le tableau effect conserve une liste des styles de la propriété stylesFactory qui sont réellement des effets.

Cette propriété est utilisée par la méthode createComponentsFromDescriptors() pour enregistrer les effets dans le gestionnaire EffectManager.

stylesFactory

propriété 
public var stylesFactory:Function

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Fonction qui construit un objet contenant des paires nom/valeur pour les styles hérités du composant, tels que spécifiés dans le code MXML.

Si, par exemple, vous écrivez le code suivant :

	  <mx:TextInput borderColor="0x888888" color="0xDDDDDD"/>

alors la propriété stylesFactory du descripteur est la fonction :

	  function():void { this.borderColor = 0x888888; this.color = 0xDDDDDD };

La propriété stylesFactory a la valeur null si aucun style MXML n’est spécifié pour l’instance du composant.

Détails du constructeur

UIComponentDescriptor

()Constructeur
public function UIComponentDescriptor(descriptorProperties:Object)

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Constructeur.

Paramètres
descriptorProperties:Object — Objet contenant des paires nom/valeur pour les propriétés de l’objet UIComponentDescriptor, telles que type, id, propertiesFactory, events, stylesFactory et effects.




[ X ]Pourquoi existe-t-il du contenu en anglais ?
Certaines parties du Guide de référence ActionScript 3.0 sont en anglais

Tout le contenu du Guide de référence ActionScript 3.0 n’a pas été traduit dans toutes les langues. Si un élément de langage n’est pas traduit, il s’affiche en anglais. Par exemple, la classe ga.controls.HelpBox n’est traduite dans aucune langue. Ainsi, dans la version française du guide de référence, la classe ga.controls.HelpBox apparaît en anglais.