com.vaadin.testbench

Class TestBenchElement

java.lang.Object

com.vaadin.testbench.AbstractHasTestBenchCommandExecutor

com.vaadin.testbench.TestBenchElement

All Implemented Interfaces:

CanCompareScreenshots, CanWaitForVaadin, TestBenchElementCommands, HasDriver, HasSearchContext, HasTestBenchCommandExecutor, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebElement, org.openqa.selenium.WrapsElement

Direct Known Subclasses:

AbstractElement

public class TestBenchElement
extends AbstractHasTestBenchCommandExecutor
implements org.openqa.selenium.WrapsElement, org.openqa.selenium.WebElement, TestBenchElementCommands, CanWaitForVaadin, HasDriver, CanCompareScreenshots

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 Summary

Constructors

Modifier	Constructor and Description
protected	TestBenchElement()
protected	TestBenchElement(org.openqa.selenium.WebElement webElement, TestBenchCommandExecutor tbCommandExecutor)

Method Summary

Modifier and Type	Method and Description
void	clear()
void	click()
void	click(int x, int y, org.openqa.selenium.Keys... modifiers) Clicks at the specified coordinates on an element while pressing possible modifier keys.
void	clickHiddenElement() Calls the Javascript click method on the element.
boolean	compareScreen(BufferedImage reference, String referenceName) Tests that a screen shot is equal to the specified reference image.
boolean	compareScreen(File reference) Tests that a screen shot is equal to the specified reference image.
boolean	compareScreen(String referenceId) Tests that a screen shot is equal to the specified reference image.
void	contextClick()
void	doubleClick()
boolean	equals(Object obj)
org.openqa.selenium.WebElement	findElement(org.openqa.selenium.By by)
List<org.openqa.selenium.WebElement>	findElements(org.openqa.selenium.By by)
void	focus() Move browser focus to this Element
String	getAccessibleName()
String	getAriaRole()
String	getAttribute(String name)
protected org.openqa.selenium.Capabilities	getCapabilities() Returns information about current browser used
Set<String>	getClassNames() Gets all the class names set for this element.
TestBenchCommandExecutor	getCommandExecutor() Return a reference to the related TestBenchCommandExecutor instance.
org.openqa.selenium.SearchContext	getContext() Returns this TestBenchElement cast to a SearchContext.
String	getCssValue(String propertyName)
String	getDomAttribute(String name)
org.openqa.selenium.WebDriver	getDriver() Return the WebDriver instance associated with the implementing class instance.
String	getId() Returns the id value set for this element.
org.openqa.selenium.Point	getLocation()
org.openqa.selenium.Rectangle	getRect()
<X> X	getScreenshotAs(org.openqa.selenium.OutputType<X> target)
org.openqa.selenium.SearchContext	getShadowRoot()
org.openqa.selenium.Dimension	getSize()
String	getTagName()
String	getText()
org.openqa.selenium.WebElement	getWrappedElement()
boolean	hasAttribute(String attribute) Checks if the given attribute is present on the element.
boolean	hasClassName(String className) Checks if this element has the given class name.
int	hashCode()
protected void	init() This is run after initializing a TestBenchElement.
protected void	init(org.openqa.selenium.WebElement element, TestBenchCommandExecutor tbCommandExecutor) TestBenchElement initialization function.
protected boolean	isChrome() Checks if the current test is running on Chrome.
boolean	isDisplayed()
boolean	isEnabled() Returns whether the Vaadin component, that this element represents, is enabled or not.
protected boolean	isFirefox() Checks if the current test is running on Firefox.
boolean	isFocused() Checks whether the current element is the focused element on the page.
boolean	isReadOnly() Returns whether the Vaadin component represented by this element has been set read-only.
boolean	isSelected()
void	scroll(int scrollTop) Sets the number of pixels that an element's content is scrolled from the top.
void	scrollIntoView() Scrolls the element into the visible area of the browser window
void	scrollLeft(int scrollLeft) Sets the number of pixels that an element's content is scrolled to the left.
void	sendKeys(CharSequence... keysToSend)
void	showTooltip() Shows the tool tip of the specified element.
void	submit()
void	waitForVaadin()
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.
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.
<T extends AbstractElement> T	wrap(Class<T> elementType) Decorates the element with the specified Element type, making it possible to use Vaadin component-specific API on elements found using standard selenium API.
protected static TestBenchElement	wrapElement(org.openqa.selenium.WebElement element, TestBenchCommandExecutor tbCommandExecutor)
protected static List<TestBenchElement>	wrapElements(List<org.openqa.selenium.WebElement> elements, TestBenchCommandExecutor tbCommandExecutor)

Methods inherited from class com.vaadin.testbench.AbstractHasTestBenchCommandExecutor

$, $$, isElementPresent, isElementPresent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openqa.selenium.WebElement

getDomProperty

Constructor Detail

TestBenchElement

protected TestBenchElement()

TestBenchElement

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

Method Detail

init

protected void init(org.openqa.selenium.WebElement element,
                    TestBenchCommandExecutor tbCommandExecutor)

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

tbCommandExecutor - 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

public void waitForVaadin()

Specified by:

waitForVaadin in interface CanWaitForVaadin

showTooltip

public void showTooltip()

Description copied from interface: TestBenchElementCommands

Shows the tool tip of the specified element.

Specified by:

showTooltip in interface TestBenchElementCommands

getId

public String getId()

Returns the id value 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.

Specified by:

scroll in interface TestBenchElementCommands

Parameters:

scrollTop - value set to Element.scroll property

See Also:

TestBenchElementCommands.scroll(int)

scrollLeft

public void scrollLeft(int scrollLeft)

Sets the number of pixels that an element's content is scrolled to the left.

Specified by:

scrollLeft in interface TestBenchElementCommands

Parameters:

scrollLeft - value set to Element.scrollLeft property

See Also:

TestBenchElementCommands.scrollLeft(int)

isFocused

public boolean isFocused()

Checks whether 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

getDomAttribute

public String getDomAttribute(String name)

Specified by:

getDomAttribute in interface org.openqa.selenium.WebElement

getAttribute

public String getAttribute(String name)

Specified by:

getAttribute 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

getAriaRole

public String getAriaRole()

Specified by:

getAriaRole in interface org.openqa.selenium.WebElement

getAccessibleName

public String getAccessibleName()

Specified by:

getAccessibleName in interface org.openqa.selenium.WebElement

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 represented by this element has been set read-only.

Returns:

true if the element has the readonly attribute, false otherwise.

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 org.openqa.selenium.WebElement findElement(org.openqa.selenium.By by)

Specified by:

findElement in interface org.openqa.selenium.SearchContext

Specified by:

findElement in interface org.openqa.selenium.WebElement

getShadowRoot

public org.openqa.selenium.SearchContext getShadowRoot()

Specified by:

getShadowRoot in interface org.openqa.selenium.WebElement

clickHiddenElement

public void clickHiddenElement()

Calls the Javascript click method on the element. Useful for elements that are hidden or covered by a pseudo-element on some browser-theme combinations (for instance Firefox-Valo)

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)

Description copied from interface: TestBenchElementCommands

Clicks at the specified coordinates on an element while pressing possible modifier keys. The coordinates are relative to top left on the element.

Specified by:

click in interface TestBenchElementCommands

Parameters:

x - the offset from the left position of the element

y - the offset from the top position of the element

modifiers - any modifier keys to press while clicking the element (optional).

doubleClick

public void doubleClick()

contextClick

public void contextClick()

wrap

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

Description copied from interface: TestBenchElementCommands

Decorates the element with the specified Element type, making it possible to use Vaadin component-specific API on elements found using standard selenium API.

Example: WebElement e = driver.findElement(By.id("my-table")); TableElement table = testBenchElement(e).wrap(TableElement.class); assertEquals("Foo", table.getHeaderCell(1).getText());

Specified by:

wrap in interface TestBenchElementCommands

Type Parameters:

T - The wrapper element type.

Parameters:

elementType - The type (class) containing the API to decorate with. Must extend AbstractElement.

Returns:

The element wrapped in an instance of the specified element type.

getCommandExecutor

public TestBenchCommandExecutor getCommandExecutor()

Description copied from interface: HasTestBenchCommandExecutor

Return a reference to the related TestBenchCommandExecutor instance.

Specified by:

getCommandExecutor in interface HasTestBenchCommandExecutor

Returns:

executor

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

Specified by:

focus in interface TestBenchElementCommands

wrapElements

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

wrapElement

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

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 condition

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 condition

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