HierarchicalCollectionView

Package	mx.collections
Classe	public class HierarchicalCollectionView
Héritage	HierarchicalCollectionView EventDispatcher Object
Implémente	IHierarchicalCollectionView, IXMLNotifiable

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 HierarchicalCollectionView fournit une vue hiérarchique d’une collection standard.

Syntaxe MXML expanded

Masquer la syntaxe MXML

The <mx.HierarchicalCollectionView> inherits all the tag attributes of its superclass, and defines the following tag attributes:

  <mx:HierarchicalCollectionView
  Properties 
    showRoot="true|false"
    source="No default"
  />

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
		constructor : Object Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.	Object
		hasRoot : Boolean [lecture seule] Si la valeur de cet indicateur est true, cela signifie que le fournisseur de données actuel contient un nœud racine, par exemple un nœud de niveau supérieur unique dans une structure hiérarchique.	HierarchicalCollectionView
		length : int [lecture seule] Longueur de la collection actuellement analysée.	HierarchicalCollectionView
		openNodes : Object Tableau d’objets contenant l’élément de fournisseur de données de tous les nœuds des branches ouvertes des données.	HierarchicalCollectionView
		showRoot : Boolean Indicateur booléen spécifiant si le nœud racine du fournisseur de données doit être affiché.	HierarchicalCollectionView
		source : IHierarchicalData Données source de l’interface IHierarchicalCollectionView.	HierarchicalCollectionView

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		HierarchicalCollectionView(hierarchicalData:IHierarchicalData = null, argOpenNodes:Object = null) Constructeur.	HierarchicalCollectionView
		addChild(parent:Object, newChild:Object):Boolean Ajoute un nœud enfant à un nœud de données.	HierarchicalCollectionView
		addChildAt(parent:Object, newChild:Object, index:int):Boolean Ajoute un nœud enfant au nœud qui se trouve à l’index spécifié.	HierarchicalCollectionView
		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
		closeNode(node:Object):void Ferme un nœud pour masquer ses enfants.	HierarchicalCollectionView
		contains(item:Object):Boolean Recherche l’élément de données dans la collection en utilisant le test d’égalité standard.	HierarchicalCollectionView
		createCursor():IViewCursor Renvoie une nouvelle instance d’un itérateur de vue portant sur les éléments de cette vue.	HierarchicalCollectionView
		dispatchEvent(event:Event):Boolean Distribue un événement dans le flux d’événements.	EventDispatcher
		getChildren(node:Object):ICollectionView Renvoie une collection d’enfants, s’ils existent.	HierarchicalCollectionView
		getNodeDepth(node:Object):int Renvoie la profondeur du nœud dans la collection.	HierarchicalCollectionView
		getParentItem(node:Object):* Renvoie le parent d’un nœud.	HierarchicalCollectionView
		hasEventListener(type:String):Boolean Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indique si la propriété spécifiée d’un objet est définie.	Object
		isPrototypeOf(theClass:Object):Boolean 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
		openNode(node:Object):void Ouvre un nœud pour afficher ses enfants.	HierarchicalCollectionView
		propertyIsEnumerable(name:String):Boolean Indique si la propriété spécifiée existe et est énumérable.	Object
		refresh():Boolean Applique le tri et le filtre à la vue.	HierarchicalCollectionView
		removeChild(parent:Object, child:Object):Boolean Supprime le nœud du nœud parent.	HierarchicalCollectionView
		removeChildAt(parent:Object, index:int):Boolean Supprime le nœud enfant d’un nœud à l’index spécifié.	HierarchicalCollectionView
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Supprime un écouteur de l’objet EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.	Object
		toLocaleString():String Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.	Object
		toString():String Renvoie la représentation sous forme de chaîne de l’objet spécifié.	Object
		valueOf():Object Renvoie la valeur primitive de l’objet spécifié.	Object
		willTrigger(type:String):Boolean 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

Evénements

Cliquez pour plus d’informations sur les événements

Masquer les événements hérités

