- Type Parameters:
T
- The type of the value contained within the TreeItem
- All Implemented Interfaces:
EventTarget
CheckBoxTreeCell
installed.
A CheckBoxTreeItem can be independent
or
dependent. By default, CheckBoxTreeItem instances are dependent, which means
that any changes to the selection state of a TreeItem will have an impact on
parent and children CheckBoxTreeItem instances. If a CheckBoxTreeItem is
set to be independent, this means that any changes to that CheckBoxTreeItem
will not directly impact the state of parent and children CheckBoxTreeItem
instances.
The indeterminate
property is used to
represent the same concept as that in CheckBox.indeterminateProperty()
,
namely, that the CheckBox is neither selected or unselected. This is commonly
used inside a TreeView when some, but not all, of a branches children are
selected.
A simple example of using the CheckBoxTreeItem class, in conjunction with
CheckBoxTreeCell
is shown below:
// 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());
- Since:
- JavaFX 2.2
- See Also:
-
Property Summary
TypePropertyDescriptionfinal BooleanProperty
ABooleanProperty
used to represent the independent state of this CheckBoxTreeItem.final BooleanProperty
ABooleanProperty
used to represent the indeterminate state of this CheckBoxTreeItem.final BooleanProperty
ABooleanProperty
used to represent the selected state of this CheckBoxTreeItem. -
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
A TreeModificationEvent class that works in a similar vein to theTreeItem.TreeModificationEvent
class, in that this event will bubble up the CheckBoxTreeItem hierarchy, until the parent node is null. -
Constructor Summary
ConstructorDescriptionCreates an empty CheckBoxTreeItem.CheckBoxTreeItem
(T value) Creates a CheckBoxTreeItem with the value property set to the provided object.CheckBoxTreeItem
(T value, Node graphic) Creates a CheckBoxTreeItem with the value property set to the provided object, and the graphic set to the provided Node.CheckBoxTreeItem
(T value, Node graphic, boolean selected) Creates a CheckBoxTreeItem with the value property set to the provided object, the graphic set to the provided Node, and the initial state of theselectedProperty()
set to the provided boolean value.CheckBoxTreeItem
(T value, Node graphic, boolean selected, boolean independent) Creates a CheckBoxTreeItem with the value property set to the provided object, the graphic set to the provided Node, the initial state of theselectedProperty()
set to the provided boolean value, and the initial state of theindependent
property to the provided boolean value. -
Method Summary
Modifier and TypeMethodDescriptionstatic <T> EventType<CheckBoxTreeItem.TreeModificationEvent<T>>
An EventType used when the CheckBoxTreeItem selection / indeterminate state changes.final BooleanProperty
ABooleanProperty
used to represent the independent state of this CheckBoxTreeItem.final BooleanProperty
ABooleanProperty
used to represent the indeterminate state of this CheckBoxTreeItem.final boolean
Gets the value of theindependent
property.final boolean
Returns the indeterminate state of this CheckBoxTreeItem.final boolean
Returns the selected state of this CheckBoxTreeItem.final BooleanProperty
ABooleanProperty
used to represent the selected state of this CheckBoxTreeItem.final void
setIndependent
(boolean value) Sets the value of theindependent
property.final void
setIndeterminate
(boolean value) Sets the indeterminate state of this CheckBoxTreeItem.final void
setSelected
(boolean value) Sets the selected state of this CheckBoxTreeItem.Methods declared in class javafx.scene.control.TreeItem
addEventHandler, branchCollapsedEvent, branchExpandedEvent, buildEventDispatchChain, 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
-
Property Details
-
selected
ABooleanProperty
used to represent the selected state of this CheckBoxTreeItem. -
indeterminate
ABooleanProperty
used to represent the indeterminate state of this CheckBoxTreeItem. -
independent
ABooleanProperty
used to represent the independent state of this CheckBoxTreeItem. The independent state is used to represent whether changes to a single CheckBoxTreeItem should influence the state of its parent and children.By default, the independent property is false, which means that when a CheckBoxTreeItem has state changes to the selected or indeterminate properties, the state of related CheckBoxTreeItems will possibly be changed. If the independent property is set to true, the state of related CheckBoxTreeItems will never change.
-
-
Constructor Details
-
CheckBoxTreeItem
public CheckBoxTreeItem()Creates an empty CheckBoxTreeItem. -
CheckBoxTreeItem
Creates a CheckBoxTreeItem with the value property set to the provided object.- Parameters:
value
- The object to be stored as the value of this TreeItem.
-
CheckBoxTreeItem
Creates a CheckBoxTreeItem with the value property set to the provided object, and the graphic set to the provided Node.- Parameters:
value
- The object to be stored as the value of this CheckBoxTreeItem.graphic
- The Node to show in the TreeView next to this CheckBoxTreeItem.
-
CheckBoxTreeItem
Creates a CheckBoxTreeItem with the value property set to the provided object, the graphic set to the provided Node, and the initial state of theselectedProperty()
set to the provided boolean value.- Parameters:
value
- The object to be stored as the value of this CheckBoxTreeItem.graphic
- The Node to show in the TreeView next to this CheckBoxTreeItem.selected
- The initial value of theselected
property.
-
CheckBoxTreeItem
Creates a CheckBoxTreeItem with the value property set to the provided object, the graphic set to the provided Node, the initial state of theselectedProperty()
set to the provided boolean value, and the initial state of theindependent
property to the provided boolean value.- Parameters:
value
- The object to be stored as the value of this CheckBoxTreeItem.graphic
- The Node to show in the TreeView next to this CheckBoxTreeItem.selected
- The initial value of theselected
property.independent
- The initial value of theindependent
property
-
-
Method Details
-
checkBoxSelectionChangedEvent
public static <T> EventType<CheckBoxTreeItem.TreeModificationEvent<T>> checkBoxSelectionChangedEvent()An EventType used when the CheckBoxTreeItem selection / indeterminate state changes. To use this, it is recommended that you use code along the lines of the following:child1.addEventHandler(CheckBoxTreeItem.<String>checkBoxSelectionChangedEvent(), new EventHandler<TreeModificationEvent<String>>() { public void handle(TreeModificationEvent<String> event) { ... } });
- Type Parameters:
T
- The type of the value contained within the TreeItem.- Returns:
- the EventType used when the CheckBoxTreeItem selection / indeterminate state changes
-
setSelected
public final void setSelected(boolean value) Sets the selected state of this CheckBoxTreeItem.- Parameters:
value
- the selected state of this CheckBoxTreeItem
-
isSelected
public final boolean isSelected()Returns the selected state of this CheckBoxTreeItem.- Returns:
- true if CheckBoxTreeItem is selected
-
selectedProperty
ABooleanProperty
used to represent the selected state of this CheckBoxTreeItem.- Returns:
- the selected state property of this CheckBoxTreeItem
- See Also:
-
setIndeterminate
public final void setIndeterminate(boolean value) Sets the indeterminate state of this CheckBoxTreeItem.- Parameters:
value
- the indeterminate state of this CheckBoxTreeItem
-
isIndeterminate
public final boolean isIndeterminate()Returns the indeterminate state of this CheckBoxTreeItem.- Returns:
- true if CheckBoxTreeItem is indeterminate state
-
indeterminateProperty
ABooleanProperty
used to represent the indeterminate state of this CheckBoxTreeItem.- Returns:
- the indeterminate state property of this CheckBoxTreeItem
- See Also:
-
independentProperty
ABooleanProperty
used to represent the independent state of this CheckBoxTreeItem. The independent state is used to represent whether changes to a single CheckBoxTreeItem should influence the state of its parent and children.By default, the independent property is false, which means that when a CheckBoxTreeItem has state changes to the selected or indeterminate properties, the state of related CheckBoxTreeItems will possibly be changed. If the independent property is set to true, the state of related CheckBoxTreeItems will never change.
- Returns:
- the independent state property of this CheckBoxTreeItem
- See Also:
-
setIndependent
public final void setIndependent(boolean value) Sets the value of theindependent
property.- Property description:
- A
BooleanProperty
used to represent the independent state of this CheckBoxTreeItem. The independent state is used to represent whether changes to a single CheckBoxTreeItem should influence the state of its parent and children.By default, the independent property is false, which means that when a CheckBoxTreeItem has state changes to the selected or indeterminate properties, the state of related CheckBoxTreeItems will possibly be changed. If the independent property is set to true, the state of related CheckBoxTreeItems will never change.
- Parameters:
value
- the value for theindependent
property- See Also:
-
isIndependent
public final boolean isIndependent()Gets the value of theindependent
property.- Property description:
- A
BooleanProperty
used to represent the independent state of this CheckBoxTreeItem. The independent state is used to represent whether changes to a single CheckBoxTreeItem should influence the state of its parent and children.By default, the independent property is false, which means that when a CheckBoxTreeItem has state changes to the selected or indeterminate properties, the state of related CheckBoxTreeItems will possibly be changed. If the independent property is set to true, the state of related CheckBoxTreeItems will never change.
- Returns:
- the value of the
independent
property - See Also:
-