net.serenitybdd.core.pages

Class WebElementFacadeImpl

java.lang.Object

net.serenitybdd.core.pages.WebElementFacadeImpl

All Implemented Interfaces:

io.appium.java_client.FindsByAccessibilityId, io.appium.java_client.FindsByAndroidUIAutomator, io.appium.java_client.FindsByIosUIAutomation, WebElementFacade, WebElementState, ConfigurableTimeouts, org.openqa.selenium.internal.Locatable, org.openqa.selenium.internal.WrapsElement, org.openqa.selenium.SearchContext, org.openqa.selenium.WebElement

Direct Known Subclasses:

WebElementFacadeImpl, WidgetObjectImpl

public class WebElementFacadeImpl
extends java.lang.Object
implements WebElementFacade, WebElementFacade

A proxy class for a web element, providing some more methods.

Constructor Summary

Constructors

Constructor and Description
WebElementFacadeImpl(org.openqa.selenium.WebDriver driver, org.openqa.selenium.support.pagefactory.ElementLocator locator, long implicitTimeoutInMilliseconds)
WebElementFacadeImpl(org.openqa.selenium.WebDriver driver, org.openqa.selenium.support.pagefactory.ElementLocator locator, long implicitTimeoutInMilliseconds, long waitForTimeoutInMilliseconds)
WebElementFacadeImpl(org.openqa.selenium.WebDriver driver, org.openqa.selenium.support.pagefactory.ElementLocator locator, org.openqa.selenium.WebElement webElement, long implicitTimeoutInMilliseconds)
WebElementFacadeImpl(org.openqa.selenium.WebDriver driver, org.openqa.selenium.support.pagefactory.ElementLocator locator, org.openqa.selenium.WebElement webElement, long implicitTimeoutInMilliseconds, long waitForTimeoutInMilliseconds)

Method Summary

