ktfx-commons/ktfx.cells/checkBoxCellFactory

checkBoxCellFactory

inline fun <T> ListView<T>.checkBoxCellFactory(noinline selectedPropertyProvider: (T) -> ObservableValue<Boolean>)

Sets a CheckBoxListCell factory for use in this ListView.

Parameters

T

The type of the elements contained within the ListView.

selectedPropertyProvider

A provider that, given an object from ListView<T>.items, will return an ObservableValue<Boolean> that represents whether the given item is selected or not.

inline fun <T> ListView<T>.checkBoxCellFactory(converter: StringConverter<T>, noinline selectedPropertyProvider: (T) -> ObservableValue<Boolean>)

Sets a CheckBoxListCell factory for use in this ListView.

Parameters

T

The type of the elements contained within the ListView.

converter

A string converter that, given an object of type T, will return a String that can be used to represent the object visually.

selectedPropertyProvider

A provider that, given an object from ListView<T>.items, will return an ObservableValue<Boolean> that represents whether the given item is selected or not.

inline fun <S> TableColumn<S, Boolean>.checkBoxCellFactory()

Sets a CheckBoxTableCell factory for use in this TableColumn.

inline fun <S, T> TableColumn<S, T>.checkBoxCellFactory(noinline selectedPropertyProvider: (Int) -> ObservableValue<Boolean>)

Sets a CheckBoxTableCell factory for use in this TableColumn.

Parameters

T

The type of the elements contained within the TableColumn.

selectedPropertyProvider

A provider that, given an object from TableColumn<S,T>, will return an ObservableValue<Boolean> that represents whether the given item is selected or not.

inline fun <S, T> TableColumn<S, T>.checkBoxCellFactory(converter: StringConverter<T>, noinline selectedPropertyProvider: (Int) -> ObservableValue<Boolean>)

Sets a CheckBoxTableCell factory for use in this TableColumn.

Parameters

T

The type of the elements contained within the TableColumn.

converter

A string converter that, given an object of type T, will return a String that can be used to represent the object visually.

selectedPropertyProvider

A provider that, given an object from TableColumn<S,T>, will return an ObservableValue<Boolean> that represents whether the given item is selected or not.

inline fun <S, T> TableColumn<S, T>.checkBoxCellFactory(showLabel: Boolean, noinline selectedPropertyProvider: (Int) -> ObservableValue<Boolean>)

Sets a CheckBoxTableCell factory for use in this TableColumn.

Parameters

T

The type of the elements contained within the TableColumn.

showLabel

In some cases, it may be desirable to show a label in the TableCell beside the javafx.scene.control.CheckBox.

selectedPropertyProvider

A provider that, given an object from TableColumn<S,T>, will return an ObservableValue<Boolean> that represents whether the given item is selected or not.

inline fun <T> TreeView<T>.checkBoxCellFactory()

Sets a CheckBoxTreeCell factory for use in this TreeView.

Parameters

T

The type of the elements contained within the TreeView.

inline fun <T> TreeView<T>.checkBoxCellFactory(noinline selectedPropertyProvider: (TreeItem<T>) -> ObservableValue<Boolean>)

Sets a CheckBoxTreeCell factory for use in this TreeView.

Parameters

T

The type of the elements contained within the TreeView.

selectedPropertyProvider

A provider that, given an object from TreeItem<T>, will return an ObservableValue<Boolean> that represents whether the given item is selected or not.

inline fun <T> TreeView<T>.checkBoxCellFactory(converter: StringConverter<TreeItem<T>>, noinline selectedPropertyProvider: (TreeItem<T>) -> ObservableValue<Boolean>)

Sets a CheckBoxTreeCell factory for use in this TreeView.

Parameters

T

The type of the elements contained within the TreeView.

converter

A string converter that, given an object of type T, will return a String that can be used to represent the object visually.

selectedPropertyProvider

A provider that, given an object from TreeItem<T>, will return an ObservableValue<Boolean> that represents whether the given item is selected or not.

inline fun <S> TreeTableColumn<S, Boolean>.checkBoxCellFactory()

Sets a CheckBoxTreeTableCell factory for use in this TreeTableColumn.

inline fun <S, T> TreeTableColumn<S, T>.checkBoxCellFactory(noinline selectedPropertyProvider: (Int) -> ObservableValue<Boolean>)

Sets a CheckBoxTreeTableCell factory for use in this TreeTableColumn.

Parameters

T

The type of the elements contained within the TreeTableColumn.

selectedPropertyProvider

A provider that, given an object from TreeTableColumn<S,T>, will return an ObservableValue<Boolean> that represents whether the given item is selected or not.

inline fun <S, T> TreeTableColumn<S, T>.checkBoxCellFactory(converter: StringConverter<T>, noinline selectedPropertyProvider: (Int) -> ObservableValue<Boolean>)

Sets a CheckBoxTreeTableCell factory for use in this TreeTableColumn.

Parameters

T

The type of the elements contained within the TreeTableColumn.

converter

A string converter that, given an object of type T, will return a String that can be used to represent the object visually.

selectedPropertyProvider

A provider that, given an object from TreeTableColumn<S,T>, will return an ObservableValue<Boolean> that represents whether the given item is selected or not.

inline fun <S, T> TreeTableColumn<S, T>.checkBoxCellFactory(showLabel: Boolean, noinline selectedPropertyProvider: (Int) -> ObservableValue<Boolean>)

Sets a CheckBoxTreeTableCell factory for use in this TreeTableColumn.

Parameters

T

The type of the elements contained within the TreeTableColumn.

showLabel

In some cases, it may be desirable to show a label in the TableCell beside the javafx.scene.control.CheckBox.

selectedPropertyProvider

A provider that, given an object from TreeTableColumn<S,T>, will return an ObservableValue<Boolean> that represents whether the given item is selected or not.