パッケージmx.controls.menuClasses
インターフェイスpublic interface IMenuDataDescriptor
インプリメンタDefaultDataDescriptor

IMenuDataDescriptor インターフェイスは、Menu または MenuBar コントロールの dataDescriptor が実装する必要があるインターフェイスを定義します。このインターフェイスは、Menu コントロールまたは MenuBar コントロールによって表示されるデータのコレクションを解析および変更するメソッドを提供します。

関連項目

mx.collections.ICollectionView
メニューベースのコントロールの使用


パブリックメソッド
 メソッド定義
  addChildAt(parent:Object, newChild:Object, index:int, model:Object = null):Boolean
ノードの指定されたインデックス位置に子ノードを追加します。
IMenuDataDescriptor
  getChildren(node:Object, model:Object = null):ICollectionView
ノードの子へのアクセスを提供します。
IMenuDataDescriptor
  getData(node:Object, model:Object = null):Object
ノードのデータを返します。
IMenuDataDescriptor
  getGroupName(node:Object):String
ノードの所属先のラジオボタングループの名前を返します (存在する場合)。
IMenuDataDescriptor
  getType(node:Object):String
ノードのタイプ識別子を返します。
IMenuDataDescriptor
  hasChildren(node:Object, model:Object = null):Boolean
ノードに実際に子がある場合は、true を返します。
IMenuDataDescriptor
  isBranch(node:Object, model:Object = null):Boolean
ノードが終端であるかどうかをテストします。
IMenuDataDescriptor
  isEnabled(node:Object):Boolean
ノードが有効かどうかを返します。
IMenuDataDescriptor
  isToggled(node:Object):Boolean
ノードが切り替えられたかどうかを返します。
IMenuDataDescriptor
  removeChildAt(parent:Object, child:Object, index:int, model:Object = null):Boolean
指定されたインデックス位置にある子ノードをノードから削除します。
IMenuDataDescriptor
  setEnabled(node:Object, value:Boolean):void
ノードが有効かどうかを識別するデータプロバイダ内のフィールドまたは属性の値を設定します。
IMenuDataDescriptor
  setToggled(node:Object, value:Boolean):void
ノードが切り替えられたどうかを識別するデータプロバイダ内のフィールドまたは属性の値を設定します。
IMenuDataDescriptor
メソッドの詳細
addChildAt()メソッド
public function addChildAt(parent:Object, newChild:Object, index:int, model:Object = null):Boolean

ノードの指定されたインデックス位置に子ノードを追加します。この実装では、以下の処理を行います。

パラメータ
parent:Object — 子の親になるノードオブジェクトです。
 
newChild:Object — ノードの子になるノードオブジェクトです。
 
index:int — 親に対する子ノードを配置する位置の 0 から始まるインデックスです。
 
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

ノードに実際に子がある場合は、true を返します。

パラメータ
node:Object — 現在評価されているノードオブジェクトです。
 
model:Object (default = null) — ノードを含むコレクションです。このクラスでは無視されます。

戻り値
Boolean — このノードに子があるかどうかを示すブール値です。
isBranch()メソッド 
public function isBranch(node:Object, model:Object = null):Boolean

ノードが終端であるかどうかをテストします。ブランチは終端ではありませんが、リーフノードは必要ありません。ノードが XML の場合、ノードに子または true 属性があれば true isBranch 属性を返します。ノードがオブジェクトの場合、ノードに children フィールドがあれば true を返します (フィールドは空の可能性があります)。

パラメータ
node:Object — 現在評価されているノードオブジェクトです。
 
model:Object (default = null) — ノードを含むコレクションです。このクラスでは無視されます。

戻り値
Boolean — このノードが終端でないかどうかを示すブール値です。
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 — 削除する子ノードの親に対する 0 から始まるインデックスです。
 
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 — ノードが切り替えられたかどうかを示します。