Интерфейс TreeModel

public interface TreeModel

Модель, используемая JTree.

JTree и связанные с ним классы широко используют TreePath для идентификации узлов в TreeModel. Если TreeModel возвращает один и тот же объект, как сравнивается с помощью equals, в двух разных индексах под одним родителем, то и получаемые TreePath объекты также будут считаться равными. Некоторые реализации могут предполагать, что если два TreePath равны, они идентифицируют один и тот же узел. Если это условие не выполняется, могут возникнуть проблемы с отрисовкой и другие несоответствия. Другими словами, если getChild для данного родителя возвращает тот же объект (как определено equals) могут возникнуть проблемы, и рекомендуется этого избегать.

Аналогично JTree и связанные с ним классы размещают TreePath в Map. Таким образом, если узел запрашивается дважды, возвращаемые значения должны быть равны (используя метод equals) и иметь тот же hashCode.

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

Методы

getRoot

Object getRoot()

Возвращает корень дерева. Возвращает null только если дерево не содержит узлов.

Возвращает:

корень дерева

getChild

Object getChild(Object parent,
                int index)

Возвращает потомка parent с индексом index в массиве потомков родителя. parent должен быть узлом, ранее полученным из этого источника данных. Это не должно возвращать null если index является допустимым индексом для parent (то есть index >= 0 && index < getChildCount(parent).

Параметры:

parent - узел в дереве, полученный из этого источника данных

Возвращает:

потомка parent с индексом index

getChildCount

int getChildCount(Object parent)

Возвращает количество потомков parent . Возвращает 0, если узел является листом или не имеет потомков. parent должен быть узлом, ранее полученным из этого источника данных.

Параметры:

parent - узел в дереве, полученный из этого источника данных

Возвращает:

количество потомков узла parent

isLeaf

boolean isLeaf(Object node)

Возвращает true если node является листом. Возможно, что этот метод вернёт false даже если у node нет потомков. Например, каталог в файловой системе может не содержать файлов; узел, представляющий каталог, не является листом, но и не имеет потомков.

Параметры:

node - узел в дереве, полученный из этого источника данных

Возвращает:

true, если node является листом

valueForPathChanged

void valueForPathChanged(TreePath path,
                         Object newValue)

Сообщается, когда пользователь изменил значение для элемента, идентифицированного path на newValue. Если newValue обозначает действительно новое значение, модель должна отправить событие treeNodesChanged.

Параметры:

path - путь к узлу, который пользователь изменил

newValue - новое значение из TreeCellEditor

getIndexOfChild

int getIndexOfChild(Object parent,
                    Object child)

Возвращает индекс потомка в родителе. Если либо parent либо child являются null, возвращает -1. Если ни parent ни child не принадлежат этой модели дерева, возвращает -1.

Параметры:

parent - узел в дереве, полученный из этого источника данных

child - узел, который нас интересует

Возвращает:

индекс потомка в родителе или -1, если либо child либо parent являются null или не принадлежат этой модели дерева

addTreeModelListener

void addTreeModelListener(TreeModelListener l)

Добавляет слушателя для TreeModelEvent, отправляемого после изменений дерева.

Параметры:

l - слушатель для добавления

См. также:

removeTreeModelListener(javax.swing.event.TreeModelListener)

removeTreeModelListener

void removeTreeModelListener(TreeModelListener l)

Удаляет слушателя, ранее добавленного с помощью addTreeModelListener.

Параметры:

l - слушатель для удаления

См. также:

addTreeModelListener(javax.swing.event.TreeModelListener)