mx.controls.menuClasses
接口public interface IMenuDataDescriptor
实现器 DefaultDataDescriptor

IMenuDataDescriptor 接口定义 Menu 或 MenuBar 控件的 dataDescriptor 必须实现的接口。此接口提供了分析和修改通过 Menu 或 MenuBar 控件显示的数据集合的方法。

另请参见

mx.collections.ICollectionView
Using Menu-Based Controls


公共方法
 方法定义方
  
addChildAt(parent:Object, newChild:Object, index:int, model:Object = null):Boolean
将子节点添加到指定索引处的节点。
IMenuDataDescriptor
  
提供对节点子项的访问。
IMenuDataDescriptor
  
getData(node:Object, model:Object = null):Object
返回节点的数据。
IMenuDataDescriptor
  
返回节点所属的单选按钮组的名称(如果存在)。
IMenuDataDescriptor
  
返回节点的类型标识符。
IMenuDataDescriptor
  
hasChildren(node:Object, model:Object = null):Boolean
确定节点实际是否有子节点。
IMenuDataDescriptor
  
isBranch(node:Object, model:Object = null):Boolean
测试节点的终止性。
IMenuDataDescriptor
  
返回是否已启用节点。
IMenuDataDescriptor
  
返回是否已切换节点。
IMenuDataDescriptor
  
removeChildAt(parent:Object, child:Object, index:int, model:Object = null):Boolean
从指定索引处的节点删除子节点。
IMenuDataDescriptor
  
设置数据提供程序中用于标识是否已启用节点的字段或属性的值。
IMenuDataDescriptor
  
设置数据提供程序中用于标识是否已切换节点的字段或属性的值。
IMenuDataDescriptor
方法详细信息
addChildAt()方法
public function addChildAt(parent:Object, newChild:Object, index:int, model:Object = null):Boolean

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

参数

parent:Object — 将成为子节点父级的节点对象。
 
newChild:Object — 节点将成为其父级的节点对象。
 
index:int — 要从中放置子节点(相对于父项)的从零开始的索引.
 
model:Object (default = null) — 包含此节点的整个集合。

返回
Boolean如果成功,则为 true.
getChildren()方法 
public function getChildren(node:Object, model:Object = null):ICollectionView

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

参数

node:Object — 当前计算的节点对象。
 
model:Object (default = null) — 包含节点的集合;此类会将其忽略。

返回
ICollectionView — 包含子节点的对象。
getData()方法 
public function getData(node:Object, model:Object = null):Object

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

参数

node:Object — 当前计算的节点对象。
 
model:Object (default = null) — 包含节点的集合;此类会将其忽略。

返回
Object — 节点。
getGroupName()方法 
public function getGroupName(node:Object):String

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

参数

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

返回
String — 节点的 groupName 属性或字段的值;如果不存在此类条目,则为空字符串。
getType()方法 
public function getType(node:Object):String

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

参数

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

返回
Stringtype 属性或字段的值,或空字符串(如果不存在这样的字段)。
hasChildren()方法 
public function hasChildren(node:Object, model:Object = null):Boolean

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

参数

node:Object — 当前计算的节点对象。
 
model:Object (default = null) — 包含节点的集合;此类会将其忽略。

返回
Boolean — 如果此节点当前有子节点,则为 true
isBranch()方法 
public function isBranch(node:Object, model:Object = null):Boolean

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

参数

node:Object — 当前计算的节点对象。
 
model:Object (default = null) — 包含节点的集合;此类会将其忽略。

返回
Boolean — 如果此节点不是终端节点,则为 true
isEnabled()方法 
public function isEnabled(node:Object):Boolean

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

参数

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

返回
Boolean — 节点的 enabled 属性或字段的值;如果不存在此类条目或值不是 false,则为 true
isToggled()方法 
public function isToggled(node:Object):Boolean

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

参数

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

返回
Boolean — 节点的 toggled 属性或字段的值;如果不存在此类条目,则为 false
removeChildAt()方法 
public function removeChildAt(parent:Object, child:Object, index:int, model:Object = null):Boolean

从指定索引处的节点删除子节点。如果 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

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

参数

node:Object — 要设置状态的节点。
 
value:Boolean — 是否已启用节点。

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

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

参数

node:Object — 要设置状态的节点。
 
value:Boolean — 是否已切换节点。