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.controls.treeClasses 

DefaultDataDescriptor  - AS3 Flex

Packagemx.controls.treeClasses
Classepublic class DefaultDataDescriptor
HéritageDefaultDataDescriptor Inheritance Object
Implémente ITreeDataDescriptor2, IMenuDataDescriptor

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

La classe DefaultDataDescriptor fournit une implémentation par défaut pour l’accès et la manipulation des données à utiliser dans des contrôles comme Tree et Menu. Cette implémentation gère les nœuds XML e4x et d’objet de façons proches mais différentes. Consultez la description de chaque méthode pour savoir comment la méthode accède aux valeurs dans les nœuds de types différents. Cette classe est la valeur par défaut des propriétés dataDescriptor des contrôles Tree, Menu, MenuBar et PopUpMenuButton.

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
Méthodes publiques
 MéthodeDéfini par
  
Constructeur.
DefaultDataDescriptor
  
addChildAt(parent:Object, newChild:Object, index:int, model:Object = null):Boolean
Ajoute un nœud enfant au nœud qui se trouve à l’index spécifié.
DefaultDataDescriptor
  
Permet d’accéder aux enfants d’un nœud.
DefaultDataDescriptor
  
getData(node:Object, model:Object = null):Object
Renvoie les données d’un nœud.
DefaultDataDescriptor
  
Renvoie le nom du groupe de cases d’option auquel appartient le nœud, le cas échéant.
DefaultDataDescriptor
  
getHierarchicalCollectionAdaptor(hierarchicalData:ICollectionView, uidFunction:Function, openItems:Object, model:Object = null):ICollectionView
Renvoie une instance ICollectionView qui donne aux données hiérarchiques l’apparence d’une instance ICollectionView linéaire.
DefaultDataDescriptor
  
getNodeDepth(node:Object, iterator:IViewCursor, model:Object = null):int
Renvoie la profondeur du nœud, c’est-à-dire le nombre de ses ancêtres.
DefaultDataDescriptor
  
getParent(node:Object, collection:ICollectionView, model:Object = null):Object
Renvoie le parent du nœud. Le parent d’un nœud de niveau supérieur a la valeur null.
DefaultDataDescriptor
  
Renvoie l’identifiant de type d’un nœud.
DefaultDataDescriptor
  
hasChildren(node:Object, model:Object = null):Boolean
Détermine si le nœud a réellement des enfants.
DefaultDataDescriptor
 Inherited
Indique si la propriété spécifiée d’un objet est définie.
Object
  
isBranch(node:Object, model:Object = null):Boolean
Vérifie la fin d’exécution d’un nœud.
DefaultDataDescriptor
  
Indique si le nœud est activé.
DefaultDataDescriptor
 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
  
Indique si le nœud est basculé.
DefaultDataDescriptor
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
  
removeChildAt(parent:Object, child:Object, index:int, model:Object = null):Boolean
Supprime le nœud enfant d’un nœud à l’index spécifié.
DefaultDataDescriptor
  
Définit la valeur du champ ou attribut dans le fournisseur de données qui identifie si le nœud est activé.
DefaultDataDescriptor
 Inherited
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.
Object
  
Définit la valeur du champ ou attribut dans le fournisseur de données qui identifie si le nœud est basculé.
DefaultDataDescriptor
 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 représentation sous forme de chaîne de l’objet spécifié.
Object
 Inherited
Renvoie la valeur primitive de l’objet spécifié.
Object
Détails du constructeur

DefaultDataDescriptor

()Constructeur
public function DefaultDataDescriptor()

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

Constructeur.

Détails de la méthode

addChildAt

()méthode
public function addChildAt(parent:Object, newChild:Object, index:int, model:Object = null):Boolean

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

Ajoute un nœud enfant au nœud qui se trouve à l’index spécifié. Cette implémentation se comporte comme suit :

  • Si le paramètre parent a la valeur null ou undefined, il insère le paramètre child à l’index spécifié dans la collection indiquée par le paramètre model.
  • Si le paramètre parent a un champ ou une propriété children, la méthode lui ajoute le paramètre child à l’emplacement du paramètre index. Dans ce cas, le paramètre model n’est pas nécessaire.
  • Si le paramètre parent n’a pas de champ ou de propriété children, la méthode ajoute la propriété children au paramètre parent. La méthode ajoute ensuite le paramètre child au parent à l’emplacement du paramètre index. Dans ce cas, le paramètre model n’est pas nécessaire.
  • Si la valeur index est supérieure à la longueur de la collection ou au nombre d’enfants du parent, l’objet est ajouté en tant que dernier enfant.

