Package com.vaadin.flow.component.combobox

Class ComboBoxLocator<Y>

java.lang.Object
com.vaadin.browserless.locator.Locator<ComboBox<Y>,ComboBoxLocator<Y>>
com.vaadin.flow.component.combobox.ComboBoxLocator<Y>
All Implemented Interfaces:
Clickable<ComboBox<Y>>, HasAriaLabelFilter<ComboBox<Y>,ComboBoxLocator<Y>>, HasLabelFilter<ComboBox<Y>,ComboBoxLocator<Y>>, HasThemeFilter<ComboBox<Y>,ComboBoxLocator<Y>>, HasValueFilter<ComboBox<Y>,Y,ComboBoxLocator<Y>>
@Generated("com.vaadin.browserless.locator.processor.LocatorProcessor") public class ComboBoxLocator<Y> extends Locator<ComboBox<Y>,ComboBoxLocator<Y>> implements Clickable<ComboBox<Y>>, HasLabelFilter<ComboBox<Y>,ComboBoxLocator<Y>>, HasAriaLabelFilter<ComboBox<Y>,ComboBoxLocator<Y>>, HasValueFilter<ComboBox<Y>,Y,ComboBoxLocator<Y>>, HasThemeFilter<ComboBox<Y>,ComboBoxLocator<Y>>
Generated locator for ComboBox, derived from ComboBoxTester. Filter steps are inherited from Locator; action methods delegate to a fresh tester around the resolved component, so behavioral changes belong on the tester, not here.

  • Constructor Details

    • ComboBoxLocator

      public ComboBoxLocator(Class<Y> yType)

    • ComboBoxLocator

      public ComboBoxLocator(ComboBox<Y> component)

  • Method Details

    • getComponent

      public ComboBox<Y> getComponent()
      Description copied from interface: Clickable
      Gets the component being tested.
      Specified by:
      getComponent in interface Clickable<Y>
      Returns:
      the component under test

    • ensureComponentIsUsable

      public void ensureComponentIsUsable()
      Description copied from interface: Clickable
      Ensures the component is in a usable state before interaction.
      Specified by:
      ensureComponentIsUsable in interface Clickable<Y>

    • 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. Javadoc copied from ComboBoxTester.setFilter(java.lang.String).

      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");
      Javadoc copied from ComboBoxTester.selectItem(java.lang.String).
      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. Javadoc copied from ComboBoxTester.getSelected().
      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. Javadoc copied from ComboBoxTester.getSuggestions().
      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. Javadoc copied from ComboBoxTester.getSuggestionItems().
      Returns:
      List of items