Класс TreePath

java.lang.Object

javax.swing.tree.TreePath

Все реализуемые интерфейсы:: Serializable

public class TreePath extends Object implements Serializable

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

TreePath широко используется классами JTree и связанными с ними классами. Например, JTree представляет собой выборку в виде массива TreePath. При использовании с JTree, элементы пути — это объекты, возвращаемые методом TreeModel. При использовании JTree совместно с DefaultTreeModel, элементы пути — это TreeNode. Следующий пример иллюстрирует извлечение объекта пользователя из выделения JTree:

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

Подклассы обычно нуждаются только в переопределении методов


 getLastPathComponent

и getParentPath. Поскольку JTree внутренне создаёт TreePath в различных точках, обычно не имеет смысла подклассифицировать TreePath и использовать с JTree.

Хотя TreePath сериализуем, будет брошено исключение NotSerializableException если какой-либо элемент пути не сериализуем.

Дополнительную информацию и примеры использования путей дерева см. в Руководстве по использованию деревьев в Java Tutorial.

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

Краткое описание конструкторов

TreePath()

TreePath(Object lastPathComponent)

TreePath(Object[] path)

TreePath(Object[] path,
 int length)

TreePath(TreePath parent,
 Object lastPathComponent)

Модификатор	Конструктор	Описание
`protected`	Создаёт пустой `TreePath`.
	Создаёт `TreePath` содержащий один элемент.
	Создаёт `TreePath` из массива.
`protected`	Создаёт `TreePath` из массива.
`protected`	Создаёт `TreePath` с указанным родителем и элементом.

Краткое описание методов

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

Методы, объявленные в классе java.lang.Object

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

Подробное описание конструкторов

TreePath

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

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

Параметры:: path - массив объектов, представляющий путь к узлу
Исключения:: IllegalArgumentException - если path является null, пустым или содержит значение null

TreePath

public TreePath(Object lastPathComponent)

Создаёт объект TreePath, содержащий единственный элемент. Используется для создания TreePath, идентифицирующего корень.

Параметры:

lastPathComponent - корень

Исключения:

IllegalArgumentException - если lastPathComponent является null

См. также:

TreePath

protected TreePath(TreePath parent, Object lastPathComponent)

Создаёт объект TreePath с указанным родительским элементом и элементом.

Параметры:: parent - путь к родителю или null для указания корня; lastPathComponent - последний элемент пути
Исключения:: IllegalArgumentException - если lastPathComponent является null

TreePath

protected TreePath(Object[] path, int length)

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

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

Параметры:: path - массив для создания объекта TreePath; length - определяет количество элементов в массиве для создания объекта 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 - если индекс выходит за пределы диапазона данного пути

equals

public boolean equals(Object o)

Сравнивает данный объект TreePath с указанным объектом. Возвращает true, если obj является объектом TreePath с точно такими же элементами (как определено с помощью метода equals для каждого элемента пути).

Переопределяет:

equals в классе Object

Параметры:

o - сравниваемый объект

Возвращает:

true если этот объект такой же, как аргумент obj; false в противном случае.

См. также:

hashCode

public int hashCode()

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

Переопределяет:

hashCode в классе Object

Возвращает:

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

См. также:

isDescendant

public boolean isDescendant(TreePath aTreePath)

Возвращает true, если obj является потомком данного объекта TreePath. Объект TreePath obj является потомком объекта TreePath this, если obj содержит все элементы, составляющие путь этого объекта. Например, если у этого объекта путь [1, 2, 3], и у объекта obj путь [1, 2], то obj является потомком этого объекта. Однако, если у объекта obj путь [1, 4], то он не является потомком этого объекта. По этому определению объект TreePath всегда считается потомком самого себя. То есть, isDescendant(this) возвращает true.

Параметры:: aTreePath - объект TreePath для проверки
Возвращает:: true, если obj является потомком данного пути

pathByAddingChild

public TreePath pathByAddingChild(Object child)

Возвращает новый объект TreePath, содержащий все элементы данного пути плюс добавленный элемент. Новый добавленный элемент — последний элемент нового объекта TreePath.

Параметры:: child - элемент пути для добавления
Возвращает:: новый объект TreePath, содержащий все элементы данного пути плюс добавленный элемент
Исключения:: NullPointerException - если child является null

getParentPath

public TreePath getParentPath()

Возвращает путь родителя. Значение null указывает на корневой узел.

Возвращает:: путь родителя

toString

public String toString()

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

Переопределяет:: toString в классе Object
Возвращает:: строковое представление этого объекта

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/tree/TreePath.html