Класс CheckBoxTreeItem<T>

java.lang.Object

javafx.scene.control.TreeItem<T>

javafx.scene.control.CheckBoxTreeItem<T>

Параметры типа:: T - Тип значения, содержащегося в элементе дерева

Все реализуемые интерфейсы:: EventTarget

public class CheckBoxTreeItem<T> extends TreeItem<T>

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

CheckBoxTreeItem может быть independent или зависимым. По умолчанию, экземпляры CheckBoxTreeItem являются зависимыми, что означает, что любые изменения в состоянии выделения элемента дерева повлияют на родительские и дочерние 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());

С:

JavaFX 2.2

См. также:

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

Тип	Свойство	Описание
`final BooleanProperty`	`independent`	Объект `BooleanProperty`, используемый для представления независимого состояния этого элемента CheckBoxTreeItem.
`final BooleanProperty`	`indeterminate`	Объект `BooleanProperty`, используемый для представления состояния неопределенности этого элемента CheckBoxTreeItem.
`final 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, установленным в указанный объект, и графическим элементом, установленным в указанный объект Node.
`CheckBoxTreeItem(T value, Node graphic, boolean selected)`	Создаёт CheckBoxTreeItem со свойством value, установленным в указанный объект, графическим элементом, установленным в указанный объект Node, и начальным состоянием свойства `selectedProperty()`, установленным в указанное булево значение.
`CheckBoxTreeItem(T value, Node graphic, boolean selected, boolean independent)`	Создаёт CheckBoxTreeItem со свойством value, установленным в указанный объект, графическим элементом, установленным в указанный объект Node, начальным состоянием свойства `selectedProperty()`, установленным в указанное булево значение, и начальным состоянием свойства `independent`, установленным в указанное булево значение.

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

Модификатор и тип	Метод	Описание
`static <T> EventType<CheckBoxTreeItem.TreeModificationEvent<T>>`	`checkBoxSelectionChangedEvent()`	Тип события, используемого при изменении выбора/состояния неопределенности в элементе CheckBoxTreeItem.
`final BooleanProperty`	`independentProperty()`	Свойство `BooleanProperty`, используемое для представления независимого состояния этого элемента CheckBoxTreeItem.
`final BooleanProperty`	`indeterminateProperty()`	Свойство `BooleanProperty`, используемое для представления состояния неопределенности этого элемента CheckBoxTreeItem.
`final boolean`	`isIndependent()`	Получает значение свойства `independent`.
`final boolean`	`isIndeterminate()`	Возвращает состояние неопределенности этого элемента CheckBoxTreeItem.
`final boolean`	`isSelected()`	Возвращает состояние выбора этого элемента CheckBoxTreeItem.
`final BooleanProperty`	`selectedProperty()`	Свойство `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

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

См. также:

isSelected()
setSelected(boolean)
selectedProperty()

indeterminate

public final BooleanProperty indeterminateProperty

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

См. также:

isIndeterminate()
setIndeterminate(boolean)
indeterminateProperty()

independent

public final BooleanProperty independentProperty

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

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

См. также:

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

Тип события, используемого при изменении состояния выбора/неопределённости 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.

Возвращает:

свойство состояния выбора данного 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.

Возвращает:

свойство состояния неопределённости данного CheckBoxTreeItem

См. также:

isIndeterminate()
setIndeterminate(boolean)

independentProperty

public final BooleanProperty independentProperty()

Свойство BooleanProperty, используемое для представления состояния независимости данного CheckBoxTreeItem. Состояние независимости определяет, влияют ли изменения одного CheckBoxTreeItem на состояние его родителя и дочерних элементов.

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

Возвращает:

свойство состояния независимости данного CheckBoxTreeItem

См. также:

isIndependent()
setIndependent(boolean)

setIndependent

public final void setIndependent(boolean value)

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

Описание свойства:

Параметры:

value - значение для свойства independent

См. также:

isIndependent()
independentProperty()

isIndependent

public final boolean isIndependent()

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

Описание свойства:

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

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

Возвращает:

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

См. также:

setIndependent(boolean)
independentProperty()

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