T
- The type of the elements contained within the ListView.public class CheckBoxListCell<T>
extends <any>
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.
CheckBox
,
ListCell
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 |
Constructor and Description |
---|
CheckBoxListCell()
Creates a default CheckBoxListCell.
|
CheckBoxListCell(<any> getSelectedProperty)
Creates a default CheckBoxListCell.
|
CheckBoxListCell(<any> getSelectedProperty,
<any> converter)
Creates a CheckBoxListCell with a custom string converter.
|
Modifier and Type | Method and Description |
---|---|
<any> |
converterProperty()
The
StringConverter property. |
static <T> <any> |
forListView(<any> getSelectedProperty)
Creates a cell factory for use in ListView controls.
|
static <T> <any> |
forListView(<any> getSelectedProperty,
<any> converter)
Creates a cell factory for use in ListView controls.
|
<any> |
getConverter()
Returns the
StringConverter used in this cell. |
<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) |
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 <any> booleanProperty
private <any> converter
private <any> selectedStateCallback
public CheckBoxListCell()
public CheckBoxListCell(<any> getSelectedProperty)
getSelectedProperty
- A Callback
that will return an
ObservableValue<Boolean>
given an item from the ListView.public CheckBoxListCell(<any> getSelectedProperty, <any> converter)
getSelectedProperty
- A Callback
that will return an
ObservableValue<Boolean>
given an item from the ListView.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 <T> <any> forListView(<any> getSelectedProperty)
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.T
- The type of the elements contained within the ListView.getSelectedProperty
- 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).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> <any> forListView(<any> getSelectedProperty, <any> converter)
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.T
- The type of the elements contained within the ListView.getSelectedProperty
- 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
- A StringConverter that, give an object of type T, will
return a String that can be used to represent the object visually.Callback
that will return a ListCell that is able to
work on the type of element contained within the ListView.public final <any> converterProperty()
StringConverter
property.StringConverter
propertypublic final void setConverter(<any> value)
StringConverter
to be used in this cell.value
- the StringConverter
public 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
public 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)