DefaultDataDescriptor

包	mx.controls.treeClasses
类	public class DefaultDataDescriptor
继承	DefaultDataDescriptor Object
实现	ITreeDataDescriptor2, IMenuDataDescriptor

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

DefaultDataDescriptor 类提供了访问和操作数据的默认实现，以便在控件（如 Tree 和 Menu）中使用这些数据。此实现处理 e4x XML 和 object 节点的方式相似，但不尽相同。有关如何使用该方法访问各种节点中的值的详细信息，请参阅每个方法的描述。此类是 Tree、Menu、MenuBar 和 PopUpMenuButton 控件 dataDescriptor 属性的默认值。

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		DefaultDataDescriptor() 构造函数。	DefaultDataDescriptor
		addChildAt(parent:Object, newChild:Object, index:int, model:Object = null):Boolean 将子节点添加到指定索引处的节点。	DefaultDataDescriptor
		getChildren(node:Object, model:Object = null):ICollectionView 提供对节点子项的访问。	DefaultDataDescriptor
		getData(node:Object, model:Object = null):Object 返回节点的数据。	DefaultDataDescriptor
		getGroupName(node:Object):String 返回节点所属的单选按钮组的名称（如果存在）。	DefaultDataDescriptor
		getHierarchicalCollectionAdaptor(hierarchicalData:ICollectionView, uidFunction:Function, openItems:Object, model:Object = null):ICollectionView 返回将层次结构数据显示为线性 ICollectionView 实例的 ICollectionView 实例。	DefaultDataDescriptor
		getNodeDepth(node:Object, iterator:IViewCursor, model:Object = null):int 返回节点的深度，即节点具有的祖代数。	DefaultDataDescriptor
		getParent(node:Object, collection:ICollectionView, model:Object = null):Object 返回节点的父节点，顶级节点的父节点为 null。	DefaultDataDescriptor
		getType(node:Object):String 返回节点的类型标识符。	DefaultDataDescriptor
		hasChildren(node:Object, model:Object = null):Boolean 确定节点实际是否有子节点。	DefaultDataDescriptor
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		isBranch(node:Object, model:Object = null):Boolean 测试节点的终止性。	DefaultDataDescriptor
		isEnabled(node:Object):Boolean 返回是否已启用节点。	DefaultDataDescriptor
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		isToggled(node:Object):Boolean 返回是否已切换节点。	DefaultDataDescriptor
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		removeChildAt(parent:Object, child:Object, index:int, model:Object = null):Boolean 从指定索引处的节点删除子节点。	DefaultDataDescriptor
		setEnabled(node:Object, value:Boolean):void 设置数据提供程序中用于标识是否已启用节点的字段或属性的值。	DefaultDataDescriptor
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		setToggled(node:Object, value:Boolean):void 设置数据提供程序中用于标识是否已切换节点的字段或属性的值。	DefaultDataDescriptor
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		valueOf():Object 返回指定对象的原始值。	Object

构造函数详细信息

()

构造函数

public function DefaultDataDescriptor()

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

构造函数。

方法详细信息

addChildAt

()

方法

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

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

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

如果 parent 参数为 null 或尚未定义，则会在 model 参数指定的集合中的指定索引处插入 child 参数。
如果 parent 参数包含 children 字段或属性，则此方法会向其在 index 参数位置添加 child 参数。在这种情况下，不需要 model 参数。
如果 parent 参数不包含 children 字段或属性，则此方法会向 parent 添加 children 属性。然后此方法会向父级在 index 参数位置上添加 child 参数。在这种情况下，不需要 model 参数。
如果 index 值大于集合长度或父节点中的子节点数，则将对象添加为最后一个子节点。

参数

	`parent:Object` — 将成为子节点父级的节点对象。

	`newChild:Object` — 节点将成为其父级的节点对象。

	`index:int` — 要从中放置子节点（相对于父项）的从零开始的索引。

	`model:Object` (default = `null`) — 包含此节点的整个集合。

Boolean — 如果成功，则为 true.

getChildren

()

方法

public function getChildren(node:Object, model:Object = null):ICollectionView

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

提供对节点子项的访问。如果存在，则返回节点子项的集合。如果节点是 Object，此方法会将该对象 children 字段的内容作为 ArrayCollection 返回。如果节点是 XML，此方法将返回包含子元素的 XMLListCollection。

参数

	`node:Object` — 当前计算的节点对象。

	`model:Object` (default = `null`) — 包含节点的集合；此类会将其忽略。

ICollectionView — 包含子节点的对象。

getData

()

方法

public function getData(node:Object, model:Object = null):Object

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

返回节点的数据。当前返回整个节点。

参数

	`node:Object` — 当前计算的节点对象。

	`model:Object` (default = `null`) — 包含节点的集合；此类会将其忽略。

Object — 节点。

getGroupName

()

方法

public function getGroupName(node:Object):String

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

