net.serenitybdd.core.pages

Class PageObject

java.lang.Object

net.serenitybdd.core.pages.PageObject

Direct Known Subclasses:

AnyPage, PageObject

public abstract class PageObject
extends java.lang.Object

A base class representing a WebDriver page object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PageObject.FieldEntry

Constructor Summary

Constructors

Constructor and Description
PageObject(org.openqa.selenium.WebDriver driver)
PageObject(org.openqa.selenium.WebDriver driver, EnvironmentVariables environmentVariables)
PageObject(org.openqa.selenium.WebDriver driver, int ajaxTimeout)

Method Summary

Modifier and Type	Method and Description
<T extends WebElementFacade> T	$(java.lang.String xpathOrCssSelector)
<T extends WebElementFacade> T	$(org.openqa.selenium.WebElement webElement)
void	addJQuerySupport()
void	blurActiveElement()
void	callWhenPageOpensMethods() Override this method
void	clickOn(org.openqa.selenium.WebElement webElement)
boolean	compatibleWithUrl(java.lang.String currentUrl) Does this page object work for this URL? When matching a URL, we check with and without trailing slashes
boolean	containsAllText(java.lang.String... textValues) Check that the specified text appears somewhere in the page.
boolean	containsElements(org.openqa.selenium.By bySelector)
boolean	containsElements(java.lang.String xpathOrCssSelector)
boolean	containsText(java.lang.String textValue)
boolean	containsTextInElement(org.openqa.selenium.WebElement webElement, java.lang.String textValue) Deprecated. use element(webElement).containsText(textValue)
<T extends WebElementFacade> T	element(org.openqa.selenium.By bySelector) Provides a fluent API for querying web elements.
<T extends WebElementFacade> T	element(java.lang.String xpathOrCssSelector) Provides a fluent API for querying web elements.
<T extends WebElementFacade> T	element(org.openqa.selenium.WebElement webElement) Provides a fluent API for querying web elements.
PageObject.FieldEntry	enter(java.lang.String value) Clear a field and enter a value into it.
java.lang.Object	evaluateJavascript(java.lang.String script)
java.lang.Object	evaluateJavascript(java.lang.String script, java.lang.Object... params)
<T extends WebElementFacade> T	find(org.openqa.selenium.By... selectors)
<T extends WebElementFacade> T	find(java.util.List<org.openqa.selenium.By> selectors)
java.util.List<WebElementFacade>	findAll(org.openqa.selenium.By bySelector)
java.util.List<WebElementFacade>	findAll(java.lang.String xpathOrCssSelector)
<T extends WebElementFacade> T	findBy(java.lang.String xpathOrCssSelector)
<T extends PageObject> T	foo()
org.openqa.selenium.Alert	getAlert()
org.openqa.selenium.WebDriver	getDriver()
org.openqa.selenium.support.ui.Duration	getImplicitWaitTimeout()
java.lang.String	getSelectedLabelFrom(org.openqa.selenium.WebElement dropdown)
java.util.Set<java.lang.String>	getSelectedOptionLabelsFrom(org.openqa.selenium.WebElement dropdown)
java.util.Set<java.lang.String>	getSelectedOptionValuesFrom(org.openqa.selenium.WebElement dropdown)
java.lang.String	getSelectedValueFrom(org.openqa.selenium.WebElement dropdown)
java.lang.String	getTitle()
org.openqa.selenium.support.ui.Duration	getWaitForElementTimeout() Deprecated.
org.openqa.selenium.support.ui.Duration	getWaitForTimeout()
boolean	hasFocus(org.openqa.selenium.WebElement webElement) Deprecated. Use element(webElement).hasFocus() instead
long	implicitTimoutMilliseconds()
RadioButtonGroup	inRadioButtonGroup(java.lang.String name)
java.lang.Boolean	isElementVisible(org.openqa.selenium.By byCriteria) Returns true if at least one matching element is found on the page and is visible.
boolean	matchesAnyUrl()
<T extends WebElementFacade> T	moveTo(org.openqa.selenium.By locator)
<T extends WebElementFacade> T	moveTo(java.lang.String xpathOrCssSelector)
void	open() Open the webdriver browser to the base URL, determined by the DefaultUrl annotation if present.
void	open(java.lang.String[] parameterValues) Open the webdriver browser using a paramaterized URL.
void	open(java.lang.String urlTemplateName, java.lang.String[] parameterValues)
void	openAt(java.lang.String startingUrl)
void	openUnchecked() Opens page without checking URL patterns.
void	openUnchecked(java.lang.String... parameterValues) Opens page without checking URL patterns.
void	openUnchecked(java.lang.String urlTemplateName, java.lang.String[] parameterValues) Opens page without checking URL patterns.
void	resetImplicitTimeout()
void	selectFromDropdown(org.openqa.selenium.WebElement dropdown, java.lang.String visibleLabel)
void	selectMultipleItemsFromDropdown(org.openqa.selenium.WebElement dropdown, java.lang.String... selectedLabels)
void	setCheckbox(org.openqa.selenium.WebElement field, boolean value)
void	setDefaultBaseUrl(java.lang.String defaultBaseUrl)
void	setDriver(org.openqa.selenium.WebDriver driver)
void	setImplicitTimeout(int duration, java.util.concurrent.TimeUnit unit)
void	setPages(Pages pages)
void	setPageUrls(PageUrls pageUrls) Only for testing purposes.
void	setWaitForElementTimeout(long waitForTimeoutInMilliseconds)
void	setWaitForTimeout(long waitForTimeoutInMilliseconds)
void	shouldBeDisplayed() Use the @At annotation (if present) to check that a page object is displaying the correct page.
void	shouldBeVisible(org.openqa.selenium.By byCriteria)
void	shouldBeVisible(org.openqa.selenium.WebElement field) Fail the test if this element is not displayed (rendered) on the screen.
void	shouldContainAllText(java.lang.String... textValues) Check that all of the specified texts appears somewhere in the page.
void	shouldContainText(java.lang.String textValue) Check that the specified text appears somewhere in the page.
void	shouldContainTextInElement(org.openqa.selenium.WebElement webElement, java.lang.String textValue) Deprecated.
void	shouldNotBeVisible(org.openqa.selenium.By byCriteria)
void	shouldNotBeVisible(org.openqa.selenium.WebElement field)
void	shouldNotContainTextInElement(org.openqa.selenium.WebElement webElement, java.lang.String textValue) Deprecated.
<T extends PageObject> T	switchToPage(java.lang.Class<T> pageObjectClass)
java.util.List<org.openqa.selenium.WebElement>	thenReturnElementList(org.openqa.selenium.By byListCriteria)
java.lang.String	toString()
void	typeInto(org.openqa.selenium.WebElement field, java.lang.String value) Clear a field and enter a value into it.
java.lang.String	updateUrlWithBaseUrlIfDefined(java.lang.String startingUrl)
FileToUpload	upload(java.lang.String filename) Upload a file via an HTML form.
FileToUpload	uploadData(byte[] data)
FileToUpload	uploadData(java.lang.String data)
PageObject	waitFor(org.openqa.selenium.support.ui.ExpectedCondition expectedCondition)
WaitForBuilder<? extends PageObject>	waitFor(int duration)
PageObject	waitFor(java.lang.String xpathOrCssSelector)
WebElementFacade	waitFor(org.openqa.selenium.WebElement webElement)
WebElementFacade	waitFor(WebElementFacade webElement)
PageObject	waitForAbsenceOf(java.lang.String xpathOrCssSelector)
PageObject	waitForAllTextToAppear(java.lang.String... expectedTexts) Waits for all of a number of text blocks to appear on the screen.
void	waitForAngularRequestsToFinish()
PageObject	waitForAnyRenderedElementOf(org.openqa.selenium.By... expectedElements)
PageObject	waitForAnyTextToAppear(java.lang.String... expectedText) Waits for any of a number of text blocks to appear anywhere on the screen.
PageObject	waitForAnyTextToAppear(org.openqa.selenium.WebElement element, java.lang.String... expectedText)
ThucydidesFluentWait<org.openqa.selenium.WebDriver>	waitForCondition()
PageObject	waitForPresenceOf(java.lang.String xpathOrCssSelector)
PageObject	waitForRenderedElements(org.openqa.selenium.By byElementCriteria)
PageObject	waitForRenderedElementsToBePresent(org.openqa.selenium.By byElementCriteria)
PageObject	waitForRenderedElementsToDisappear(org.openqa.selenium.By byElementCriteria)
PageObject	waitForTextToAppear(java.lang.String expectedText) Waits for a given text to appear anywhere on the page.
PageObject	waitForTextToAppear(java.lang.String expectedText, long timeout) Waits for a given text to appear anywhere on the page.
PageObject	waitForTextToAppear(org.openqa.selenium.WebElement element, java.lang.String expectedText) Waits for a given text to appear inside the element.
PageObject	waitForTextToDisappear(java.lang.String expectedText)
PageObject	waitForTextToDisappear(java.lang.String expectedText, long timeoutInMilliseconds) Waits for a given text to not be anywhere on the page.
PageObject	waitForTextToDisappear(org.openqa.selenium.WebElement element, java.lang.String expectedText) Waits for a given text to disappear from the element.
long	waitForTimeoutInMilliseconds()
PageObject	waitForTitleToAppear(java.lang.String expectedTitle)
PageObject	waitForTitleToDisappear(java.lang.String expectedTitle)
ThucydidesFluentWait<org.openqa.selenium.WebDriver>	waitForWithRefresh()
org.openqa.selenium.interactions.Actions	withAction()
PageObject	withDriver(org.openqa.selenium.WebDriver driver)
static java.lang.String[]	withParameters(java.lang.String... parameterValues)
RenderedPageObjectView	withTimeoutOf(org.openqa.selenium.support.ui.Duration timeout)
RenderedPageObjectView	withTimeoutOf(int timeout, java.util.concurrent.TimeUnit units)

Methods inherited from class java.lang.Object

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

Constructor Detail

PageObject

public PageObject(org.openqa.selenium.WebDriver driver,
                  int ajaxTimeout)

PageObject

public PageObject(org.openqa.selenium.WebDriver driver)

PageObject

public PageObject(org.openqa.selenium.WebDriver driver,
                  EnvironmentVariables environmentVariables)

Method Detail

setImplicitTimeout

public void setImplicitTimeout(int duration,
                               java.util.concurrent.TimeUnit unit)

resetImplicitTimeout

public void resetImplicitTimeout()

setDriver

public void setDriver(org.openqa.selenium.WebDriver driver)

withDriver

public PageObject withDriver(org.openqa.selenium.WebDriver driver)

getWaitForTimeout

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

getWaitForElementTimeout

@Deprecated
public org.openqa.selenium.support.ui.Duration getWaitForElementTimeout()

Deprecated.

getImplicitWaitTimeout

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

setPages

public void setPages(Pages pages)

switchToPage

public <T extends PageObject> T switchToPage(java.lang.Class<T> pageObjectClass)

upload

public FileToUpload upload(java.lang.String filename)

Upload a file via an HTML form. By default, this will look for a file on the file system, at the location provided.

uploadData

public FileToUpload uploadData(java.lang.String data)
                        throws java.io.IOException

