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

Class ComboBoxElement

  • All Implemented Interfaces:
    com.vaadin.testbench.commands.CanCompareScreenshots, com.vaadin.testbench.HasCallFunction, com.vaadin.testbench.HasClearButton, com.vaadin.testbench.HasDriver, com.vaadin.testbench.HasElementQuery, com.vaadin.testbench.HasHelper, com.vaadin.testbench.HasLabel, 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 ComboBoxElement
extends com.vaadin.testbench.TestBenchElement
implements com.vaadin.testbench.HasLabel, com.vaadin.testbench.HasSelectByText, com.vaadin.testbench.HasHelper, com.vaadin.testbench.HasValidation, com.vaadin.testbench.HasClearButton
    A TestBench element representing a <vaadin-combo-box> element.

    • Constructor Summary

      Constructors 
      Constructor Description
      ComboBoxElement()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clear()
      Clears the value of the combobox.
      void closePopup()
      Close the popup with options, if it is open.
      String getFilter()
      Gets the filter for the options in the popup.
      String getInputElementValue()  
      List<String> getOptions()
      Gets a list of all available options.
      String getSelectedText()  
      protected String getValue()
      Gets the property "value" as a string.
      boolean isAutoOpen()
      Gets whether dropdown will open automatically or not.
      boolean isPopupOpen()
      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)  
      void sendKeys​(CharSequence... keysToSend)  
      void setFilter​(String filter)
      Sets the filter for the options in the popup.
      protected void setValue​(String value)
      Sets the property "value" as a string.

      • Methods inherited from class com.vaadin.testbench.TestBenchElement

        callFunction, click, click, compareScreen, compareScreen, compareScreen, contextClick, dispatchEvent, dispatchEvent, doubleClick, equals, executeScript, findElement, findElements, focus, getAttribute, getCapabilities, getChildren, getClassNames, getCommandExecutor, getContext, getCssValue, 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, scrollLeft, setProperty, setProperty, setProperty, setProperty, submit, waitForVaadin, waitUntil, waitUntil, wrap, wrapElement, wrapElements

      • Methods inherited from interface com.vaadin.testbench.HasCallFunction

        callFunction

      • Methods inherited from interface com.vaadin.testbench.HasClearButton

        clickClearButton, isClearButtonVisible

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

        getErrorMessage, isInvalid, isRequired

      • Methods inherited from interface org.openqa.selenium.TakesScreenshot

        getScreenshotAs

      • Methods inherited from interface org.openqa.selenium.WebElement

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

    • Constructor Detail

      • ComboBoxElement

        public ComboBoxElement()

    • Method Detail

      • clear

        public void clear()
        Clears the value of the combobox.
        Specified by:
        clear in interface org.openqa.selenium.WebElement
        Overrides:
        clear in class com.vaadin.testbench.TestBenchElement

      • setValue

        protected void setValue​(String value)
        Sets the property "value" as a string.

        Parameters:
        value - the value to set

      • getValue

        protected String getValue()
        Gets the property "value" as a string.

        Returns:
        the value of the combobox or an empty string if no value is selected

      • selectByText

        public void selectByText​(String text)
        Specified by:
        selectByText in interface com.vaadin.testbench.HasSelectByText

      • getSelectedText

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

      • getInputElementValue

        public String getInputElementValue()

      • openPopup

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

      • closePopup

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

      • isPopupOpen

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

      • getOptions

        public List<String> getOptions()
        Gets a list of all available options.
        Returns:
        a list of the options (visible text)

      • 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

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