javax.swing.tree
クラス TreePath

java.lang.Object
  javax.swing.tree.TreePath

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

Serializable

public class TreePath
extends Object
implements Serializable

ノードへのパスを表します。TreePath とは TreeModel から生成される Object の配列です。配列の要素は常にルートが配列の先頭の要素 (インデックス 0) になるように順序付けされます。TreePath は Serializable ですが、パスのコンポーネントが直列化可能でない場合は、書き出されません。

ツリーパスの詳細および使用例は、「The Java Tutorial」の「How to Use Trees」セクションを参照してください。

警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースと互換ではなくなる予定です。現在の直列化のサポートは、短期間の運用や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。JDK バージョン 1.4 以降、すべての JavaBeans^™ の長期間の運用サポートは、java.beans パッケージに追加されています。詳細は、XMLEncoder を参照してください。

コンストラクタの概要

protected	TreePath() 主に、パスをさまざまな方法で表すサブクラス用に提供されます。
	TreePath(Object singlePath) 単一要素のみを持つ TreePath を構築します。
	TreePath(Object[] path) Object の配列からパスを構築し、ツリーのデータモデルによって返される、ツリーのルートから特定のノードまでのパスを一意に識別します。
protected	TreePath(Object[] path, int length) 長さ length の識別パスコンポーネントがある新規 TreePath を構築します。
protected	TreePath(TreePath parent, Object lastElement) lastElement で終了する parent が識別するパスである、新規 TreePath を構築します。

メソッドの概要

boolean	equals(Object o) 各パスの要素が同じかどうかを判定して、2 つの TreePath が同じかどうかを判定します。
Object	getLastPathComponent() このパスの末尾コンポーネントを返します。
TreePath	getParentPath() オブジェクトのすべての要素を格納するパスを返します。
Object[]	getPath() この TreePath のコンポーネントを格納する Object の順序付き配列を返します。
Object	getPathComponent(int element) 指定されたインデックスにあるパスコンポーネントを返します。
int	getPathCount() パス内の要素数を返します。
int	hashCode() オブジェクトの hashCode を返します。
boolean	isDescendant(TreePath aTreePath) aTreePath がこの TreePath の下位オブジェクトである場合は、true を返します。
TreePath	pathByAddingChild(Object child) このオブジェクトのすべての要素に加えて child の要素を格納する新しいパスを返します。
String	toString() このオブジェクトのプロパティを表示および識別する文字列を返します。

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

TreePath

public TreePath(Object[] path)

Object の配列からパスを構築し、ツリーのデータモデルによって返される、ツリーのルートから特定のノードまでのパスを一意に識別します。

モデルは、それがパスを表すのに必要とする任意の Object の配列を自由に返します。DefaultTreeModel は TreeNode オブジェクトの配列を返します。パスの最初の TreeNode はツリーのルートで、最後の TreeNode はパスで識別されるノードです。

パラメータ:

path - ノードへのパスを表す Object の配列

TreePath

public TreePath(Object singlePath)

単一要素のみを持つ TreePath を構築します。通常、TreeModel のルートの TreePath 構築に使用します。

パラメータ:

singlePath - ノードへのパスを表す Object

関連項目:

TreePath(Object[])

TreePath

protected TreePath(TreePath parent,
                   Object lastElement)

lastElement で終了する parent が識別するパスである、新規 TreePath を構築します。

TreePath

protected TreePath(Object[] path,
                   int length)

長さ length の識別パスコンポーネントがある新規 TreePath を構築します。

TreePath

protected TreePath()

主に、パスをさまざまな方法で表すサブクラス用に提供されます。サブクラスがこのコンストラクタを使用する場合には、getPath、getPathCount、code>getPathComponent、場合によっては、equals メソッドをオーバーライドする必要があります。

メソッドの詳細

getPath

public Object[] getPath()

この TreePath のコンポーネントを格納する Object の順序付き配列を返します。先頭の要素 (インデックス 0) はルートです。

戻り値:

TreePath を表す Object の配列

関連項目:

TreePath(Object[])

getLastPathComponent

public Object getLastPathComponent()

このパスの末尾コンポーネントを返します。DefaultTreeModel が返すパスに対しては TreeNode のインスタンスを返します。

戻り値:

パスの最後にある Object

関連項目:

TreePath(Object[])

getPathCount

public int getPathCount()

パス内の要素数を返します。

戻り値:

パスの項目数を示す int 値

getPathComponent

public Object getPathComponent(int element)

指定されたインデックスにあるパスコンポーネントを返します。

パラメータ:

element - パス内の要素を指定する int 値。ただし、パスの最初の要素は 0

戻り値:

そのインデックス位置にある Object

例外:

IllegalArgumentException - インデックスがパスの長さを超える場合

関連項目:

TreePath(Object[])

equals

public boolean equals(Object o)

各パスの要素が同じかどうかを判定して、2 つの TreePath が同じかどうかを判定します。長さが同じで同じ要素を持っている場合 (.equals) は 2 つのパスは同等と見なされます。

オーバーライド:

クラス Object 内の equals

パラメータ:

o - 比較対象の Object

戻り値:

obj 引数に指定されたオブジェクトとこのオブジェクトが等しい場合は true、そうでない場合は false

関連項目:

Object.hashCode(), Hashtable

hashCode

public int hashCode()

オブジェクトの hashCode を返します。TreePath のハッシュコードは、パス内で最後のコンポーネントのハッシュコードになるように定義されます。

オーバーライド:

クラス Object 内の hashCode

戻り値:

オブジェクトの hashCode

関連項目:

Object.equals(java.lang.Object), Hashtable

isDescendant

public boolean isDescendant(TreePath aTreePath)

aTreePath がこの TreePath の下位オブジェクトである場合は、true を返します。P1 が P2 のパスを構成するすべてのコンポーネントを格納している場合は、TreePath P1 は TreePath P2 の下位オブジェクトになります。たとえば、このオブジェクトにパス [a、b] があり、aTreePath にパス [a、b、c] がある場合は、aTreePath はこのオブジェクトの下位オブジェクトとなります。ただし、aTreePath にパス [a] がある場合は、このオブジェクトの下位オブジェクトではありません。

戻り値:

aTreePath がこのパスの下位オブジェクトである場合は true

pathByAddingChild

public TreePath pathByAddingChild(Object child)

このオブジェクトのすべての要素に加えて child の要素を格納する新しいパスを返します。child は新しく生成された TreePath の最後の要素となります。子が null の場合は NullPointerException をスローします。

getParentPath

public TreePath getParentPath()

オブジェクトのすべての要素を格納するパスを返します。ただし、最後のパスコンポーネントは除きます。

toString

public String toString()

このオブジェクトのプロパティを表示および識別する文字列を返します。

オーバーライド:

クラス Object 内の toString

戻り値:

このオブジェクトの文字列表現