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

By default, the CheckBoxTableCell is rendered with a CheckBox centred in
the TableColumn. If a label is required, it is necessary to provide a
non-null StringConverter instance to the
CheckBoxTableCell(Callback, StringConverter) constructor.

To construct an instance of this class, it is necessary to provide a
Callback that, given an object of type T, will return an
ObservableProperty<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).

Note that the CheckBoxTableCell 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.

Method Detail

forTableColumn

Creates a cell factory for use in a TableColumn cell factory.
This method requires that the TableColumn be of type Boolean.

When used in a TableColumn, the CheckBoxCell is rendered with a
CheckBox centered in the column.

The ObservableValue<Boolean> contained within each cell in the
column will be bound bidirectionally. This means 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:

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

forTableColumn

Creates a cell factory for use in a TableColumn cell factory.
This method requires that the TableColumn be of type
ObservableValue<Boolean>.

When used in a TableColumn, the CheckBoxCell is rendered with a
CheckBox centered in the column.

Type Parameters:

T - The type of the elements contained within the TableColumn
instance.

Parameters:

getSelectedProperty - A Callback that, given an object of
type TableColumn<S,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:

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

forTableColumn

Creates a cell factory for use in a TableColumn cell factory.
This method requires that the TableColumn be of type
ObservableValue<Boolean>.

When used in a TableColumn, the CheckBoxCell is rendered with a
CheckBox centered in the column.

Type Parameters:

T - The type of the elements contained within the TableColumn
instance.

Parameters:

getSelectedProperty - A Callback that, given an object of
type TableColumn<S,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).

showLabel - In some cases, it may be desirable to show a label in
the TableCell beside the CheckBox. By default a label is not
shown, but by setting this to true the item in the cell will also
have toString() called on it. If this is not the desired behavior,
consider using
forTableColumn(javafx.util.Callback, javafx.util.StringConverter),
which allows for you to provide a callback that specifies the label for a
given row item.

Returns:

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

forTableColumn

Creates a cell factory for use in a TableColumn cell factory.
This method requires that the TableColumn be of type
ObservableValue<Boolean>.

When used in a TableColumn, the CheckBoxCell is rendered with a
CheckBox centered in the column.

Type Parameters:

T - The type of the elements contained within the TableColumn
instance.

Parameters:

getSelectedProperty - A Callback that, given an object of type
TableColumn<S,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 - A StringConverter that, give an object of type T, will return a
String that can be used to represent the object visually. The default
implementation in forTableColumn(Callback, boolean) (when
showLabel is true) 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:

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

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
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:

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.