Класс 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 ячейка CheckBox отображается с 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 ячейка CheckBox отображается с CheckBox справа от 'узла раскрытия' (т.е. стрелки). Элемент, хранящийся в TreeItem.getValue(), затем будет иметь вызываемый StringConverter, и этот текст займёт всё оставшееся горизонтальное пространство.

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