Package com.vaadin.flow.component.listbox

Class MultiSelectListBoxLocator<V>

java.lang.Object

com.vaadin.browserless.locator.Locator<MultiSelectListBox<V>,MultiSelectListBoxLocator<V>>

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

All Implemented Interfaces:

Clickable<MultiSelectListBox<V>>, HasAriaLabelFilter<MultiSelectListBox<V>,MultiSelectListBoxLocator<V>>, HasValueFilter<MultiSelectListBox<V>,Set<V>,MultiSelectListBoxLocator<V>>

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

Generated locator for MultiSelectListBox, derived from MultiSelectListBoxTester. 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
MultiSelectListBoxLocator(MultiSelectListBox<V> component)
MultiSelectListBoxLocator(Class<V> vType)

Method Summary

Modifier and Type	Method	Description
void	clearSelection()	Clear all selected items from the component.
void	deselectItems(String... selection)	Deselect item(s) by client string representation.
void	ensureComponentIsUsable()	Ensures the component is in a usable state before interaction.
MultiSelectListBox<V>	getComponent()	Gets the component being tested.
Set<V>	getSelected()	Get the currently selected items.
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	selectItems(String... selection)	Select item(s) 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

MultiSelectListBoxLocator

public MultiSelectListBoxLocator(Class<V> vType)

MultiSelectListBoxLocator

public MultiSelectListBoxLocator(MultiSelectListBox<V> component)

Method Details

getComponent

public MultiSelectListBox<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 Set<V> getSelected()

Get the currently selected items. Javadoc copied from MultiSelectListBoxTester.getSelected().

Returns:

current selection

selectItems

public void selectItems(String... selection)

Select item(s) by client string representation. Javadoc copied from MultiSelectListBoxTester.selectItems(java.lang.String[]).

Parameters:

selection - item representation string, not null

deselectItems

public void deselectItems(String... selection)

Deselect item(s) by client string representation. Javadoc copied from MultiSelectListBoxTester.deselectItems(java.lang.String[]).

Parameters:

selection - item representation string, not null

Throws:

IllegalArgumentException - if selection contained item not available for selection

clearSelection

public void clearSelection()

Clear all selected items from the component. Javadoc copied from MultiSelectListBoxTester.clearSelection().

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 MultiSelectListBoxTester.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 MultiSelectListBoxTester.getSuggestionItems().

Returns:

List of items