JavaFX 25 · javafx.scene.control.cell.CheckBoxTreeCell

A class containing a TreeCell implementation that draws a CheckBox node inside the cell, along with support for common interactions (discussed in more depth shortly).

To make creating TreeViews with CheckBoxes easier, a convenience class called CheckBoxTreeItem is provided. It is highly recommended that developers use this class, rather than the regular TreeItem class, when constructing their TreeView tree structures. Refer to the CheckBoxTreeItem API documentation for an example on how these two classes can be combined.

When used in a TreeView, the CheckBoxCell is rendered with a CheckBox to the right of the 'disclosure node' (i.e. the arrow). The item stored in CheckBoxTreeItem#getValue() will then have the StringConverter called on it, and this text will take all remaining horizontal space. Additionally, by using CheckBoxTreeItem, the TreeView will automatically handle situations such as:

Clicking on the CheckBox beside an item that has children will result in all children also becoming selected/unselected.
Clicking on the CheckBox beside an item that has a parent will possibly toggle the state of the parent. For example, if you select a single child, the parent will become indeterminate (indicating partial selection of children). If you proceed to select all children, the parent will then show that it too is selected. This is recursive, with all parent nodes updating as expected.

If it is decided that using CheckBoxTreeItem is not desirable, then it is necessary to call one of the constructors where a Callback is provided that can return an ObservableValue<Boolean> given a TreeItem instance. This ObservableValue<Boolean> should represent the boolean state of the given TreeItem.

Note that the CheckBoxTreeCell renders the CheckBox 'live', meaning that the CheckBox is always interactive and can be directly toggled by the user. This means that it is not necessary that the cell enter its editing state (usually by the user double-clicking on the cell). A side-effect of this is that the usual editing callbacks (such as on edit commit) will not be called. If you want to be notified of changes, it is recommended to directly observe the boolean properties that are manipulated by the CheckBox.

Modifier and Type	Field and Description
private ObservableValue<Boolean>	booleanProperty
private final CheckBox	checkBox
private ObjectProperty<StringConverter<TreeItem<T>>>	converter
private BooleanProperty	indeterminateProperty
private ObjectProperty<Callback<TreeItem<T>, ObservableValue<Boolean>>>	selectedStateCallback

Constructor Summary

Access	Constructor and Description
public	CheckBoxTreeCell() Creates a default `CheckBoxTreeCell` that assumes the TreeView is constructed with `CheckBoxTreeItem` instances, rather than the default `TreeItem`.
public	CheckBoxTreeCell(final Callback<TreeItem<T>, ObservableValue<Boolean>> A `Callback` that will return an `ObservableValue<Boolean>` that represents whether the given item is selected or not. getSelectedProperty) Creates a `CheckBoxTreeCell` for use in a TreeView control via a cell factory.
public	CheckBoxTreeCell(final Callback<TreeItem<T>, ObservableValue<Boolean>> A `Callback` that will return an `ObservableValue<Boolean>` that represents whether the given item is selected or not. getSelectedProperty, final StringConverter<TreeItem<T>> A StringConverter that, give an object of type TreeItem<T>, will return a String that can be used to represent the object visually. converter) Creates a `CheckBoxTreeCell` for use in a TreeView control via a cell factory.
private	CheckBoxTreeCell(final Callback<TreeItem<T>, ObservableValue<Boolean>> getSelectedProperty, final StringConverter<TreeItem<T>> converter, final Callback<TreeItem<T>, ObservableValue<Boolean>> getIndeterminateProperty)

Method Summary

