Класс CheckBoxTreeCell<T>

public final ObjectProperty<StringConverter<TreeItem<T>>> converterProperty

Свойство StringConverter.

public final ObjectProperty<Callback<TreeItem<T>,ObservableValue<Boolean>>> selectedStateCallbackProperty

Свойство, представляющее Callback, привязанное к элементу CheckBox, отображаемому на экране.

public CheckBoxTreeCell()

Создает стандартный CheckBoxTreeCell, предполагающий, что TreeView построен с использованием CheckBoxTreeItem, а не стандартных TreeItem. При использовании CheckBoxTreeItem, он будет внутренне управлять выбранным и неопределённым состоянием каждого элемента в дереве.

public CheckBoxTreeCell(Callback<TreeItem<T>,​ObservableValue<Boolean>> getSelectedProperty)

Создаёт CheckBoxTreeCell для использования в элементе управления TreeView через фабрику ячеек. В отличие от CheckBoxTreeCell(), этот метод не предполагает, что все элементы TreeItem в TreeView являются CheckBoxTreeItem.

Для вызова этого метода необходимо предоставить Callback, который, получив объект типа TreeItem<T>, вернёт ObservableValue<Boolean>, представляющий, выбран ли данный элемент. Это ObservableValue<Boolean> будет привязано двунаправленно (т. е. CheckBox в ячейке установит/сбросит это свойство на основе пользовательских взаимодействий, и CheckBox отразит состояние ObservableValue<Boolean>, если оно изменится внешним образом).

Если элементы не являются CheckBoxTreeItem, разработчик несёт ответственность за обновление состояния родительских и дочерних TreeItem. Это означает, что, получив TreeItem, этот класс просто переключает предоставленное ObservableValue<Boolean>, и не более. Конечно, эту функциональность можно реализовать внешним образом, добавив наблюдателей к ObservableValue<Boolean>, и переключив состояние других свойств по мере необходимости.

public CheckBoxTreeCell(Callback<TreeItem<T>,​ObservableValue<Boolean>> getSelectedProperty, StringConverter<TreeItem<T>> converter)

Создаёт CheckBoxTreeCell для использования в элементе управления TreeView через фабрику ячеек. В отличие от CheckBoxTreeCell(), этот метод не предполагает, что все элементы TreeItem в TreeView являются CheckBoxTreeItem.

Для вызова этого метода необходимо предоставить Callback, который, получив объект типа TreeItem<T>, вернёт ObservableValue<Boolean>, представляющий, выбран ли данный элемент. Это ObservableValue<Boolean> будет привязано двунаправленно (т. е. CheckBox в ячейке установит/сбросит это свойство на основе пользовательских взаимодействий, и CheckBox отразит состояние ObservableValue<Boolean>, если оно изменится внешним образом).

Если элементы не являются CheckBoxTreeItem, разработчик несёт ответственность за обновление состояния родительских и дочерних TreeItem. Это означает, что, получив TreeItem, этот класс просто переключает предоставленное ObservableValue<Boolean>, и не более. Конечно, эту функциональность можно реализовать внешним образом, добавив наблюдателей к ObservableValue<Boolean>, и переключив состояние других свойств по мере необходимости.

public static <T> Callback<TreeView<T>,TreeCell<T>> forTreeView()

Создаёт фабрику ячеек для использования в элементе управления TreeView, хотя существует важное предположение при использовании в TreeView: эта фабрика ячеек предполагает, что корень TreeView и все дочерние элементы являются экземплярами CheckBoxTreeItem, а не стандартного класса TreeItem, используемого обычно.

При использовании в TreeView CheckBoxCell отображается с CheckBox справа от 'узла раскрытия' (т. е. стрелки). Элемент, хранящийся в TreeItem.getValue(), затем будет обработан StringConverter, и этот текст займёт всё оставшееся горизонтальное пространство. Кроме того, при использовании CheckBoxTreeItem, TreeView автоматически обрабатывает ситуации, такие как:

• Нажатие на CheckBox рядом с элементом, имеющим дочерние элементы, приведёт к тому, что все дочерние элементы также станут выбранными/невыбранными.
• Нажатие на CheckBox рядом с элементом, имеющим родительский элемент, возможно, переключит состояние родительского элемента. Например, если вы выберете единственный дочерний элемент, родительский элемент станет неопределённым (что указывает на частичный выбор дочерних элементов). Если вы продолжите выбирать все дочерние элементы, родительский элемент также будет выбран. Это рекурсивно, и все родительские узлы обновляются как ожидается.

К сожалению, из-за ограничений Java, при использовании этого метода необходимо явно выполнить приведение типов. Например:

 
 final TreeView<String> treeView = new TreeView<String>();
 treeView.setCellFactory(CheckBoxCell.<String>forTreeView());

