JavaFX 24 · javafx.scene.control.cell.CheckBoxListCell

A class containing a ListCell implementation that draws a CheckBox node inside the cell, optionally with a label to indicate what the checkbox represents.

The CheckBoxListCell is rendered with a CheckBox on the left-hand side of the ListView, and the text related to the list item taking up all remaining horizontal space.

To construct an instance of this class, it is necessary to provide a Callback that, given an object of type T, will return a ObservableValue<Boolean> that represents whether the given item is selected or not. This ObservableValue 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).

Note that the CheckBoxListCell 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<T>>	converter
private ObjectProperty<Callback<T, ObservableValue<Boolean>>>	selectedStateCallback

Constructor Summary

Access	Constructor and Description
public	CheckBoxListCell() Creates a default CheckBoxListCell.
public	CheckBoxListCell(final Callback<T, ObservableValue<Boolean>> A `Callback` that will return an `ObservableValue<Boolean>` given an item from the ListView. getSelectedProperty) Creates a default CheckBoxListCell.
public	CheckBoxListCell(final Callback<T, ObservableValue<Boolean>> A `Callback` that will return an `ObservableValue<Boolean>` given an item from the ListView. getSelectedProperty, final StringConverter<T> A StringConverter that, given an object of type T, will return a String that can be used to represent the object visually. converter) Creates a CheckBoxListCell with a custom string converter.

Method Summary

Modifier and Type	Method and Description
public final ObjectProperty<StringConverter<T>>	Returns: the `StringConverter` property converterProperty() The `StringConverter` property.
public static < The type of the elements contained within the ListView. T> Callback<ListView<T>, ListCell<T>>	Returns: A `Callback` that will return a ListCell that is able to work on the type of element contained within the ListView items list. forListView(final Callback<T, ObservableValue<Boolean>> A `Callback` that, given an object of type T (which is a value taken out of the `ListView<T>.items` list), will return an `ObservableValue<Boolean>` that represents whether the given item is selected or not. This ObservableValue 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, if it changes externally). getSelectedProperty) Creates a cell factory for use in ListView controls.
public static < The type of the elements contained within the ListView. T> Callback<ListView<T>, ListCell<T>>	Returns: A `Callback` that will return a ListCell that is able to work on the type of element contained within the ListView. forListView(final Callback<T, ObservableValue<Boolean>> A `Callback` that, given an object of type T (which is a value taken out of the `ListView<T>.items` list), will return an `ObservableValue<Boolean>` that represents whether the given item is selected or not. This ObservableValue 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, if it changes externally). getSelectedProperty, final StringConverter<T> A StringConverter that, give an object of type T, will return a String that can be used to represent the object visually. converter) Creates a cell factory for use in ListView controls.
public final StringConverter<T>	Returns: the `StringConverter` used in this cell getConverter() Returns the `StringConverter` used in this cell.
public final Callback<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 final ObjectProperty<Callback<T, ObservableValue<Boolean>>>	Returns: 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<T> the `StringConverter` value) Sets the `StringConverter` to be used in this cell.
public final void	setSelectedStateCallback(Callback<T, ObservableValue<Boolean>> the `Callback` value) Sets the `Callback` that is bound to by the CheckBox shown on screen.
public void	updateItem(T The new item for the cell. item, boolean whether or not this cell represents data from the list. If it is empty, then it does not represent any domain data, but is a cell being used to render an "empty" row. empty) Overrides 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.

Inherited from javafx.scene.control.ListCell:: cancelEdit commitEdit createDefaultSkin executeAccessibleAction getListView layoutChildren listViewProperty queryAccessibleAttribute startEdit updateListView

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<T>> converter

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

Constructor Detail

CheckBoxListCell	back to summary
public CheckBoxListCell() Creates a default CheckBoxListCell.

CheckBoxListCell back to summary

CheckBoxListCell	back to summary
public CheckBoxListCell(final Callback<T, ObservableValue<Boolean>> getSelectedProperty) Creates a default CheckBoxListCell. Parameters getSelectedProperty:Callback<T, ObservableValue<Boolean>> A `Callback` that will return an `ObservableValue<Boolean>` given an item from the ListView.

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

Creates a default CheckBoxListCell.

Parameters

getSelectedProperty:Callback<T, ObservableValue<Boolean>>: A Callback that will return an ObservableValue<Boolean> given an item from the ListView.

CheckBoxListCell back to summary

CheckBoxListCell	back to summary
public CheckBoxListCell(final Callback<T, ObservableValue<Boolean>> getSelectedProperty, final StringConverter<T> converter) Creates a CheckBoxListCell with a custom string converter. Parameters getSelectedProperty:Callback<T, ObservableValue<Boolean>> A `Callback` that will return an `ObservableValue<Boolean>` given an item from the ListView. converter:StringConverter<T> A StringConverter that, given an object of type T, will return a String that can be used to represent the object visually.

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

Creates a CheckBoxListCell with a custom string converter.

Parameters

