Module org.controlsfx.controls
Package org.controlsfx.control.tableview2.cell

Class ComboBox2TableCell<S,​T>

  • Type Parameters:
    S - The type of the objects contained within the TableView items list.
    T - The type of the elements contained within the TableColumn.
    All Implemented Interfaces:
    Styleable, EventTarget, Skinnable
    public class ComboBox2TableCell<S,​T>
extends ComboBoxTableCell<S,​T>
    A class containing a TableCell implementation that draws a ComboBox node inside the cell.

    By default, the ComboBox2TableCell is rendered as a Label when not being edited, and as a ComboBox when in editing mode. The ComboBox will, by default, stretch to fill the entire table cell.

    To create a ComboBox2TableCell, it is necessary to provide 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. This table cell supports commit on focus lost. By default the ComboBox will be set as editable.

    • Constructor Detail

      • ComboBox2TableCell

        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

        @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 - The items to show in the ComboBox popup menu when selected by the user.

      • ComboBox2TableCell

        @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 - 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 - The items to show in the ComboBox popup menu when selected by the user.

      • ComboBox2TableCell

        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 - The items to show in the ComboBox popup menu when selected by the user.

      • ComboBox2TableCell

        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 - 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 - The items to show in the ComboBox popup menu when selected by the user.

    • Method Detail

      • forTableColumn

        @SafeVarargs
public static <S,​T> Callback<TableColumn<S,​T>,​TableCell<S,​T>> forTableColumn​(T... items)
        Creates a ComboBox cell factory for use in TableColumn controls. By default, the ComboBoxCell is rendered as a 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.
        Type Parameters:
        S - The type of the objects contained within the TableView
        T - The type of the elements contained within the TableColumn.
        Parameters:
        items - 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:
        A Callback that will return a TableCell that is able to work on the type of element contained within the TableColumn.

      • forTableColumn

        @SafeVarargs
public static <S,​T> Callback<TableColumn<S,​T>,​TableCell<S,​T>> forTableColumn​(StringConverter<T> converter,
                                                                                                     T... items)
        Creates a ComboBox cell factory for use in TableColumn controls. By default, the ComboBoxCell is rendered as a 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.
        Type Parameters:
        S - The type of the objects contained within the TableView
        T - The type of the elements contained within the TableColumn.
        Parameters:
        converter - A StringConverter to convert the given item (of type T) to a String for displaying to the user.
        items - 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:
        A Callback that will return a TableCell that is able to work on the type of element contained within the TableColumn.

      • forTableColumn

        public static <S,​T> Callback<TableColumn<S,​T>,​TableCell<S,​T>> forTableColumn​(ObservableList<T> items)
        Creates a ComboBox cell factory for use in TableColumn controls. By default, the ComboBoxCell is rendered as a 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.
        Type Parameters:
        S - The type of the objects contained within the TableView
        T - The type of the elements contained within the TableColumn.
        Parameters:
        items - 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:
        A Callback that will return a TableCell that is able to work on the type of element contained within the TableColumn.

      • forTableColumn

        public static <S,​T> Callback<TableColumn<S,​T>,​TableCell<S,​T>> forTableColumn​(StringConverter<T> converter,
                                                                                                     ObservableList<T> items)
        Creates a ComboBox cell factory for use in TableColumn controls. By default, the ComboBoxCell is rendered as a 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.
        Type Parameters:
        S - The type of the objects contained within the TableView
        T - The type of the elements contained within the TableColumn.
        Parameters:
        converter - A StringConverter to convert the given item (of type T) to a String for displaying to the user.
        items - 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:
        A Callback that will return a TableCell that is able to work on the type of element contained within the TableColumn.