T
- The type of the elements contained within the TableColumn.public class CheckBoxTableCell<S,T>
extends <any>
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.
Type | Property and Description |
---|---|
<any> |
converter
The
StringConverter property. |
<any> |
selectedStateCallback
Property representing the
Callback that is bound to by the
CheckBox shown on screen. |
Modifier and Type | Field and Description |
---|---|
private <any> |
booleanProperty |
private CheckBox |
checkBox
*
Fields *
*
|
private <any> |
converter
*
Properties *
*
|
private <any> |
selectedStateCallback |
private boolean |
showLabel |
Constructor and Description |
---|
CheckBoxTableCell()
Creates a default CheckBoxTableCell.
|
CheckBoxTableCell(<any> getSelectedProperty)
Creates a default CheckBoxTableCell with a custom
Callback to
retrieve an ObservableValue for a given cell index. |
CheckBoxTableCell(<any> getSelectedProperty,
<any> converter)
Creates a CheckBoxTableCell with a custom string converter.
|
Modifier and Type | Method and Description |
---|---|
<any> |
converterProperty()
The
StringConverter property. |
static <S> <any> |
forTableColumn(<any> column)
Creates a cell factory for use in a
TableColumn cell factory. |
static <S,T> <any> |
forTableColumn(<any> getSelectedProperty)
Creates a cell factory for use in a
TableColumn cell factory. |
static <S,T> <any> |
forTableColumn(<any> getSelectedProperty,
<any> converter)
Creates a cell factory for use in a
TableColumn cell factory. |
static <S,T> <any> |
forTableColumn(<any> getSelectedProperty,
boolean showLabel)
Creates a cell factory for use in a
TableColumn cell factory. |
<any> |
getConverter()
Returns the
StringConverter used in this cell. |
private <any> |
getSelectedProperty() |
<any> |
getSelectedStateCallback()
Returns the
Callback that is bound to by the CheckBox shown on screen. |
<any> |
selectedStateCallbackProperty()
Property representing the
Callback that is bound to by the
CheckBox shown on screen. |
void |
setConverter(<any> value)
Sets the
StringConverter to be used in this cell. |
void |
setSelectedStateCallback(<any> value)
Sets the
Callback that is bound to by the CheckBox shown on screen. |
void |
updateItem(T item,
boolean empty) |
private void |
updateShowLabel()
*
Private implementation *
*
|
public final <any> converterProperty
StringConverter
property.StringConverter
propertypublic final <any> selectedStateCallbackProperty
Callback
that is bound to by the
CheckBox shown on screen.getSelectedStateCallback()
,
#setSelectedStateCallback()
private final CheckBox checkBox
private boolean showLabel
private <any> booleanProperty
private <any> converter
private <any> selectedStateCallback
public CheckBoxTableCell()
public CheckBoxTableCell(<any> getSelectedProperty)
Callback
to
retrieve an ObservableValue for a given cell index.getSelectedProperty
- A Callback
that will return an ObservableValue
given an index from the TableColumn.public CheckBoxTableCell(<any> getSelectedProperty, <any> converter)
getSelectedProperty
- A Callback
that will return a ObservableValue
given an index from the TableColumn.converter
- A StringConverter that, given an object of type T, will return a
String that can be used to represent the object visually.public static <S> <any> forTableColumn(<any> column)
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).
S
- The type of the TableView generic typecolumn
- The TableColumn of type BooleanCallback
that will return a TableCell
that is
able to work on the type of element contained within the TableColumn.public static <S,T> <any> forTableColumn(<any> getSelectedProperty)
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.
S
- The type of the TableView generic typeT
- The type of the elements contained within the TableColumn
instance.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).Callback
that will return a TableCell
that is
able to work on the type of element contained within the TableColumn.public static <S,T> <any> forTableColumn(<any> getSelectedProperty, boolean showLabel)
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.
S
- The type of the TableView generic typeT
- The type of the elements contained within the TableColumn
instance.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.Callback
that will return a TableCell
that is
able to work on the type of element contained within the TableColumn.public static <S,T> <any> forTableColumn(<any> getSelectedProperty, <any> converter)
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.
S
- The type of the TableView generic typeT
- The type of the elements contained within the TableColumn
instance.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).Callback
that will return a TableCell
that is
able to work on the type of element contained within the TableColumn.public final <any> converterProperty()
StringConverter
property.StringConverter
propertypublic final void setConverter(<any> value)
StringConverter
to be used in this cell.value
- the StringConverter
to be used in this cellpublic final <any> getConverter()
StringConverter
used in this cell.StringConverter
used in this cellpublic final <any> selectedStateCallbackProperty()
Callback
that is bound to by the
CheckBox shown on screen.getSelectedStateCallback()
,
#setSelectedStateCallback()
public final void setSelectedStateCallback(<any> value)
Callback
that is bound to by the CheckBox shown on screen.value
- the Callback
that is bound to by the CheckBox shown
on screenpublic final <any> getSelectedStateCallback()
Callback
that is bound to by the CheckBox shown on screen.Callback
that is bound to by the CheckBox shown on screenpublic void updateItem(T item, boolean empty)
private void updateShowLabel()
private <any> getSelectedProperty()