ControlsFX 11.2.2 · org.controlsfx.control.tableview2.cell.ComboBox2TableCell

Modifier and Type	Field and Description
private ComboBox<T>	comboBox Hides javafx.scene.control.cell.ComboBoxTableCell.comboBox. * Fields * *
private final ChangeListener<Boolean>	focusListener
private final EventHandler<KeyEvent>	keyEventHandler

Constructor Summary

Access	Constructor and Description
public	ComboBox2TableCell() Creates a default ComboBox2TableCell with an empty items list.
public	ComboBox2TableCell(T... The items to show in the ComboBox popup menu when selected by the user. items) Creates a default `ComboBox2TableCell` instance with the given items being used to populate the `ComboBox` when it is shown.
public	ComboBox2TableCell(StringConverter<T> A `StringConverter` that can convert an item of type T into a user-readable string so that it may then be shown in the ComboBox popup menu. converter, T... The items to show in the ComboBox popup menu when selected by the user. items) Creates a `ComboBox2TableCell` instance with the given items being used to populate the `ComboBox` when it is shown, and the `StringConverter` being used to convert the item in to a user-readable form.
public	ComboBox2TableCell(ObservableList<T> The items to show in the ComboBox popup menu when selected by the user. items) Creates a default `ComboBox2TableCell` instance with the given items being used to populate the `ComboBox` when it is shown.
public	ComboBox2TableCell(StringConverter<T> A `StringConverter` that can convert an item of type T into a user-readable string so that it may then be shown in the ComboBox popup menu. converter, ObservableList<T> The items to show in the ComboBox popup menu when selected by the user. items) Creates a `ComboBox2TableCell` instance with the given items being used to populate the `ComboBox` when it is shown, and the `StringConverter` being used to convert the item in to a user-readable form.

Method Summary

Modifier and Type	Method and Description
public void	commitEdit(T item) Overrides javafx.scene.control.TableCell.commitEdit. Commits an edit to the value of the cell.
public static < The type of the objects contained within the TableView S, The type of the elements contained within the TableColumn. T> Callback<TableColumn<S, T>, TableCell<S, T>>	Returns: A `Callback` that will return a TableCell that is able to work on the type of element contained within the TableColumn. forTableColumn(final T... Zero or more items that will be shown to the user when the `ComboBox` menu is showing. These items must be of the same type as the TableColumn. Note that it is up to the developer to set `event handlers` to listen to edit events in the TableColumn, and react accordingly. Methods of interest include `setOnEditStart`, `setOnEditCommit`, and `setOnEditCancel`. items) Hides javafx.scene.control.cell.ComboBoxTableCell.forTableColumn. Creates a ComboBox cell factory for use in `TableColumn` controls.
public static < The type of the objects contained within the TableView S, The type of the elements contained within the TableColumn. T> Callback<TableColumn<S, T>, TableCell<S, T>>	Returns: A `Callback` that will return a TableCell that is able to work on the type of element contained within the TableColumn. forTableColumn(final StringConverter<T> A `StringConverter` to convert the given item (of type T) to a String for displaying to the user. converter, final T... Zero or more items that will be shown to the user when the `ComboBox` menu is showing. These items must be of the same type as the TableColumn. Note that it is up to the developer to set `event handlers` to listen to edit events in the TableColumn, and react accordingly. Methods of interest include `setOnEditStart`, `setOnEditCommit`, and `setOnEditCancel`. items) Hides javafx.scene.control.cell.ComboBoxTableCell.forTableColumn. Creates a ComboBox cell factory for use in `TableColumn` controls.
public static < The type of the objects contained within the TableView S, The type of the elements contained within the TableColumn. T> Callback<TableColumn<S, T>, TableCell<S, T>>	Returns: A `Callback` that will return a TableCell that is able to work on the type of element contained within the TableColumn. forTableColumn(final ObservableList<T> Zero or more items that will be shown to the user when the `ComboBox` menu is showing. These items must be of the same type as the TableColumn. Note that it is up to the developer to set `event handlers` to listen to edit events in the TableColumn, and react accordingly. Methods of interest include `setOnEditStart`, `setOnEditCommit`, and `setOnEditCancel`. items) Hides javafx.scene.control.cell.ComboBoxTableCell.forTableColumn. Creates a ComboBox cell factory for use in `TableColumn` controls.
public static < The type of the objects contained within the TableView S, The type of the elements contained within the TableColumn. T> Callback<TableColumn<S, T>, TableCell<S, T>>	Returns: A `Callback` that will return a TableCell that is able to work on the type of element contained within the TableColumn. forTableColumn(final StringConverter<T> A `StringConverter` to convert the given item (of type T) to a String for displaying to the user. converter, final ObservableList<T> Zero or more items that will be shown to the user when the `ComboBox` menu is showing. These items must be of the same type as the TableColumn. Note that it is up to the developer to set `event handlers` to listen to edit events in the TableColumn, and react accordingly. Methods of interest include `setOnEditStart`, `setOnEditCommit`, and `setOnEditCancel`. items) Hides javafx.scene.control.cell.ComboBoxTableCell.forTableColumn. Creates a ComboBox cell factory for use in `TableColumn` controls.
private void	updateListeners(boolean editable)

