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

Class ChoiceBoxTableCell<S,T>

  • Type Parameters:
    S - The type of the TableView generic type
    T - The type of the elements contained within the TableColumn.
    All Implemented Interfaces:
    Styleable, EventTarget, Skinnable
    public class ChoiceBoxTableCell<S,T>
extends TableCell<S,T>
    A class containing a TableCell implementation that draws a ChoiceBox node inside the cell.

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

    To create a ChoiceBoxTableCell, it is necessary to provide zero or more items that will be shown to the user when the ChoiceBox menu is showing. These items must be of the same type as the TableColumn.

    Since:
    JavaFX 2.2

    • Constructor Detail

      • ChoiceBoxTableCell

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

      • ChoiceBoxTableCell

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

      • ChoiceBoxTableCell

        @SafeVarargs
public ChoiceBoxTableCell​(StringConverter<T> converter,
                          T... items)
        Creates a ChoiceBoxTableCell instance with the given items being used to populate the ChoiceBox 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 ChoiceBox popup menu.
        items - The items to show in the ChoiceBox popup menu when selected by the user.

      • ChoiceBoxTableCell

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

      • ChoiceBoxTableCell

        public ChoiceBoxTableCell​(StringConverter<T> converter,
                          ObservableList<T> items)
        Creates a ChoiceBoxTableCell instance with the given items being used to populate the ChoiceBox 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 ChoiceBox popup menu.
        items - The items to show in the ChoiceBox 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 ChoiceBox cell factory for use in TableColumn controls. By default, the ChoiceBoxCell is rendered as a Label when not being edited, and as a ChoiceBox when in editing mode. The ChoiceBox will, by default, stretch to fill the entire list cell.
        Type Parameters:
        S - The type of the TableView generic type
        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 ChoiceBox 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 ChoiceBox cell factory for use in TableColumn controls. By default, the ChoiceBoxCell is rendered as a Label when not being edited, and as a ChoiceBox when in editing mode. The ChoiceBox will, by default, stretch to fill the entire list cell.
        Type Parameters:
        S - The type of the TableView generic type
        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 ChoiceBox 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 ChoiceBox cell factory for use in TableColumn controls. By default, the ChoiceBoxCell is rendered as a Label when not being edited, and as a ChoiceBox when in editing mode. The ChoiceBox will, by default, stretch to fill the entire list cell.
        Type Parameters:
        S - The type of the TableView generic type
        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 ChoiceBox 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 ChoiceBox cell factory for use in TableColumn controls. By default, the ChoiceBoxCell is rendered as a Label when not being edited, and as a ChoiceBox when in editing mode. The ChoiceBox will, by default, stretch to fill the entire list cell.
        Type Parameters:
        S - The type of the TableView generic type
        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 ChoiceBox 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.

      • getItems

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