Modifier and Type	Method and Description
WebElementFacade	and() Convenience method to chain method calls more fluently.
void	clear()
void	click() Wait for an element to be visible and enabled, and then click on it.
boolean	containsElements(org.openqa.selenium.By bySelector)
boolean	containsElements(java.lang.String xpathOrCssSelector)
boolean	containsOnlyText(java.lang.String value) Does this element exactly match given text?
boolean	containsSelectOption(java.lang.String value) Does this dropdown contain the specified value.
boolean	containsText(java.lang.String value) Does this element contain a given text?
WebElementState	expect(java.lang.String errorMessage)
WebElementFacade	find(org.openqa.selenium.By bySelector)
WebElementFacade	findBy(org.openqa.selenium.By selector)
<T extends WebElementFacade> T	findBy(java.lang.String xpathOrCssSelector)
org.openqa.selenium.WebElement	findElement(org.openqa.selenium.By by)
org.openqa.selenium.WebElement	findElementByAccessibilityId(java.lang.String id)
org.openqa.selenium.WebElement	findElementByAndroidUIAutomator(java.lang.String using)
org.openqa.selenium.WebElement	findElementByIosUIAutomation(java.lang.String using)
java.util.List<org.openqa.selenium.WebElement>	findElements(org.openqa.selenium.By by)
java.util.List<org.openqa.selenium.WebElement>	findElementsByAccessibilityId(java.lang.String id)
java.util.List<org.openqa.selenium.WebElement>	findElementsByAndroidUIAutomator(java.lang.String using)
java.util.List<org.openqa.selenium.WebElement>	findElementsByIosUIAutomation(java.lang.String using)
java.lang.String	getAttribute(java.lang.String name)
org.openqa.selenium.interactions.internal.Coordinates	getCoordinates()
java.lang.String	getCssValue(java.lang.String propertyName)
org.openqa.selenium.support.ui.Duration	getCurrentImplicitTimeout()
org.openqa.selenium.support.ui.Duration	getImplicitTimeout()
long	getImplicitTimeoutInMilliseconds()
org.openqa.selenium.Point	getLocation()
org.openqa.selenium.support.pagefactory.ElementLocator	getLocator()
java.lang.String	getSelectedValue()
java.lang.String	getSelectedVisibleTextValue()
java.util.List<java.lang.String>	getSelectOptions()
org.openqa.selenium.Dimension	getSize()
java.lang.String	getTagName()
java.lang.String	getText()
java.lang.String	getTextValue()
java.lang.String	getValue()
org.openqa.selenium.WebElement	getWrappedElement()
boolean	hasClass(java.lang.String cssClassName)
boolean	hasFocus() Does this element currently have the focus.
boolean	isCurrentlyEnabled()
boolean	isCurrentlyVisible() Is this web element present and visible on the screen This method will not throw an exception if the element is not on the screen at all.
boolean	isDisplayed()
boolean	isEnabled()
boolean	isPresent()
boolean	isSelected()
boolean	isVisible() Is this web element present and visible on the screen This method will not throw an exception if the element is not on the screen at all.
void	resetTimeouts()
WebElementFacade	selectByIndex(int indexValue)
WebElementFacade	selectByValue(java.lang.String value)
WebElementFacade	selectByVisibleText(java.lang.String label)
void	sendKeys(java.lang.CharSequence... keysToSend)
void	setImplicitTimeout(org.openqa.selenium.support.ui.Duration implicitTimeout)
void	setWindowFocus()
void	shouldBeCurrentlyVisible() Checks whether a web element is visible.
void	shouldBeEnabled()
void	shouldBePresent()
void	shouldBeVisible() Checks whether a web element is visible.
void	shouldContainElements(org.openqa.selenium.By bySelector)
void	shouldContainElements(java.lang.String xpathOrCssSelector)
void	shouldContainOnlyText(java.lang.String textValue) Check that an element exactly matches a text value
void	shouldContainSelectedOption(java.lang.String textValue)
void	shouldContainText(java.lang.String textValue) Check that an element contains a text value
void	shouldNotBeCurrentlyVisible() Checks whether a web element is not visible straight away.
void	shouldNotBeEnabled()
void	shouldNotBePresent()
void	shouldNotBeVisible() Checks whether a web element is not visible.
void	shouldNotContainText(java.lang.String textValue) Check that an element does not contain a text value
void	submit()
WebElementFacade	then() Convenience method to chain method calls more fluently.
WebElementFacade	then(org.openqa.selenium.By bySelector)
WebElementFacade	then(java.lang.String xpathOrCssSelector)
java.util.List<WebElementFacade>	thenFindAll(org.openqa.selenium.By selector)
java.util.List<WebElementFacade>	thenFindAll(java.lang.String xpathOrCssSelector)
long	timeoutInMilliseconds()
java.lang.String	toString()
WebElementFacade	type(java.lang.String value) Type a value into a field, making sure that the field is empty first.
WebElementFacade	typeAndEnter(java.lang.String value) Type a value into a field and then press Enter, making sure that the field is empty first.
WebElementFacade	typeAndTab(java.lang.String value) Type a value into a field and then press TAB, making sure that the field is empty first.
org.openqa.selenium.support.ui.Wait<org.openqa.selenium.WebDriver>	waitForCondition()
WebElementFacade	waitUntilClickable()
WebElementFacade	waitUntilDisabled()
WebElementFacade	waitUntilEnabled()
WebElementFacade	waitUntilNotVisible()
WebElementFacade	waitUntilPresent()
WebElementFacade	waitUntilVisible()
WebElementFacade	withTimeoutOf(int timeout, java.util.concurrent.TimeUnit unit)
static <T extends WebElementFacade> T	wrapWebElement(org.openqa.selenium.WebDriver driver, org.openqa.selenium.WebElement element, long timeout)
static <T extends WebElementFacade> T	wrapWebElement(org.openqa.selenium.WebDriver driver, org.openqa.selenium.WebElement element, long timeoutInMilliseconds, long waitForTimeoutInMilliseconds)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WebElementFacadeImpl

public WebElementFacadeImpl(org.openqa.selenium.WebDriver driver,
                            org.openqa.selenium.support.pagefactory.ElementLocator locator,
                            org.openqa.selenium.WebElement webElement,
                            long implicitTimeoutInMilliseconds,
                            long waitForTimeoutInMilliseconds)

WebElementFacadeImpl

public WebElementFacadeImpl(org.openqa.selenium.WebDriver driver,
                            org.openqa.selenium.support.pagefactory.ElementLocator locator,
                            org.openqa.selenium.WebElement webElement,
                            long implicitTimeoutInMilliseconds)

WebElementFacadeImpl

public WebElementFacadeImpl(org.openqa.selenium.WebDriver driver,
                            org.openqa.selenium.support.pagefactory.ElementLocator locator,
                            long implicitTimeoutInMilliseconds)

WebElementFacadeImpl

public WebElementFacadeImpl(org.openqa.selenium.WebDriver driver,
                            org.openqa.selenium.support.pagefactory.ElementLocator locator,
                            long implicitTimeoutInMilliseconds,
                            long waitForTimeoutInMilliseconds)