Modifier and Type	Method and Description
public final ObjectProperty<StringConverter<TreeItem<T>>>	Returns: the `StringConverter` property converterProperty() The `StringConverter` property.
public static < The type of the elements contained within the `CheckBoxTreeItem` instances. T> Callback<TreeView<T>, TreeCell<T>>	Returns: A `Callback` that will return a TreeCell that is able to work on the type of element contained within the TreeView root, and all of its children (recursively). forTreeView() Creates a cell factory for use in a TreeView control, although there is a major assumption when used in a TreeView: this cell factory assumes that the TreeView root, and all children are instances of `CheckBoxTreeItem`, rather than the default `TreeItem` class that is used normally.
public static < The type of the elements contained within the `TreeItem` instances. T> Callback<TreeView<T>, TreeCell<T>>	Returns: A `Callback` that will return a TreeCell that is able to work on the type of element contained within the TreeView root, and all of its children (recursively). forTreeView(final Callback<TreeItem<T>, ObservableValue<Boolean>> A `Callback` that, given an object of type TreeItem<T>, will return an `ObservableValue<Boolean>` that represents whether the given item is selected or not. This `ObservableValue<Boolean>` will be bound bidirectionally (meaning that the CheckBox in the cell will set/unset this property based on user interactions, and the CheckBox will reflect the state of the `ObservableValue<Boolean>`, if it changes externally). getSelectedProperty) Creates a cell factory for use in a TreeView control.
public static < The type of the elements contained within the `TreeItem` instances. T> Callback<TreeView<T>, TreeCell<T>>	Returns: A `Callback` that will return a TreeCell that is able to work on the type of element contained within the TreeView root, and all of its children (recursively). forTreeView(final Callback<TreeItem<T>, ObservableValue<Boolean>> A Callback that, given an object of type TreeItem<T>, will return an `ObservableValue<Boolean>` that represents whether the given item is selected or not. This `ObservableValue<Boolean>` will be bound bidirectionally (meaning that the CheckBox in the cell will set/unset this property based on user interactions, and the CheckBox will reflect the state of the `ObservableValue<Boolean>`, if it changes externally). getSelectedProperty, final StringConverter<TreeItem<T>> A StringConverter that, give an object of type TreeItem<T>, will return a String that can be used to represent the object visually. The default implementation in `forTreeView(Callback)` is to simply call .toString() on all non-null items (and to just return an empty string in cases where the given item is null). converter) Creates a cell factory for use in a TreeView control.
public final StringConverter<TreeItem<T>>	Returns: the `StringConverter` used in this cell getConverter() Returns the `StringConverter` used in this cell.
public final Callback<TreeItem<T>, ObservableValue<Boolean>>	Returns: the `Callback` that is bound to by the CheckBox shown on screen getSelectedStateCallback() Returns the `Callback` that is bound to by the CheckBox shown on screen.
public Object	queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters) Overrides javafx.scene.control.TreeCell.queryAccessibleAttribute. This method is called by the assistive technology to request the value for an attribute.
public final ObjectProperty<Callback<TreeItem<T>, ObservableValue<Boolean>>>	Returns: the property representing the `Callback` that is bound to by the CheckBox shown on screen selectedStateCallbackProperty() Property representing the `Callback` that is bound to by the CheckBox shown on screen.
public final void	setConverter(StringConverter<TreeItem<T>> the `StringConverter` to be used in this cell value) Sets the `StringConverter` to be used in this cell.
public final void	setSelectedStateCallback(Callback<TreeItem<T>, ObservableValue<Boolean>> the `Callback` that is bound to by the CheckBox shown on screen value) Sets the `Callback` that is bound to by the CheckBox shown on screen.
pack-priv void	updateDisplay(T item, boolean empty) Overrides javafx.scene.control.cell.DefaultTreeCell.updateDisplay.
public void	updateItem(T item, boolean empty) Overrides javafx.scene.control.cell.DefaultTreeCell.updateItem. The updateItem method should not be called by developers, but it is the best method for developers to override to allow for them to customise the visuals of the cell.

Field Detail

booleanProperty	back to summary
private ObservableValue<Boolean> booleanProperty

checkBox	back to summary
private final CheckBox checkBox

converter	back to summary
private ObjectProperty<StringConverter<TreeItem<T>>> converter

indeterminateProperty	back to summary
private BooleanProperty indeterminateProperty

selectedStateCallback	back to summary
private ObjectProperty<Callback<TreeItem<T>, ObservableValue<Boolean>>> selectedStateCallback

Constructor Detail

CheckBoxTreeCell	back to summary
public CheckBoxTreeCell() Creates a default `CheckBoxTreeCell` that assumes the TreeView is constructed with `CheckBoxTreeItem` instances, rather than the default `TreeItem`. By using `CheckBoxTreeItem`, it will internally manage the selected and indeterminate state of each item in the tree.

CheckBoxTreeCell back to summary

CheckBoxTreeCell	back to summary
public CheckBoxTreeCell(final Callback<TreeItem<T>, ObservableValue<Boolean>> getSelectedProperty) Creates a `CheckBoxTreeCell` for use in a TreeView control via a cell factory. Unlike `CheckBoxTreeCell#CheckBoxTreeCell()`, this method does not assume that all TreeItem instances in the TreeView are `CheckBoxTreeItem`. To call this method, it is necessary to provide a `Callback` that, given an object of type TreeItem<T>, will return an `ObservableValue<Boolean>` that represents whether the given item is selected or not. This `ObservableValue<Boolean>` will be bound bidirectionally (meaning that the CheckBox in the cell will set/unset this property based on user interactions, and the CheckBox will reflect the state of the `ObservableValue<Boolean>`, if it changes externally). If the items are not `CheckBoxTreeItem` instances, it becomes the developers responsibility to handle updating the state of parent and children TreeItems. This means that, given a TreeItem, this class will simply toggles the `ObservableValue<Boolean>` that is provided, and no more. Of course, this functionality can then be implemented externally by adding observers to the `ObservableValue<Boolean>`, and toggling the state of other properties as necessary. Parameters getSelectedProperty:Callback<TreeItem<T>, ObservableValue<Boolean>> A `Callback` that will return an `ObservableValue<Boolean>` that represents whether the given item is selected or not.

public CheckBoxTreeCell(final Callback<TreeItem<T>, ObservableValue<Boolean>> getSelectedProperty)

Creates a CheckBoxTreeCell for use in a TreeView control via a cell factory. Unlike CheckBoxTreeCell#CheckBoxTreeCell(), this method does not assume that all TreeItem instances in the TreeView are CheckBoxTreeItem.

To call this method, it is necessary to provide a Callback that, given an object of type TreeItem<T>, will return an ObservableValue<Boolean> that represents whether the given item is selected or not. This ObservableValue<Boolean> will be bound bidirectionally (meaning that the CheckBox in the cell will set/unset this property based on user interactions, and the CheckBox will reflect the state of the ObservableValue<Boolean>, if it changes externally).

If the items are not CheckBoxTreeItem instances, it becomes the developers responsibility to handle updating the state of parent and children TreeItems. This means that, given a TreeItem, this class will simply toggles the ObservableValue<Boolean> that is provided, and no more. Of course, this functionality can then be implemented externally by adding observers to the ObservableValue<Boolean>, and toggling the state of other properties as necessary.

Parameters

getSelectedProperty:Callback<TreeItem<T>, ObservableValue<Boolean>>: A Callback that will return an ObservableValue<Boolean> that represents whether the given item is selected or not.

CheckBoxTreeCell back to summary

CheckBoxTreeCell	back to summary
public CheckBoxTreeCell(final Callback<TreeItem<T>, ObservableValue<Boolean>> getSelectedProperty, final StringConverter<TreeItem<T>> converter) Creates a `CheckBoxTreeCell` for use in a TreeView control via a cell factory. Unlike `CheckBoxTreeCell#CheckBoxTreeCell()`, this method does not assume that all TreeItem instances in the TreeView are `CheckBoxTreeItem`. To call this method, it is necessary to provide a `Callback` that, given an object of type TreeItem<T>, will return an `ObservableValue<Boolean>` that represents whether the given item is selected or not. This `ObservableValue<Boolean>` will be bound bidirectionally (meaning that the CheckBox in the cell will set/unset this property based on user interactions, and the CheckBox will reflect the state of the `ObservableValue<Boolean>`, if it changes externally). If the items are not `CheckBoxTreeItem` instances, it becomes the developers responsibility to handle updating the state of parent and children TreeItems. This means that, given a TreeItem, this class will simply toggles the `ObservableValue<Boolean>` that is provided, and no more. Of course, this functionality can then be implemented externally by adding observers to the `ObservableValue<Boolean>`, and toggling the state of other properties as necessary. Parameters getSelectedProperty:Callback<TreeItem<T>, ObservableValue<Boolean>> A `Callback` that will return an `ObservableValue<Boolean>` that represents whether the given item is selected or not. converter:StringConverter<TreeItem<T>> A StringConverter that, give an object of type TreeItem<T>, will return a String that can be used to represent the object visually.

public CheckBoxTreeCell(final Callback<TreeItem<T>, ObservableValue<Boolean>> getSelectedProperty, final StringConverter<TreeItem<T>> converter)

Parameters

getSelectedProperty:Callback<TreeItem<T>, ObservableValue<Boolean>>: A Callback that will return an ObservableValue<Boolean> that represents whether the given item is selected or not.
converter:StringConverter<TreeItem<T>>: A StringConverter that, give an object of type TreeItem<T>, will return a String that can be used to represent the object visually.

CheckBoxTreeCell	back to summary
private CheckBoxTreeCell(final Callback<TreeItem<T>, ObservableValue<Boolean>> getSelectedProperty, final StringConverter<TreeItem<T>> converter, final Callback<TreeItem<T>, ObservableValue<Boolean>> getIndeterminateProperty)

Method Detail

converterProperty back to summary

converterProperty	back to summary
public final ObjectProperty<StringConverter<TreeItem<T>>> converterProperty() The `StringConverter` property. Returns:ObjectProperty<StringConverter<TreeItem<T>>> the `StringConverter` property

public final ObjectProperty<StringConverter<TreeItem<T>>> converterProperty()

The StringConverter property.

Returns:ObjectProperty<StringConverter<TreeItem<T>>>: the StringConverter property

forTreeView back to summary

forTreeView	back to summary
public static <T> Callback<TreeView<T>, TreeCell<T>> forTreeView() Creates a cell factory for use in a TreeView control, although there is a major assumption when used in a TreeView: this cell factory assumes that the TreeView root, and all children are instances of `CheckBoxTreeItem`, rather than the default `TreeItem` class that is used normally. When used in a TreeView, the CheckBoxCell is rendered with a CheckBox to the right of the 'disclosure node' (i.e. the arrow). The item stored in `CheckBoxTreeItem#getValue()` will then have the StringConverter called on it, and this text will take all remaining horizontal space. Additionally, by using `CheckBoxTreeItem`, the TreeView will automatically handle situations such as: Clicking on the `CheckBox` beside an item that has children will result in all children also becoming selected/unselected. Clicking on the `CheckBox` beside an item that has a parent will possibly toggle the state of the parent. For example, if you select a single child, the parent will become indeterminate (indicating partial selection of children). If you proceed to select all children, the parent will then show that it too is selected. This is recursive, with all parent nodes updating as expected. Unfortunately, due to limitations in Java, it is necessary to provide an explicit cast when using this method. For example: `final TreeView<String> treeView = new TreeView<String>(); treeView.setCellFactory(CheckBoxCell.<String>forTreeView());` Parameters <T> The type of the elements contained within the `CheckBoxTreeItem` instances. Returns:Callback<TreeView<T>, TreeCell<T>> A `Callback` that will return a TreeCell that is able to work on the type of element contained within the TreeView root, and all of its children (recursively).

public static <T> Callback<TreeView<T>, TreeCell<T>> forTreeView()

Creates a cell factory for use in a TreeView control, although there is a major assumption when used in a TreeView: this cell factory assumes that the TreeView root, and all children are instances of CheckBoxTreeItem, rather than the default TreeItem class that is used normally.

Clicking on the CheckBox beside an item that has children will result in all children also becoming selected/unselected.
Clicking on the CheckBox beside an item that has a parent will possibly toggle the state of the parent. For example, if you select a single child, the parent will become indeterminate (indicating partial selection of children). If you proceed to select all children, the parent will then show that it too is selected. This is recursive, with all parent nodes updating as expected.

Unfortunately, due to limitations in Java, it is necessary to provide an explicit cast when using this method. For example:

final TreeView<String> treeView = new TreeView<String>();
treeView.setCellFactory(CheckBoxCell.<String>forTreeView());

Parameters

<T>: The type of the elements contained within the CheckBoxTreeItem instances.

Returns:Callback<TreeView<T>, TreeCell<T>>

A Callback that will return a TreeCell that is able to work on the type of element contained within the TreeView root, and all of its children (recursively).

forTreeView back to summary

forTreeView	back to summary
public static <T> Callback<TreeView<T>, TreeCell<T>> forTreeView(final Callback<TreeItem<T>, ObservableValue<Boolean>> getSelectedProperty) Creates a cell factory for use in a TreeView control. Unlike `forTreeView()`, this method does not assume that all TreeItem instances in the TreeView are `CheckBoxTreeItem` instances. When used in a TreeView, the CheckBoxCell is rendered with a CheckBox to the right of the 'disclosure node' (i.e. the arrow). The item stored in `CheckBoxTreeItem#getValue()` will then have the StringConverter called on it, and this text will take all remaining horizontal space. Unlike `forTreeView()`, this cell factory does not handle updating the state of parent or children TreeItems - it simply toggles the `ObservableValue<Boolean>` that is provided, and no more. Of course, this functionality can then be implemented externally by adding observers to the `ObservableValue<Boolean>`, and toggling the state of other properties as necessary. Parameters <T> The type of the elements contained within the `TreeItem` instances. getSelectedProperty:Callback<TreeItem<T>, ObservableValue<Boolean>> A `Callback` that, given an object of type TreeItem<T>, will return an `ObservableValue<Boolean>` that represents whether the given item is selected or not. This `ObservableValue<Boolean>` will be bound bidirectionally (meaning that the CheckBox in the cell will set/unset this property based on user interactions, and the CheckBox will reflect the state of the `ObservableValue<Boolean>`, if it changes externally). Returns:Callback<TreeView<T>, TreeCell<T>> A `Callback` that will return a TreeCell that is able to work on the type of element contained within the TreeView root, and all of its children (recursively).

public static <T> Callback<TreeView<T>, TreeCell<T>> forTreeView(final Callback<TreeItem<T>, ObservableValue<Boolean>> getSelectedProperty)

Creates a cell factory for use in a TreeView control. Unlike forTreeView(), this method does not assume that all TreeItem instances in the TreeView are CheckBoxTreeItem instances.

Unlike forTreeView(), this cell factory does not handle updating the state of parent or children TreeItems - it simply toggles the ObservableValue<Boolean> that is provided, and no more. Of course, this functionality can then be implemented externally by adding observers to the ObservableValue<Boolean>, and toggling the state of other properties as necessary.

Parameters

<T>: The type of the elements contained within the TreeItem instances.
getSelectedProperty:Callback<TreeItem<T>, ObservableValue<Boolean>>: A Callback that, given an object of type TreeItem<T>, will return an ObservableValue<Boolean> that represents whether the given item is selected or not. This ObservableValue<Boolean> will be bound bidirectionally (meaning that the CheckBox in the cell will set/unset this property based on user interactions, and the CheckBox will reflect the state of the ObservableValue<Boolean>, if it changes externally).

Returns:Callback<TreeView<T>, TreeCell<T>>

A Callback that will return a TreeCell that is able to work on the type of element contained within the TreeView root, and all of its children (recursively).

forTreeView back to summary

forTreeView	back to summary
public static <T> Callback<TreeView<T>, TreeCell<T>> forTreeView(final Callback<TreeItem<T>, ObservableValue<Boolean>> getSelectedProperty, final StringConverter<TreeItem<T>> converter) Creates a cell factory for use in a TreeView control. Unlike `forTreeView()`, this method does not assume that all TreeItem instances in the TreeView are `CheckBoxTreeItem`. When used in a TreeView, the CheckBoxCell is rendered with a CheckBox to the right of the 'disclosure node' (i.e. the arrow). The item stored in `TreeItem#getValue()` will then have the the StringConverter called on it, and this text will take all remaining horizontal space. Unlike `forTreeView()`, this cell factory does not handle updating the state of parent or children TreeItems - it simply toggles the `ObservableValue<Boolean>` that is provided, and no more. Of course, this functionality can then be implemented externally by adding observers to the `ObservableValue<Boolean>`, and toggling the state of other properties as necessary. Parameters <T> The type of the elements contained within the `TreeItem` instances. getSelectedProperty:Callback<TreeItem<T>, ObservableValue<Boolean>> A Callback that, given an object of type TreeItem<T>, will return an `ObservableValue<Boolean>` that represents whether the given item is selected or not. This `ObservableValue<Boolean>` will be bound bidirectionally (meaning that the CheckBox in the cell will set/unset this property based on user interactions, and the CheckBox will reflect the state of the `ObservableValue<Boolean>`, if it changes externally). converter:StringConverter<TreeItem<T>> A StringConverter that, give an object of type TreeItem<T>, will return a String that can be used to represent the object visually. The default implementation in `forTreeView(Callback)` is to simply call .toString() on all non-null items (and to just return an empty string in cases where the given item is null). Returns:Callback<TreeView<T>, TreeCell<T>> A `Callback` that will return a TreeCell that is able to work on the type of element contained within the TreeView root, and all of its children (recursively).

