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 とオブジェクトノードを同様の方法で処理しますが、完全に同じというわけではありません。メソッドがさまざまなタイプのノードの値にどのようにアクセスするかについては、各メソッドの説明を参照してください。このクラスは、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 または未定義の場合に、child パラメーターを model パラメーターで指定されたコレクション内の指定のインデックス位置に挿入します。
parent パラメーターに children フィールドまたはプロパティが存在する場合、このメソッドは child パラメーターを index パラメーターの位置に追加します。この場合、model パラメーターは不要です。
parent パラメーターに children フィールドまたはプロパティが存在しない場合、このメソッドは children プロパティを parent に追加します。次にこのメソッドは、child パラメーターを index パラメーターの位置の親に追加します。この場合、model パラメーターは不要です。
index の値がコレクションの長さより大きいか、親に含まれている子の数より大きい場合、オブジェクトを最後の子として追加します。

パラメーター

	`parent:Object` — 子の親になるノードオブジェクトです。

	`newChild:Object` — ノードの子になるノードオブジェクトです。

	`index:int` — 親に対する子ノードを配置する位置の 0 から始まるインデックスです。

	`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` — オブジェクトをパラメーターに取り、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` — ノードを定義するオブジェクトです。

	`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` — ノードを定義するオブジェクトです。

	`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 を返します（ノードに子または true isBranch 属性がある場合）。ノードがオブジェクトの場合、true を返します（ノードに children フィールド（フィールドは空の可能性があります）がある場合）。

パラメーター

	`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 属性またはフィールドの値です。true になるのは、該当するエントリが存在しないか、値が false でない場合です。

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` — 削除する子ノードの、親からの相対的な位置を示す、0 から始まるインデックスです。

	`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