Method Detail

wrapWebElement

public static <T extends WebElementFacade> T wrapWebElement(org.openqa.selenium.WebDriver driver,
                                                            org.openqa.selenium.WebElement element,
                                                            long timeoutInMilliseconds,
                                                            long waitForTimeoutInMilliseconds)

wrapWebElement

public static <T extends WebElementFacade> T wrapWebElement(org.openqa.selenium.WebDriver driver,
                                                            org.openqa.selenium.WebElement element,
                                                            long timeout)

then

public WebElementFacade then(java.lang.String xpathOrCssSelector)

Specified by:

then in interface WebElementFacade

findBy

public <T extends WebElementFacade> T findBy(java.lang.String xpathOrCssSelector)

Specified by:

findBy in interface WebElementFacade

timeoutInMilliseconds

public long timeoutInMilliseconds()

thenFindAll

public java.util.List<WebElementFacade> thenFindAll(java.lang.String xpathOrCssSelector)

Specified by:

thenFindAll in interface WebElementFacade

findBy

public WebElementFacade findBy(org.openqa.selenium.By selector)

Specified by:

findBy in interface WebElementFacade

find

public WebElementFacade find(org.openqa.selenium.By bySelector)

Specified by:

find in interface WebElementFacade

then

public WebElementFacade then(org.openqa.selenium.By bySelector)

Specified by:

then in interface WebElementFacade

getAttribute

public java.lang.String getAttribute(java.lang.String name)

Specified by:

getAttribute in interface WebElementFacade

Specified by:

getAttribute in interface org.openqa.selenium.WebElement

thenFindAll

public java.util.List<WebElementFacade> thenFindAll(org.openqa.selenium.By selector)

Specified by:

thenFindAll in interface WebElementFacade

findElementByAccessibilityId

public org.openqa.selenium.WebElement findElementByAccessibilityId(java.lang.String id)

Specified by:

findElementByAccessibilityId in interface io.appium.java_client.FindsByAccessibilityId

findElementsByAccessibilityId

public java.util.List<org.openqa.selenium.WebElement> findElementsByAccessibilityId(java.lang.String id)

Specified by:

findElementsByAccessibilityId in interface io.appium.java_client.FindsByAccessibilityId

findElementByAndroidUIAutomator

public org.openqa.selenium.WebElement findElementByAndroidUIAutomator(java.lang.String using)

Specified by:

findElementByAndroidUIAutomator in interface io.appium.java_client.FindsByAndroidUIAutomator

findElementsByAndroidUIAutomator

public java.util.List<org.openqa.selenium.WebElement> findElementsByAndroidUIAutomator(java.lang.String using)

Specified by:

findElementsByAndroidUIAutomator in interface io.appium.java_client.FindsByAndroidUIAutomator

findElementByIosUIAutomation

public org.openqa.selenium.WebElement findElementByIosUIAutomation(java.lang.String using)

Specified by:

findElementByIosUIAutomation in interface io.appium.java_client.FindsByIosUIAutomation

findElementsByIosUIAutomation

public java.util.List<org.openqa.selenium.WebElement> findElementsByIosUIAutomation(java.lang.String using)

Specified by:

findElementsByIosUIAutomation in interface io.appium.java_client.FindsByIosUIAutomation

getImplicitTimeoutInMilliseconds

public long getImplicitTimeoutInMilliseconds()

Specified by:

getImplicitTimeoutInMilliseconds in interface WebElementFacade

getImplicitTimeout

public org.openqa.selenium.support.ui.Duration getImplicitTimeout()

withTimeoutOf

public WebElementFacade withTimeoutOf(int timeout,
                                      java.util.concurrent.TimeUnit unit)

Specified by:

withTimeoutOf in interface WebElementFacade

isVisible

public boolean isVisible()

Is this web element present and visible on the screen This method will not throw an exception if the element is not on the screen at all. If the element is not visible, the method will wait a bit to see if it appears later on.

Specified by:

isVisible in interface WebElementState

and

public WebElementFacade and()

Convenience method to chain method calls more fluently.

Specified by:

and in interface WebElementFacade

then

public WebElementFacade then()

Convenience method to chain method calls more fluently.

Specified by:

then in interface WebElementFacade

isCurrentlyVisible

public boolean isCurrentlyVisible()

Is this web element present and visible on the screen This method will not throw an exception if the element is not on the screen at all. The method will fail immediately if the element is not visible on the screen. There is a little black magic going on here - the web element class will detect if it is being called by a method called "isCurrently*" and, if so, fail immediately without waiting as it would normally do.

Specified by:

isCurrentlyVisible in interface WebElementState

isCurrentlyEnabled

public boolean isCurrentlyEnabled()

Specified by:

isCurrentlyEnabled in interface WebElementState

shouldBeVisible

public void shouldBeVisible()

Checks whether a web element is visible. Throws an AssertionError if the element is not rendered.

Specified by:

shouldBeVisible in interface WebElementState

shouldBeCurrentlyVisible

public void shouldBeCurrentlyVisible()

Checks whether a web element is visible. Throws an AssertionError if the element is not rendered.

Specified by:

shouldBeCurrentlyVisible in interface WebElementState

shouldNotBeVisible

public void shouldNotBeVisible()

Checks whether a web element is not visible. Throws an AssertionError if the element is not rendered.

Specified by:

shouldNotBeVisible in interface WebElementState

shouldNotBeCurrentlyVisible

public void shouldNotBeCurrentlyVisible()

Checks whether a web element is not visible straight away. Throws an AssertionError if the element is not rendered.

Specified by:

shouldNotBeCurrentlyVisible in interface WebElementState

hasFocus

public boolean hasFocus()

Does this element currently have the focus.

Specified by:

hasFocus in interface WebElementState

containsText

public boolean containsText(java.lang.String value)

Does this element contain a given text?

Specified by:

containsText in interface WebElementState

containsOnlyText

public boolean containsOnlyText(java.lang.String value)

Does this element exactly match given text?

Specified by:

containsOnlyText in interface WebElementState

containsSelectOption

public boolean containsSelectOption(java.lang.String value)

Does this dropdown contain the specified value.

Specified by:

containsSelectOption in interface WebElementState

getSelectOptions

public java.util.List<java.lang.String> getSelectOptions()

Specified by:

getSelectOptions in interface WebElementFacade

getLocator

public org.openqa.selenium.support.pagefactory.ElementLocator getLocator()

setImplicitTimeout

public void setImplicitTimeout(org.openqa.selenium.support.ui.Duration implicitTimeout)

Specified by:

setImplicitTimeout in interface ConfigurableTimeouts

getCurrentImplicitTimeout

public org.openqa.selenium.support.ui.Duration getCurrentImplicitTimeout()

Specified by:

getCurrentImplicitTimeout in interface ConfigurableTimeouts

resetTimeouts

public void resetTimeouts()

Specified by:

resetTimeouts in interface ConfigurableTimeouts

shouldContainText

public void shouldContainText(java.lang.String textValue)

Check that an element contains a text value

Specified by:

shouldContainText in interface WebElementState

Parameters:

textValue -

shouldContainOnlyText

public void shouldContainOnlyText(java.lang.String textValue)

Check that an element exactly matches a text value

Specified by:

shouldContainOnlyText in interface WebElementState

Parameters:

textValue -

shouldContainSelectedOption

public void shouldContainSelectedOption(java.lang.String textValue)

Specified by:

shouldContainSelectedOption in interface WebElementState

shouldNotContainText

public void shouldNotContainText(java.lang.String textValue)

Check that an element does not contain a text value

Specified by:

shouldNotContainText in interface WebElementState

Parameters:

textValue -

shouldBeEnabled

public void shouldBeEnabled()

Specified by:

shouldBeEnabled in interface WebElementState

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface WebElementState

Specified by:

isEnabled in interface org.openqa.selenium.WebElement

shouldNotBeEnabled

public void shouldNotBeEnabled()

Specified by:

shouldNotBeEnabled in interface WebElementState

type

public WebElementFacade type(java.lang.String value)

Type a value into a field, making sure that the field is empty first.

Specified by:

type in interface WebElementFacade

Parameters:

value -

typeAndEnter

public WebElementFacade typeAndEnter(java.lang.String value)

Type a value into a field and then press Enter, making sure that the field is empty first.

Specified by:

typeAndEnter in interface WebElementFacade

Parameters:

value -

typeAndTab

public WebElementFacade typeAndTab(java.lang.String value)

Type a value into a field and then press TAB, making sure that the field is empty first. This currently is not supported by all browsers, notably Firefox.

Specified by:

typeAndTab in interface WebElementFacade

Parameters:

value -

setWindowFocus

public void setWindowFocus()

Specified by:

setWindowFocus in interface WebElementFacade

selectByVisibleText

public WebElementFacade selectByVisibleText(java.lang.String label)

Specified by:

selectByVisibleText in interface WebElementFacade

getSelectedVisibleTextValue

public java.lang.String getSelectedVisibleTextValue()

Specified by:

getSelectedVisibleTextValue in interface WebElementState

selectByValue

public WebElementFacade selectByValue(java.lang.String value)

Specified by:

selectByValue in interface WebElementFacade

getSelectedValue

public java.lang.String getSelectedValue()

Specified by:

getSelectedValue in interface WebElementState

selectByIndex

public WebElementFacade selectByIndex(int indexValue)

Specified by:

selectByIndex in interface WebElementFacade

isPresent

public boolean isPresent()

Specified by:

isPresent in interface WebElementState

shouldBePresent

public void shouldBePresent()

Specified by:

shouldBePresent in interface WebElementState

shouldNotBePresent

public void shouldNotBePresent()

Specified by:

shouldNotBePresent in interface WebElementState

waitUntilVisible

public WebElementFacade waitUntilVisible()

Specified by:

waitUntilVisible in interface WebElementFacade

waitUntilPresent

public WebElementFacade waitUntilPresent()

Specified by:

waitUntilPresent in interface WebElementFacade

waitForCondition

public org.openqa.selenium.support.ui.Wait<org.openqa.selenium.WebDriver> waitForCondition()

Specified by:

waitForCondition in interface WebElementFacade

waitUntilNotVisible

public WebElementFacade waitUntilNotVisible()

Specified by:

waitUntilNotVisible in interface WebElementFacade

getValue

public java.lang.String getValue()

Specified by:

getValue in interface WebElementFacade

isSelected

public boolean isSelected()

Specified by:

isSelected in interface WebElementState

Specified by:

isSelected in interface org.openqa.selenium.WebElement

getText

public java.lang.String getText()

Specified by:

getText in interface WebElementFacade

Specified by:

getText in interface org.openqa.selenium.WebElement

waitUntilEnabled

public WebElementFacade waitUntilEnabled()

Specified by:

waitUntilEnabled in interface WebElementFacade

waitUntilClickable

public WebElementFacade waitUntilClickable()

Specified by:

waitUntilClickable in interface WebElementFacade

waitUntilDisabled

public WebElementFacade waitUntilDisabled()

Specified by:

waitUntilDisabled in interface WebElementFacade

getTextValue

public java.lang.String getTextValue()

Specified by:

getTextValue in interface WebElementState

expect

public WebElementState expect(java.lang.String errorMessage)

Specified by:

expect in interface WebElementState

click

public void click()

Wait for an element to be visible and enabled, and then click on it.

Specified by:

click in interface WebElementFacade

Specified by:

click in interface org.openqa.selenium.WebElement

clear

public void clear()

Specified by:

clear in interface WebElementFacade

Specified by:

clear in interface org.openqa.selenium.WebElement

toString

public java.lang.String toString()

Specified by:

toString in interface WebElementFacade

Overrides:

toString in class java.lang.Object

submit

public void submit()

Specified by:

submit in interface org.openqa.selenium.WebElement

sendKeys

public void sendKeys(java.lang.CharSequence... keysToSend)

Specified by:

sendKeys in interface org.openqa.selenium.WebElement

getTagName

public java.lang.String getTagName()

Specified by:

getTagName in interface org.openqa.selenium.WebElement

findElements

public java.util.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

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 java.lang.String getCssValue(java.lang.String propertyName)

Specified by:

getCssValue in interface org.openqa.selenium.WebElement

getWrappedElement

public org.openqa.selenium.WebElement getWrappedElement()

Specified by:

getWrappedElement in interface org.openqa.selenium.internal.WrapsElement

getCoordinates

public org.openqa.selenium.interactions.internal.Coordinates getCoordinates()

Specified by:

getCoordinates in interface org.openqa.selenium.internal.Locatable

containsElements

public boolean containsElements(org.openqa.selenium.By bySelector)

Specified by:

containsElements in interface WebElementFacade

containsElements

public boolean containsElements(java.lang.String xpathOrCssSelector)

Specified by:

containsElements in interface WebElementFacade

shouldContainElements

public void shouldContainElements(org.openqa.selenium.By bySelector)

Specified by:

shouldContainElements in interface WebElementFacade

shouldContainElements

public void shouldContainElements(java.lang.String xpathOrCssSelector)

Specified by:

shouldContainElements in interface WebElementFacade

hasClass

public boolean hasClass(java.lang.String cssClassName)

Specified by:

hasClass in interface WebElementFacade