HierarchicalCollectionView

包	mx.collections
类	public class HierarchicalCollectionView
继承	HierarchicalCollectionView EventDispatcher Object
实现	IHierarchicalCollectionView, IXMLNotifiable

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

HierarchicalCollectionView 类提供标准集合的层次结构视图。

MXML 语法

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

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		hasRoot : Boolean [只读] 一种标志，如果为 true，表示当前数据提供程序具有根节点；例如，层次结构中的单个顶级节点。	HierarchicalCollectionView
		length : int [只读] 当前分析的集合的长度。	HierarchicalCollectionView
		openNodes : Object 包含数据的所有开型分枝节点的数据提供程序元素的对象 Array。	HierarchicalCollectionView
		showRoot : Boolean 指定是否显示数据提供程序的根节点的布尔值标志。	HierarchicalCollectionView
		source : IHierarchicalData IHierarchicalCollectionView 的源数据。	HierarchicalCollectionView

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		HierarchicalCollectionView(hierarchicalData:IHierarchicalData = null, argOpenNodes:Object = null) 构造函数。	HierarchicalCollectionView
		addChild(parent:Object, newChild:Object):Boolean 为数据的节点添加子节点。	HierarchicalCollectionView
		addChildAt(parent:Object, newChild:Object, index:int):Boolean 将子节点添加到指定索引处的节点。	HierarchicalCollectionView
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	EventDispatcher
		closeNode(node:Object):void 关闭要隐藏其子项的节点。	HierarchicalCollectionView
		contains(item:Object):Boolean 使用标准相等测试检查数据项目的集合。	HierarchicalCollectionView
		createCursor():IViewCursor 返回此视图中有关项目的视图迭代器的新实例。	HierarchicalCollectionView
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	EventDispatcher
		getChildren(node:Object):ICollectionView 返回子项的集合（如果存在）。	HierarchicalCollectionView
		getNodeDepth(node:Object):int 返回集合中节点的深度。	HierarchicalCollectionView
		getParentItem(node:Object):* 返回节点的父项。	HierarchicalCollectionView
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	EventDispatcher
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		openNode(node:Object):void 打开要显示其子项的节点。	HierarchicalCollectionView
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		refresh():Boolean 将排序和滤镜应用到视图。	HierarchicalCollectionView
		removeChild(parent:Object, child:Object):Boolean 从父节点删除子节点。	HierarchicalCollectionView
		removeChildAt(parent:Object, index:int):Boolean 从指定索引处的节点删除子节点。	HierarchicalCollectionView
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		valueOf():Object 返回指定对象的原始值。	Object
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	EventDispatcher

事件

单击此处了解有关事件的更多信息

隐藏继承的事件

显示继承的事件

	事件		摘要	由以下参数定义
		activate	[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。	EventDispatcher
		deactivate	[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。	EventDispatcher

属性详细信息

hasRoot

属性

hasRoot:Boolean [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

一种标志，如果为 true，表示当前数据提供程序具有根节点；例如，层次结构中的单个顶级节点。XML 和 Object 就是具有根节点的数据类型，而 Lists 和 Arrays 不属于这种数据类型。

实现
public function get hasRoot():Boolean

length

属性

length:int [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

当前分析的集合的长度。

实现
public function get length():int

openNodes

属性

openNodes:Object

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

包含数据的所有开型分枝节点的数据提供程序元素的对象 Array。

实现
public function get openNodes():Object
public function set openNodes(value:Object):void

showRoot

属性

showRoot:Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

指定是否显示数据提供程序的根节点的布尔值标志。如果源数据具有根节点，并且此属性设置为 false，则该集合中将不包含根项目。该集合中将仅包含此根项目的后代。

此属性不影响没有根节点的源，如 List 和 Array 对象。

默认值为 true。

此属性可用作数据绑定的源。修改此属性后，将调度 propertyChange 事件。

实现
public function get showRoot():Boolean
public function set showRoot(value:Boolean):void

source

属性

source:IHierarchicalData

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

IHierarchicalCollectionView 的源数据。

实现
public function get source():IHierarchicalData
public function set source(value:IHierarchicalData):void

构造函数详细信息

()

构造函数

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

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

构造函数。

参数

	`hierarchicalData:IHierarchicalData` (default = `null`) — 包含层次结构数据的数据结构。

	`argOpenNodes:Object` (default = `null`) — 用于定义显示为起始位置的节点的 Object。

方法详细信息

addChild

()

方法

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

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

为数据的节点添加子节点。

参数

	`parent:Object` — 用于定义父节点的 Object。

	`newChild:Object` — 用于定义新节点的 Object。

Boolean — 如果成功添加节点，则为 true。

addChildAt

()

方法

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

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

将子节点添加到指定索引处的节点。此实现执行以下操作：

如果 parent 为空或未定义，则在 source 指定的集合中的指定 index 处插入 child。
如果 parent 包含 children 字段或属性，则该方法会将 child 添加到父节点的 index 位置。在这种情况下，不需要使用 source。
如果 parent 不包含 children 字段或属性，则该方法会将 children 添加到 parent。然后，此方法将 child 添加到父节点的 index 位置。在这种情况下，不需要使用 source。
如果 index 值大于集合长度或父节点中的子节点数，则将对象添加为最后一个子节点。

参数

	`parent:Object` — 用于定义父节点的 Object。

	`newChild:Object` — 用于定义子节点的 Object。

	`index:int` — 要在该处插入子节点的从零开始的索引。

Boolean — 如果成功添加子节点，则为 true。

closeNode

()

方法

public function closeNode(node:Object):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

关闭要隐藏其子项的节点。

参数

node:Object — 定义该节点的 Object。

contains

()

方法

public function contains(item:Object):Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

使用标准相等测试检查数据项目的集合。

参数

item:Object — 用于定义要查找的节点的 Object。

Boolean — 如果数据项目位于集合中，则为 true，否则为 false。

createCursor

()

方法

public function createCursor():IViewCursor

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

返回此视图中有关项目的视图迭代器的新实例。

IViewCursor — IViewCursor 实例。

getChildren

()

方法

public function getChildren(node:Object):ICollectionView

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

返回子项的集合（如果存在）。

参数

node:Object — 定义该节点的 Object。如果为 null，则返回顶级节点的集合。

ICollectionView — 包含子节点的 ICollectionView 实例。

getNodeDepth

()

方法

public function getNodeDepth(node:Object):int

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

返回集合中节点的深度。

参数

node:Object — 定义该节点的 Object。

int — 节点的深度。

getParentItem

()

方法

public function getParentItem(node:Object):*

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

返回节点的父项。顶级节点的父项为 null。

参数

node:Object — 定义该节点的 Object。

* — 包含该节点的父节点；如果为顶级节点，则为 null；如果无法确定父节点，则为 undefined。

openNode

()

方法

public function openNode(node:Object):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

打开要显示其子项的节点。

参数

node:Object — 定义该节点的 Object。

refresh

()

方法

public function refresh():Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

将排序和滤镜应用到视图。ICollectionView 不自动检测对排序或滤镜的更改，因此您必须在设置 sort 或 filterFunction 属性后调用 refresh() 方法以更新视图。如果 ICollectionView 实现也实现 IMXMLObject 接口，则应从 initialized() 方法调用 refresh() 方法。

如果刷新成功，则返回 true；如果排序尚未完成（例如，项目仍待处理），则返回 false。视图的客户端应等待执行带有 CollectionEventKind.REFRESH kind 属性的 CollectionEvent 事件以确保完成 refresh() 操作。

Boolean — 如果已经完成 refresh()，则为 true；如果未完成 refresh()，则为 false。

removeChild

()

方法

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

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

从父节点删除子节点。

参数

	`parent:Object` — 用于定义父节点的 Object；对于顶级节点，为 `null`。

	`child:Object` — 用于定义要删除的子节点的 Object。

Boolean — 如果成功删除节点，则为 true。

removeChildAt

()

方法

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

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

从指定索引处的节点删除子节点。

参数

	`parent:Object` — 用于定义父节点的 Object。

	`index:int` — 要删除的相对于父项的子节点的从零开始的索引。

Boolean — 如果成功删除子节点，则返回 true。

法律声明 | 在线隐私策略

HierarchicalCollectionView - AS3 Flex

包x

语言元素

附录

包 mx.collections

hasRoot

length

openNodes

showRoot

source