Inherited from javafx.scene.control.cell.ComboBoxTableCell:: cancelEdit comboBoxEditableProperty converterProperty getConverter getItems isComboBoxEditable setComboBoxEditable setConverter startEdit updateItem

Field Detail

comboBox	back to summary
private ComboBox<T> comboBox Hides javafx.scene.control.cell.ComboBoxTableCell.comboBox. * Fields * *

comboBox

back to summary

private ComboBox<T> comboBox

Hides javafx.scene.control.cell.ComboBoxTableCell.comboBox.

* Fields * *

focusListener	back to summary
private final ChangeListener<Boolean> focusListener

keyEventHandler	back to summary
private final EventHandler<KeyEvent> keyEventHandler

Constructor Detail

ComboBox2TableCell	back to summary
public ComboBox2TableCell() Creates a default ComboBox2TableCell with an empty items list. This table cell supports commit on focus lost. By default the ComboBox is set as editable.

ComboBox2TableCell back to summary

ComboBox2TableCell	back to summary
public ComboBox2TableCell(T... items) Creates a default `ComboBox2TableCell` instance with the given items being used to populate the `ComboBox` when it is shown. This table cell supports commit on focus lost. By default the ComboBox is set as editable. Parameters items:T[] The items to show in the ComboBox popup menu when selected by the user. Annotations @SafeVarargs

public ComboBox2TableCell(T... items)

Creates a default ComboBox2TableCell instance with the given items being used to populate the ComboBox when it is shown. This table cell supports commit on focus lost. By default the ComboBox is set as editable.

Parameters

items:T[]: The items to show in the ComboBox popup menu when selected by the user.

Annotations

@SafeVarargs

ComboBox2TableCell back to summary

ComboBox2TableCell	back to summary
public ComboBox2TableCell(StringConverter<T> converter, T... items) Creates a `ComboBox2TableCell` instance with the given items being used to populate the `ComboBox` when it is shown, and the `StringConverter` being used to convert the item in to a user-readable form. This table cell supports commit on focus lost. By default the ComboBox is set as editable. Parameters converter:StringConverter<T> A `StringConverter` that can convert an item of type T into a user-readable string so that it may then be shown in the ComboBox popup menu. items:T[] The items to show in the ComboBox popup menu when selected by the user. Annotations @SafeVarargs

public ComboBox2TableCell(StringConverter<T> converter, T... items)

Creates a ComboBox2TableCell instance with the given items being used to populate the ComboBox when it is shown, and the StringConverter being used to convert the item in to a user-readable form. This table cell supports commit on focus lost. By default the ComboBox is set as editable.

Parameters

converter:StringConverter<T>: A StringConverter that can convert an item of type T into a user-readable string so that it may then be shown in the ComboBox popup menu.
items:T[]: The items to show in the ComboBox popup menu when selected by the user.