返回节点所属的单选按钮组的名称（如果存在）。基于菜单的控件使用此方法。

参数

node:Object — 要获得组名称的节点。

String — 节点的 groupName 属性或字段的值；如果不存在此类条目，则为空字符串。

getHierarchicalCollectionAdaptor

()

方法

 public function getHierarchicalCollectionAdaptor(hierarchicalData:ICollectionView, uidFunction:Function, openItems:Object, model:Object = null):ICollectionView

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

返回将层次结构数据显示为线性 ICollectionView 实例的 ICollectionView 实例。

参数

	`hierarchicalData:ICollectionView` — 层次结构数据。

	`uidFunction:Function` — 使用 Object 并以 String 形式返回 UID 的函数。此参数通常为 `Tree.itemToUID()` 方法。

	`openItems:Object` — 已打开或已设置为打开的项目。

	`model:Object` (default = `null`) — 此节点所属的集合。

ICollectionView — ICollectionView 实例。

getNodeDepth

()

方法

public function getNodeDepth(node:Object, iterator:IViewCursor, model:Object = null):int

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

返回节点的深度，即节点具有的祖代数。

参数

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

	`iterator:IViewCursor` — 可用于计算的 IViewCursor 实例。

	`model:Object` (default = `null`) — 此节点所属的集合。

int — 节点的深度，其中 0 对应顶级，如果深度无法计算则为 -1。

getParent

()

方法

public function getParent(node:Object, collection:ICollectionView, model:Object = null):Object

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

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

参数

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

	`collection:ICollectionView` — 可用于计算的 ICollectionView 实例。

	`model:Object` (default = `null`) — 此节点所属的集合。

Object — 包含作为子项的节点的父节点，如果为顶级节点，则返回 null；如果无法确定父节点，则返回 undefined。

getType

()

方法

public function getType(node:Object):String

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

返回节点的类型标识符。基于菜单的控件使用此方法确定节点是否提供分隔符、单选按钮、复选框或常规项目。

参数

node:Object — 要获得类型的节点对象。

String — type 属性或字段的值，或空字符串（如果不存在这样的字段）。

hasChildren

()

方法

public function hasChildren(node:Object, model:Object = null):Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

确定节点实际是否有子节点。

参数

	`node:Object` — 当前计算的节点对象。

	`model:Object` (default = `null`) — 包含节点的集合；此类会将其忽略。

Boolean — 如果此节点当前有子节点，则为 true。

isBranch

()

方法

public function isBranch(node:Object, model:Object = null):Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

测试节点的终止性。分支是非终止的但无需包含任何叶节点。如果节点是 XML 且节点包含子节点或 true isBranch 属性，则返回 true。如果节点是一个对象且节点包含（可能为空）children 字段，则返回 true。

参数

	`node:Object` — 当前计算的节点对象。

	`model:Object` (default = `null`) — 包含节点的集合；此类会将其忽略。

Boolean — 如果此节点不是终端节点，则为 true。

isEnabled

()

方法

public function isEnabled(node:Object):Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

返回是否已启用节点。基于菜单的控件使用此方法。

参数

node:Object — 要获得状态的节点。

Boolean — 节点的 enabled 属性或字段的值；如果不存在此类条目或值不是 false，则为 true。

isToggled

()

方法

public function isToggled(node:Object):Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

返回是否已切换节点。基于菜单的控件使用此方法。

参数

node:Object — 要获得状态的节点。

Boolean — 节点的 toggled 属性或字段的值；如果不存在此类条目，则为 false。

removeChildAt

()

方法

public function removeChildAt(parent:Object, child:Object, index:int, model:Object = null):Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

从指定索引处的节点删除子节点。如果 parent 参数为 null 或尚未定义，则此方法使用 model 参数访问子节点；否则使用 parent 参数并忽略 model 参数。

参数

	`parent:Object` — 当前作为此子节点父项的节点对象。

	`child:Object` — 正在删除的节点。

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

	`model:Object` (default = `null`) — 包含此节点的整个集合。

Boolean — 如果成功，则为 true.

setEnabled

()

方法

public function setEnabled(node:Object, value:Boolean):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

设置数据提供程序中用于标识是否已启用节点的字段或属性的值。此方法设置节点的 enabled 属性或字段的值。基于菜单的控件使用此方法。

参数

	`node:Object` — 要设置状态的节点。

	`value:Boolean` — 是否已启用节点。

setToggled

()

方法

public function setToggled(node:Object, value:Boolean):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

设置数据提供程序中用于标识是否已切换节点的字段或属性的值。此方法设置节点的 toggled 属性或字段的值。基于菜单的控件使用此方法。

参数

	`node:Object` — 要设置状态的节点。

	`value:Boolean` — 是否已切换节点。

法律声明 | 在线隐私策略

DefaultDataDescriptor - AS3 Flex

包x

语言元素

附录

包 mx.controls.treeClasses