（仅限 Flex 数据可视化组件）
包mx.collections
接口public interface IHierarchicalCollectionView extends ICollectionView , IEventDispatcher
实现器 HierarchicalCollectionView

IHierarchicalCollectionView 接口定义用于层次结构数据或分组数据的接口。通常，将此数据与 AdvancedDataGrid 控件一起使用。

另请参见

mx.controls.AdvancedDataGrid

公共属性
 属性定义方
 InheritedfilterFunction : Function
视图用来消除不符合函数条件的项目的函数。
ICollectionView
  hasRoot : Boolean
[只读 (read-only)] 一种标志，如果为 true，表示当前数据提供程序具有根节点；例如，层次结构中的单个顶级节点。
IHierarchicalCollectionView
 Inheritedlength : int
[只读 (read-only)] 此视图中的项目数。
ICollectionView
  openNodes : Object
包含数据的所有开型分枝节点的数据提供程序元素的对象 Array。
IHierarchicalCollectionView
  showRoot : Boolean
指定是否显示数据提供程序的根节点的布尔值标志。
IHierarchicalCollectionView
 Inheritedsort : Sort
将应用于 ICollectionView 的排序。
ICollectionView
  source : IHierarchicalData
IHierarchicalCollectionView 的源数据。
IHierarchicalCollectionView
公共方法
 方法定义方
  
addChild(parent:Object, newChild:Object):Boolean
为数据的节点添加子节点。
IHierarchicalCollectionView
  
addChildAt(parent:Object, newChild:Object, index:int):Boolean
在数据的特定索引处为数据的节点添加子节点。
IHierarchicalCollectionView
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。
IEventDispatcher
  
closeNode(node:Object):void
关闭要隐藏其子项的节点。
IHierarchicalCollectionView
 Inherited
contains(item:Object):Boolean
返回指示视图是否包含指定对象的信息。
ICollectionView
 Inherited
createCursor():IViewCursor
创建使用此视图的新 IViewCursor。
ICollectionView
 Inherited
disableAutoUpdate():void
防止视图调度对集合本身和集合中的项目的更改。
ICollectionView
 Inherited
dispatchEvent(event:Event):Boolean
将事件调度到事件流中。
IEventDispatcher
 Inherited
enableAutoUpdate():void
启用自动更新。
ICollectionView
  
getChildren(node:Object):ICollectionView
返回子项的集合（如果存在）。
IHierarchicalCollectionView
  
getNodeDepth(node:Object):int
返回集合中节点的深度。
IHierarchicalCollectionView
  
getParentItem(node:Object):*
返回节点的父项。
IHierarchicalCollectionView
 Inherited
hasEventListener(type:String):Boolean
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。
IEventDispatcher
 Inherited
itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
通知视图，某个项目已更新。
ICollectionView
  
openNode(node:Object):void
打开要显示其子项的节点。
IHierarchicalCollectionView
 Inherited
refresh():Boolean
将排序和滤镜应用到视图。
ICollectionView
  
removeChild(parent:Object, child:Object):Boolean
从父节点删除子节点。
IHierarchicalCollectionView
  
removeChildAt(parent:Object, index:int):Boolean
从指定索引处的节点删除子节点。
IHierarchicalCollectionView
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
从 EventDispatcher 对象中删除侦听器。
IEventDispatcher
 Inherited
willTrigger(type:String):Boolean
检查是否用此 EventDispatcher 对象或其任何始祖为指定事件类型注册了事件侦听器。
IEventDispatcher
属性详细信息
hasRoot属性
hasRoot:Boolean  [只读 (read-only)]

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



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

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



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

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

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

默认值为 true.



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

另请参见

hasRoot
source属性 
source:IHierarchicalData  [读写]

IHierarchicalCollectionView 的源数据。



实现
    public function get source():IHierarchicalData
    public function set source(value:IHierarchicalData):void
方法详细信息
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。

getChildren()方法 
public function getChildren(node:Object):ICollectionView

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

参数

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

返回
ICollectionView — 包含子节点的 ICollectionView 实例。
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 — 当前作为此子节点父项的节点对象。对于顶级节点，请将 parent 设置为 null。
 
index:int — 要删除的子节点（相对于父项）的从零开始的索引。

返回
Boolean — 如果成功，则为 true；如果失败，则为 false。



© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Sun Dec 14 2008, 10:39 PM -08:00