Annotations

@SafeVarargs

ComboBox2TableCell back to summary

ComboBox2TableCell	back to summary
public ComboBox2TableCell(ObservableList<T> items) Creates a default `ComboBox2TableCell` instance with the given items being used to populate the `ComboBox` when it is shown. This table cell supports commit on focus lost. By default the ComboBox is set as editable. Parameters items:ObservableList<T> The items to show in the ComboBox popup menu when selected by the user.

public ComboBox2TableCell(ObservableList<T> items)

Parameters

items:ObservableList<T>: The items to show in the ComboBox popup menu when selected by the user.

ComboBox2TableCell back to summary

ComboBox2TableCell	back to summary
public ComboBox2TableCell(StringConverter<T> converter, ObservableList<T> items) Creates a `ComboBox2TableCell` instance with the given items being used to populate the `ComboBox` when it is shown, and the `StringConverter` being used to convert the item in to a user-readable form. This table cell supports commit on focus lost. By default the ComboBox is set as editable. Parameters converter:StringConverter<T> A `StringConverter` that can convert an item of type T into a user-readable string so that it may then be shown in the ComboBox popup menu. items:ObservableList<T> The items to show in the ComboBox popup menu when selected by the user.

public ComboBox2TableCell(StringConverter<T> converter, ObservableList<T> items)

Parameters

converter:StringConverter<T>: A StringConverter that can convert an item of type T into a user-readable string so that it may then be shown in the ComboBox popup menu.
items:ObservableList<T>: The items to show in the ComboBox popup menu when selected by the user.

Method Detail

commitEdit back to summary

