メソッド フレームあり | フレームなし

mx.controls.treeclasses
TreeDataProvider インターフェイス

TreeDataProvider インターフェイス

TreeDataProvider は、Tree コントロールおよび Menu コントロールに階層データを提供するために、オブジェクトが実装する必要のあるインターフェイスです。階層は、このインターフェイスを実装したオブジェクトのインスタンスで構成されます。Tree コントロールを扱う際は、このインターフェイスを構成する実装オブジェクトの場合とは異なり、このインターフェイスが持つメソッドを必ず調べる必要があります。

関連項目
    TreeNode
    XMLTreeDataProvider


メソッド
       addTreeNode( labelOrNode, data)
データプロバイダの最後に新しい子を追加します。
       addTreeNodeAt( index, labelOrNode, data)
このデータプロバイダの指定された位置に子を追加します。
       getChildNodes( ) :  Array
すべての子ノードを含む配列を返します。
       getData( ) :  Object
このアイテムのデータを返します。
       getParent( )
親ノードへの参照を返します。
       getProperty( propertyName:String)
このアイテムのプロパティを返します。
       getTreeNodeAt( index:Number)
指定の位置にある子アイテムを指す参照を取得します。
       hasChildNodes( ) :  Boolean
アイテムに子ノードがある場合、true を返します。
       indexOf( item:Object) :  Number
アイテムのインデックスを返します。
       isTreeDataProvider( ) :  Boolean
データプロバイダが有効かどうかを判断します。
       removeAll( )
このノードからすべての子を削除します。
       removeTreeNode( )
このノードまたはアイテムを親ノードから削除します。
       removeTreeNodeAt( index)
指定された位置にある子アイテムを、このアイテムから削除します。
       setData( data:Object)
アイテムのデータを設定します。
       setProperty( propertyName:String, propertyValue, broadcastChange:Boolean)
このアイテムのプロパティを設定します。



メソッドの詳細

addTreeNode

addTreeNode( labelOrNode, data)

データプロバイダの最後に新しい子を追加します。1 番目の引数は必須ですが、2 番目の引数はオプションです。

パラメータ
    labelOrNode - 作成するノードのラベル、またはノードとしてラップするオブジェクトを表します。ストリングを渡すと、新しいノードの label プロパティにそのストリングが割り当てられます。メモ : Tree の labelField を label 以外のプロパティに設定した場合は、正しい値を使用してこのノードで setProperty() メソッドを呼び出す必要があります。呼び出さない場合、labelOrNode 引数がコピーされません。Object を渡すと、オブジェクトであるプロパティ (ストリング、数値、ブール値ではないプロパティ) はすべて子として表示されます。このパラメータは必須です。
    data - ノードの data プロパティとして追加するデータです。getData() メソッドを使用すると、このデータにアクセスできます。このパラメータはオプションです。

戻り値
    TreeDataProvider API を実装しているオブジェクトです。

addTreeNodeAt

addTreeNodeAt( index, labelOrNode, data)

このデータプロバイダの指定された位置に子を追加します。

パラメータ
    index - アイテムを追加する位置です。インデックス 0 が最初のアイテムです。
    labelOrNode - 作成するノードのラベル、またはノードとしてラップするオブジェクトを表します。ストリングを渡すと、新しいノードの label プロパティにそのストリングが割り当てられます。メモ : Tree の labelField を label 以外のプロパティに設定した場合は、正しい値を使用してこのノードで setProperty() メソッドを呼び出す必要があります。呼び出さない場合、labelOrNode 引数がコピーされません。Object を渡すと、オブジェクトであるプロパティ (ストリング、数値、ブール値ではないプロパティ) はすべて子として表示されます。このパラメータは必須です。
    data - ノードの data プロパティとして追加するデータです。getData() メソッドを使用すると、このデータにアクセスできます。このパラメータはオプションです。

戻り値
    TreeDataProvider API を実装しているオブジェクトです。

getChildNodes

getChildNodes( ) :  Array

すべての子ノードを含む配列を返します。

getData

getData( ) :  Object

このアイテムのデータを返します。これは、addTreeNode() メソッドまたは addTreeNodeAt() メソッドのデータ引数です。または、setData() メソッドを使用して明示的に設定されたデータです。

getParent

getParent( )

親ノードへの参照を返します。ノードがルートノードの場合、この関数は undefined を返します。

戻り値
    TreeDataProvider API を実装しているオブジェクトです。

getProperty

getProperty( propertyName:String)

このアイテムのプロパティを返します。addTreeNode() メソッドに 1 番目の引数としてノードを渡した場合、これはそのノードのプロパティとなります。データオブジェクトのプロパティではありません。

パラメータ
    propertyName:String - プロパティの名前です。

getTreeNodeAt

getTreeNodeAt( index:Number)

指定の位置にある子アイテムを指す参照を取得します。孫アイテムはリストに含まれません。

パラメータ
    index:Number - 返すアイテムの位置です。

戻り値
    TreeDataProvider API を実装しているオブジェクトです。

hasChildNodes

hasChildNodes( ) :  Boolean

アイテムに子ノードがある場合、true を返します。

indexOf

indexOf( item:Object) :  Number

アイテムのインデックスを返します。孫アイテムはリストに含まれません。したがって、目的のアイテムを子アイテムのリストから探す前に、正しいアイテムを指定していることを確認してください。

パラメータ
    item:Object - インデックスの確認対象のアイテムを表します。

isTreeDataProvider

isTreeDataProvider( ) :  Boolean

データプロバイダが有効かどうかを判断します。

removeAll

removeAll( )

このノードからすべての子を削除します。

removeTreeNode

removeTreeNode( )

このノードまたはアイテムを親ノードから削除します。

戻り値
     このノード

removeTreeNodeAt

removeTreeNodeAt( index)

指定された位置にある子アイテムを、このアイテムから削除します。

パラメータ
    index - 削除するアイテムの位置です。

戻り値
     削除されたノードです。

setData

setData( data:Object)

アイテムのデータを設定します。任意のデータをアイテムと関連付けて設定できます。

パラメータ
    data:Object - 設定するデータです。

setProperty

setProperty( propertyName:String, propertyValue, broadcastChange:Boolean)

このアイテムのプロパティを設定します。

パラメータ
    propertyName:String - プロパティの名前です。
    propertyValue - プロパティに設定する値です。
    broadcastChange:Boolean - 変更イベントをデータプロバイダからブロードキャストするかどうかを指定します。false の場合、TreeDataProvider を監視しているコントロールは自動的には更新されません。デフォルト値は true です。