Package com.vaadin.flow.component.combobox.testbench

Class MultiSelectComboBoxElement

java.lang.Object

com.vaadin.testbench.TestBenchElement

com.vaadin.flow.component.combobox.testbench.MultiSelectComboBoxElement

All Implemented Interfaces:

CanCompareScreenshots, HasCallFunction, HasDriver, HasElementQuery, HasHelper, HasLabel, HasPropertySettersGetters, HasSearchContext, HasTestBenchCommandExecutor, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebElement, org.openqa.selenium.WrapsElement

public class MultiSelectComboBoxElement
extends TestBenchElement
implements HasLabel, HasHelper

A TestBench element representing a <vaadin-multi-select-combo-box> element.

Constructor Summary

Constructors

Constructor	Description
MultiSelectComboBoxElement()

Method Summary

Modifier and Type	Method	Description
void	closePopup()	Close the popup, if it is open.
void	deselectAll()	Deselects all items, effectively clearing the value.
void	deselectByText(String label)	Attempts to deselect an item that is currently selected, by matching the label.
String	getFilter()	Gets the filter for the options in the popup.
String	getInputElementValue()
List<String>	getOptions()	Opens the popup, and gets the labels of the items that are currently loaded in the popup
List<String>	getSelectedTexts()	Gets the labels of the currently selected items.
boolean	isAutoOpen()	Gets whether dropdown will open automatically or not.
boolean	isPopupOpen()	Checks whether the popup is open.
void	openPopup()	Opens the popup, if it is not already open.
void	selectByText(String label)	Attempts to select an item from the popup by matching the label.
void	sendKeys(CharSequence... keysToSend)
void	setFilter(String filter)	Sets the filter for the options in the popup.
void	waitForLoadingFinished()	Waits until the combo box has finished loading items to show in the popup

Methods inherited from class com.vaadin.testbench.TestBenchElement

callFunction, clear, click, click, compareScreen, compareScreen, compareScreen, contextClick, dispatchEvent, dispatchEvent, doubleClick, equals, executeScript, findElement, findElements, focus, getAttribute, getCapabilities, getClassNames, getCommandExecutor, getContext, getCssValue, getDriver, getLocation, getProperty, getPropertyBoolean, getPropertyDouble, getPropertyElement, getPropertyElements, getPropertyInteger, getPropertyString, getRect, getScreenshotAs, getSize, getTagName, getText, getWrappedElement, hasAttribute, hasClassName, hashCode, init, init, isChrome, isDisplayed, isEnabled, isFirefox, isSelected, scroll, scrollIntoView, scrollLeft, setProperty, setProperty, setProperty, setProperty, submit, waitForVaadin, waitUntil, waitUntil, wrap, wrapElement, wrapElements

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.testbench.HasElementQuery

$, $

Methods inherited from interface com.vaadin.testbench.HasHelper

getHelperComponent, getHelperText

Methods inherited from interface com.vaadin.testbench.HasLabel

getLabel

Methods inherited from interface com.vaadin.testbench.HasPropertySettersGetters

getProperty, getPropertyBoolean, getPropertyDouble, getPropertyElement, getPropertyElements, getPropertyInteger, getPropertyString, setProperty, setProperty, setProperty, setProperty

Methods inherited from interface com.vaadin.testbench.HasSearchContext

getContext

Methods inherited from interface org.openqa.selenium.TakesScreenshot

getScreenshotAs

Methods inherited from interface org.openqa.selenium.WebElement

clear, click, findElement, findElements, getAccessibleName, getAriaRole, getAttribute, getCssValue, getDomAttribute, getDomProperty, getLocation, getRect, getShadowRoot, getSize, getTagName, getText, isDisplayed, isEnabled, isSelected, submit

Constructor Details

MultiSelectComboBoxElement

public MultiSelectComboBoxElement()

Method Details

getInputElementValue

public String getInputElementValue()

openPopup

public void openPopup()

Opens the popup, if it is not already open.

closePopup

public void closePopup()

Close the popup, if it is open.

isPopupOpen

public boolean isPopupOpen()

Checks whether the popup is open.

Returns:

true if the popup is open, false otherwise

getOptions

public List<String> getOptions()

Opens the popup, and gets the labels of the items that are currently loaded in the popup

Returns:

labels of the items that are loaded in the popup

selectByText

public void selectByText(String label)

Attempts to select an item from the popup by matching the label. Throws an IllegalArgumentException if the popup does not contain an item with the specified label. Does nothing if the item is already selected.

Parameters:

label - The label of the item to select from the popup

Throws:

IllegalArgumentException - if there is no item with the specified label

deselectByText

public void deselectByText(String label)

Attempts to deselect an item that is currently selected, by matching the label. Does nothing if the item is not selected.

Parameters:

label - The label of the item to deselect

deselectAll

public void deselectAll()

Deselects all items, effectively clearing the value.

getSelectedTexts

public List<String> getSelectedTexts()

Gets the labels of the currently selected items.

Returns:

the labels of the currently selected items

setFilter

public void setFilter(String filter)

Sets the filter for the options in the popup.

Parameters:

filter - the filter to use for filtering options

getFilter

public String getFilter()

Gets the filter for the options in the popup.

Returns:

the filter to use for filtering options

waitForLoadingFinished

public void waitForLoadingFinished()

Waits until the combo box has finished loading items to show in the popup

isAutoOpen

public boolean isAutoOpen()

Gets whether dropdown will open automatically or not.

Returns:

true if enabled, false otherwise

sendKeys

public void sendKeys(CharSequence... keysToSend)

Specified by:

sendKeys in interface org.openqa.selenium.WebElement

Overrides:

sendKeys in class TestBenchElement