commitEdit	back to summary
public void commitEdit(T item) Overrides javafx.scene.control.TableCell.commitEdit. Doc from javafx.scene.control.TableCell.commitEdit. Commits an edit to the value of the cell. Call this function when appropriate (based on the user interaction requirements of your cell editing user interface) to do two things: Fire the appropriate events back to the backing UI control (e.g., `ListView`). This will begin the process of pushing this edit back to the relevant data source / property (although it does not guarantee that this will be successful - that is dependent upon the specific edit commit handler being used). Refer to the UI control class javadoc for more detail. Begin the transition from an editing state into a non-editing state. In general there is no need to override this method in custom cell implementations - it should be sufficient to simply call this method when appropriate (e.g., when the user pressed the Enter key, you may do something like `cell.commitEdit(converter.fromString(textField.getText()));` Annotations @Override

public void commitEdit(T item)

Overrides javafx.scene.control.TableCell.commitEdit.

Doc from javafx.scene.control.TableCell.commitEdit.

Commits an edit to the value of the cell. Call this function when appropriate (based on the user interaction requirements of your cell editing user interface) to do two things:

Fire the appropriate events back to the backing UI control (e.g., ListView). This will begin the process of pushing this edit back to the relevant data source / property (although it does not guarantee that this will be successful - that is dependent upon the specific edit commit handler being used). Refer to the UI control class javadoc for more detail.
Begin the transition from an editing state into a non-editing state.

In general there is no need to override this method in custom cell implementations - it should be sufficient to simply call this method when appropriate (e.g., when the user pressed the Enter key, you may do something like cell.commitEdit(converter.fromString(textField.getText()));

Annotations

@Override

forTableColumn back to summary

forTableColumn	back to summary
public static <S, T> Callback<TableColumn<S, T>, TableCell<S, T>> forTableColumn(final T... items) Hides javafx.scene.control.cell.ComboBoxTableCell.forTableColumn. Creates a ComboBox cell factory for use in `TableColumn` controls. By default, the ComboBoxCell is rendered as a `javafx.scene.control.Label` when not being edited, and as a ComboBox when in editing mode. The ComboBox will, by default, stretch to fill the entire list cell. This table cell supports commit on focus lost. By default the ComboBox is set as editable. Parameters <S> The type of the objects contained within the TableView <T> The type of the elements contained within the TableColumn. items:T[] Zero or more items that will be shown to the user when the `ComboBox` menu is showing. These items must be of the same type as the TableColumn. Note that it is up to the developer to set `event handlers` to listen to edit events in the TableColumn, and react accordingly. Methods of interest include `setOnEditStart`, `setOnEditCommit`, and `setOnEditCancel`. Returns:Callback<TableColumn<S, T>, TableCell<S, T>> A `Callback` that will return a TableCell that is able to work on the type of element contained within the TableColumn. Annotations @SafeVarargs

public static <S, T> Callback<TableColumn<S, T>, TableCell<S, T>> forTableColumn(final T... items)

Hides javafx.scene.control.cell.ComboBoxTableCell.forTableColumn.

Creates a ComboBox cell factory for use in TableColumn controls. By default, the ComboBoxCell is rendered as a javafx.scene.control.Label when not being edited, and as a ComboBox when in editing mode. The ComboBox will, by default, stretch to fill the entire list cell. This table cell supports commit on focus lost. By default the ComboBox is set as editable.

Parameters

<S>: The type of the objects contained within the TableView
<T>: The type of the elements contained within the TableColumn.
items:T[]: Zero or more items that will be shown to the user when the ComboBox menu is showing. These items must be of the same type as the TableColumn. Note that it is up to the developer to set event handlers to listen to edit events in the TableColumn, and react accordingly. Methods of interest include setOnEditStart, setOnEditCommit, and setOnEditCancel.

Returns:Callback<TableColumn<S, T>, TableCell<S, T>>

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

Annotations

@SafeVarargs

forTableColumn back to summary

forTableColumn	back to summary
public static <S, T> Callback<TableColumn<S, T>, TableCell<S, T>> forTableColumn(final StringConverter<T> converter, final T... items) Hides javafx.scene.control.cell.ComboBoxTableCell.forTableColumn. Creates a ComboBox cell factory for use in `TableColumn` controls. By default, the ComboBoxCell is rendered as a `javafx.scene.control.Label` when not being edited, and as a ComboBox when in editing mode. The ComboBox will, by default, stretch to fill the entire list cell. This table cell supports commit on focus lost. By default the ComboBox is set as editable. Parameters <S> The type of the objects contained within the TableView <T> The type of the elements contained within the TableColumn. converter:StringConverter<T> A `StringConverter` to convert the given item (of type T) to a String for displaying to the user. items:T[] Zero or more items that will be shown to the user when the `ComboBox` menu is showing. These items must be of the same type as the TableColumn. Note that it is up to the developer to set `event handlers` to listen to edit events in the TableColumn, and react accordingly. Methods of interest include `setOnEditStart`, `setOnEditCommit`, and `setOnEditCancel`. Returns:Callback<TableColumn<S, T>, TableCell<S, T>> A `Callback` that will return a TableCell that is able to work on the type of element contained within the TableColumn. Annotations @SafeVarargs

public static <S, T> Callback<TableColumn<S, T>, TableCell<S, T>> forTableColumn(final StringConverter<T> converter, final T... items)

Hides javafx.scene.control.cell.ComboBoxTableCell.forTableColumn.

Parameters

<S>: The type of the objects contained within the TableView
<T>: The type of the elements contained within the TableColumn.
converter:StringConverter<T>: A StringConverter to convert the given item (of type T) to a String for displaying to the user.
items:T[]: Zero or more items that will be shown to the user when the ComboBox menu is showing. These items must be of the same type as the TableColumn. Note that it is up to the developer to set event handlers to listen to edit events in the TableColumn, and react accordingly. Methods of interest include setOnEditStart, setOnEditCommit, and setOnEditCancel.

Returns:Callback<TableColumn<S, T>, TableCell<S, T>>

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

Annotations

@SafeVarargs

forTableColumn back to summary

forTableColumn	back to summary
public static <S, T> Callback<TableColumn<S, T>, TableCell<S, T>> forTableColumn(final ObservableList<T> items) Hides javafx.scene.control.cell.ComboBoxTableCell.forTableColumn. Creates a ComboBox cell factory for use in `TableColumn` controls. By default, the ComboBoxCell is rendered as a `javafx.scene.control.Label` when not being edited, and as a ComboBox when in editing mode. The ComboBox will, by default, stretch to fill the entire list cell. This table cell supports commit on focus lost. By default the ComboBox is set as editable. Parameters <S> The type of the objects contained within the TableView <T> The type of the elements contained within the TableColumn. items:ObservableList<T> Zero or more items that will be shown to the user when the `ComboBox` menu is showing. These items must be of the same type as the TableColumn. Note that it is up to the developer to set `event handlers` to listen to edit events in the TableColumn, and react accordingly. Methods of interest include `setOnEditStart`, `setOnEditCommit`, and `setOnEditCancel`. Returns:Callback<TableColumn<S, T>, TableCell<S, T>> A `Callback` that will return a TableCell that is able to work on the type of element contained within the TableColumn.

public static <S, T> Callback<TableColumn<S, T>, TableCell<S, T>> forTableColumn(final ObservableList<T> items)

Hides javafx.scene.control.cell.ComboBoxTableCell.forTableColumn.

Parameters

<S>: The type of the objects contained within the TableView
<T>: The type of the elements contained within the TableColumn.
items:ObservableList<T>: Zero or more items that will be shown to the user when the ComboBox menu is showing. These items must be of the same type as the TableColumn. Note that it is up to the developer to set event handlers to listen to edit events in the TableColumn, and react accordingly. Methods of interest include setOnEditStart, setOnEditCommit, and setOnEditCancel.

Returns:Callback<TableColumn<S, T>, TableCell<S, T>>

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

forTableColumn back to summary

forTableColumn	back to summary
public static <S, T> Callback<TableColumn<S, T>, TableCell<S, T>> forTableColumn(final StringConverter<T> converter, final ObservableList<T> items) Hides javafx.scene.control.cell.ComboBoxTableCell.forTableColumn. Creates a ComboBox cell factory for use in `TableColumn` controls. By default, the ComboBoxCell is rendered as a `javafx.scene.control.Label` when not being edited, and as a ComboBox when in editing mode. The ComboBox will, by default, stretch to fill the entire list cell. This table cell supports commit on focus lost. By default the ComboBox is set as editable. Parameters <S> The type of the objects contained within the TableView <T> The type of the elements contained within the TableColumn. converter:StringConverter<T> A `StringConverter` to convert the given item (of type T) to a String for displaying to the user. items:ObservableList<T> Zero or more items that will be shown to the user when the `ComboBox` menu is showing. These items must be of the same type as the TableColumn. Note that it is up to the developer to set `event handlers` to listen to edit events in the TableColumn, and react accordingly. Methods of interest include `setOnEditStart`, `setOnEditCommit`, and `setOnEditCancel`. Returns:Callback<TableColumn<S, T>, TableCell<S, T>> A `Callback` that will return a TableCell that is able to work on the type of element contained within the TableColumn.

public static <S, T> Callback<TableColumn<S, T>, TableCell<S, T>> forTableColumn(final StringConverter<T> converter, final ObservableList<T> items)

Hides javafx.scene.control.cell.ComboBoxTableCell.forTableColumn.

Parameters

<S>: The type of the objects contained within the TableView
<T>: The type of the elements contained within the TableColumn.
converter:StringConverter<T>: A StringConverter to convert the given item (of type T) to a String for displaying to the user.
items:ObservableList<T>: Zero or more items that will be shown to the user when the ComboBox menu is showing. These items must be of the same type as the TableColumn. Note that it is up to the developer to set event handlers to listen to edit events in the TableColumn, and react accordingly. Methods of interest include setOnEditStart, setOnEditCommit, and setOnEditCancel.

Returns:Callback<TableColumn<S, T>, TableCell<S, T>>

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

updateListeners	back to summary
private void updateListeners(boolean editable)

public Class ComboBox2TableCell<S, T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail