パッケージmx.controls.treeClasses
クラスpublic class DefaultDataDescriptor
継承DefaultDataDescriptor Inheritance Object
実装 ITreeDataDescriptor2, IMenuDataDescriptor

DefaultDataDescriptor クラスは、Tree や Menu などのコントロールで使用するデータへのアクセスと操作を行うためのデフォルトの実装を提供します。 この実装では、e4x XML とオブジェクトノードを同様の方法で処理しますが、完全に同じというわけではありません。 メソッドがさまざまなタイプのノードの値にどのようにアクセスするかについては、各メソッドの説明を参照してください。 このクラスは、Tree、Menu、MenuBar、および PopUpMenuButton コントロールの dataDescriptor プロパティのデフォルト値です。

関連項目

mx.controls.treeClasses.ITreeDataDescriptor
mx.controls.menuClasses.IMenuDataDescriptor
mx.controls.Menu
mx.controls.MenuBar
mx.controls.PopUpMenuButton
mx.controls.Tree


パブリックプロパティ
 プロパティ定義元
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
パブリックメソッド
 メソッド定義元
  
コンストラクタです。
DefaultDataDescriptor
  
addChildAt(parent:Object, newChild:Object, index:int, model:Object = null):Boolean
ノードの指定されたインデックス位置に子ノードを追加します。
DefaultDataDescriptor
  
ノードの子へのアクセスを提供します。
DefaultDataDescriptor
  
getData(node:Object, model:Object = null):Object
ノードのデータを返します。
DefaultDataDescriptor
  
ノードの所属先のラジオボタングループの名前を返します(存在する場合)。
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
  
ノードのタイプ識別子を返します。
DefaultDataDescriptor
  
hasChildren(node:Object, model:Object = null):Boolean
ノードに実際に子があるかどうかを判別します。
DefaultDataDescriptor
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
  
isBranch(node:Object, model:Object = null):Boolean
ノードが終端であるかどうかをテストします。
DefaultDataDescriptor
  
ノードが有効かどうかを返します。
DefaultDataDescriptor
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
  
ノードが切り替えられたかどうかを返します。
DefaultDataDescriptor
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
  
removeChildAt(parent:Object, child:Object, index:int, model:Object = null):Boolean
指定されたインデックス位置にある子ノードをノードから削除します。
DefaultDataDescriptor
  
ノードが有効かどうかを識別するデータプロバイダ内のフィールドまたは属性の値を設定します。
DefaultDataDescriptor
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
  
ノードが切り替えられたどうかを識別するデータプロバイダ内のフィールドまたは属性の値を設定します。
DefaultDataDescriptor
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
コンストラクタの詳細
DefaultDataDescriptor()コンストラクタ
public function DefaultDataDescriptor()

コンストラクタです。

メソッドの詳細
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 属性またはフィールドの値です。該当するエントリが存在しない場合は、空のストリングとなります。
getHierarchicalCollectionAdaptor()メソッド 
public function getHierarchicalCollectionAdaptor(hierarchicalData:ICollectionView, uidFunction:Function, openItems:Object, model:Object = null):ICollectionView

ICollectionView インスタンスを返します。これにより、階層データを直線的な ICollectionView インスタンスのように表示できるようになります。

パラメータ

hierarchicalData:ICollectionView — 階層データです。
 
uidFunction:Function — オブジェクトをパラメータに取り、UID をストリングとして返す関数です。 このパラメータは、通常 Tree.itemToUID() メソッドです。
 
openItems:Object — 開かれた状態のアイテムまたは開くように設定されたアイテムです。
 
model:Object (default = null) — このノードが属するコレクションです。

戻り値
ICollectionView — ICollectionView インスタンスです。
getNodeDepth()メソッド 
public function getNodeDepth(node:Object, iterator:IViewCursor, model:Object = null):int

ノードの深度(祖先の数)を返します。

パラメータ

node:Object — ノードを定義するオブジェクトです。
 
iterator:IViewCursor — 計算の実行に使用できる IViewCursor インスタンスです。
 
model:Object (default = null) — このノードが属するコレクションです。

戻り値
int — ノードの深度です。0 は最上位を表し、深度を計算できない場合は -1 です。
getParent()メソッド 
public function getParent(node:Object, collection:ICollectionView, model:Object = null):Object

ノードの親を返します。最上位ノードの親は null です。

パラメータ

node:Object — ノードを定義するオブジェクトです。
 
collection:ICollectionView — 計算の実行に使用できる ICollectionView インスタンスです。
 
model:Object (default = null) — このノードが属するコレクションです。

戻り値
Object — ノードを子として含む親ノードです。最上位ノードの場合は null、親を決定できない場合は undefined です。
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 を返します(ノードに子または true isBranch 属性がある場合)。 ノードがオブジェクトの場合、true を返します(ノードに children フィールド(フィールドは空の可能性があります)がある場合)。

パラメータ

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

戻り値
Boolean — このノードが終端でない場合は true です。
isEnabled()メソッド 
public function isEnabled(node:Object):Boolean

ノードが有効かどうかを返します。 このメソッドは、メニューベースのコントロールで使用されます。

パラメータ

node:Object — 状態を取得するノードです。

戻り値
Boolean — ノードの enabled 属性またはフィールドの値です。true になるのは、該当するエントリが存在しないか、値が false でない場合です。
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 — ノードが切り替えられたかどうかを示します。





 

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/controls/treeClasses/DefaultDataDescriptor.html