DefaultTreeModel (Java Platform SE 7)

java.lang.Object
- javax.swing.tree.DefaultTreeModel

すべての実装されたインタフェース:

Serializable, TreeModel
```
public class DefaultTreeModel
extends Object
implements Serializable, TreeModel
```
TreeNodes を使用する単純なツリーデータモデルです。DefaultTreeModel の詳細および使用例は、「The Java Tutorial」の「How to Use Trees」を参照してください。
警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースとの互換性がなくなる予定です。現在の直列化のサポートは、短期間の格納や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。1.4 以降、すべての JavaBeans^TM 用の長期間の格納サポートが java.beans パッケージに追加されています。XMLEncoder を参照してください。

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`protected boolean`	`asksAllowsChildren` ノードが葉ノードかどうかを `isLeaf` メソッドが判断する方法を決定します。
`protected EventListenerList`	`listenerList` リスナーです。
`protected TreeNode`	`root` ツリーのルートです。

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`DefaultTreeModel(TreeNode root)` どのノードでも子を持てるツリーを作成します。
`DefaultTreeModel(TreeNode root, boolean asksAllowsChildren)` どのノードでも子を持てるかどうか、特定のノードだけが子を持てるかどうかを指定するツリーを作成します。

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`void`	`addTreeModelListener(TreeModelListener l)` ツリーが変更されたあとに送信された TreeModelEvent のリスナーを追加します。
`boolean`	`asksAllowsChildren()` 葉ノードの判別方法を通知します。
`protected void`	`fireTreeNodesChanged(Object source, Object[] path, int[] childIndices, Object[] children)` このイベントタイプの通知対象として登録されているすべてのリスナーに通知します。
`protected void`	`fireTreeNodesInserted(Object source, Object[] path, int[] childIndices, Object[] children)` このイベントタイプの通知対象として登録されているすべてのリスナーに通知します。
`protected void`	`fireTreeNodesRemoved(Object source, Object[] path, int[] childIndices, Object[] children)` このイベントタイプの通知対象として登録されているすべてのリスナーに通知します。
`protected void`	`fireTreeStructureChanged(Object source, Object[] path, int[] childIndices, Object[] children)` このイベントタイプの通知対象として登録されているすべてのリスナーに通知します。
`Object`	`getChild(Object parent, int index)` 親の持つ子配列の、インデックス index にある parent の子を返します。
`int`	`getChildCount(Object parent)` parent の子の数を返します。
`int`	`getIndexOfChild(Object parent, Object child)` 親の子のインデックスを返します。
`<T extends EventListener> T[]`	`getListeners(Class<T> listenerType)` このモデルに `FooListener` として現在登録されているすべてのオブジェクトの配列を返します。
`TreeNode[]`	`getPathToRoot(TreeNode aNode)` ルートノードまでを含むノードの親を構築します。ただし、元のノードは返される配列内の最後の要素です。
`protected TreeNode[]`	`getPathToRoot(TreeNode aNode, int depth)` ルートノードまでを含むノードの親を構築します。ただし、元のノードは返される配列内の最後の要素です。
`Object`	`getRoot()` ツリーのルートを返します。
`TreeModelListener[]`	`getTreeModelListeners()` このモデルに登録された、すべてのツリーモデルリスナーからなる配列を返します。
`void`	`insertNodeInto(MutableTreeNode newChild, MutableTreeNode parent, int index)` このメソッドを呼び出して、親の子たちの位置インデックスに newChild を挿入します。
`boolean`	`isLeaf(Object node)` 指定のノードが葉ノードかどうかを返します。
`void`	`nodeChanged(TreeNode node)` ユーザーがツリー内のノードの表現方法を変更したあとで、このメソッドを呼び出します。
`void`	`nodesChanged(TreeNode node, int[] childIndices)` childIndicies で識別される子をツリー内で表現する方法をユーザーが変更したあとで、このメソッドを呼び出します。
`void`	`nodeStructureChanged(TreeNode node)` ノードの子、その子の子、などのようにユーザーがノードの子孫を全体的に変更した場合に、このメソッドを呼び出します。
`void`	`nodesWereInserted(TreeNode node, int[] childIndices)` ユーザーがいくつかの TreeNode をノードに挿入したあとでこのメソッドを呼び出します。
`void`	`nodesWereRemoved(TreeNode node, int[] childIndices, Object[] removedChildren)` ユーザーがいくつかの TreeNode をノードから削除したあとでこのメソッドを呼び出します。
`void`	`reload()` ユーザーがこのモデルの依存する `TreeNode` を変更した場合、このメソッドを呼び出します。
`void`	`reload(TreeNode node)` ユーザーがこのモデルの依存する `TreeNode` を変更した場合、このメソッドを呼び出します。
`void`	`removeNodeFromParent(MutableTreeNode node)` このメソッドをメッセージとして送って、ノードをその親から削除します。
`void`	`removeTreeModelListener(TreeModelListener l)` 以前に addTreeModelListener() で追加されたリスナーを削除します。
`void`	`setAsksAllowsChildren(boolean newValue)` TreeNode に getAllowsChildren() または isLeaf() で問い合わせることにより、葉かどうかの判定をするかしないかを設定します。
`void`	`setRoot(TreeNode root)` ルートを `root` に設定します。
`void`	`valueForPathChanged(TreePath path, Object newValue)` パスで識別される TreeNode のユーザーオブジェクトを設定し、変更済みのノードを送ります。

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - root
```
protected TreeNode root
```
    ツリーのルートです。
  - listenerList
```
protected EventListenerList listenerList
```
    リスナーです。
  - asksAllowsChildren
```
protected boolean asksAllowsChildren
```
    ノードが葉ノードかどうかを isLeaf メソッドが判断する方法を決定します。true の場合、ノードが子を許可しなければ葉ノードです。子を許可する場合は、子が存在しなくても葉ノードではありません。これで、たとえばファイルシステムのフォルダノードとファイルノードを区別できます。
    この値が false の場合は、子を持たないノードは葉ノードで、どのノードでも子を持つことができます。
    
    関連項目:
    TreeNode.getAllowsChildren(), TreeModel.isLeaf(java.lang.Object), setAsksAllowsChildren(boolean)
- コンストラクタの詳細
  - DefaultTreeModel
```
@ConstructorProperties(value="root")
public DefaultTreeModel(TreeNode root)
```
    どのノードでも子を持てるツリーを作成します。
    
    パラメータ:
    root - ツリーのルートである TreeNode オブジェクト
    関連項目:
    DefaultTreeModel(TreeNode, boolean)
  - DefaultTreeModel
```
public DefaultTreeModel(TreeNode root,
                boolean asksAllowsChildren)
```
    どのノードでも子を持てるかどうか、特定のノードだけが子を持てるかどうかを指定するツリーを作成します。
    
    パラメータ:
    root - ツリーのルートである TreeNode オブジェクト
    asksAllowsChildren - boolean 型。どのノードでも子を持てる場合は false、各ノードが子を持てるかどうか確認するように求められる場合は true
    関連項目:
    asksAllowsChildren
- メソッドの詳細
  - setAsksAllowsChildren
```
public void setAsksAllowsChildren(boolean newValue)
```
    TreeNode に getAllowsChildren() または isLeaf() で問い合わせることにより、葉かどうかの判定をするかしないかを設定します。newvalue が true の場合は、getAllowsChildren() がメッセージとして送られます。そうでない場合は、isLeaf() がメッセージとして送られます。
  - asksAllowsChildren
```
public boolean asksAllowsChildren()
```
    葉ノードの判別方法を通知します。
    
    戻り値:
    子を許可しないノードだけが葉ノードである場合は true、子を持たないノード (子は許可されていても) が葉ノードである場合は false
    関連項目:
    asksAllowsChildren
  - setRoot
```
public void setRoot(TreeNode root)
```
    ルートを root に設定します。null の root は、ツリーには何も表示されず、かつ適正であることを意味します。
  - getRoot
```
public Object getRoot()
```
    ツリーのルートを返します。ツリーにノードがない場合だけ、null を返します。
    
    定義:
    
    getRoot、インタフェース: TreeModel
    
    戻り値:
    ツリーのルート
  - getIndexOfChild
```
public int getIndexOfChild(Object parent,
                  Object child)
```
    親の子のインデックスを返します。親か子のどちらかが null の場合は、-1 を返します。
    
    定義:
    
    getIndexOfChild、インタフェース: TreeModel
    
    パラメータ:
    parent - このデータソースから取得された、ツリー内のノード
    child - 対象となるノード
    
    戻り値:
    親の子のインデックス。親または子が null の場合は -1
  - getChild
```
public Object getChild(Object parent,
              int index)
```
    親の持つ子配列の、インデックス index にある parent の子を返します。parent は、このデータソースからそれまでに取得されたノードである必要があります。index が parent の有効なインデックス (つまり、index >= 0 && index < getChildCount(parent)) である場合は、null を返しません。
    
    定義:
    
    getChild、インタフェース: TreeModel
    
    パラメータ:
    parent - このデータソースから取得された、ツリー内のノード
    
    戻り値:
    インデックス index にある parent の子
  - getChildCount
```
public int getChildCount(Object parent)
```
    parent の子の数を返します。ノードが葉の場合や、ノードが子を持たない場合は、0 を返します。parent は、このデータソースからそれまでに取得されたノードである必要があります。
    
    定義:
    
    getChildCount、インタフェース: TreeModel
    
    パラメータ:
    parent - このデータソースから取得された、ツリー内のノード
    
    戻り値:
    ノード parent の子の数
  - isLeaf
```
public boolean isLeaf(Object node)
```
    指定のノードが葉ノードかどうかを返します。判定の実行方法は、askAllowsChildren の設定に依存します。
    
    定義:
    
    isLeaf、インタフェース: TreeModel
    
    パラメータ:
    node - チェック対象のノード
    
    戻り値:
    ノードが葉ノードの場合は true
    関連項目:
    asksAllowsChildren, TreeModel.isLeaf(java.lang.Object)
  - reload
```
public void reload()
```
    ユーザーがこのモデルの依存する TreeNode を変更した場合、このメソッドを呼び出します。モデルは、それ自身が変更済みであることを、そのリスナーのすべてに通知します。
  - valueForPathChanged
```
public void valueForPathChanged(TreePath path,
                       Object newValue)
```
    パスで識別される TreeNode のユーザーオブジェクトを設定し、変更済みのノードを送ります。TreeModel 内のカスタムユーザーオブジェクトを使用すると、これをサブクラス化し、変更済みノードのユーザーオブジェクトを意味のある内容に設定する必要がでてきます。
    
    定義:
    
    valueForPathChanged、インタフェース: TreeModel
    
    パラメータ:
    path - ユーザーが変更したノードへのパス
    newValue - TreeCellEditor からの新しい値
  - insertNodeInto
```
public void insertNodeInto(MutableTreeNode newChild,
                  MutableTreeNode parent,
                  int index)
```
    このメソッドを呼び出して、親の子たちの位置インデックスに newChild を挿入します。それから、nodesWereInserted をメッセージとして送り、適切なイベントを生成します。適切なイベントを生成するので、子を追加するための望ましい方法です。
  - removeNodeFromParent
```
public void removeNodeFromParent(MutableTreeNode node)
```
    このメソッドをメッセージとして送って、ノードをその親から削除します。それから、nodesWereRemoved をメッセージとして送り、適切なイベントを生成します。イベント生成をユーザーのために処理するので、ノードを削除するための望ましい方法です。
  - nodeChanged
```
public void nodeChanged(TreeNode node)
```
    ユーザーがツリー内のノードの表現方法を変更したあとで、このメソッドを呼び出します。
  - reload