Paramètres

parent:Object — Objet nœud qui sera le parent de l’enfant.
 
newChild:Object — Objet nœud qui sera le parent du nœud.
 
index:int — Index de base zéro de l’endroit où placer le nœud enfant par rapport au parent.
 
model:Object (default = null) — Collection entière dont fait partie ce nœud.

Valeur renvoyée
Boolean — La valeur est true en cas de réussite.

getChildren

()méthode 
public function getChildren(node:Object, model:Object = null):ICollectionView

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

Permet d’accéder aux enfants d’un nœud. Renvoie une collection d’enfants s’ils existent. Si le nœud est un objet, la méthode renvoie le contenu du champ children de l’objet en tant qu’objet ArrayCollection. Si le nœud est XML, la méthode renvoie un objet XMLListCollection contenant les éléments enfant.

Paramètres

node:Object — Objet nœud en cours d’évaluation.
 
model:Object (default = null) — Collection contenant le nœud ; ignorée par cette classe.

Valeur renvoyée
ICollectionView — Objet contenant les nœuds enfant.

getData

()méthode 
public function getData(node:Object, model:Object = null):Object

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

Renvoie les données d’un nœud. Renvoie actuellement le nœud entier.

Paramètres

node:Object — Objet nœud en cours d’évaluation.
 
model:Object (default = null) — Collection contenant le nœud ; ignorée par cette classe.

Valeur renvoyée
Object — Nœud.

getGroupName

()méthode 
public function getGroupName(node:Object):String

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

Renvoie le nom du groupe de cases d’option auquel appartient le nœud, le cas échéant. Cette méthode est utilisée par les contrôles basés sur les menus.

Paramètres

node:Object — Nœud pour lequel extraire le nom du groupe.

Valeur renvoyée
String — Valeur de l’attribut groupName ou du champ du nœud ou chaîne vide si aucune entrée de ce type n’existe.

getHierarchicalCollectionAdaptor

()méthode 
public function getHierarchicalCollectionAdaptor(hierarchicalData:ICollectionView, uidFunction:Function, openItems:Object, model:Object = null):ICollectionView

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

Renvoie une instance ICollectionView qui donne aux données hiérarchiques l’apparence d’une instance ICollectionView linéaire.

Paramètres

hierarchicalData:ICollectionView — Données hiérarchiques.
 
uidFunction:Function — Fonction qui prend un objet et renvoie l’UID, en tant que chaîne. Ce paramètre correspond généralement à la méthode Tree.itemToUID().
 
openItems:Object — Les éléments qui ont été ouverts ou définis comme étant ouverts.
 
model:Object (default = null) — Collection à laquelle appartient ce nœud.

Valeur renvoyée
ICollectionView — Instance ICollectionView.

getNodeDepth

()méthode 
public function getNodeDepth(node:Object, iterator:IViewCursor, model:Object = null):int

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

Renvoie la profondeur du nœud, c’est-à-dire le nombre de ses ancêtres.

Paramètres

node:Object — Objet définissant le nœud.
 
iterator:IViewCursor — Instance IViewCursor pouvant servir au calcul.
 
model:Object (default = null) — Collection à laquelle appartient ce nœud.

Valeur renvoyée
int — Profondeur du nœud, où 0 correspond au niveau supérieur et -1 si la profondeur ne peut pas être calculée.

getParent

()méthode 
public function getParent(node:Object, collection:ICollectionView, model:Object = null):Object

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

Renvoie le parent du nœud. Le parent d’un nœud de niveau supérieur a la valeur null.

Paramètres

node:Object — Objet définissant le nœud.
 
collection:ICollectionView — Instance ICollectionView pouvant servir au calcul.
 
model:Object (default = null) — Collection à laquelle appartient ce nœud.