Afficher les événements hérités

	Evénement		Synthèse	Défini par
		activate	[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.	EventDispatcher
		deactivate	[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive.	EventDispatcher

Détails de la propriété

hasRoot

propriété

hasRoot:Boolean [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Si la valeur de cet indicateur est true, cela signifie que le fournisseur de données actuel contient un nœud racine, par exemple un nœud de niveau supérieur unique dans une structure hiérarchique. Les types XML et Object sont des exemples de types de données possédant un nœud racine. En revanche, les types List et Array n’en possèdent pas.

Implémentation
public function get hasRoot():Boolean

length

propriété

length:int [lecture seule]

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Longueur de la collection actuellement analysée.

Implémentation
public function get length():int

openNodes

propriété

openNodes:Object

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Tableau d’objets contenant l’élément de fournisseur de données de tous les nœuds des branches ouvertes des données.

Implémentation
public function get openNodes():Object
public function set openNodes(value:Object):void

showRoot

propriété

showRoot:Boolean

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Indicateur booléen spécifiant si le nœud racine du fournisseur de données doit être affiché. Si les données source possèdent un nœud racine et que cette propriété est définie sur false, la collection n’inclura pas l’élément racine. Seuls les descendants de l’élément racine seront inclus dans la collection.

Cette propriété n’a aucun effet sur une source qui ne contient pas de nœud racine, par exemple des objets List ou Array.

La valeur par défaut est true.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .

Implémentation
public function get showRoot():Boolean
public function set showRoot(value:Boolean):void

source

propriété

source:IHierarchicalData

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Données source de l’interface IHierarchicalCollectionView.

Implémentation
public function get source():IHierarchicalData
public function set source(value:IHierarchicalData):void

Détails du constructeur

()

Constructeur

public function HierarchicalCollectionView(hierarchicalData:IHierarchicalData = null, argOpenNodes:Object = null)

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

	`hierarchicalData:IHierarchicalData` (default = `null`) — Structure de données contenant les données hiérarchiques.

	`argOpenNodes:Object` (default = `null`) — Objet définissant un nœud devant apparaître comme étant ouvert.

Détails de la méthode

addChild

()

méthode

public function addChild(parent:Object, newChild: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

Ajoute un nœud enfant à un nœud de données.

Paramètres

	`parent:Object` — Objet définissant le nœud parent.

	`newChild:Object` — Objet définissant le nouveau nœud.

Valeur renvoyée

Boolean — true si le nœud est correctement ajouté.

addChildAt

()

méthode

public function addChildAt(parent:Object, newChild:Object, index:int):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 parent est null ou undefined, l’enfant child est inséré à l’index spécifié, dans la collection spécifiée par le paramètre source.
Si le parent contient un champ ou une propriété children, la méthode y ajoute l’enfant child à l’emplacement index. Dans ce cas, la source n’est pas requise.
Si le parent ne contient pas de champ ou de propriété children, la méthode ajoute l’enfant children au parent. La méthode ajoute ensuite l’enfant child au parent, à l’emplacement index. Dans ce cas, la source n’est pas requise.
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 définissant le nœud parent.

	`newChild:Object` — Objet définissant le nœud enfant.

	`index:int` — Index de base zéro de l’emplacement d’insertion du nœud enfant.

Valeur renvoyée

Boolean — true si l’enfant est correctement ajouté.

closeNode

()

méthode

public function closeNode(node:Object):void

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Ferme un nœud pour masquer ses enfants.

Paramètres

node:Object — Objet définissant le nœud.

contains

()

méthode

public function contains(item: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

Recherche l’élément de données dans la collection en utilisant le test d’égalité standard.

Paramètres

item:Object — Objet définissant le nœud à rechercher.

Valeur renvoyée

Boolean — true si l’élément de données est bien présent dans la collection, false dans le cas contraire.

createCursor

()

méthode

public function createCursor():IViewCursor

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 nouvelle instance d’un itérateur de vue portant sur les éléments de cette vue.

Valeur renvoyée

IViewCursor — Instance IViewCursor.

Eléments de l’API associés

mx.utils.IViewCursor

getChildren

()

méthode

public function getChildren(node:Object):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 collection d’enfants, s’ils existent.

Paramètres

node:Object — Objet définissant le nœud. Si la valeur est null, une collection de nœuds de niveau supérieur est renvoyée.

Valeur renvoyée

ICollectionView — Instance ICollectionView contenant les nœuds enfant.

getNodeDepth

()

méthode

public function getNodeDepth(node:Object):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 dans la collection.

Paramètres

node:Object — Objet définissant le nœud.

Valeur renvoyée

int — Profondeur du nœud.

getParentItem

()

méthode

public function getParentItem(node: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 d’un nœud. Le parent d’un nœud de niveau supérieur est null.

Paramètres

node:Object — Objet définissant le nœud.

Valeur renvoyée

* — Nœud parent contenant le nœud. 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.

openNode

()

méthode

public function openNode(node:Object):void

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Ouvre un nœud pour afficher ses enfants.

Paramètres

node:Object — Objet définissant le nœud.

refresh

()

méthode

public function refresh():Boolean

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

Applique le tri et le filtre à la vue. L’interface ICollectionView ne détecte pas automatiquement les modifications apportées à un tri ou à un filtre. Par conséquent, vous devez appeler la méthode refresh() pour actualiser la vue après avoir défini la propriété sort ou filterFunction. Si l’implémentation ICollectionView implémente également l’interface IMXMLObject, vous devez appeler la méthode refresh() à partir de la méthode initialized().

Renvoie true si l’actualisation aboutit et false si le tri n’est pas encore terminé (c’est-à-dire si des éléments sont toujours en attente). Un client de la vue doit attendre un événement CollectionEvent dont la propriété CollectionEventKind.REFRESH est définie sur kind pour faire en sorte que l’opération refresh() aboutisse.

Valeur renvoyée

Boolean — true si la méthode refresh() est terminée et false si cela n’est pas le cas.

removeChild

()

méthode

public function removeChild(parent:Object, child: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

Supprime le nœud du nœud parent.

Paramètres

	`parent:Object` — Objet définissant le nœud parent. La valeur est `null` s’il s’agit d’un nœud de niveau supérieur.

	`child:Object` — Objet définissant le nœud enfant à supprimer.

Valeur renvoyée

Boolean — true si la suppression du nœud aboutit.

removeChildAt

()

méthode

public function removeChildAt(parent:Object, index:int):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é.

Paramètres

	`parent:Object` — Objet définissant le nœud parent.

	`index:int` — Index de base zéro du nœud enfant à supprimer, par rapport au parent.

Valeur renvoyée

Boolean — true si l’enfant est correctement supprimé.

Informations juridiques | Politique de confidentialité en ligne

HierarchicalCollectionView - AS3 Flex

Classes x

hasRoot

length

openNodes

showRoot

source