Class ChoiceBoxTreeTableCell<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 ChoiceBoxTreeTableCell<S,T>
    extends TreeTableCell<S,T>
    A class containing a TreeTableCell implementation that draws a ChoiceBox node inside the cell.

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

    Since:
    JavaFX 8.0
    • Constructor Detail

      • ChoiceBoxTreeTableCell

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

        @SafeVarargs
        public ChoiceBoxTreeTableCell​(T... items)
        Creates a default ChoiceBoxTreeTableCell 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.
      • ChoiceBoxTreeTableCell

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

        public ChoiceBoxTreeTableCell​(ObservableList<T> items)
        Creates a default ChoiceBoxTreeTableCell 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.
      • ChoiceBoxTreeTableCell

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

      • forTreeTableColumn

        @SafeVarargs
        public static <S,T> Callback<TreeTableColumn<S,T>,TreeTableCell<S,T>> forTreeTableColumn​(T... items)
        Creates a ChoiceBox cell factory for use in TreeTableColumn 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 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 ChoiceBox 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 ChoiceBox cell factory for use in TreeTableColumn 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 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 ChoiceBox 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 ChoiceBox cell factory for use in TreeTableColumn 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 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 ChoiceBox 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 ChoiceBox cell factory for use in TreeTableColumn 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 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 ChoiceBox 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.
      • 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