Throws:

java.io.IOException

uploadData

public FileToUpload uploadData(byte[] data)
                        throws java.io.IOException

Throws:

java.io.IOException

setPageUrls

public void setPageUrls(PageUrls pageUrls)

Only for testing purposes.

setWaitForTimeout

public void setWaitForTimeout(long waitForTimeoutInMilliseconds)

setWaitForElementTimeout

public void setWaitForElementTimeout(long waitForTimeoutInMilliseconds)

getDriver

public org.openqa.selenium.WebDriver getDriver()

getTitle

public java.lang.String getTitle()

matchesAnyUrl

public boolean matchesAnyUrl()

compatibleWithUrl

public final boolean compatibleWithUrl(java.lang.String currentUrl)

Does this page object work for this URL? When matching a URL, we check with and without trailing slashes

waitForRenderedElements

public PageObject waitForRenderedElements(org.openqa.selenium.By byElementCriteria)

withTimeoutOf

public RenderedPageObjectView withTimeoutOf(int timeout,
                                            java.util.concurrent.TimeUnit units)

withTimeoutOf

public RenderedPageObjectView withTimeoutOf(org.openqa.selenium.support.ui.Duration timeout)

waitFor

public PageObject waitFor(java.lang.String xpathOrCssSelector)

waitFor

public PageObject waitFor(org.openqa.selenium.support.ui.ExpectedCondition expectedCondition)

waitForRenderedElementsToBePresent

public PageObject waitForRenderedElementsToBePresent(org.openqa.selenium.By byElementCriteria)

waitForPresenceOf

public PageObject waitForPresenceOf(java.lang.String xpathOrCssSelector)

waitForRenderedElementsToDisappear

public PageObject waitForRenderedElementsToDisappear(org.openqa.selenium.By byElementCriteria)

waitForAbsenceOf

public PageObject waitForAbsenceOf(java.lang.String xpathOrCssSelector)

waitForTextToAppear

public PageObject waitForTextToAppear(java.lang.String expectedText)

Waits for a given text to appear anywhere on the page.

waitForTitleToAppear

public PageObject waitForTitleToAppear(java.lang.String expectedTitle)

waitForTitleToDisappear

public PageObject waitForTitleToDisappear(java.lang.String expectedTitle)

waitForTextToAppear

public PageObject waitForTextToAppear(org.openqa.selenium.WebElement element,
                                      java.lang.String expectedText)

