Module javafx.controls
Package javafx.scene.control.cell

Class ComboBoxTreeTableCell<S,T>

  • Type Parameters:
    S - The type of the TreeTableView generic type
    T - The type of the elements contained within the TreeTableColumn.
    All Implemented Interfaces:
    Styleable, EventTarget, Skinnable
    public class ComboBoxTreeTableCell<S,T>
extends TreeTableCell<S,T>
    A class containing a TreeTableCell implementation that draws a ComboBox node inside the cell.

    By default, the ComboBoxTreeTableCell 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 ComboBoxTreeTableCell, 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 TreeTableColumn.

    Since:
    JavaFX 8.0

    • Constructor Detail

      • ComboBoxTreeTableCell

        public ComboBoxTreeTableCell()
        Creates a default ComboBoxTreeTableCell with an empty items list.

      • ComboBoxTreeTableCell

        @SafeVarargs
public ComboBoxTreeTableCell​(T... items)
        Creates a default ComboBoxTreeTableCell instance with the given items being used to populate the ComboBox when it is shown.
        Parameters:
        items - The items to show in the ComboBox popup menu when selected by the user.

      • ComboBoxTreeTableCell

        @SafeVarargs
public ComboBoxTreeTableCell​(StringConverter<T> converter,
                             T... items)
        Creates a ComboBoxTreeTableCell 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.
        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.

      • ComboBoxTreeTableCell

        public ComboBoxTreeTableCell​(ObservableList<T> items)
        Creates a default ComboBoxTreeTableCell instance with the given items being used to populate the ComboBox when it is shown.
        Parameters:
        items - The items to show in the ComboBox popup menu when selected by the user.

      • ComboBoxTreeTableCell

        public ComboBoxTreeTableCell​(StringConverter<T> converter,
                             ObservableList<T> items)
        Creates a ComboBoxTreeTableCell 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.
        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

      • forTreeTableColumn

        @SafeVarargs
public static <S,T> Callback<TreeTableColumn<S,T>,TreeTableCell<S,T>> forTreeTableColumn​(T... items)
        Creates a ComboBox cell factory for use in TreeTableColumn 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.
        Type Parameters:
        S - The type of the TreeTableView generic type
        T - The type of the elements contained within the TreeTableColumn.
        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 TreeTableColumn. Note that it is up to the developer to set event handlers to listen to edit events in the TreeTableColumn, and react accordingly. Methods of interest include setOnEditStart, setOnEditCommit, and setOnEditCancel.
        Returns:
        A Callback that will return a TreeTableCell that is able to work on the type of element contained within the TreeTableColumn.

      • forTreeTableColumn

        @SafeVarargs
public static <S,T> Callback<TreeTableColumn<S,T>,TreeTableCell<S,T>> forTreeTableColumn​(StringConverter<T> converter,
                                                                                         T... items)
        Creates a ComboBox cell factory for use in TreeTableColumn 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.
        Type Parameters:
        S - The type of the TreeTableView generic type
        T - The type of the elements contained within the TreeTableColumn.
        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 TreeTableColumn. Note that it is up to the developer to set event handlers to listen to edit events in the TreeTableColumn, and react accordingly. Methods of interest include setOnEditStart, setOnEditCommit, and setOnEditCancel.
        Returns:
        A Callback that will return a TreeTableCell that is able to work on the type of element contained within the TreeTableColumn.

      • forTreeTableColumn

        public static <S,T> Callback<TreeTableColumn<S,T>,TreeTableCell<S,T>> forTreeTableColumn​(ObservableList<T> items)
        Creates a ComboBox cell factory for use in TreeTableColumn 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.
        Type Parameters:
        S - The type of the TreeTableView generic type
        T - The type of the elements contained within the TreeTableColumn.
        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 TreeTableColumn. Note that it is up to the developer to set event handlers to listen to edit events in the TreeTableColumn, and react accordingly. Methods of interest include setOnEditStart, setOnEditCommit, and setOnEditCancel.
        Returns:
        A Callback that will return a TreeTableCell that is able to work on the type of element contained within the TreeTableColumn.

      • forTreeTableColumn

        public static <S,T> Callback<TreeTableColumn<S,T>,TreeTableCell<S,T>> forTreeTableColumn​(StringConverter<T> converter,
                                                                                         ObservableList<T> items)
        Creates a ComboBox cell factory for use in TreeTableColumn 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.
        Type Parameters:
        S - The type of the TreeTableView generic type
        T - The type of the elements contained within the TreeTableColumn.
        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 TreeTableColumn. Note that it is up to the developer to set event handlers to listen to edit events in the TreeTableColumn, and react accordingly. Methods of interest include setOnEditStart, setOnEditCommit, and setOnEditCancel.
        Returns:
        A Callback that will return a TreeTableCell that is able to work on the type of element contained within the TreeTableColumn.

      • setConverter

        public final void setConverter​(StringConverter<T> value)
        Sets the StringConverter to be used in this cell.
        Parameters:
        value - the string converter

      • setComboBoxEditable

        public final void setComboBoxEditable​(boolean value)
        Configures the ComboBox to be editable (to allow user input outside of the options provide in the dropdown list).
        Parameters:
        value - the editable value to be set for this ComboBox

      • isComboBoxEditable

        public final boolean isComboBoxEditable()
        Returns true if the ComboBox is editable.
        Returns:
        true if the ComboBox is editable

      • getItems

        public ObservableList<T> getItems()
        Returns the items to be displayed in the ComboBox when it is showing.
        Returns:
        the items to be displayed in this ComboBox when it is showing