Package com.vaadin.testbench

Class TestBenchElement

java.lang.Object
com.vaadin.testbench.TestBenchElement
All Implemented Interfaces:
CanCompareScreenshots, HasCallFunction, HasDriver, HasElementQuery, HasPropertySettersGetters, HasSearchContext, HasTestBenchCommandExecutor, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebElement, org.openqa.selenium.WrapsElement
Direct Known Subclasses:
AccordionElement, AnchorElement, AppLayoutElement, AvatarElement, AvatarGroupElement, BigDecimalFieldElement, BoardElement, ButtonElement, CardElement, ChartElement, CheckboxElement, CheckboxGroupElement, ComboBoxElement, ConfirmDialogElement, ContextMenuElement, ContextMenuItemElement, ContextMenuOverlayElement, CookieConsentElement, CrudElement, CustomFieldElement, DashboardElement, DashboardSectionElement, DashboardWidgetElement, DatePickerElement, DatePickerElement.MonthCalendarElement, DatePickerElement.OverlayContentElement, DatePickerElement.WeekdayElement, DateTimePickerElement, DescriptionListElement, DetailsElement, DialogElement, DivElement, DrawerToggleElement, EmailFieldElement, EmphasisElement, FormItemElement, FormLayoutElement, GridElement, GridProElement, GridTHTDElement, GridTHTDElement, GridTRElement, GridTRElement, H1Element, H2Element, H3Element, H4Element, H5Element, H6Element, HorizontalLayoutElement, HrElement, IconElement, ImageElement, InputTextElement, IntegerFieldElement, LabelElement, ListBoxElement, ListItemElement, LoginFormElement, LoginOverlayElement, MarkdownElement, MasterDetailLayoutElement, MenuBarButtonElement, MenuBarElement, MenuBarItemElement, MessageElement, MessageInputElement, MessageListElement, MultiSelectComboBoxElement, NativeButtonElement, NativeDetailsElement, NativeLabelElement, NativeTableBodyElement, NativeTableCaptionElement, NativeTableCellElement, NativeTableElement, NativeTableFooterElement, NativeTableHeaderCellElement, NativeTableHeaderElement, NativeTableRowElement, NotificationElement, NumberFieldElement, OrderedListElement, ParagraphElement, PasswordFieldElement, PopoverElement, PreElement, ProgressBarElement, RadioButtonElement, RadioButtonGroupElement, RangeInputElement, RichTextEditorElement, RowElement, ScrollerElement, SelectElement, SelectElement, SelectElement.ItemElement, SideNavElement, SideNavItemElement, SpanElement, SplitLayoutElement, TabElement, TabsElement, TabSheetElement, TextAreaElement, TextFieldElement, TimePickerElement, TimePickerElement.TimePickerComboBoxElement, TimePickerElement.TimePickerOverlayElement, UnorderedListElement, UploadElement, VerticalLayoutElement, VirtualListElement
public class TestBenchElement extends Object implements org.openqa.selenium.WrapsElement, org.openqa.selenium.WebElement, HasDriver, CanCompareScreenshots, HasTestBenchCommandExecutor, HasElementQuery, HasPropertySettersGetters, HasCallFunction
TestBenchElement is a WebElement wrapper. It provides Vaadin specific helper functionality. TestBenchElements are created when you search for elements from TestBenchTestCase or a context relative search from TestBenchElement.

  • Constructor Details

    • TestBenchElement

      protected TestBenchElement()

    • TestBenchElement

      protected TestBenchElement(org.openqa.selenium.WebElement webElement, TestBenchCommandExecutor commandExecutor)

  • Method Details

    • init

      protected void init(org.openqa.selenium.WebElement element, TestBenchCommandExecutor commandExecutor)
      TestBenchElement initialization function. If a subclass of TestBenchElement needs to run some initialization code, it should override init(), not this function.
      Parameters:
      element - WebElement to wrap
      commandExecutor - TestBenchCommandExecutor instance

    • isChrome

      protected boolean isChrome()
      Checks if the current test is running on Chrome.
      Returns:
      true if the test is running on Chrome, false otherwise

    • isFirefox

      protected boolean isFirefox()
      Checks if the current test is running on Firefox.
      Returns:
      true if the test is running on Firefox, false otherwise

    • getCapabilities

      protected org.openqa.selenium.Capabilities getCapabilities()
      Returns information about current browser used
      Returns:
      information about current browser used
      See Also:
      • Capabilities

    • init

      protected void init()
      This is run after initializing a TestBenchElement. This can be overridden in subclasses of TestBenchElement to run some initialization code.

    • getWrappedElement

      public org.openqa.selenium.WebElement getWrappedElement()
      Specified by:
      getWrappedElement in interface org.openqa.selenium.WrapsElement

    • waitForVaadin

      protected void waitForVaadin()

    • getId

      public String getId()
      Gets the id set for this element.
      Returns:
      String value, can be null

    • scroll

      public void scroll(int scrollTop)
      Sets the number of pixels that an element's content is scrolled from the top.
      Parameters:
      scrollTop - value set to Element.scroll property

    • scrollLeft

      public void scrollLeft(int scrollLeft)
      Sets the number of pixels that an element's content is scrolled to the left.
      Parameters:
      scrollLeft - value set to Element.scrollLeft property

    • isFocused

      public boolean isFocused()
      Checks if the current element is the focused element on the page.
      Returns:
      true if this element is the currently focused element, false otherwise.

    • click

      public void click()
      Specified by:
      click in interface org.openqa.selenium.WebElement

    • submit

      public void submit()
      Specified by:
      submit in interface org.openqa.selenium.WebElement

    • sendKeys

      public void sendKeys(CharSequence... keysToSend)
      Specified by:
      sendKeys in interface org.openqa.selenium.WebElement

    • clear

      public void clear()
      Specified by:
      clear in interface org.openqa.selenium.WebElement

    • getTagName

      public String getTagName()
      Specified by:
      getTagName in interface org.openqa.selenium.WebElement

    • getAttribute

      public String getAttribute(String name)
      Specified by:
      getAttribute in interface org.openqa.selenium.WebElement
      Parameters:
      name - The name of the attribute.
      Returns:
      The attribute/ property's current value or null if the value is not set.

    • getDomAttribute

      public @Nullable String getDomAttribute(String name)
      Specified by:
      getDomAttribute in interface org.openqa.selenium.WebElement

    • getDomProperty

      public @Nullable String getDomProperty(String name)
      Specified by:
      getDomProperty in interface org.openqa.selenium.WebElement

    • hasAttribute

      public boolean hasAttribute(String attribute)
      Checks if the given attribute is present on the element.
      Parameters:
      attribute - the name of the attribute
      Returns:
      true if the attribute is present, false otherwise

    • isSelected

      public boolean isSelected()
      Specified by:
      isSelected in interface org.openqa.selenium.WebElement

    • isEnabled

      public boolean isEnabled()
      Returns whether the Vaadin component, that this element represents, is enabled or not.
      Specified by:
      isEnabled in interface org.openqa.selenium.WebElement
      Returns:
      true if the component is enabled.

    • isReadOnly

      public boolean isReadOnly()
      Returns whether the Vaadin component, that this element represents, is having readonly attribute set or not.
      Returns:
      true if the component has readonly attribute set.

    • getText

      public String getText()
      Specified by:
      getText in interface org.openqa.selenium.WebElement

    • findElements

      public List<org.openqa.selenium.WebElement> findElements(org.openqa.selenium.By by)
      Specified by:
      findElements in interface org.openqa.selenium.SearchContext
      Specified by:
      findElements in interface org.openqa.selenium.WebElement

    • findElement

      public TestBenchElement findElement(org.openqa.selenium.By by)
      Specified by:
      findElement in interface org.openqa.selenium.SearchContext
      Specified by:
      findElement in interface org.openqa.selenium.WebElement

    • isDisplayed

      public boolean isDisplayed()
      Specified by:
      isDisplayed in interface org.openqa.selenium.WebElement

    • getLocation

      public org.openqa.selenium.Point getLocation()
      Specified by:
      getLocation in interface org.openqa.selenium.WebElement

    • getSize

      public org.openqa.selenium.Dimension getSize()
      Specified by:
      getSize in interface org.openqa.selenium.WebElement

    • getCssValue

      public String getCssValue(String propertyName)
      Specified by:
      getCssValue in interface org.openqa.selenium.WebElement

    • click

      public void click(int x, int y, org.openqa.selenium.Keys... modifiers)

    • doubleClick

      public void doubleClick()

    • contextClick

      public void contextClick()

    • wrap

      public <T extends TestBenchElement> T wrap(Class<T> elementType)

    • getCommandExecutor

      public TestBenchCommandExecutor getCommandExecutor()
      Description copied from interface: HasTestBenchCommandExecutor
      Return a reference to the related TestBenchCommandExecutor instance.
      Specified by:
      getCommandExecutor in interface HasTestBenchCommandExecutor
      Returns:
      the TestBenchCommandExecutor instance

    • getDriver

      public org.openqa.selenium.WebDriver getDriver()
      Description copied from interface: HasDriver
      Return the WebDriver instance associated with the implementing class instance. This can be simply the class itself re-cast as a WebDriver, or a reference to some WebDriver obtainable by any other means.
      Specified by:
      getDriver in interface HasDriver
      Returns:
      the contained WebDriver instance

    • getContext

      public org.openqa.selenium.SearchContext getContext()
      Returns this TestBenchElement cast to a SearchContext. Method provided for compatibility and consistency.
      Specified by:
      getContext in interface HasSearchContext
      Returns:
      a SearchContext instance

    • focus

      public void focus()
      Move browser focus to this Element

    • wrapElements

      protected static List<TestBenchElement> wrapElements(List<org.openqa.selenium.WebElement> elements, TestBenchCommandExecutor commandExecutor)

    • wrapElement

      protected static TestBenchElement wrapElement(org.openqa.selenium.WebElement element, TestBenchCommandExecutor commandExecutor)

    • getScreenshotAs

      public <X> X getScreenshotAs(org.openqa.selenium.OutputType<X> target) throws org.openqa.selenium.WebDriverException
      Specified by:
      getScreenshotAs in interface org.openqa.selenium.TakesScreenshot
      Throws:
      org.openqa.selenium.WebDriverException

    • getRect

      public org.openqa.selenium.Rectangle getRect()
      Specified by:
      getRect in interface org.openqa.selenium.WebElement

    • getClassNames

      public Set<String> getClassNames()
      Gets all the class names set for this element.
      Returns:
      a set of class names

    • hasClassName

      public boolean hasClassName(String className)
      Checks if this element has the given class name.

      Matches only full class names, i.e. has ("foo") does not match class="foobar bafoo"

      Parameters:
      className - the class name to check for
      Returns:
      true if the element has the given class name, false otherwise

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • compareScreen

      public boolean compareScreen(String referenceId) throws IOException
      Description copied from interface: CanCompareScreenshots
      Tests that a screen shot is equal to the specified reference image. The comparison tolerance can be specified by setting the com.vaadin.testbench.block.error system property to a value between 0 and 1, where 0 == no changes are accepted and 1 == big changes are accepted. Note that specifying 1 doesn't mean that any reference image is accepted.
      Specified by:
      compareScreen in interface CanCompareScreenshots
      Parameters:
      referenceId - the ID of the reference image
      Returns:
      true if the screenshot is considered equal to the reference image, false otherwise.
      Throws:
      IOException - if there was a problem accessing the reference image

    • compareScreen

      public boolean compareScreen(File reference) throws IOException
      Description copied from interface: CanCompareScreenshots
      Tests that a screen shot is equal to the specified reference image. The comparison tolerance can be specified by setting the com.vaadin.testbench.block.error system property to a value between 0 and 1, where 0 == no changes are accepted and 1 == all changes are accepted.
      Specified by:
      compareScreen in interface CanCompareScreenshots
      Parameters:
      reference - the reference image file
      Returns:
      true if the screenshot is considered equal to the reference image, false otherwise.
      Throws:
      IOException - if there was a problem accessing the reference image

    • compareScreen

      public boolean compareScreen(BufferedImage reference, String referenceName) throws IOException
      Description copied from interface: CanCompareScreenshots
      Tests that a screen shot is equal to the specified reference image. The comparison tolerance can be specified by setting the com.vaadin.testbench.block.error system property to a value between 0 and 1, where 0 == no changes are accepted and 1 == all changes are accepted.
      Specified by:
      compareScreen in interface CanCompareScreenshots
      Parameters:
      reference - the reference image
      referenceName - the filename of the reference image. Used when writing the error files.
      Returns:
      true if the screenshot is considered equal to the reference image, false otherwise.
      Throws:
      IOException - if there was a problem accessing the reference image

    • scrollIntoView

      public void scrollIntoView()
      Scrolls the element into the visible area of the browser window

    • waitUntil

      protected <T> T waitUntil(org.openqa.selenium.support.ui.ExpectedCondition<T> condition, long timeoutInSeconds)
      Waits the given number of seconds for the given condition to become neither null nor false. NotFoundExceptions are ignored by default.

      Use e.g. as waitUntil(ExpectedConditions.presenceOfElementLocated(by), 10);

      Type Parameters:
      T - The return type of the ExpectedCondition and this method
      Parameters:
      condition - Models a condition that might reasonably be expected to eventually evaluate to something that is neither null nor false.
      timeoutInSeconds - The timeout in seconds for the wait.
      Returns:
      The condition's return value if it returned something different from null or false before the timeout expired.
      Throws:
      org.openqa.selenium.TimeoutException - If the timeout expires.
      See Also:
      • FluentWait.until(java.util.function.Function<? super T, V>)
      • ExpectedCondition

    • waitUntil

      protected <T> T waitUntil(org.openqa.selenium.support.ui.ExpectedCondition<T> condition)
      Waits up to 10 seconds for the given condition to become neither null nor false. NotFoundExceptions are ignored by default.

      Use e.g. as waitUntil(ExpectedConditions.presenceOfElementLocated(by));

      Type Parameters:
      T - The return type of the ExpectedCondition and this method
      Parameters:
      condition - Models a condition that might reasonably be expected to eventually evaluate to something that is neither null nor false.
      Returns:
      The condition's return value if it returned something different from null or false before the timeout expired.
      Throws:
      org.openqa.selenium.TimeoutException - If 10 seconds passed.
      See Also:
      • FluentWait.until(java.util.function.Function<? super T, V>)
      • ExpectedCondition

    • setProperty

      public void setProperty(String name, String value)
      Description copied from interface: HasPropertySettersGetters
      Sets a JavaScript property of the given element.
      Specified by:
      setProperty in interface HasPropertySettersGetters
      Parameters:
      name - the name of the property
      value - the value to set

    • setProperty

      public void setProperty(String name, Boolean value)
      Description copied from interface: HasPropertySettersGetters
      Sets a JavaScript property of the given element.
      Specified by:
      setProperty in interface HasPropertySettersGetters
      Parameters:
      name - the name of the property
      value - the value to set

    • setProperty

      public void setProperty(String name, Double value)
      Description copied from interface: HasPropertySettersGetters
      Sets a JavaScript property of the given element.
      Specified by:
      setProperty in interface HasPropertySettersGetters
      Parameters:
      name - the name of the property
      value - the value to set

    • setProperty

      public void setProperty(String name, Integer value)
      Description copied from interface: HasPropertySettersGetters
      Sets a JavaScript property of the given element.
      Specified by:
      setProperty in interface HasPropertySettersGetters
      Parameters:
      name - the name of the property
      value - the value to set

    • getPropertyString

      public String getPropertyString(String... propertyNames)
      Description copied from interface: HasPropertySettersGetters
      Gets a JavaScript property of the given element as a string.
      Specified by:
      getPropertyString in interface HasPropertySettersGetters
      Parameters:
      propertyNames - the name of on or more properties, forming a property chain of type property1.property2.property3
      Returns:
      the value of the property

    • getPropertyBoolean

      public Boolean getPropertyBoolean(String... propertyNames)
      Description copied from interface: HasPropertySettersGetters
      Gets a JavaScript property of the given element as a boolean.
      Specified by:
      getPropertyBoolean in interface HasPropertySettersGetters
      Parameters:
      propertyNames - the name of on or more properties, forming a property chain of type property1.property2.property3
      Returns:
      the value of the property

    • getPropertyElement

      public TestBenchElement getPropertyElement(String... propertyNames)
      Description copied from interface: HasPropertySettersGetters
      Gets a JavaScript property of the given element as a DOM element.
      Specified by:
      getPropertyElement in interface HasPropertySettersGetters
      Parameters:
      propertyNames - the name of on or more properties, forming a property chain of type property1.property2.property3
      Returns:
      the value of the property

    • getPropertyElements

      public List<TestBenchElement> getPropertyElements(String... propertyNames)
      Description copied from interface: HasPropertySettersGetters
      Gets a JavaScript property of the given element as a list of DOM elements.
      Specified by:
      getPropertyElements in interface HasPropertySettersGetters
      Parameters:
      propertyNames - the name of on or more properties, forming a property chain of type property1.property2.property3
      Returns:
      the value of the property

    • getPropertyDouble

      public Double getPropertyDouble(String... propertyNames)
      Description copied from interface: HasPropertySettersGetters
      Gets a JavaScript property of the given element as a double.
      Specified by:
      getPropertyDouble in interface HasPropertySettersGetters
      Parameters:
      propertyNames - the name of on or more properties, forming a property chain of type property1.property2.property3
      Returns:
      the value of the property

    • getPropertyInteger

      public Integer getPropertyInteger(String... propertyNames)
      Description copied from interface: HasPropertySettersGetters
      Gets a JavaScript property of the given element as an integer.
      Specified by:
      getPropertyInteger in interface HasPropertySettersGetters
      Parameters:
      propertyNames - the name of on or more properties, forming a property chain of type property1.property2.property3
      Returns:
      the value of the property

    • getProperty

      public Object getProperty(String... propertyNames)
      Description copied from interface: HasPropertySettersGetters
      Gets a JavaScript property of the given element.

      The return value needs to be cast manually to the correct type.

      Specified by:
      getProperty in interface HasPropertySettersGetters
      Parameters:
      propertyNames - the name of on or more properties, forming a property chain of type property1.property2.property3
      Returns:
      the value of the property

    • executeScript

      protected Object executeScript(String script, Object... args)
      Executes the given JavaScript in the context of the currently selected frame or window. The script fragment provided will be executed as the body of an anonymous function.

      This method wraps any returned WebElement as TestBenchElement.

      Parameters:
      script - the script to execute
      args - the arguments, available in the script as arguments[0]...arguments[N]
      Returns:
      whatever JavascriptExecutor.executeScript(String, Object...) returns
      Throws:
      UnsupportedOperationException - if the underlying driver does not support JavaScript execution
      See Also:
      • JavascriptExecutor.executeScript(String, Object...)

    • callFunction

      public Object callFunction(String methodName, Object... args)
      Description copied from interface: HasCallFunction
      Invoke the given method on this element using the given arguments as arguments to the method.
      Specified by:
      callFunction in interface HasCallFunction
      Parameters:
      methodName - the method to invoke
      args - the arguments to pass to the method
      Returns:
      the value returned by the method

    • dispatchEvent

      public void dispatchEvent(String eventType)
      Dispatches (fires) a custom event of the given type on the element.

      The event is created without any parameters.

      Parameters:
      eventType - the type of custom event to dispatch

    • dispatchEvent

      public void dispatchEvent(String eventType, Map<String,Object> customEventInit)
      Dispatches (fires) a custom event of the given type on the element with the given properties
      Parameters:
      eventType - the type of custom event to dispatch
      customEventInit - map with properties and values that will be used to initialize the event

    • getParent

      public TestBenchElement getParent()
      Gets the parent element of this element.
      Returns:
      The parent as TestBenchElement, can be null.

    • getShadowRoot

      @Deprecated public org.openqa.selenium.SearchContext getShadowRoot()
      Deprecated.
      This method is deprecated. Use $ instead to find elements in the shadow root.
      Not implemented. This method is not supported for the TestBenchElement. Use $ instead to find elements in the shadow root. Example usage: 
       
 TestBenchElement element = ...;
 TestBenchElement child = element.$(TestBenchElement.class).id("elementid");
      Specified by:
      getShadowRoot in interface org.openqa.selenium.WebElement
      Returns:
      the SearchContext representing the shadow root.

    • getChildren

      public List<TestBenchElement> getChildren()
      Get list of immediate children of this element.
      Returns:
      List of TestBenchElements

    • hover

      public void hover()
      Hover mouse pointer on this element. Note: This works well only if this element is atomic.