站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JavaTM 2 Platform Standard Edition 5.0 API 规范中文版

TreePath (Java 2 Platform SE 5.0) - JavaTM 2 Platform Standard Edition 5.0 API 规范中文版

JavaTM 2 Platform
Standard Ed. 5.0

javax.swing.tree
类 TreePath

java.lang.Object
  继承者 javax.swing.tree.TreePath
所有已实现的接口:
Serializable

public class TreePath
extends Object
implements Serializable

表示节点的路径。TreePath 是 TreeModel 提供的 Objects 的数组。对数组的元素进行排序,使根始终是数组的第一个元素 (index 为 0)。TreePath 是可序列化的,但是如果该路径的任何组件不可序列化,则它将不能写出。

有关使用树路径的更多信息和示例,请参阅《The Java Tutorial》中的 How to Use Trees 一节。

警告:此类的已序列化对象与以后的 Swing 版本不兼容。当前的序列化支持适用于短期存储或运行相同 Swing 版本的应用程序之间的 RMI。从 1.4 版本开始,已在 java.beans 包中添加了支持所有 JavaBeansTM 长期存储的功能。请参见 XMLEncoder


构造方法摘要
protected TreePath()
          主要为以不同方式表示路径的子类提供。
  TreePath(Object singlePath)
          构造仅包含单个元素的 TreePath。
  TreePath(Object[] path)
          从 Objects 的数组构造路径,并根据树的数据模型的返回情况,惟一地标识树的根到指定节点的路径。
protected TreePath(Object[] path, int length)
          构造一个具有长度为 length 的标识路径组件的新 TreePath。
protected TreePath(TreePath parent, Object lastElement)
          构造一个新的 TreePath,它是以 lastElement 结束的 parent 标识的路径。
 
方法摘要
 boolean equals(Object o)
          通过检查路径中每个元素的相等性,测试两个 TreePaths 的相等性。
 Object getLastPathComponent()
          返回此路径的最后一个组件。
 TreePath getParentPath()
          返回包含除最后一个路径组件之外的此对象所有元素的路径。
 Object[] getPath()
          返回有序的 Objects 数组,它包含此 TreePath 的组件。
 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)
从 Objects 的数组构造路径,并根据树的数据模型的返回情况,惟一地标识树的根到指定节点的路径。

该模型可自由地返回需要表示该路径的任何 Objects 的数组。DefaultTreeModel 返回 TreeNode 对象的数组。该路径中的第一个 TreeNode 是树的根,最后一个 TreeNode 是该路径标识的节点。

参数:
path - 表示节点路径的 Objects 数组

TreePath

public TreePath(Object singlePath)
构造仅包含单个元素的 TreePath。这通常用于构造 TreeModel 的根的 TreePath。

参数:
singlePath - 表示节点路径的 Object
另请参见:
TreePath(Object[])

TreePath

protected TreePath(TreePath parent,
                   Object lastElement)
构造一个新的 TreePath,它是以 lastElement 结束的 parent 标识的路径。


TreePath

protected TreePath(Object[] path,
                   int length)
构造一个具有长度为 length 的标识路径组件的新 TreePath。


TreePath

protected TreePath()
主要为以不同方式表示路径的子类提供。如果子类使用此构造方法,则它还应重写 getPathgetPathCountgetPathComponent 方法,并可能重写 equals 方法。

方法详细信息

getPath

public Object[] getPath()
返回有序的 Objects 数组,它包含此 TreePath 的组件。第一个元素 (index 为 0) 是根。

返回:
表示 TreePath 的 Objects 的数组
另请参见:
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)
通过检查路径中每个元素的相等性,测试两个 TreePaths 的相等性。如果两个路径等长,并且包含相同的元素 (.equals),则认为它们相等。

覆盖:
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
返回:
此对象的 String 表示形式

JavaTM 2 Platform
Standard Ed. 5.0

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java 2 SDK SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策