Module com.dua3.utility.fx.controls
Package com.dua3.utility.fx.controls

Class ComboBoxEx<T>

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
com.dua3.utility.fx.controls.CustomControl<HBox>
com.dua3.utility.fx.controls.ComboBoxEx<T>
Type Parameters:
T - the type of the items contained in the ComboBox
All Implemented Interfaces:
InputControl<T>, Styleable, EventTarget, Skinnable
public class ComboBoxEx<T> extends CustomControl<HBox> implements InputControl<T>
A custom ComboBox control that supports additional features like editing, adding, and removing items.

  • Property Details

  • Constructor Details

    • ComboBoxEx

      @SafeVarargs public ComboBoxEx(@Nullable UnaryOperator<T> edit, @Nullable Supplier<T> add, @Nullable BiPredicate<ComboBoxEx<T>,T> remove, Function<T,String> format, T... items)
      Constructs a ComboBoxEx with the specified edit, add, remove, format, and items.
      Parameters:
      edit - the unary operator to perform editing on the selected item (nullable)
      add - the supplier to provide a new item to add (nullable)
      remove - the bi-predicate to determine if an item should be removed (nullable)
      format - the function to format the items as strings
      items - the initial items to populate the ComboBox (variadic parameter)

    • ComboBoxEx

      public ComboBoxEx(@Nullable UnaryOperator<T> edit, @Nullable Supplier<T> add, @Nullable BiPredicate<ComboBoxEx<T>,T> remove, Function<T,String> format, Collection<T> items)
      Constructs a ComboBoxEx with the specified edit, add, remove, format, and items.
      Parameters:
      edit - the unary operator to perform editing on the selected item (nullable)
      add - the supplier to provide a new item to add (nullable)
      remove - the bi-predicate to determine if an item should be removed (nullable)
      format - the function to format the items as strings
      items - the initial items to populate the ComboBox (variadic parameter)

  • Method Details

    • askBeforeRemoveSelectedItem

      public boolean askBeforeRemoveSelectedItem(T item)
      Prompts the user with a confirmation dialogue to verify whether to remove the selected item.

      Pass this as the remove parameter to the constructor to show a confirmation dialog when the user wants to remove an item.

      Parameters:
      item - the item to be removed
      Returns:
      true if the user confirms the removal, false otherwise

    • alwaysRemoveSelectedItem

      public static <T> boolean alwaysRemoveSelectedItem(ComboBoxEx<T> cb, T item)
      Remove the selected item without showing a confirmation dialog.

      Pass this as the remove parameter to the constructor to remove items without showing a confirmation dialog.

      Type Parameters:
      T - the type of items contained in the ComboBoxEx
      Parameters:
      cb - the ComboBoxEx to remove the item from
      item - the item to be removed
      Returns:
      true if the user confirms the removal, false otherwise

    • getSelectedItem

      public Optional<T> getSelectedItem()
      Retrieves the currently selected item from the ComboBoxEx.
      Returns:
      an Optional containing the selected item if one is selected, or an empty Optional if no item is selected

    • getItems

      public List<T> getItems()
      Retrieves a copy of the items in the ComboBoxEx.
      Returns:
      an immutable list containing the current items in the ComboBoxEx

    • selectedItemProperty

      public ReadOnlyObjectProperty<T> selectedItemProperty()
      Returns the property containing the selected item in the ComboBoxEx.
      See Also:

    • setComparator

      public void setComparator(Comparator<? super T> comparator)
      Sets the comparator for the ComboBoxEx and sorts the items accordingly. If the comparator is null, the items will not be sorted.
      Parameters:
      comparator - the comparator to set, which is used for sorting the items

    • sortItems

      public void sortItems()
      Sorts the items in the ComboBoxEx using the defined comparator. If the comparator is null, the method returns without performing any action. The currently selected item, if any, will remain selected after sorting.

    • node

      public Node node()
      Description copied from interface: InputControl
      Get the Node for this input element.
      Specified by:
      node in interface InputControl<T>
      Returns:
      the node

    • valueProperty

      public Property<T> valueProperty()
      Description copied from interface: InputControl
      Provides the property representing the value of this input control.
      Specified by:
      valueProperty in interface InputControl<T>
      Returns:
      the property containing the current value

    • reset

      public void reset()
      Description copied from interface: InputControl
      Reset value to default
      Specified by:
      reset in interface InputControl<T>

    • validProperty

      public ReadOnlyBooleanProperty validProperty()
      Description copied from interface: InputControl
      Provides a read-only property representing the validity of the input.
      Specified by:
      validProperty in interface InputControl<T>
      Returns:
      a ReadOnlyBooleanProperty that is true if the input is valid and false otherwise

    • errorProperty

      public ReadOnlyStringProperty errorProperty()
      Description copied from interface: InputControl
      Provides a read-only property representing the error message for this input control.

      This property contains an error message if the input is invalid, otherwise it is empty.

      Specified by:
      errorProperty in interface InputControl<T>
      Returns:
      a ReadOnlyStringProperty containing the error message if there is a validation error, otherwise empty