HierarchicalCollectionView

Paket	mx.collections
Klass	public class HierarchicalCollectionView
Arv	HierarchicalCollectionView EventDispatcher Object
Implementerar	IHierarchicalCollectionView, IXMLNotifiable

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

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

MXML-syntax expanded

Dölj MXML-syntax

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

Publika egenskaper

Dölj ärvda publika egenskaper

Visa ärvda publika egenskaper

	Egenskap		Definieras med
		constructor : Object En referens till klassobjektet eller konstruktorfunktionen för en given objektinstans.	Object
		hasRoot : Boolean [skrivskyddad] 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 [skrivskyddad] 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

Publika metoder

Dölj ärvda publika metoder

Visa ärvda publika metoder

	Metod		Definieras med
		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 Registrerar ett händelseavlyssnarobjekt för ett EventDispatcher-objekt så att avlyssnaren får meddelanden om händelser.	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 Skickar en händelse till händelseflödet.	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 Kontrollerar om EventDispatcher-objektet har några avlyssnare registrerade för en viss typ av händelse.	EventDispatcher
		hasOwnProperty(name:String):Boolean Anger om det finns en egenskap angiven för ett objekt.	Object
		isPrototypeOf(theClass:Object):Boolean Anger om en instans av klassen Object finns i prototypkedjan för objektet som anges som parameter.	Object
		openNode(node:Object):void Opens a node to display its children.	HierarchicalCollectionView
		propertyIsEnumerable(name:String):Boolean Anger om den angivna egenskapen finns och är uppräkningsbar.	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 Tar bort en avlyssnare från EventDispatcher-objektet.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Anger tillgänglighet för en dynamisk egenskap för slingåtgärder.	Object
		toLocaleString():String Returnerar det här objektets strängrepresentation, formaterad i enlighet med språkspecifika konventioner.	Object
		toString():String Returnerar det angivna objektets strängbeteckning.	Object
		valueOf():Object Returnerar det angivna objektets primitiva värde.	Object
		willTrigger(type:String):Boolean Kontrollerar om en händelseavlyssnare är registrerad för det här EventDispatcher-objektet eller något av dess överordnade objekt för den angivna händelsetypen.	EventDispatcher

Händelser

Klicka för mer information om händelser

Dölj ärvda händelser

Visa ärvda händelser

	Händelse		Sammanfattning	Definieras med
		activate	[utsändningshändelse] Skickas när Flash Player eller AIR får operativsystemfokus och blir aktivt.	EventDispatcher
		deactivate	[utsändningshändelse] Skickas när Flash Player eller AIR förlorar operativsystemfokus och blir inaktivt.	EventDispatcher

Egenskapsdetaljer

hasRoot

egenskap

hasRoot:Boolean [skrivskyddad]

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

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.

Implementering
public function get hasRoot():Boolean

length

egenskap

length:int [skrivskyddad]

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

The length of the currently parsed collection.

Implementering
public function get length():int

openNodes

egenskap

openNodes:Object

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

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

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

showRoot

egenskap

showRoot:Boolean

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

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.

Standardvärdet är true.

Den här egenskapen kan användas som källan för databindning. När den här egenskapen ändras, skickas händelsen propertyChange .

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

source

egenskap

source:IHierarchicalData

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

The source data of the IHierarchicalCollectionView.

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

Konstruktordetaljer

()

Konstruktor

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

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

Constructor.

Parametrar

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

Metoddetaljer

addChild

()

metod

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

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

Adds a child node to a node of the data.

Parametrar

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

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

Returnerar

Boolean — true if the node is added successfully.

addChildAt

()

metod

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

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

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.

Parametrar

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

Returnerar

Boolean — true if the child is added successfully.

closeNode

()

metod

public function closeNode(node:Object):void

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

Closes a node to hide its children.

Parametrar

node:Object — The Object that defines the node.

contains

()

metod

public function contains(item:Object):Boolean

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

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

Parametrar

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

Returnerar

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

createCursor

()

metod

public function createCursor():IViewCursor

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

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

Returnerar

IViewCursor — IViewCursor instance.

Relaterade API-element

mx.utils.IViewCursor

getChildren

()

metod

public function getChildren(node:Object):ICollectionView

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

Returns a collection of children, if they exist.

Parametrar

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

Returnerar

ICollectionView — ICollectionView instance containing the child nodes.

getNodeDepth

()

metod

public function getNodeDepth(node:Object):int

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

Returns the depth of the node in the collection.

Parametrar

node:Object — The Object that defines the node.

Returnerar

int — The depth of the node.

getParentItem

()

metod

public function getParentItem(node:Object):*

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

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

Parametrar

node:Object — The Object that defines the node.

Returnerar

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

openNode

()

metod

public function openNode(node:Object):void

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

Opens a node to display its children.

Parametrar

node:Object — The Object that defines the node.

refresh

()

metod

public function refresh():Boolean

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

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.

Returnerar

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

removeChild

()

metod

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

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

Removes the child node from the parent node.

Parametrar

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

Returnerar

Boolean — true if the node is removed successfully.

removeChildAt

()

metod

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

Språkversion:

ActionScript 3.0

Produktversion:

Flex 3

Körningsmiljöversioner:

Flash Player 9, AIR 1.1

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

Parametrar

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

Returnerar

Boolean — true if the child is removed successfully.

Juridiska meddelanden | Onlinesekretesspolicy

HierarchicalCollectionView - AS3 Flex

Klasser x

hasRoot

length

openNodes

showRoot

source