getSelectedProperty:Callback<T, ObservableValue<Boolean>>: A Callback that will return an ObservableValue<Boolean> given an item from the ListView.
converter:StringConverter<T>: A StringConverter that, given an object of type T, will return a String that can be used to represent the object visually.

Method Detail

converterProperty back to summary

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

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

The StringConverter property.

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

forListView back to summary

forListView	back to summary
public static <T> Callback<ListView<T>, ListCell<T>> forListView(final Callback<T, ObservableValue<Boolean>> getSelectedProperty) Creates a cell factory for use in ListView controls. When used in a ListView, the `CheckBoxListCell` is rendered with a CheckBox on the left-hand side of the ListView, with the text related to the list item taking up all remaining horizontal space. Parameters <T> The type of the elements contained within the ListView. getSelectedProperty:Callback<T, ObservableValue<Boolean>> A `Callback` that, given an object of type T (which is a value taken out of the `ListView<T>.items` list), will return an `ObservableValue<Boolean>` that represents whether the given item is selected or not. This ObservableValue 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, if it changes externally). Returns:Callback<ListView<T>, ListCell<T>> A `Callback` that will return a ListCell that is able to work on the type of element contained within the ListView items list.

public static <T> Callback<ListView<T>, ListCell<T>> forListView(final Callback<T, ObservableValue<Boolean>> getSelectedProperty)

Creates a cell factory for use in ListView controls. When used in a ListView, the CheckBoxListCell is rendered with a CheckBox on the left-hand side of the ListView, with the text related to the list item taking up all remaining horizontal space.

Parameters

<T>: The type of the elements contained within the ListView.
getSelectedProperty:Callback<T, ObservableValue<Boolean>>: A Callback that, given an object of type T (which is a value taken out of the ListView<T>.items list), will return an ObservableValue<Boolean> that represents whether the given item is selected or not. This ObservableValue 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, if it changes externally).

Returns:Callback<ListView<T>, ListCell<T>>

A Callback that will return a ListCell that is able to work on the type of element contained within the ListView items list.

forListView back to summary

forListView	back to summary
public static <T> Callback<ListView<T>, ListCell<T>> forListView(final Callback<T, ObservableValue<Boolean>> getSelectedProperty, final StringConverter<T> converter) Creates a cell factory for use in ListView controls. When used in a ListView, the `CheckBoxListCell` is rendered with a CheckBox on the left-hand side of the ListView, with the text related to the list item taking up all remaining horizontal space. Parameters <T> The type of the elements contained within the ListView. getSelectedProperty:Callback<T, ObservableValue<Boolean>> A `Callback` that, given an object of type T (which is a value taken out of the `ListView<T>.items` list), will return an `ObservableValue<Boolean>` that represents whether the given item is selected or not. This ObservableValue 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, if it changes externally). converter:StringConverter<T> A StringConverter that, give an object of type T, will return a String that can be used to represent the object visually. Returns:Callback<ListView<T>, ListCell<T>> A `Callback` that will return a ListCell that is able to work on the type of element contained within the ListView.

public static <T> Callback<ListView<T>, ListCell<T>> forListView(final Callback<T, ObservableValue<Boolean>> getSelectedProperty, final StringConverter<T> converter)

Parameters

<T>: The type of the elements contained within the ListView.
getSelectedProperty:Callback<T, ObservableValue<Boolean>>: A Callback that, given an object of type T (which is a value taken out of the ListView<T>.items list), will return an ObservableValue<Boolean> that represents whether the given item is selected or not. This ObservableValue 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, if it changes externally).
converter:StringConverter<T>: A StringConverter that, give an object of type T, will return a String that can be used to represent the object visually.

Returns:Callback<ListView<T>, ListCell<T>>

A Callback that will return a ListCell that is able to work on the type of element contained within the ListView.

getConverter back to summary

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

public final StringConverter<T> getConverter()

Returns the StringConverter used in this cell.

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

getSelectedStateCallback back to summary

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

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

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

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

selectedStateCallbackProperty back to summary

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

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

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

Returns:ObjectProperty<Callback<T, ObservableValue<Boolean>>>: 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<T> value) Sets the `StringConverter` to be used in this cell. Parameters value:StringConverter<T> the `StringConverter`

public final void setConverter(StringConverter<T> value)

Sets the StringConverter to be used in this cell.

Parameters

value:StringConverter<T>: the StringConverter

setSelectedStateCallback back to summary

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

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

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

Parameters

value:Callback<T, ObservableValue<Boolean>>: the Callback

updateItem back to summary

updateItem	back to summary
public void updateItem(T item, boolean empty) Overrides javafx.scene.control.Cell.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. Parameters item:T The new item for the cell. empty:boolean whether or not this cell represents data from the list. If it is empty, then it does not represent any domain data, but is a cell being used to render an "empty" row. Annotations @Override

public void updateItem(T item, boolean empty)

Overrides javafx.scene.control.Cell.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.

Parameters

item:T: The new item for the cell.
empty:boolean: whether or not this cell represents data from the list. If it is empty, then it does not represent any domain data, but is a cell being used to render an "empty" row.

Annotations

@Override

public Class CheckBoxListCell<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail