Класс 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, разработчик несёт ответственность за обновление состояния родительских и дочерних TreeItems. Это означает, что для данного 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 не должен вызываться разработчиками, но это лучший метод для переопределения, чтобы позволить разработчикам настроить визуальные элементы ячейки. Для ясности, разработчики никогда не должны вызывать этот метод в своём коде (они должны позволить элементу управления UI, например элементу управления ListView, вызывать этот метод). Однако цель метода updateItem заключается в том, чтобы разработчики, при указании пользовательских фабрик ячеек (опять же, таких как ListView cell factory), могли переопределить метод updateItem, чтобы обеспечить полную настраиваемость ячейки.

Крайне важно, чтобы подклассы Cell должным образом переопределяли метод 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. Если мы этого не сделаем, практически гарантировано, что конечные пользователи увидят графические артефакты в ячейках неожиданно.