Package com.vaadin.flow.component.combobox

Class ComboBoxTester<T extends ComboBox<Y>,Y>

java.lang.Object
com.vaadin.testbench.unit.ComponentTester<T>
com.vaadin.flow.component.combobox.ComboBoxTester<T,Y>
All Implemented Interfaces:
Clickable<T>
public class ComboBoxTester<T extends ComboBox<Y>,Y> extends ComponentTester<T>

  • Constructor Details

    • ComboBoxTester

      public ComboBoxTester(T component)
      Wrap given component for testing.
      Parameters:
      component - target component

  • Method Details

    • setFilter

      public void setFilter(String filter)
      Simulate writing a filter to the combobox.

      Use getSuggestions() to get the string values show in the dropdown or getSuggestionItems() to get the actual items in the suggestion.

      Parameters:
      filter - string to use for filtering

    • selectItem

      public void selectItem(String selection)
      Selects an item by its string representation (label).

      This method searches for the item among the current suggestions, which are affected by any filter set via setFilter(String). If no filter is set, all items are available for selection. If a filter is set, only the filtered items can be selected.

      To select an item when the ComboBox uses custom filtering logic (e.g., set via setItems(ItemFilter, Collection)), first call setFilter(String) to apply the filter, then call this method to select from the filtered results.

      Example usage with filtering: 

       // Apply filter first
 comboBoxTester.setFilter("search text");
 // Then select from filtered items
 comboBoxTester.selectItem("Matching Item Label");
      Parameters:
      selection - the item's string representation (label) to select, or null to clear the selection
      Throws:
      IllegalArgumentException - if no item with the given label is found among current suggestions
      See Also:

    • getSelected

      public Y getSelected()
      Get the currently selected item.
      Returns:
      current selection

    • getSuggestions

      public List<String> getSuggestions()
      Get dropdown suggestions as String representations sent to the client. Any filter that is set is taken into account.
      Returns:
      List of item representation strings

    • getSuggestionItems

      public List<Y> getSuggestionItems()
      Get the actual items for the dropdown as a List. Any filter that is set is taken into account.
      Returns:
      List of items