Valeur renvoyée
Object — Nœud parent comptant le nœud parmi ses enfants. La valeur est null s’il s’agit d’un nœud de niveau supérieur et undefined s’il est impossible de déterminer le parent.

getType

()méthode 
public function getType(node:Object):String

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

Renvoie l’identifiant de type d’un nœud. Cette méthode est utilisée pour les contrôles basés sur les menus pour déterminer si le nœud représente un séparateur, une case d’option, une case à cocher ou un élément normal.

Paramètres

node:Object — Objet nœud pour lequel extraire le type.

Valeur renvoyée
String — Valeur de l’attribut type ou du champ du nœud ou chaîne vide si aucun champ de ce type n’existe.

hasChildren

()méthode 
public function hasChildren(node:Object, model:Object = null):Boolean

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

Détermine si le nœud a réellement des enfants.

Paramètres

node:Object — Objet nœud en cours d’évaluation.
 
model:Object (default = null) — Collection contenant le nœud ; ignorée par cette classe.

Valeur renvoyée
Boolean — La valeur est true si ce nœud a actuellement des enfants.

isBranch

()méthode 
public function isBranch(node:Object, model:Object = null):Boolean

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

Vérifie la fin d’exécution d’un nœud. Les branches sont sans fin d’exécution mais n’ont pas besoin d’avoir des nœuds terminaux. Si le nœud est XML, renvoie la valeur true si le nœud a des enfants ou un attribut true isBranch. Si le nœud est un objet, renvoie la valeur true si le nœud a un champ (éventuellement vide) children.

Paramètres

node:Object — Objet nœud en cours d’évaluation.
 
model:Object (default = null) — Collection contenant le nœud ; ignorée par cette classe.

Valeur renvoyée
Boolean — La valeur est true si ce nœud est sans fin d’exécution.

isEnabled

()méthode 
public function isEnabled(node:Object):Boolean

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

Indique si le nœud est activé. Cette méthode est utilisée par les contrôles basés sur les menus.

Paramètres

node:Object — Nœud pour lequel extraire l’état.

Valeur renvoyée
Boolean — Valeur de l’attribut enabled ou du champ du nœud ou valeur true si aucune entrée de ce type n’existe ou si la valeur n’est pas false.

isToggled

()méthode 
public function isToggled(node:Object):Boolean

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

Indique si le nœud est basculé. Cette méthode est utilisée par les contrôles basés sur les menus.

Paramètres

node:Object — Nœud pour lequel extraire l’état.

Valeur renvoyée
Boolean — Valeur de l’attribut toggled ou du champ du nœud ou valeur false si aucune entrée de ce type n’existe.

removeChildAt

()méthode 
public function removeChildAt(parent:Object, child:Object, index:int, model:Object = null):Boolean

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

Supprime le nœud enfant d’un nœud, à l’index spécifié. Si le paramètre parent a la valeur null ou est indéterminé, la méthode utilise le paramètre model pour accéder à l’enfant. Sinon, il utilise le paramètre parent et ignore le paramètre model.

Paramètres

parent:Object — Objet nœud qui est le parent actuel du nœud enfant.
 
child:Object — Nœud en cours de suppression.
 
index:int — Index de base zéro du nœud enfant à supprimer, par rapport au parent.
 
model:Object (default = null) — Collection entière dont fait partie ce nœud.

Valeur renvoyée
Boolean — La valeur est true en cas de réussite.

setEnabled

()méthode 
public function setEnabled(node:Object, value:Boolean):void

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

Définit la valeur du champ ou attribut dans le fournisseur de données qui identifie si le nœud est activé. Cette méthode définit la valeur de l’attribut ou du champ enabled du nœud. Cette méthode est utilisée par les contrôles basés sur les menus.

Paramètres

node:Object — Nœud pour lequel définir l’état.
 
value:Boolean — Indique si le nœud est activé.

setToggled

()méthode 
public function setToggled(node:Object, value:Boolean):void

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

Définit la valeur du champ ou attribut dans le fournisseur de données qui identifie si le nœud est basculé. Cette méthode définit la valeur de l’attribut ou du champ toggled du nœud. Cette méthode est utilisée par les contrôles basés sur les menus.

Paramètres

node:Object — Nœud pour lequel définir l’état.
 
value:Boolean — Indique si le nœud est basculé.





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