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

Class ChoiceBoxListCell<T>

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
javafx.scene.control.Labeled
javafx.scene.control.Cell<T>
javafx.scene.control.IndexedCell<T>
javafx.scene.control.ListCell<T>
javafx.scene.control.cell.ChoiceBoxListCell<T>
Type Parameters:
T - The type of the elements contained within the ListView.
All Implemented Interfaces:
Styleable, EventTarget, Skinnable
public class ChoiceBoxListCell<T>
extends ListCell<T>
A class containing a ListCell implementation that draws a ChoiceBox node inside the cell.

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

To create a ChoiceBoxListCell, 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 ListView items sequence, such that upon selection, they replace the existing value in the items list.

Since:
JavaFX 2.2

  • Property Details

  • Constructor Details

    • ChoiceBoxListCell

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

    • ChoiceBoxListCell

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

    • ChoiceBoxListCell

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

    • ChoiceBoxListCell

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

    • ChoiceBoxListCell

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

    • forListView

      @SafeVarargs public static <T> Callback<ListView<T>,​ListCell<T>> forListView​(T... items)
      Creates a ChoiceBox cell factory for use in ListView 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:
      T - The type of the elements contained within the ListView.
      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 ListView items list, such that upon selection, they replace the existing value in the items list.
      Returns:
      A Callback that will return a ListCell that is able to work on the type of element contained within the ListView.

    • forListView

      @SafeVarargs public static <T> Callback<ListView<T>,​ListCell<T>> forListView​(StringConverter<T> converter, T... items)
      Creates a ChoiceBox cell factory for use in ListView 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:
      T - The type of the elements contained within the ListView.
      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 ListView items list, such that upon selection, they replace the existing value in the items list.
      Returns:
      A Callback that will return a ListCell that is able to work on the type of element contained within the ListView.

    • forListView

      public static <T> Callback<ListView<T>,​ListCell<T>> forListView​(ObservableList<T> items)
      Creates a ChoiceBox cell factory for use in ListView 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:
      T - The type of the elements contained within the ListView.
      Parameters:
      items - An ObservableList containing 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 ListView items sequence, such that upon selection, they replace the existing value in the items list.
      Returns:
      A Callback that will return a ListCell that is able to work on the type of element contained within the ListView.

    • forListView

      public static <T> Callback<ListView<T>,​ListCell<T>> forListView​(StringConverter<T> converter, ObservableList<T> items)
      Creates a ChoiceBox cell factory for use in ListView 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:
      T - The type of the elements contained within the ListView.
      Parameters:
      converter - A StringConverter to convert the given item (of type T) to a String for displaying to the user.
      items - An ObservableList containing 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 ListView items sequence, such that upon selection, they replace the existing value in the items list.
      Returns:
      A Callback that will return a ListCell that is able to work on the type of element contained within the ListView.

    • converterProperty

      public final ObjectProperty<StringConverter<T>> converterProperty()
      The StringConverter property.
      See Also:
      getConverter(), setConverter(StringConverter)

    • setConverter

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

    • getConverter

      public final StringConverter<T> getConverter()
      Returns the StringConverter used in this cell.
      Returns:
      the StringConverter used in this cell

    • 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