```
public void reload(TreeNode node)
```
    ユーザーがこのモデルの依存する TreeNode を変更した場合、このメソッドを呼び出します。モデルは、指定のノードより下の部分で変更されたことを、そのすべてのリスナーに通知します。
    
    パラメータ:
    node - 特定のノード。モデルはこのノードより下の部分で変更された
  - nodesWereInserted
```
public void nodesWereInserted(TreeNode node,
                     int[] childIndices)
```
    ユーザーがいくつかの TreeNode をノードに挿入したあとでこのメソッドを呼び出します。childIndices は新しい要素のインデックスで、昇順でソートされる必要があります。
  - nodesWereRemoved
```
public void nodesWereRemoved(TreeNode node,
                    int[] childIndices,
                    Object[] removedChildren)
```
    ユーザーがいくつかの TreeNode をノードから削除したあとでこのメソッドを呼び出します。childIndices は削除された要素のインデックスで、昇順でソートされる必要があります。そして、removedChildren は、削除された子オブジェクトの配列になります。
  - nodesChanged
```
public void nodesChanged(TreeNode node,
                int[] childIndices)
```
    childIndicies で識別される子をツリー内で表現する方法をユーザーが変更したあとで、このメソッドを呼び出します。
  - nodeStructureChanged
```
public void nodeStructureChanged(TreeNode node)
```
    ノードの子、その子の子、などのようにユーザーがノードの子孫を全体的に変更した場合に、このメソッドを呼び出します。このメソッドは、treeStructureChanged イベントを送ります。
  - getPathToRoot
```
public TreeNode[] getPathToRoot(TreeNode aNode)
```
    ルートノードまでを含むノードの親を構築します。ただし、元のノードは返される配列内の最後の要素です。返される配列の長さは、ツリー内のノードの深さを指定します。
    
    パラメータ:
    aNode - パスを取得する TreeNode
  - getPathToRoot
```
protected TreeNode[] getPathToRoot(TreeNode aNode,
                       int depth)
```
    ルートノードまでを含むノードの親を構築します。ただし、元のノードは返される配列内の最後の要素です。返される配列の長さは、ツリー内のノードの深さを指定します。
    
    パラメータ:
    aNode - パスを取得する TreeNode
    depth - 返される配列のサイズ指定に使用する、(再帰呼び出しで) すでに取得済みのルートまでのステップ数を示す int 値
    
    戻り値:
    ルートから指定されたノードまでのパスを示す TreeNode の配列
  - addTreeModelListener
```
public void addTreeModelListener(TreeModelListener l)
```
    ツリーが変更されたあとに送信された TreeModelEvent のリスナーを追加します。
    
    定義:
    
    addTreeModelListener、インタフェース: TreeModel
    
    パラメータ:
    l - 追加するリスナー
    関連項目:
    removeTreeModelListener(javax.swing.event.TreeModelListener)
  - removeTreeModelListener
```
public void removeTreeModelListener(TreeModelListener l)
```
    以前に addTreeModelListener() で追加されたリスナーを削除します。
    
    定義:
    
    removeTreeModelListener、インタフェース: TreeModel
    
    パラメータ:
    l - 削除するリスナー
    関連項目:
    addTreeModelListener(javax.swing.event.TreeModelListener)
  - getTreeModelListeners
```
public TreeModelListener[] getTreeModelListeners()
```
    このモデルに登録された、すべてのツリーモデルリスナーからなる配列を返します。
    
    戻り値:
    このモデルの TreeModelListener 全部。ツリーモデルリスナーが現在登録されていない場合は空の配列
    導入されたバージョン:
    
    1.4
    
    関連項目:
    addTreeModelListener(javax.swing.event.TreeModelListener), removeTreeModelListener(javax.swing.event.TreeModelListener)
  - fireTreeNodesChanged