public static <T> Callback<TreeView<T>,TreeCell<T>> forTreeView​(Callback<TreeItem<T>,​ObservableValue<Boolean>> getSelectedProperty)

Создаёт фабрику ячеек для использования в элементе управления TreeView. В отличие от forTreeView(), этот метод не предполагает, что все элементы TreeItem в TreeView являются CheckBoxTreeItem.

При использовании в TreeView CheckBoxCell отображается с CheckBox справа от 'узла раскрытия' (т. е. стрелки). Элемент, хранящийся в TreeItem.getValue(), затем будет обработан StringConverter, и этот текст займёт всё оставшееся горизонтальное пространство.

В отличие от forTreeView(), эта фабрика ячеек не обрабатывает обновление состояния родительских или дочерних TreeItem - она просто переключает предоставленное ObservableValue<Boolean>, и не более. Конечно, эту функциональность можно реализовать внешним образом, добавив наблюдателей к ObservableValue<Boolean>, и переключив состояние других свойств по мере необходимости.

public static <T> Callback<TreeView<T>,TreeCell<T>> forTreeView​(Callback<TreeItem<T>,​ObservableValue<Boolean>> getSelectedProperty, StringConverter<TreeItem<T>> converter)

Создаёт фабрику ячеек для использования в элементе управления TreeView. В отличие от forTreeView(), этот метод не предполагает, что все экземпляры TreeItem в TreeView являются CheckBoxTreeItem.

При использовании в TreeView CheckBoxCell отображается с CheckBox справа от «узла раскрытия» (т.е. стрелки). Элемент, хранящийся в TreeItem.getValue(), затем будет обработан StringConverter, и этот текст займёт всё оставшееся горизонтальное пространство.

В отличие от forTreeView(), эта фабрика ячеек не обрабатывает обновление состояния родительских или дочерних TreeItem — она просто переключает предоставленное значение ObservableValue<Boolean>, и ничего больше. Конечно, эту функциональность можно реализовать внешне, добавив наблюдателей к ObservableValue<Boolean> и переключив состояние других свойств по мере необходимости.

public final ObjectProperty<StringConverter<TreeItem<T>>> converterProperty()

Свойство StringConverter.

public final void setConverter(StringConverter<TreeItem<T>> value)

Устанавливает StringConverter для использования в этой ячейке.

public final StringConverter<TreeItem<T>> getConverter()

Возвращает StringConverter, используемый в этой ячейке.

public final ObjectProperty<Callback<TreeItem<T>,ObservableValue<Boolean>>> selectedStateCallbackProperty()

Свойство, представляющее Callback, к которому привязана отображаемая на экране CheckBox.

public final void setSelectedStateCallback(Callback<TreeItem<T>,​ObservableValue<Boolean>> value)

Устанавливает Callback, к которому привязана отображаемая на экране CheckBox.

public final Callback<TreeItem<T>,ObservableValue<Boolean>> getSelectedStateCallback()

Возвращает Callback, к которому привязана отображаемая на экране CheckBox.

public void updateItem(T item, boolean empty)

Метод updateItem не должен вызываться разработчиками, но это лучший метод для переопределения разработчиками, чтобы позволить им настроить визуальные элементы ячейки. Для ясности, разработчики никогда не должны вызывать этот метод в своём коде (они должны предоставить управлению пользовательского интерфейса, например, элементу управления ListView, вызвать этот метод). Однако цель метода updateItem заключается в том, чтобы разработчики при указании пользовательских фабрик ячеек (опять же, как в ListView cell factory) могли переопределить метод updateItem, чтобы позволить полную настройку ячейки.

Очень важно, чтобы подклассы Cell должным образом переопределяли метод updateItem, так как отказ от этого приведёт к проблемам, таким как пустые ячейки или ячейки с неожиданным содержимым, появляющимся в них. Вот пример того, как правильно переопределить метод updateItem:

 protected void updateItem(T item, boolean empty) {
     super.updateItem(item, empty);

     if (empty || item == null) {
         setText(null);
         setGraphic(null);
     } else {
         setText(item.toString());
     }
 }
 

Обратите внимание на два важных момента в этом примере кода:

1. Мы вызываем метод super.updateItem(T, boolean). Если этого не сделать, свойства item и empty не будут правильно установлены, и у вас, скорее всего, возникнут графические проблемы.
2. Мы проверяем условие empty и, если оно верно, устанавливаем свойства text и graphic в null. Если этого не сделать, почти гарантировано, что конечные пользователи увидят графические артефакты в ячейках неожиданно.