HierarchicalCollectionView

Pacchetto	mx.collections
Classe	public class HierarchicalCollectionView
Ereditarietà	HierarchicalCollectionView EventDispatcher Object
Implementa	IHierarchicalCollectionView, IXMLNotifiable

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

The HierarchicalCollectionView class provides a hierarchical view of a standard collection.

Sintassi MXML expanded

Nascondi sintassi 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"
  />

Proprietà pubbliche

Nascondi proprietà pubbliche ereditate

Mostra proprietà pubbliche ereditate

	Proprietà		Definito da
		constructor : Object Un riferimento all'oggetto classe o alla funzione di costruzione per una determinata istanza di oggetto.	Object
		hasRoot : Boolean [sola lettura] A flag that, if true, indicates that the current data provider has a root node; for example, a single top-level node in a hierarchical structure.	HierarchicalCollectionView
		length : int [sola lettura] The length of the currently parsed collection.	HierarchicalCollectionView
		openNodes : Object An Array of Objects containing the data provider element for all the open branch nodes of the data.	HierarchicalCollectionView
		showRoot : Boolean A Boolean flag that specifies whether to display the data provider's root node.	HierarchicalCollectionView
		source : IHierarchicalData The source data of the IHierarchicalCollectionView.	HierarchicalCollectionView

Metodi pubblici

Nascondi metodi pubblici ereditati

Mostra metodi pubblici ereditati

	Metodo		Definito da
		HierarchicalCollectionView(hierarchicalData:IHierarchicalData = null, argOpenNodes:Object = null) Constructor.	HierarchicalCollectionView
		addChild(parent:Object, newChild:Object):Boolean Adds a child node to a node of the data.	HierarchicalCollectionView
		addChildAt(parent:Object, newChild:Object, index:int):Boolean Add a child node to a node at the specified index.	HierarchicalCollectionView
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registra un oggetto listener di eventi con un oggetto EventDispatcher, in modo che il listener riceva la notifica di un evento.	EventDispatcher
		closeNode(node:Object):void Closes a node to hide its children.	HierarchicalCollectionView
		contains(item:Object):Boolean Checks the collection for the data item using standard equality test.	HierarchicalCollectionView
		createCursor():IViewCursor Returns a new instance of a view iterator over the items in this view.	HierarchicalCollectionView
		dispatchEvent(event:Event):Boolean Invia un evento nel flusso di eventi.	EventDispatcher
		getChildren(node:Object):ICollectionView Returns a collection of children, if they exist.	HierarchicalCollectionView
		getNodeDepth(node:Object):int Returns the depth of the node in the collection.	HierarchicalCollectionView
		getParentItem(node:Object):* Returns the parent of a node.	HierarchicalCollectionView
		hasEventListener(type:String):Boolean Verifica se per l'oggetto EventDispatcher sono presenti listener registrati per un tipo specifico di evento.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indica se per un oggetto è definita una proprietà specifica.	Object
		isPrototypeOf(theClass:Object):Boolean Indica se un'istanza della classe Object si trova nella catena di prototipi dell'oggetto specificato come parametro.	Object
		openNode(node:Object):void Opens a node to display its children.	HierarchicalCollectionView
		propertyIsEnumerable(name:String):Boolean Indica se la proprietà specificata esiste ed è enumerabile.	Object
		refresh():Boolean Applies the sort and filter to the view.	HierarchicalCollectionView
		removeChild(parent:Object, child:Object):Boolean Removes the child node from the parent node.	HierarchicalCollectionView
		removeChildAt(parent:Object, index:int):Boolean Removes the child node from a node at the specified index.	HierarchicalCollectionView
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Rimuove un listener dall'oggetto EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Imposta la disponibilità di una proprietà dinamica per le operazioni cicliche.	Object
		toLocaleString():String Restituisce la rappresentazione in formato stringa di questo oggetto, formattato in base alle convenzioni specifiche per le versioni localizzate.	Object
		toString():String Restituisce la rappresentazione in formato stringa dell'oggetto specificato.	Object
		valueOf():Object Restituisce il valore di base dell'oggetto specificato.	Object
		willTrigger(type:String):Boolean Verifica se un listener di eventi è registrato con questo oggetto EventDispatcher o qualsiasi suo antenato per il tipo di evento specificato.	EventDispatcher

Eventi

Fate clic per visualizzare altre informazioni sugli eventi

Nascondi eventi ereditati

Mostra eventi ereditati

	Evento		Riepilogo	Definito da
		activate	[evento di trasmissione] Inviato quando Flash Player o l'applicazione AIR ottiene lo stato di attivazione del sistema operativo ed entra nello stato attivo.	EventDispatcher
		deactivate	[evento di trasmissione] Inviato quando Flash Player o l'applicazione AIR perde l'attivazione del sistema operativo e sta entrando nello stato inattivo.	EventDispatcher

Descrizione delle proprietà

hasRoot

proprietà

hasRoot:Boolean [sola lettura]

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

A flag that, if true, indicates that the current data provider has a root node; for example, a single top-level node in a hierarchical structure. XML and Object are examples of data types that have a root node, while Lists and Arrays do not.

Implementazione
public function get hasRoot():Boolean

length

proprietà

length:int [sola lettura]

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

The length of the currently parsed collection.

Implementazione
public function get length():int

openNodes

proprietà

openNodes:Object

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

An Array of Objects containing the data provider element for all the open branch nodes of the data.

