Spec-Zone.ru › OpenJavaFX 24

Класс CheckBoxTreeItem<T>

java.lang.Object
javafx.scene.control.TreeItem<T>
javafx.scene.control.CheckBoxTreeItem<T>
Параметры типа:
T - Тип значения, содержащегося в TreeItem
Все реализованные интерфейсы:
EventTarget
public class CheckBoxTreeItem<T> extends TreeItem<T>
Подкласс TreeItem, добавляющий поддержку состояний выделения, невыделения и неопределённости. Это полезно при использовании с TreeView, в котором установлен CheckBoxTreeCell.

CheckBoxTreeItem может быть independent или зависимым. По умолчанию экземпляры CheckBoxTreeItem являются зависимыми, что означает, что любые изменения состояния выбора TreeItem повлияют на родительские и дочерние CheckBoxTreeItem. Если CheckBoxTreeItem установлен как независимый, это означает, что любые изменения в этом CheckBoxTreeItem не будут напрямую влиять на состояние родительских и дочерних CheckBoxTreeItem.

Свойство indeterminate используется для представления того же понятия, что и в CheckBox.indeterminateProperty(), а именно, что флажок не выбран и не невыделен. Это часто используется внутри TreeView, когда некоторые, но не все, дочерние элементы ветви выбраны.

Простой пример использования класса CheckBoxTreeItem в сочетании с CheckBoxTreeCell показан ниже:

// create the tree model
 CheckBoxTreeItem<String> jonathanGiles = new CheckBoxTreeItem<>("Jonathan");
 CheckBoxTreeItem<String> juliaGiles = new CheckBoxTreeItem<>("Julia");
 CheckBoxTreeItem<String> mattGiles = new CheckBoxTreeItem<>("Matt");
 CheckBoxTreeItem<String> sueGiles = new CheckBoxTreeItem<>("Sue");
 CheckBoxTreeItem<String> ianGiles = new CheckBoxTreeItem<>("Ian");

 CheckBoxTreeItem<String> gilesFamily = new CheckBoxTreeItem<>("Giles Family");
 gilesFamily.setExpanded(true);
 gilesFamily.getChildren().addAll(jonathanGiles, juliaGiles, mattGiles, sueGiles, ianGiles);

 // create the treeView
 final TreeView<String> treeView = new TreeView<>();
 treeView.setRoot(gilesFamily);

 // set the cell factory
 treeView.setCellFactory(CheckBoxTreeCell.<String>forTreeView());
Image of the CheckBoxTreeItem control
С:
JavaFX 2.2
См. также:
  • CheckBoxTreeCell
  • TreeItem
  • CheckBox

Краткое описание вложенных классов

Модификатор и тип Класс Описание
static class  CheckBoxTreeItem.TreeModificationEvent<T>
Класс TreeModificationEvent, работающий аналогично классу TreeItem.TreeModificationEvent, в том смысле, что это событие будет подниматься вверх по иерархии CheckBoxTreeItem, пока родительский узел не станет null.

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

Тип Свойство Описание
final BooleanProperty independent
A BooleanProperty используется для представления независимого состояния CheckBoxTreeItem.
final BooleanProperty indeterminate
A BooleanProperty используется для представления состояния неопределённости CheckBoxTreeItem.
final BooleanProperty selected
A BooleanProperty используется для представления состояния выбора CheckBoxTreeItem.

Свойства, объявленные в классе javafx.scene.control.TreeItem

expanded, graphic, leaf, parent, value

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

Конструктор Описание
CheckBoxTreeItem()
Создаёт пустой CheckBoxTreeItem.
CheckBoxTreeItem(T value)
Создаёт CheckBoxTreeItem со свойством value, установленным на предоставленный объект.
CheckBoxTreeItem(T value, Node graphic)
Создаёт CheckBoxTreeItem со свойством value, установленным на предоставленный объект, и графикой, установленной на предоставленный Node.
CheckBoxTreeItem(T value, Node graphic, boolean selected)
Создаёт CheckBoxTreeItem со свойством value, установленным на предоставленный объект, графикой, установленной на предоставленный Node, и начальным состоянием selectedProperty(), установленным на предоставленное значение boolean.
CheckBoxTreeItem(T value, Node graphic, boolean selected, boolean independent)
Создаёт CheckBoxTreeItem со свойством value, установленным на предоставленный объект, графикой, установленной на предоставленный Node, начальным состоянием selectedProperty(), установленным на предоставленное значение boolean, и начальным состоянием свойства independent на предоставленное значение boolean.

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

