Package com.vaadin.flow.component.listbox

Class ListBoxLocator<V>

java.lang.Object

com.vaadin.browserless.locator.Locator<ListBox<V>,ListBoxLocator<V>>

com.vaadin.flow.component.listbox.ListBoxLocator<V>

All Implemented Interfaces:

Clickable<ListBox<V>>, HasAriaLabelFilter<ListBox<V>,ListBoxLocator<V>>, HasValueFilter<ListBox<V>,V,ListBoxLocator<V>>

@Generated("com.vaadin.browserless.locator.processor.LocatorProcessor")
public class ListBoxLocator<V>
extends Locator<ListBox<V>,ListBoxLocator<V>>
implements Clickable<ListBox<V>>, HasAriaLabelFilter<ListBox<V>,ListBoxLocator<V>>, HasValueFilter<ListBox<V>,V,ListBoxLocator<V>>

Generated locator for ListBox, derived from ListBoxTester. 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 Summary

Constructors

Constructor	Description
ListBoxLocator(ListBox<V> component)
ListBoxLocator(Class<V> vType)

Method Summary

Modifier and Type	Method	Description
void	ensureComponentIsUsable()	Ensures the component is in a usable state before interaction.
ListBox<V>	getComponent()	Gets the component being tested.
V	getSelected()	Get the currently selected item.
List<V>	getSuggestionItems()	Get the actual items for the dropdown as a List.
List<String>	getSuggestions()	Get available items as String representations sent to the client.
void	selectItem(String selection)	Select item by client string representation.

Methods inherited from class com.vaadin.browserless.locator.Locator

atIndex, component, components, exists, inside, inside, invalidate, self, with, withAttribute, withAttribute, withClassName, withCondition, withId, withoutAttribute, withoutAttribute, withoutClassName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.browserless.Clickable

click, click, click, middleClick, middleClick, rightClick, rightClick

Methods inherited from interface com.vaadin.browserless.locator.HasAriaLabelFilter

withAriaLabel, withAriaLabelContaining

Methods inherited from interface com.vaadin.browserless.locator.HasValueFilter

withValue

Constructor Details

ListBoxLocator

public ListBoxLocator(Class<V> vType)

ListBoxLocator

public ListBoxLocator(ListBox<V> component)

Method Details

getComponent

public ListBox<V> getComponent()

Description copied from interface: Clickable

Gets the component being tested.

Specified by:

getComponent in interface Clickable<V>

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<V>

getSelected

public V getSelected()

Get the currently selected item. Javadoc copied from ListBoxTester.getSelected().

Returns:

current selection

selectItem

public void selectItem(String selection)

Select item by client string representation. Javadoc copied from ListBoxTester.selectItem(java.lang.String).

Parameters:

selection - item representation string

getSuggestions

public List<String> getSuggestions()

Get available items as String representations sent to the client. Any filter that is set is taken into account. Javadoc copied from ListBoxTester.getSuggestions().

Returns:

List of item representation strings

getSuggestionItems

public List<V> getSuggestionItems()

Get the actual items for the dropdown as a List. Any filter that is set is taken into account. Javadoc copied from ListBoxTester.getSuggestionItems().

Returns:

List of items