Waits for a given text to appear inside the element.

waitForTextToDisappear

public PageObject waitForTextToDisappear(org.openqa.selenium.WebElement element,
                                         java.lang.String expectedText)

Waits for a given text to disappear from the element.

waitForTextToDisappear

public PageObject waitForTextToDisappear(java.lang.String expectedText)

waitForTextToDisappear

public PageObject waitForTextToDisappear(java.lang.String expectedText,
                                         long timeoutInMilliseconds)

Waits for a given text to not be anywhere on the page.

waitForTextToAppear

public PageObject waitForTextToAppear(java.lang.String expectedText,
                                      long timeout)

Waits for a given text to appear anywhere on the page.

waitForAnyTextToAppear

public PageObject waitForAnyTextToAppear(java.lang.String... expectedText)

Waits for any of a number of text blocks to appear anywhere on the screen.

waitForAnyTextToAppear

public PageObject waitForAnyTextToAppear(org.openqa.selenium.WebElement element,
                                         java.lang.String... expectedText)

waitForAllTextToAppear

public PageObject waitForAllTextToAppear(java.lang.String... expectedTexts)

Waits for all of a number of text blocks to appear on the screen.

waitForAnyRenderedElementOf

public PageObject waitForAnyRenderedElementOf(org.openqa.selenium.By... expectedElements)

waitFor

public WaitForBuilder<? extends PageObject> waitFor(int duration)

thenReturnElementList

public java.util.List<org.openqa.selenium.WebElement> thenReturnElementList(org.openqa.selenium.By byListCriteria)

foo

public <T extends PageObject> T foo()

shouldContainText

public void shouldContainText(java.lang.String textValue)

Check that the specified text appears somewhere in the page.

shouldContainAllText

public void shouldContainAllText(java.lang.String... textValues)

Check that all of the specified texts appears somewhere in the page.

containsTextInElement

@Deprecated
public boolean containsTextInElement(org.openqa.selenium.WebElement webElement,
                                                 java.lang.String textValue)

Deprecated. use element(webElement).containsText(textValue)

Does the specified web element contain a given text value. Useful for dropdowns and so on.

shouldContainTextInElement

@Deprecated
public void shouldContainTextInElement(org.openqa.selenium.WebElement webElement,
                                                   java.lang.String textValue)

Deprecated.

shouldNotContainTextInElement

@Deprecated
public void shouldNotContainTextInElement(org.openqa.selenium.WebElement webElement,
                                                      java.lang.String textValue)

Deprecated.

typeInto

public void typeInto(org.openqa.selenium.WebElement field,
                     java.lang.String value)

Clear a field and enter a value into it.

enter

public PageObject.FieldEntry enter(java.lang.String value)

Clear a field and enter a value into it. This is a more fluent alternative to using the typeInto method.

selectFromDropdown

public void selectFromDropdown(org.openqa.selenium.WebElement dropdown,
                               java.lang.String visibleLabel)

selectMultipleItemsFromDropdown

public void selectMultipleItemsFromDropdown(org.openqa.selenium.WebElement dropdown,
                                            java.lang.String... selectedLabels)

getSelectedOptionLabelsFrom

public java.util.Set<java.lang.String> getSelectedOptionLabelsFrom(org.openqa.selenium.WebElement dropdown)

getSelectedOptionValuesFrom

public java.util.Set<java.lang.String> getSelectedOptionValuesFrom(org.openqa.selenium.WebElement dropdown)

getSelectedValueFrom

public java.lang.String getSelectedValueFrom(org.openqa.selenium.WebElement dropdown)

getSelectedLabelFrom

public java.lang.String getSelectedLabelFrom(org.openqa.selenium.WebElement dropdown)

setCheckbox

public void setCheckbox(org.openqa.selenium.WebElement field,
                        boolean value)

containsText

public boolean containsText(java.lang.String textValue)

containsAllText

public boolean containsAllText(java.lang.String... textValues)

Check that the specified text appears somewhere in the page.

shouldBeVisible

public void shouldBeVisible(org.openqa.selenium.WebElement field)

Fail the test if this element is not displayed (rendered) on the screen.

shouldBeVisible

public void shouldBeVisible(org.openqa.selenium.By byCriteria)

shouldNotBeVisible

public void shouldNotBeVisible(org.openqa.selenium.WebElement field)

shouldNotBeVisible

public void shouldNotBeVisible(org.openqa.selenium.By byCriteria)

waitForTimeoutInMilliseconds

public long waitForTimeoutInMilliseconds()

implicitTimoutMilliseconds