public static <T> Callback<TreeView<T>, TreeCell<T>> forTreeView(final Callback<TreeItem<T>, ObservableValue<Boolean>> getSelectedProperty, final StringConverter<TreeItem<T>> converter)

Creates a cell factory for use in a TreeView control. Unlike forTreeView(), this method does not assume that all TreeItem instances in the TreeView are CheckBoxTreeItem.

When used in a TreeView, the CheckBoxCell is rendered with a CheckBox to the right of the 'disclosure node' (i.e. the arrow). The item stored in TreeItem#getValue() will then have the the StringConverter called on it, and this text will take all remaining horizontal space.

Parameters

<T>: The type of the elements contained within the TreeItem instances.
getSelectedProperty:Callback<TreeItem<T>, ObservableValue<Boolean>>: A Callback that, given an object of type TreeItem<T>, will return an ObservableValue<Boolean> that represents whether the given item is selected or not. This ObservableValue<Boolean> will be bound bidirectionally (meaning that the CheckBox in the cell will set/unset this property based on user interactions, and the CheckBox will reflect the state of the ObservableValue<Boolean>, if it changes externally).
converter:StringConverter<TreeItem<T>>: A StringConverter that, give an object of type TreeItem<T>, will return a String that can be used to represent the object visually. The default implementation in forTreeView(Callback) is to simply call .toString() on all non-null items (and to just return an empty string in cases where the given item is null).

Returns:Callback<TreeView<T>, TreeCell<T>>

A Callback that will return a TreeCell that is able to work on the type of element contained within the TreeView root, and all of its children (recursively).

getConverter back to summary

getConverter	back to summary
public final StringConverter<TreeItem<T>> getConverter() Returns the `StringConverter` used in this cell. Returns:StringConverter<TreeItem<T>> the `StringConverter` used in this cell

public final StringConverter<TreeItem<T>> getConverter()

Returns the StringConverter used in this cell.

Returns:StringConverter<TreeItem<T>>: the StringConverter used in this cell

getSelectedStateCallback back to summary

getSelectedStateCallback	back to summary
public final Callback<TreeItem<T>, ObservableValue<Boolean>> getSelectedStateCallback() Returns the `Callback` that is bound to by the CheckBox shown on screen. Returns:Callback<TreeItem<T>, ObservableValue<Boolean>> the `Callback` that is bound to by the CheckBox shown on screen

public final Callback<TreeItem<T>, ObservableValue<Boolean>> getSelectedStateCallback()

Returns the Callback that is bound to by the CheckBox shown on screen.

Returns:Callback<TreeItem<T>, ObservableValue<Boolean>>: the Callback that is bound to by the CheckBox shown on screen

queryAccessibleAttribute	back to summary
public Object queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters) Overrides javafx.scene.control.TreeCell.queryAccessibleAttribute. Doc from javafx.scene.control.TreeCell.queryAccessibleAttribute. This method is called by the assistive technology to request the value for an attribute. This method is commonly overridden by subclasses to implement attributes that are required for a specific role. If a particular attribute is not handled, the superclass implementation must be called. Annotations @Override

queryAccessibleAttribute

back to summary

public Object queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)

Overrides javafx.scene.control.TreeCell.queryAccessibleAttribute.

Doc from javafx.scene.control.TreeCell.queryAccessibleAttribute.

This method is called by the assistive technology to request the value for an attribute.

This method is commonly overridden by subclasses to implement attributes that are required for a specific role.
If a particular attribute is not handled, the superclass implementation must be called.

Annotations

@Override

selectedStateCallbackProperty back to summary

selectedStateCallbackProperty	back to summary
public final ObjectProperty<Callback<TreeItem<T>, ObservableValue<Boolean>>> selectedStateCallbackProperty() Property representing the `Callback` that is bound to by the CheckBox shown on screen. Returns:ObjectProperty<Callback<TreeItem<T>, ObservableValue<Boolean>>> the property representing the `Callback` that is bound to by the CheckBox shown on screen

public final ObjectProperty<Callback<TreeItem<T>, ObservableValue<Boolean>>> selectedStateCallbackProperty()

Property representing the Callback that is bound to by the CheckBox shown on screen.

Returns:ObjectProperty<Callback<TreeItem<T>, ObservableValue<Boolean>>>: the property representing the Callback that is bound to by the CheckBox shown on screen

