Package com.vaadin.flow.component.select.testbench

Class SelectElement

java.lang.Object
com.vaadin.testbench.TestBenchElement
com.vaadin.flow.component.select.testbench.SelectElement
All Implemented Interfaces:
com.vaadin.testbench.commands.CanCompareScreenshots, com.vaadin.testbench.HasCallFunction, com.vaadin.testbench.HasDriver, com.vaadin.testbench.HasElementQuery, com.vaadin.testbench.HasHelper, com.vaadin.testbench.HasLabel, com.vaadin.testbench.HasPlaceholder, com.vaadin.testbench.HasPropertySettersGetters, com.vaadin.testbench.HasSearchContext, com.vaadin.testbench.HasSelectByText, com.vaadin.testbench.HasTestBenchCommandExecutor, com.vaadin.testbench.HasValidation, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebElement, org.openqa.selenium.WrapsElement
public class SelectElement extends com.vaadin.testbench.TestBenchElement implements com.vaadin.testbench.HasSelectByText, com.vaadin.testbench.HasLabel, com.vaadin.testbench.HasPlaceholder, com.vaadin.testbench.HasHelper, com.vaadin.testbench.HasValidation
Testbench Element API for vaadin-select.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    SelectElement.ItemElement
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    SelectElement()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    closePopup()
    Closes the popup with options, if it is open.
    List<SelectElement.ItemElement>
    getItems()
    Gets the items in the popup.
    Stream<SelectElement.ItemElement>
    getItemsStream()
    Gets the items in the popup as a stream.
    SelectElement.ItemElement
    getSelectedItem()
    Gets the currently selected item shown in the value button, or null if nothing is selected.
    SelectElement.ItemElement
    getSelectedOptionItem()
    Gets the selected item in the popup.
    String
    getSelectedText()
     
    boolean
    isOpened()
    Checks whether the popup with options is open.
    void
    openPopup()
    Opens the popup with options, if it is not already open.
    void
    selectByText(String text)
    Selects the item with the given text by clicking it in the popup.
    void
    selectItemByIndex(int index)
    Selects the item with the given index by clicking it 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, getChildren, getClassNames, getCommandExecutor, getContext, getCssValue, getDomAttribute, getDomProperty, getDriver, getId, getLocation, getParent, getProperty, getPropertyBoolean, getPropertyDouble, getPropertyElement, getPropertyElements, getPropertyInteger, getPropertyString, getRect, getScreenshotAs, getShadowRoot, getSize, getTagName, getText, getWrappedElement, hasAttribute, hasClassName, hashCode, hover, init, init, isChrome, isDisplayed, isEnabled, isFirefox, isFocused, isReadOnly, isSelected, scroll, scrollIntoView, scrollIntoView, scrollLeft, sendKeys, 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.HasCallFunction

    callFunction

    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.HasPlaceholder

    getPlaceholder

    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 com.vaadin.testbench.HasValidation

    getErrorMessage, isInvalid, isRequired

    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, sendKeys, submit

  • Constructor Details

    • SelectElement

      public SelectElement()

  • Method Details

    • openPopup

      public void openPopup()
      Opens the popup with options, if it is not already open.

    • closePopup

      public void closePopup()
      Closes the popup with options, if it is open.

    • isOpened

      public boolean isOpened()
      Checks whether the popup with options is open.
      Returns:
      true if the popup is open, false otherwise

    • selectItemByIndex

      public void selectItemByIndex(int index)
      Selects the item with the given index by clicking it in the popup. Opens the popup if it is not open. Clicking the item closes the popup.
      Parameters:
      index - the index of the item to select

    • getItemsStream

      public Stream<SelectElement.ItemElement> getItemsStream()
      Gets the items in the popup as a stream.
      Returns:
      a stream of the items in the popup

    • getItems

      public List<SelectElement.ItemElement> getItems()
      Gets the items in the popup.
      Returns:
      the items in the popup

    • selectByText

      public void selectByText(String text)
      Selects the item with the given text by clicking it in the popup. Opens the popup if it is not open. Clicking the item closes the popup.
      Specified by:
      selectByText in interface com.vaadin.testbench.HasSelectByText
      Parameters:
      text - the text of the item to select
      Throws:
      NoSuchElementException - if no item has the given text

    • getSelectedText

      public String getSelectedText()
      Specified by:
      getSelectedText in interface com.vaadin.testbench.HasSelectByText

    • getSelectedOptionItem

      public SelectElement.ItemElement getSelectedOptionItem()
      Gets the selected item in the popup.
      Returns:
      the selected item in the popup
      Throws:
      NoSuchElementException - if no item is selected

    • getSelectedItem

      public SelectElement.ItemElement getSelectedItem()
      Gets the currently selected item shown in the value button, or null if nothing is selected.
      Returns:
      the selected item, or null if nothing is selected