public long implicitTimoutMilliseconds()

updateUrlWithBaseUrlIfDefined

public java.lang.String updateUrlWithBaseUrlIfDefined(java.lang.String startingUrl)

open

public final void open(java.lang.String[] parameterValues)

Open the webdriver browser using a paramaterized URL. Parameters are represented in the URL using {0}, {1}, etc.

openUnchecked

public final void openUnchecked(java.lang.String... parameterValues)

Opens page without checking URL patterns. Same as open(String...)) otherwise.

open

public final void open(java.lang.String urlTemplateName,
                       java.lang.String[] parameterValues)

openUnchecked

public final void openUnchecked(java.lang.String urlTemplateName,
                                java.lang.String[] parameterValues)

Opens page without checking URL patterns. Same as open(String, String[]) otherwise.

open

public final void open()

Open the webdriver browser to the base URL, determined by the DefaultUrl annotation if present. If the DefaultUrl annotation is not present, the default base URL will be used. If the DefaultUrl annotation is present, a URL based on the current base url from the system-wide default url and the relative path provided in the DefaultUrl annotation will be used to determine the URL to open. For example, consider the following class:

     
         @DefaultUrl("http://localhost:8080/client/list")
         public class ClientList extends PageObject {
             ...

             @WhenPageOpens
             public void waitUntilTitleAppears() {...}
         }
     
 

Suppose you are using a base URL of http://stage.acme.com. When you call open() for this class, it will open http://stage.acme.com/client/list. It will then invoke the waitUntilTitleAppears() method.

openUnchecked

public final void openUnchecked()

Opens page without checking URL patterns. Same as open() otherwise.

shouldBeDisplayed

public void shouldBeDisplayed()

Use the @At annotation (if present) to check that a page object is displaying the correct page. Will throw an exception if the current URL does not match the expected one.

openAt

public final void openAt(java.lang.String startingUrl)

callWhenPageOpensMethods

public void callWhenPageOpensMethods()

Override this method

withParameters

public static java.lang.String[] withParameters(java.lang.String... parameterValues)

clickOn

public void clickOn(org.openqa.selenium.WebElement webElement)

isElementVisible

public java.lang.Boolean isElementVisible(org.openqa.selenium.By byCriteria)

Returns true if at least one matching element is found on the page and is visible.

setDefaultBaseUrl

public void setDefaultBaseUrl(java.lang.String defaultBaseUrl)

hasFocus

public boolean hasFocus(org.openqa.selenium.WebElement webElement)

Deprecated. Use element(webElement).hasFocus() instead

Returns true if the specified element has the focus.

blurActiveElement

public void blurActiveElement()

element

public <T extends WebElementFacade> T element(org.openqa.selenium.WebElement webElement)

Provides a fluent API for querying web elements.

$

public <T extends WebElementFacade> T $(org.openqa.selenium.WebElement webElement)

$

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

element

public <T extends WebElementFacade> T element(org.openqa.selenium.By bySelector)

Provides a fluent API for querying web elements.

find

public <T extends WebElementFacade> T find(java.util.List<org.openqa.selenium.By> selectors)

find

public <T extends WebElementFacade> T find(org.openqa.selenium.By... selectors)

findAll

public java.util.List<WebElementFacade> findAll(org.openqa.selenium.By bySelector)

element

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

Provides a fluent API for querying web elements.

findBy

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

findAll

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

containsElements

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

containsElements

public boolean containsElements(java.lang.String xpathOrCssSelector)

evaluateJavascript

public java.lang.Object evaluateJavascript(java.lang.String script)

evaluateJavascript

public java.lang.Object evaluateJavascript(java.lang.String script,
                                           java.lang.Object... params)

addJQuerySupport

public void addJQuerySupport()

inRadioButtonGroup

public RadioButtonGroup inRadioButtonGroup(java.lang.String name)

waitForWithRefresh

public ThucydidesFluentWait<org.openqa.selenium.WebDriver> waitForWithRefresh()

waitForCondition

public ThucydidesFluentWait<org.openqa.selenium.WebDriver> waitForCondition()

waitFor

public WebElementFacade waitFor(org.openqa.selenium.WebElement webElement)

waitFor

public WebElementFacade waitFor(WebElementFacade webElement)

getAlert

public org.openqa.selenium.Alert getAlert()

withAction

public org.openqa.selenium.interactions.Actions withAction()

moveTo

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

moveTo

public <T extends WebElementFacade> T moveTo(org.openqa.selenium.By locator)

waitForAngularRequestsToFinish

public void waitForAngularRequestsToFinish()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object