setConverter back to summary

setConverter	back to summary
public final void setConverter(StringConverter<TreeItem<T>> value) Sets the `StringConverter` to be used in this cell. Parameters value:StringConverter<TreeItem<T>> the `StringConverter` to be used in this cell

public final void setConverter(StringConverter<TreeItem<T>> value)

Sets the StringConverter to be used in this cell.

Parameters

value:StringConverter<TreeItem<T>>: the StringConverter to be used in this cell

setSelectedStateCallback back to summary

setSelectedStateCallback	back to summary
public final void setSelectedStateCallback(Callback<TreeItem<T>, ObservableValue<Boolean>> value) Sets the `Callback` that is bound to by the CheckBox shown on screen. Parameters value:Callback<TreeItem<T>, ObservableValue<Boolean>> the `Callback` that is bound to by the CheckBox shown on screen

public final void setSelectedStateCallback(Callback<TreeItem<T>, ObservableValue<Boolean>> value)

Sets the Callback that is bound to by the CheckBox shown on screen.

Parameters

value:Callback<TreeItem<T>, ObservableValue<Boolean>>: the Callback that is bound to by the CheckBox shown on screen

updateDisplay	back to summary
pack-priv void updateDisplay(T item, boolean empty) Overrides javafx.scene.control.cell.DefaultTreeCell.updateDisplay. Annotations @Override

updateDisplay

back to summary

pack-priv void updateDisplay(T item, boolean empty)

Overrides javafx.scene.control.cell.DefaultTreeCell.updateDisplay.

Annotations

@Override

updateItem back to summary

updateItem	back to summary
public void updateItem(T item, boolean empty) Overrides javafx.scene.control.cell.DefaultTreeCell.updateItem. Doc from javafx.scene.control.Cell.updateItem. The updateItem method should not be called by developers, but it is the best method for developers to override to allow for them to customise the visuals of the cell. To clarify, developers should never call this method in their code (they should leave it up to the UI control, such as the `javafx.scene.control.ListView` control) to call this method. However, the purpose of having the updateItem method is so that developers, when specifying custom cell factories (again, like the ListView `cell factory`), the updateItem method can be overridden to allow for complete customisation of the cell. It is very important that subclasses of Cell override the updateItem method properly, as failure to do so will lead to issues such as blank cells or cells with unexpected content appearing within them. Here is an example of how to properly override the updateItem method: protected void updateItem(T item, boolean empty) { super.updateItem(item, empty); if (empty \|\| item == null) { setText(null); setGraphic(null); } else { setText(item.toString()); } } Note in this code sample two important points: We call the super.updateItem(T, boolean) method. If this is not done, the item and empty properties are not correctly set, and you are likely to end up with graphical issues. We test for the `empty` condition, and if true, we set the text and graphic properties to null. If we do not do this, it is almost guaranteed that end users will see graphical artifacts in cells unexpectedly. Annotations @Override

public void updateItem(T item, boolean empty)

Overrides javafx.scene.control.cell.DefaultTreeCell.updateItem.

Doc from javafx.scene.control.Cell.updateItem.

The updateItem method should not be called by developers, but it is the best method for developers to override to allow for them to customise the visuals of the cell. To clarify, developers should never call this method in their code (they should leave it up to the UI control, such as the javafx.scene.control.ListView control) to call this method. However, the purpose of having the updateItem method is so that developers, when specifying custom cell factories (again, like the ListView cell factory), the updateItem method can be overridden to allow for complete customisation of the cell.

It is very important that subclasses of Cell override the updateItem method properly, as failure to do so will lead to issues such as blank cells or cells with unexpected content appearing within them. Here is an example of how to properly override the updateItem method:

protected void updateItem(T item, boolean empty) {
    super.updateItem(item, empty);

    if (empty || item == null) {
        setText(null);
        setGraphic(null);
    } else {
        setText(item.toString());
    }
}

Note in this code sample two important points:

We call the super.updateItem(T, boolean) method. If this is not done, the item and empty properties are not correctly set, and you are likely to end up with graphical issues.
We test for the empty condition, and if true, we set the text and graphic properties to null. If we do not do this, it is almost guaranteed that end users will see graphical artifacts in cells unexpectedly.

Annotations

@Override

public Class CheckBoxTreeCell<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail