(仅限 Flex 数据可视化组件)
mx.collections
public class HierarchicalCollectionView
继承HierarchicalCollectionView Inheritance EventDispatcher Inheritance Object
实现 IHierarchicalCollectionView

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

MXML 语法expanded隐藏 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"
  />
  


公共属性
 属性定义方
 Inheritedconstructor : Object
对类对象或给定对象实例的构造函数的引用。
Object
  hasRoot : Boolean
[只读 (read-only)] 一种标志,如果为 true,表示当前数据提供程序具有根节点;例如,层次结构中的单个顶级节点。
HierarchicalCollectionView
  length : int
[只读 (read-only)] 当前分析的集合的长度。
HierarchicalCollectionView
  openNodes : Object
包含数据的所有开型分枝节点的数据提供程序元素的对象 Array。
HierarchicalCollectionView
 Inheritedprototype : Object
[静态] 对类或函数对象的原型对象的引用。
Object
  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
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
使用 EventDispatcher 对象注册事件侦听器对象,以使侦听器能够接收事件通知。
EventDispatcher
  
关闭要隐藏其子项的节点。
HierarchicalCollectionView
  
使用标准相等测试检查数据项目的集合。
HierarchicalCollectionView
  
返回此视图中有关项目的视图迭代器的新实例。
HierarchicalCollectionView
 Inherited
将事件调度到事件流中。
EventDispatcher
  
返回集合中节点的深度。
HierarchicalCollectionView
  
返回节点的父项。
HierarchicalCollectionView
 Inherited
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。
EventDispatcher
 Inherited
指示对象是否已经定义了指定的属性。
Object
 Inherited
指示 Object 类的实例是否在指定为参数的对象的原型链中。
Object
  
打开要显示其子项的节点。
HierarchicalCollectionView
 Inherited
指示指定的属性是否存在、是否可枚举。
Object
  
从父节点删除子节点。
HierarchicalCollectionView
  
从指定索引处的节点删除子节点。
HierarchicalCollectionView
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
从 EventDispatcher 对象中删除侦听器。
EventDispatcher
 Inherited
设置循环操作动态属性的可用性。
Object
 Inherited
返回指定对象的字符串表示形式。
Object
 Inherited
返回指定对象的原始值。
Object
 Inherited
检查是否用此 EventDispatcher 对象或其任何始祖为指定事件类型注册了事件侦听器。
EventDispatcher
  
xmlNotification(currentTarget:Object, type:String, target:Object, value:Object, detail:Object):void
只要包含在列表中的 XML 对象以某种方式更新,就进行调用。
HierarchicalCollectionView
事件
 事件 摘要 定义方
 Inherited[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。EventDispatcher
 Inherited[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。EventDispatcher
属性详细信息
hasRoot属性
hasRoot:Boolean  [只读 (read-only)]

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



实现
    public function get hasRoot():Boolean
length属性 
length:int  [只读 (read-only)]

当前分析的集合的长度。



实现
    public function get length():int
openNodes属性 
openNodes:Object  [读写]

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



实现
    public function get openNodes():Object
    public function set openNodes(value:Object):void
showRoot属性 
showRoot:Boolean  [读写]

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

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

默认值为 true.

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



实现
    public function get showRoot():Boolean
    public function set showRoot(value:Boolean):void
source属性 
source:IHierarchicalData  [读写]

IHierarchicalCollectionView 的源数据。



实现
    public function get source():IHierarchicalData
    public function set source(value:IHierarchicalData):void
构造函数详细信息
HierarchicalCollectionView()构造函数
public function HierarchicalCollectionView(hierarchicalData:IHierarchicalData = null, argOpenNodes:Object = null)

构造函数。

参数
hierarchicalData:IHierarchicalData (default = null) — 包含层次结构数据的数据结构。
 
argOpenNodes:Object (default = null) — 用于定义显示为起始位置的节点的 Object。
方法详细信息
addChild()方法
public function addChild(parent:Object, newChild:Object):Boolean

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

参数

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

返回
Boolean — 如果成功添加节点,则为 true
addChildAt()方法 
public function addChildAt(parent:Object, newChild:Object, index:int):Boolean

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

参数

parent:Object — 用于定义父节点的 Object。
 
newChild:Object — 用于定义子节点的 Object。
 
index:int — 要在该处插入子节点的从零开始的索引。

返回
Boolean — 如果成功添加子节点,则为 true
closeNode()方法 
public function closeNode(node:Object):void

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

参数

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

contains()方法 
public function contains(item:Object):Boolean

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

参数

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

返回
Boolean — 如果数据项目位于集合中,则为 true,否则为 false
createCursor()方法 
public function createCursor():IViewCursor

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

返回
IViewCursor — IViewCursor 实例。

另请参见

mx.utils.IViewCursor
getNodeDepth()方法 
public function getNodeDepth(node:Object):int

返回集合中节点的深度。

参数

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

返回
int — 节点的深度。
getParentItem()方法 
public function getParentItem(node:Object):*

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

参数

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

返回
* — 包含该节点的父节点;如果为顶级节点,则为 null;如果无法确定父节点,则为 undefined
openNode()方法 
public function openNode(node:Object):void

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

参数

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

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

从父节点删除子节点。

参数

parent:Object — 用于定义父节点的 Object;对于顶级节点,为 null
 
child:Object — 用于定义要删除的子节点的 Object。

返回
Boolean — 如果成功删除节点,则为 true
removeChildAt()方法 
public function removeChildAt(parent:Object, index:int):Boolean

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

参数

parent:Object — 用于定义父节点的 Object。
 
index:int — 要删除的相对于父项的子节点的从零开始的索引。

返回
Boolean — 如果成功删除子节点,则返回 true
xmlNotification()方法 
public function xmlNotification(currentTarget:Object, type:String, target:Object, value:Object, detail:Object):void

只要包含在列表中的 XML 对象以某种方式更新,就进行调用。初始实现尝试非常宽广,无论在层次结构中的深度如何,任一 changeType 都会导致更新。

参数

currentTarget:Object
 
type:String
 
target:Object
 
value:Object
 
detail:Object