Модификатор и тип Метод Описание
static <T> EventType<CheckBoxTreeItem.TreeModificationEvent<T>> checkBoxSelectionChangedEvent()
EventType, используемый при изменении состояния выбора/неопределённости CheckBoxTreeItem.
final BooleanProperty independentProperty()
A BooleanProperty используется для представления независимого состояния CheckBoxTreeItem.
final BooleanProperty indeterminateProperty()
A BooleanProperty используется для представления состояния неопределённости CheckBoxTreeItem.
final boolean isIndependent()
Получение значения свойства independent.
final boolean isIndeterminate()
Возвращает состояние неопределённости CheckBoxTreeItem.
final boolean isSelected()
Возвращает состояние выбора CheckBoxTreeItem.
final BooleanProperty selectedProperty()
A BooleanProperty используется для представления состояния выбора CheckBoxTreeItem.
final void setIndependent(boolean value)
Устанавливает значение свойства independent.
final void setIndeterminate(boolean value)
Устанавливает состояние неопределённости CheckBoxTreeItem.
final void setSelected(boolean value)
Устанавливает состояние выбора CheckBoxTreeItem.

Методы, объявленные в классе javafx.scene.control.TreeItem

addEventFilter, addEventHandler, branchCollapsedEvent, branchExpandedEvent, buildEventDispatchChain, childrenModificationEvent, expandedItemCountChangeEvent, expandedProperty, getChildren, getGraphic, getParent, getValue, graphicChangedEvent, graphicProperty, isExpanded, isLeaf, leafProperty, nextSibling, nextSibling, parentProperty, previousSibling, previousSibling, setExpanded, setGraphic, setValue, toString, treeNotificationEvent, valueChangedEvent, valueProperty

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Методы, объявленные в интерфейсе javafx.event.EventTarget

removeEventFilter, removeEventHandler

Подробности свойства

selected

public final BooleanProperty selectedProperty
A BooleanProperty используется для представления выбранного состояния этого CheckBoxTreeItem.
См. также:
  • isSelected()
  • setSelected(boolean)
  • selectedProperty()

indeterminate

public final BooleanProperty indeterminateProperty
A BooleanProperty используется для представления неопределённого состояния этого CheckBoxTreeItem.
См. также:
  • isIndeterminate()
  • setIndeterminate(boolean)
  • indeterminateProperty()

independent

public final BooleanProperty independentProperty
A BooleanProperty используется для представления независимого состояния этого CheckBoxTreeItem. Состояние независимости используется для указания, должны ли изменения в одном CheckBoxTreeItem влиять на состояние его родительского элемента и дочерних элементов.

По умолчанию свойство independent имеет значение false, что означает, что при изменении состояния выбранности или неопределённости CheckBoxTreeItem, состояние связанных CheckBoxTreeItem может быть изменено. Если свойство independent установлено в значение true, состояние связанных CheckBoxTreeItem никогда не изменится.

См. также:
  • isIndependent()
  • setIndependent(boolean)
  • independentProperty()

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

CheckBoxTreeItem

public CheckBoxTreeItem()
Создаёт пустой CheckBoxTreeItem.

CheckBoxTreeItem

public CheckBoxTreeItem(T value)
Создаёт CheckBoxTreeItem со свойством значения, установленным на предоставленный объект.
Параметры:
value - Объект, который будет сохранён в качестве значения этого TreeItem.

CheckBoxTreeItem

public CheckBoxTreeItem(T value, Node graphic)
Создаёт CheckBoxTreeItem со свойством значения, установленным на предоставленный объект, и графикой, установленной на предоставленный узел.
Параметры:
value - Объект, который будет сохранён в качестве значения этого CheckBoxTreeItem.
graphic - Узел, который будет отображаться в TreeView рядом с этим CheckBoxTreeItem.

CheckBoxTreeItem

public CheckBoxTreeItem(T value, Node graphic, boolean selected)
Создаёт CheckBoxTreeItem со свойством значения, установленным на предоставленный объект, графикой, установленной на предоставленный узел, и начальным состоянием selectedProperty(), установленным на предоставленное булево значение.
Параметры:
value - Объект, который будет сохранён в качестве значения этого CheckBoxTreeItem.
graphic - Узел, который будет отображаться в TreeView рядом с этим CheckBoxTreeItem.
selected - Начальное значение свойства selected.

CheckBoxTreeItem

public CheckBoxTreeItem(T value, Node graphic, boolean selected, boolean independent)
Создаёт CheckBoxTreeItem со свойством значения, установленным на предоставленный объект, графикой, установленной на предоставленный узел, начальным состоянием selectedProperty(), установленным на предоставленное булево значение, и начальным состоянием свойства independent, установленным на предоставленное булево значение.
Параметры:
value - Объект, который будет сохранён в качестве значения этого CheckBoxTreeItem.
graphic - Узел, который будет отображаться в TreeView рядом с этим CheckBoxTreeItem.
selected - Начальное значение свойства selected.
independent - Начальное значение свойства independent.

