IHierarchicalCollectionView - Guide de référence de l’API Adobe ActionScript® 3 (AS3 Flex)

Package	mx.collections
Interface	public interface IHierarchicalCollectionView extends ICollectionView , IEventDispatcher
Implémenteurs	HierarchicalCollectionView

Version du langage:

ActionScript 3.0

Version du produit:

Flex 3

Versions du moteur d’exécution:

Flash Player 9, AIR 1.1

L’interface IHierarchicalCollectionView définit une interface pour les données hiérarchiques ou groupées. Ces données sont généralement utilisées avec le contrôle AdvancedDataGrid.

Eléments de l’API associés

mx.controls.AdvancedDataGrid

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
		filterFunction : Function Fonction que la vue utilisera pour éliminer les éléments qui ne correspondent pas aux critères de la fonction.	ICollectionView
		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.	IHierarchicalCollectionView
		length : int [lecture seule] Nombre d’éléments présents dans cette vue.	ICollectionView
		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.	IHierarchicalCollectionView
		showRoot : Boolean Indicateur booléen spécifiant si le nœud racine du fournisseur de données doit être affiché.	IHierarchicalCollectionView
		sort : ISort L’objet ISort qui sera appliqué à l’interface ICollectionView.	ICollectionView
		source : IHierarchicalData Données source de l’interface IHierarchicalCollectionView.	IHierarchicalCollectionView

Méthodes publiques

Masquer les méthodes publiques héritées

Afficher les méthodes publiques héritées

	Méthode		Défini par
		addChild(parent:Object, newChild:Object):Boolean Ajoute un nœud enfant à un nœud de données.	IHierarchicalCollectionView
		addChildAt(parent:Object, newChild:Object, index:int):Boolean Ajoute un nœud enfant à un nœud présent dans les données, à un index spécifié au sein des données.	IHierarchicalCollectionView
		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.	IEventDispatcher
		closeNode(node:Object):void Ferme un nœud pour masquer ses enfants.	IHierarchicalCollectionView
		contains(item:Object):Boolean Indique en retour si la vue contient l’objet spécifié.	ICollectionView
		createCursor():IViewCursor Crée une nouvelle interface IViewCursor fonctionnant avec cette vue.	ICollectionView
		disableAutoUpdate():void Empêche la vue de distribuer les modifications apportées à la collection et aux éléments de la collection.	ICollectionView
		dispatchEvent(event:Event):Boolean Distribue un événement dans le flux d’événements.	IEventDispatcher
		enableAutoUpdate():void Active la mise à jour automatique.	ICollectionView
		getChildren(node:Object):ICollectionView Renvoie une collection d’enfants, s’ils existent.	IHierarchicalCollectionView
		getNodeDepth(node:Object):int Renvoie la profondeur du nœud dans la collection.	IHierarchicalCollectionView
		getParentItem(node:Object):* Renvoie le parent d’un nœud.	IHierarchicalCollectionView
		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.	IEventDispatcher
		itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void Signale à la vue qu’un élément a été mis à jour.	ICollectionView
		openNode(node:Object):void Ouvre un nœud pour afficher ses enfants.	IHierarchicalCollectionView
		refresh():Boolean Applique le tri et le filtre à la vue.	ICollectionView
		removeChild(parent:Object, child:Object):Boolean Supprime le nœud du nœud parent.	IHierarchicalCollectionView
		removeChildAt(parent:Object, index:int):Boolean Supprime le nœud enfant d’un nœud à l’index spécifié.	IHierarchicalCollectionView
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Supprime un écouteur de l’objet EventDispatcher.	IEventDispatcher
		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é.	IEventDispatcher

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

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.

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

Eléments de l’API associés

hasRoot

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 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 à un nœud présent dans les données, à un index spécifié au sein des données.

Paramètres

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

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

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

Valeur renvoyée

Boolean — true si le nœud 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.

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

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.

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 de nœud jouant le rôle de parent du nœud enfant. Définissez le paramètre `parent` sur `null` pour les nœuds de niveau supérieur.

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

Valeur renvoyée

Boolean — true si l’opération aboutit, false dans le cas contraire.

Informations juridiques | Politique de confidentialité en ligne

IHierarchicalCollectionView - AS3 Flex

Packagesx

Eléments du langage

Annexes

Package mx.collections

hasRoot

openNodes

showRoot

source

addChild

addChildAt

closeNode

getChildren

getNodeDepth

getParentItem

openNode

removeChild

removeChildAt