javax.swing.tree

Класс TreePath

java.lang. Объект

javax.swing.tree. TreePath

Все Реализованные Интерфейсы:

Сериализуемый

public class TreePath
extends Object
implements Serializable

TreePath представляет массив объектов, которые однозначно определяют путь к узлу в дереве. Элементы массива упорядочиваются с корнем как первый элемент массива. Например, файл на файловой системе однозначно определяется основанный на массиве родительских каталогов и имени файла. Путь /tmp/foo/bar мог быть представлен a TreePath как new TreePath(new Object[] {"tmp", "foo", "bar"}).

TreePath используется экстенсивно JTree и связанные классы. Например, JTree представляет выбор как массив TreePaths. Когда использующийся с JTree, элементы пути являются объектами, возвращенными из TreeModel. Когда JTree соединяется с DefaultTreeModel, элементы пути TreeNodes. Следующий пример иллюстрирует извлечение пользовательского объекта от выбора a JTree:

   DefaultMutableTreeNode root = ...;
   DefaultTreeModel model = new DefaultTreeModel(root);
   JTree tree = new JTree(model);
   ...
   TreePath selectedPath = tree.getSelectionPath();
   DefaultMutableTreeNode selectedNode =
       ((DefaultMutableTreeNode)selectedPath.getLastPathComponent()).
       getUserObject();
 

Подклассы обычно должны переопределить только getLastPathComponent, и getParentPath. Как JTree внутренне создает TreePaths в различных точках, обычно не полезно разделить на подклассы TreePath и используйте с JTree.

В то время как TreePath сериализуемо, a NotSerializableException бросается, если какие-либо элементы пути не сериализуемы.

Для дополнительной информации и примеров использования древовидных путей, см., Как Использовать Деревья в Учебном руководстве по Java.

Предупреждение: Сериализированные объекты этого класса не будут совместимыми с будущими выпусками Swing. Текущая поддержка сериализации является подходящей для краткосрочного хранения или RMI между приложениями, выполняющими ту же самую версию Swing. С 1.4, поддержка длительного хранения всего ^JavaBeansTM была добавлена к java.beans пакет. Пожалуйста, см. XMLEncoder.

Сводка конструктора

Конструкторы

Модификатор	Конструктор и Описание
protected	TreePath() Создает пустое TreePath.
	TreePath(Object lastPathComponent) Создает a TreePath содержа единственный элемент.
	TreePath(Object[] path) Создает a TreePath от массива.
protected	TreePath(Object[] path, int length) Создает a TreePath от массива.
protected	TreePath(TreePath parent, Object lastPathComponent) Создает a TreePath с указанным родителем и элементом.

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
boolean	equals(Object o) Сравнивает это TreePath к указанному объекту.
Объект	getLastPathComponent() Возвращает последний элемент этого пути.
TreePath	getParentPath() Возвраты TreePath из родителя.
Объект[]	getPath() Возвращает упорядоченный массив элементов этого TreePath.
Объект	getPathComponent(int index) Возвращает элемент пути по указанному индексу.
int	getPathCount() Возвращает число элементов в пути.
int	hashCode() Возвращает хэш-код этого TreePath.
boolean	isDescendant(TreePath aTreePath) Возвращает true если aTreePath потомок этого TreePath.
TreePath	pathByAddingChild(Object child) Возвращает новый путь, содержащий все элементы этого пути плюс child.
Строка	toString() Возвращает строку, которая выводит на экран и идентифицирует свойства этого объекта.

Методы java.lang унаследованный от класса. Объект

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

Деталь конструктора

TreePath

@ConstructorProperties(value="path")
public TreePath(Object[] path)

Создает a TreePath от массива. Массив однозначно определяет путь к узлу.

Параметры:

path - массив объектов, представляющих путь к узлу

Броски:

IllegalArgumentException - если path null, пустой, или содержит a null значение

TreePath

public TreePath(Object lastPathComponent)

Создает a TreePath содержа единственный элемент. Это используется, чтобы создать a TreePath идентификация корня.

Параметры:

lastPathComponent - корень

Броски:

IllegalArgumentException - если lastPathComponent null

См. Также:

TreePath(Object[])

TreePath

protected TreePath(TreePath parent,
        Object lastPathComponent)

Создает a TreePath с указанным родителем и элементом.

Параметры:

parent - путь к родителю, или null указать на корень

lastPathComponent - последний элемент пути

Броски:

IllegalArgumentException - если lastPathComponent null

TreePath

protected TreePath(Object[] path,
        int length)

Создает a TreePath от массива. Возвращенный TreePath представляет элементы массива от 0 к length - 1.

Этот конструктор используется внутренне, и обычно не полезный за пределами подклассов.

Параметры:

path - массив, чтобы создать TreePath от

length - идентифицирует число элементов в path создать TreePath от

Броски:

NullPointerException - если path null

ArrayIndexOutOfBoundsException - если length - 1 вне диапазона массива

IllegalArgumentException - если любой из элементов от 0 к length - 1 null

TreePath

protected TreePath()

Создает пустое TreePath. Это обеспечивается для подклассов, которые представляют пути другим способом. Подклассы, которые используют этого конструктора, должны переопределить getLastPathComponent, и getParentPath.

Деталь метода

getPath

public Object[] getPath()

Возвращает упорядоченный массив элементов этого TreePath. Первый элемент является корнем.

Возвраты:

массив элементов в этом TreePath

getLastPathComponent

public Object getLastPathComponent()

Возвращает последний элемент этого пути.

Возвраты:

последний элемент в пути

getPathCount

public int getPathCount()

Возвращает число элементов в пути.

Возвраты:

число элементов в пути

getPathComponent

public Object getPathComponent(int index)

Возвращает элемент пути по указанному индексу.

Параметры:

index - индекс элемента требуют

Возвраты:

элемент по указанному индексу

Броски:

IllegalArgumentException - если индекс вне диапазона этого пути

равняется

public boolean equals(Object o)

Сравнивает это TreePath к указанному объекту. Это возвращается true если o a TreePath с теми же самыми элементами (как определено при использовании equals на каждом элементе пути).

Переопределения:

equals в классе Object

Параметры:

o - объект сравниться

Возвраты:

true если этот объект является тем же самым как obj параметром; false иначе.

См. Также:

Object.hashCode(), HashMap

хэш-код

public int hashCode()

Возвращает хэш-код этого TreePath. Хэш-код a TreePath хэш-код последнего элемента в пути.

Переопределения:

hashCode в классе Object

Возвраты:

хэш-код для объекта

См. Также:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

isDescendant

public boolean isDescendant(TreePath aTreePath)

Возвращает true если aTreePath потомок этого TreePath. A TreePath P1 потомок a TreePath P2 если P1 содержит все элементы, которые составляют P2's путь. Например, если у этого объекта есть путь [a, b], и aTreePath имеет путь [a, b, c], тогда aTreePath потомок этого объекта. Однако, если aTreePath имеет путь [a], тогда это не потомок этого объекта. По этому определению a TreePath всегда считается потомком себя. Таким образом, aTreePath.isDescendant(aTreePath) возвраты true.

Параметры:

aTreePath - TreePath проверять

Возвраты:

истина, если aTreePath потомок этого пути

pathByAddingChild

public TreePath pathByAddingChild(Object child)

Возвращает новый путь, содержащий все элементы этого пути плюс child. child последний элемент недавно создаваемый TreePath.

Параметры:

child - элемент пути, чтобы добавить

Броски:

NullPointerException - если child null

getParentPath

public TreePath getParentPath()

Возвраты TreePath из родителя. Возвращаемое значение null указывает, что это - корневой узел.

Возвраты:

родительский путь

toString

public String toString()

Возвращает строку, которая выводит на экран и идентифицирует свойства этого объекта.

Переопределения:

toString в классе Object

Возвраты:

Строковое представление этого объекта