Implementazione
public function get openNodes():Object
public function set openNodes(value:Object):void

showRoot

proprietà

showRoot:Boolean

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

A Boolean flag that specifies whether to display the data provider's root node. If the source data has a root node, and this property is set to false, the collection will not include the root item. Only the descendants of the root item will be included in the collection.

This property has no effect on a source with no root node, such as List and Array objects.

Il valore predefinito è true.

Questa proprietà può essere utilizzata come origine per l’associazione di dati. Quando questa proprietà viene modificata, invia l’evento propertyChange .

Implementazione
public function get showRoot():Boolean
public function set showRoot(value:Boolean):void

source

proprietà

source:IHierarchicalData

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

The source data of the IHierarchicalCollectionView.

Implementazione
public function get source():IHierarchicalData
public function set source(value:IHierarchicalData):void

Descrizione della funzione di costruzione

()

Funzione di costruzione

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

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Constructor.

Parametri

	`hierarchicalData:IHierarchicalData` (default = `null`) — The data structure containing the hierarchical data.

	`argOpenNodes:Object` (default = `null`) — The Object that defines a node to appear as open.

Descrizione dei metodi

addChild

()

metodo

public function addChild(parent:Object, newChild:Object):Boolean

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Adds a child node to a node of the data.

Parametri

	`parent:Object` — The Object that defines the parent node.

	`newChild:Object` — The Object that defines the new node.

Restituisce

Boolean — true if the node is added successfully.

addChildAt

()

metodo

public function addChildAt(parent:Object, newChild:Object, index:int):Boolean

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Add a child node to a node at the specified index. This implementation does the following:

If the parent is null or undefined, inserts the child at the specified index in the collection specified by source.
If the parent has a children field or property, the method adds the child to it at the index location. In this case, the source is not required.
If the parent does not have a children field or property, the method adds the children to the parent. The method then adds the child to the parent at the index location. In this case, the source is not required.
If the index value is greater than the collection length or number of children in the parent, adds the object as the last child.

Parametri

	`parent:Object` — The Object that defines the parent node.

	`newChild:Object` — The Object that defines the child node.

	`index:int` — The 0-based index of where to insert the child node.

Restituisce

Boolean — true if the child is added successfully.

closeNode

()

metodo

public function closeNode(node:Object):void

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Closes a node to hide its children.

Parametri

node:Object — The Object that defines the node.

contains

()

metodo

public function contains(item:Object):Boolean

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Checks the collection for the data item using standard equality test.

Parametri

item:Object — The Object that defines the node to look for.

Restituisce

Boolean — true if the data item is in the collection, and false if not.

createCursor

()

metodo

public function createCursor():IViewCursor

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Returns a new instance of a view iterator over the items in this view.

Restituisce

IViewCursor — IViewCursor instance.

Elementi API correlati

mx.utils.IViewCursor

getChildren

()

metodo

public function getChildren(node:Object):ICollectionView

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Returns a collection of children, if they exist.

Parametri

node:Object — The Object that defines the node. If null, return a collection of top level nodes.

Restituisce

ICollectionView — ICollectionView instance containing the child nodes.

getNodeDepth

()

metodo

public function getNodeDepth(node:Object):int

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Returns the depth of the node in the collection.

Parametri

node:Object — The Object that defines the node.

Restituisce

int — The depth of the node.

getParentItem

()

metodo

public function getParentItem(node:Object):*

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Returns the parent of a node. The parent of a top-level node is null.

Parametri

node:Object — The Object that defines the node.

Restituisce

* — The parent node containing the node, null for a top-level node, and undefined if the parent cannot be determined.

openNode

()

metodo

public function openNode(node:Object):void

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Opens a node to display its children.

Parametri

node:Object — The Object that defines the node.

refresh

()

metodo

public function refresh():Boolean

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Applies the sort and filter to the view. The ICollectionView does not detect changes to a sort or filter automatically, so you must call the refresh() method to update the view after setting the sort or filterFunction property. If your ICollectionView implementation also implements the IMXMLObject interface, you should to call the refresh() method from your initialized() method.

Returns true if the refresh was successful and false if the sort is not yet complete (e.g., items are still pending). A client of the view should wait for a CollectionEvent event with the CollectionEventKind.REFRESH kind property to ensure that the refresh() operation is complete.

Restituisce

Boolean — true if the refresh() was complete, false if the refresh() is incomplete.

removeChild

()

metodo

public function removeChild(parent:Object, child:Object):Boolean

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Removes the child node from the parent node.

Parametri

	`parent:Object` — The Object that defines the parent node, and `null` for top-level nodes.

	`child:Object` — The Object that defines the child node to be removed.

Restituisce

Boolean — true if the node is removed successfully.

removeChildAt

()

metodo

public function removeChildAt(parent:Object, index:int):Boolean

Versione linguaggio:

ActionScript 3.0

Versione prodotto:

Flex 3

Versioni runtime:

Flash Player 9, AIR 1.1

Removes the child node from a node at the specified index.

Parametri

	`parent:Object` — The Object that defines the parent node.

	`index:int` — The 0-based index of the child node to remove relative to the parent.

Restituisce

Boolean — true if the child is removed successfully.

Note legali | Informativa sulla privacy online

HierarchicalCollectionView - AS3 Flex

Pacchettix

Elementi del linguaggio

Appendici

Pacchetto mx.collections

hasRoot

length

openNodes

showRoot

source