Подробности метода

checkBoxSelectionChangedEvent

public static <T> EventType<CheckBoxTreeItem.TreeModificationEvent<T>> checkBoxSelectionChangedEvent()
EventType, используемый при изменении состояния выбора/неопределённости CheckBoxTreeItem. Для использования рекомендуется использовать код, подобный следующему:
 
 child1.addEventHandler(CheckBoxTreeItem.<String>checkBoxSelectionChangedEvent(), new EventHandler<TreeModificationEvent<String>>() {
     public void handle(TreeModificationEvent<String> event) {
          ...
     }
 });
 
Параметры типа:
T - Тип значения, содержащегося в TreeItem.
Возвращает:
EventType, используемый при изменении состояния выбора/неопределённости CheckBoxTreeItem

setSelected

public final void setSelected(boolean value)
Устанавливает состояние выбранности этого CheckBoxTreeItem.
Параметры:
value - состояние выбранности этого CheckBoxTreeItem

isSelected

public final boolean isSelected()
Возвращает состояние выбранности этого CheckBoxTreeItem.
Возвращает:
true, если CheckBoxTreeItem выбран

selectedProperty

public final BooleanProperty selectedProperty()
A BooleanProperty используется для представления выбранного состояния этого CheckBoxTreeItem.
Возвращает:
свойство состояния выбранности этого CheckBoxTreeItem
См. также:
  • isSelected()
  • setSelected(boolean)

setIndeterminate

public final void setIndeterminate(boolean value)
Устанавливает состояние неопределённости этого CheckBoxTreeItem.
Параметры:
value - состояние неопределённости этого CheckBoxTreeItem

isIndeterminate

public final boolean isIndeterminate()
Возвращает состояние неопределённости этого CheckBoxTreeItem.
Возвращает:
true, если CheckBoxTreeItem находится в состоянии неопределённости

indeterminateProperty

public final BooleanProperty indeterminateProperty()
A BooleanProperty используется для представления неопределённого состояния этого CheckBoxTreeItem.
Возвращает:
свойство состояния неопределённости этого CheckBoxTreeItem
См. также:
  • isIndeterminate()
  • setIndeterminate(boolean)

independentProperty

public final BooleanProperty independentProperty()
A BooleanProperty используется для представления независимого состояния этого CheckBoxTreeItem. Состояние независимости используется для указания, должны ли изменения в одном CheckBoxTreeItem влиять на состояние его родительского элемента и дочерних элементов.

По умолчанию свойство independent имеет значение false, что означает, что при изменении состояния выбранности или неопределённости CheckBoxTreeItem, состояние связанных CheckBoxTreeItem может быть изменено. Если свойство independent установлено в значение true, состояние связанных CheckBoxTreeItem никогда не изменится.

Возвращает:
свойство состояния независимости этого CheckBoxTreeItem
См. также:
  • isIndependent()
  • setIndependent(boolean)

setIndependent

public final void setIndependent(boolean value)
Устанавливает значение свойства independent.
Описание свойства:
A BooleanProperty используется для представления независимого состояния этого CheckBoxTreeItem. Состояние независимости используется для указания, должны ли изменения в одном CheckBoxTreeItem влиять на состояние его родительского элемента и дочерних элементов.

По умолчанию свойство independent имеет значение false, что означает, что при изменении состояния выбранности или неопределённости CheckBoxTreeItem, состояние связанных CheckBoxTreeItem может быть изменено. Если свойство independent установлено в значение true, состояние связанных CheckBoxTreeItem никогда не изменится.

Параметры:
value - значение для свойства independent
См. также:
  • isIndependent()
  • independentProperty()

isIndependent

public final boolean isIndependent()
Получает значение свойства independent.
Описание свойства:
Объект BooleanProperty, используемый для представления независимого состояния этого CheckBoxTreeItem. Независимое состояние используется для указания того, должны ли изменения в одном CheckBoxTreeItem влиять на состояние его родительского элемента и дочерних элементов.

По умолчанию свойство independent имеет значение false, что означает, что при изменении состояния CheckBoxTreeItem (выбранного или неопределённого) состояние связанных CheckBoxTreeItem может измениться. Если свойство independent установлено в значение true, состояние связанных CheckBoxTreeItem никогда не изменится.

Возвращает:
значение свойства independent
См. также:
  • setIndependent(boolean)
  • independentProperty()

Отправить отчет об ошибке или предложить улучшение
Авторские права © 2008, 2025, Oracle и/или его аффилированные лица. Все права защищены.

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API