Класс 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(), а именно, что CheckBox ни выбран, ни не выбран. Это обычно используется внутри 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());

С тех пор:: JavaFX 2.2
См. также:: CheckBoxTreeCell, TreeItem, CheckBox

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

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

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

expanded, graphic, leaf, parent, value

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

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

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

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

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

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

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

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

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

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

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

buildEventDispatchChain

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

selected

public final BooleanProperty selectedProperty

Объект BooleanProperty, используемый для представления состояния выбора этого элемента CheckBoxTreeItem.

См. также:: isSelected(), setSelected(boolean)

indeterminate

public final BooleanProperty indeterminateProperty

Объект BooleanProperty, используемый для представления состояния неопределенности этого элемента CheckBoxTreeItem.

См. также:: isIndeterminate(), setIndeterminate(boolean)

independent

public final BooleanProperty independentProperty

Объект BooleanProperty, используемый для представления независимого состояния этого элемента CheckBoxTreeItem. Состояние независимости указывает, должны ли изменения в отдельном CheckBoxTreeItem влиять на состояние его родителя и дочерних элементов.

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

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

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

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()

Тип события, используемый при изменении состояния выбора/неопределённости CheckBoxTreeItem. Для использования рекомендуется использовать код в соответствии со следующим:

 
 child1.addEventHandler(CheckBoxTreeItem.<String>checkBoxSelectionChangedEvent(), new EventHandler<TreeModificationEvent<String>>() {
     public void handle(TreeModificationEvent<String> event) {
          ...
     }
 });

Тип параметров:: T - Тип значения, содержащегося в элементе TreeItem.
Возвращает:: Тип события, используемый при изменении состояния выбора/неопределённости CheckBoxTreeItem

setSelected

public final void setSelected(boolean value)

Устанавливает состояние выбора этого элемента CheckBoxTreeItem.

Параметры:: value - состояние выбранности этого элемента CheckBoxTreeItem

isSelected

public final boolean isSelected()

Возвращает состояние выбора этого элемента CheckBoxTreeItem.

Возвращает:: true, если CheckBoxTreeItem выбран

selectedProperty

public final BooleanProperty selectedProperty()

Объект BooleanProperty, используемый для представления состояния выбора этого элемента 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()

Объект BooleanProperty, используемый для представления состояния неопределённости этого элемента CheckBoxTreeItem.

См. также:: isIndeterminate(), setIndeterminate(boolean)

independentProperty

public final BooleanProperty independentProperty()

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

setIndependent

public final void setIndependent(boolean value)

Устанавливает значение свойства independent.

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

isIndependent

public final boolean isIndependent()

Возвращает значение свойства independent.

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

© 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.