```
protected void fireTreeNodesChanged(Object source,
                        Object[] path,
                        int[] childIndices,
                        Object[] children)
```
    このイベントタイプの通知対象として登録されているすべてのリスナーに通知します。イベントインスタンスは、fire メソッドに渡されるパラメータを使って簡単に生成されます。
    
    パラメータ:
    source - TreeModelEvent の発生元 (通常は this)
    path - 変更されたノードの親へのパス。ルートが変更されたことを特定するには、null を使用する
    childIndices - 変更された要素のインデックス
    children - 変更された要素
  - fireTreeNodesInserted
```
protected void fireTreeNodesInserted(Object source,
                         Object[] path,
                         int[] childIndices,
                         Object[] children)
```
    このイベントタイプの通知対象として登録されているすべてのリスナーに通知します。イベントインスタンスは、fire メソッドに渡されるパラメータを使って簡単に生成されます。
    
    パラメータ:
    source - TreeModelEvent の発生元 (通常は this)
    path - ノードが追加された親へのパス
    childIndices - 新しい要素のインデックス
    children - 新規要素
  - fireTreeNodesRemoved
```
protected void fireTreeNodesRemoved(Object source,
                        Object[] path,
                        int[] childIndices,
                        Object[] children)
```
    このイベントタイプの通知対象として登録されているすべてのリスナーに通知します。イベントインスタンスは、fire メソッドに渡されるパラメータを使って簡単に生成されます。
    
    パラメータ:
    source - TreeModelEvent の発生元 (通常は this)
    path - ノードが削除された親へのパス
    childIndices - 削除された要素のインデックス
    children - 削除された要素
  - fireTreeStructureChanged
```
protected void fireTreeStructureChanged(Object source,
                            Object[] path,
                            int[] childIndices,
                            Object[] children)
```
    このイベントタイプの通知対象として登録されているすべてのリスナーに通知します。イベントインスタンスは、fire メソッドに渡されるパラメータを使って簡単に生成されます。
    
    パラメータ:
    source - TreeModelEvent の発生元 (通常は this)
    path - 変更された構造体の親へのパス。ルートが変更されたことを特定するには、null を使用する
    childIndices - 影響を受ける要素のインデックス
    children - 影響を受ける要素
  - getListeners
```
public <T extends EventListener> T[] getListeners(Class<T> listenerType)
```
    このモデルに FooListener として現在登録されているすべてのオブジェクトの配列を返します。FooListener は、addFooListener メソッドを使用して登録されます。
    FooListener.class などのクラスリテラルを使用して listenerType 引数を指定できます。たとえば、次のコードを使用して、DefaultTreeModel m をそのツリーモデルリスナーに照会できます。
```
TreeModelListener[] tmls = (TreeModelListener[])(m.getListeners(TreeModelListener.class));
```
    このようなリスナーがない場合は空の配列を返します。
    パラメータ:
    listenerType - 要求されるリスナーの型。次の下位インタフェースを指定: java.util.EventListener
    
    戻り値:
    このコンポーネント上で FooListener として登録されたすべてのオブジェクトの配列、またはこのようなリスナーが追加されていない場合は空の配列
    
    例外:
    
    ClassCastException - listenerType で、java.util.EventListener を実装するクラスまたはインタフェースが指定されなかった場合
    導入されたバージョン:
    
    1.3
    
    関連項目:
    getTreeModelListeners()

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス DefaultTreeModel

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラス java.lang.Object から継承されたメソッド

フィールドの詳細

root

listenerList

asksAllowsChildren

コンストラクタの詳細

DefaultTreeModel

DefaultTreeModel

メソッドの詳細

setAsksAllowsChildren

asksAllowsChildren

setRoot

getRoot

getIndexOfChild

getChild

getChildCount

isLeaf

reload

valueForPathChanged

insertNodeInto

removeNodeFromParent

nodeChanged

reload

nodesWereInserted

nodesWereRemoved

nodesChanged

nodeStructureChanged

getPathToRoot

getPathToRoot

addTreeModelListener

removeTreeModelListener

getTreeModelListeners

fireTreeNodesChanged

fireTreeNodesInserted

fireTreeNodesRemoved

fireTreeStructureChanged

getListeners