Package net.serenitybdd.core.pages

Class PageObject

java.lang.Object
net.serenitybdd.core.pages.PageObject
Direct Known Subclasses:
AnyPage, PageObject, UIInteractionSteps, UIQuerySteps
public abstract class PageObject
extends java.lang.Object
A base class representing a WebDriver page object.
Author:
johnsmart

  • Constructor Details

    • PageObject

      protected PageObject()

    • PageObject

      protected PageObject​(org.openqa.selenium.WebDriver driver, com.google.common.base.Predicate<? super PageObject> callback)

    • 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 Details

    • setImplicitTimeout

      public void setImplicitTimeout​(int duration, java.time.temporal.TemporalUnit unit)

    • resetImplicitTimeout

      public void resetImplicitTimeout()

    • setDriver

      protected void setDriver​(org.openqa.selenium.WebDriver driver, long timeout)

    • setDriver

      public <T extends PageObject> T setDriver​(org.openqa.selenium.WebDriver driver)

    • withDriver

      public <T extends PageObject> T withDriver​(org.openqa.selenium.WebDriver driver)

    • getWaitForTimeout

      public java.time.Duration getWaitForTimeout()

    • getWaitForElementTimeout

      @Deprecated public java.time.Duration getWaitForElementTimeout()
      Deprecated.

    • getImplicitWaitTimeout

      public java.time.Duration getImplicitWaitTimeout()

    • setPages

      public void setPages​(Pages pages)

    • switchToPage

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

    • 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)

    • getRenderedView

      protected RenderedPageObjectView getRenderedView()

    • getClock

      protected SystemClock getClock()

    • 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

      @Deprecated public RenderedPageObjectView withTimeoutOf​(int timeout, java.util.concurrent.TimeUnit units)
      Deprecated.
      TimeUnit has been replaced by TemporalUnit in Selenium. For more consistancy use a TemporalUnit parameter.

    • withTimeoutOf

      public RenderedPageObjectView withTimeoutOf​(int timeout, java.time.temporal.TemporalUnit units)

    • withTimeoutOf

      public RenderedPageObjectView withTimeoutOf​(java.time.Duration timeout)

    • waitFor

      public PageObject waitFor​(java.lang.String xpathOrCssSelector, java.lang.Object... arguments)

    • waitFor

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

    • waitFor

      public PageObject waitFor​(java.lang.String message, org.openqa.selenium.support.ui.ExpectedCondition expectedCondition)

    • waitForRenderedElementsToBePresent

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

    • waitForPresenceOf

      public PageObject waitForPresenceOf​(java.lang.String xpathOrCssSelector, java.lang.Object... arguments)

    • waitForRenderedElementsToDisappear

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

    • waitForAbsenceOf

      public PageObject waitForAbsenceOf​(java.lang.String xpathOrCssSelector, java.lang.Object... arguments)

    • 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)

    • waitOnPage

      public org.openqa.selenium.support.ui.WebDriverWait waitOnPage()

    • 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)

    • waitABit

      protected void waitABit​(long timeInMilliseconds)

    • waitFor

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

    • thenReturnElementList

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

    • 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.CharSequence... keysToSend)
      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)

    • isRelative

      protected boolean isRelative​(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 PageObject.OpenWithParams open​(java.lang.String urlTemplateName)

    • 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 relativeUrl)

    • openUrl

      public final void openUrl​(java.lang.String absoluteUrl)

    • callWhenPageOpensMethods

      public void callWhenPageOpensMethods()
      Override this method

    • withParameters

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

    • openPageNamed

      public void openPageNamed​(java.lang.String pageName)
      Open an environment-specific page defined in the `serenity.conf` file under the `pages` section.
      Parameters:
      pageName -

    • 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()

    • getJavascriptExecutorFacade

      protected JavascriptExecutorFacade getJavascriptExecutorFacade()

    • 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 $​(WithLocator locator)

    • $

      public <T extends WebElementFacade> T $​(WithByLocator locator)

    • $

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

    • $

      public <T extends WebElementFacade> T $​(java.lang.String xpathOrCssSelector, java.lang.Object... arguments)

    • $

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

    • textOf

      public java.lang.String textOf​(WithLocator locator)
      Return the text value of a given element

    • textOf

      public java.lang.String textOf​(WithByLocator locator)

    • textOf

      public java.lang.String textOf​(java.lang.String xpathOrCssSelector, java.lang.Object... arguments)

    • textOf

      public java.lang.String textOf​(org.openqa.selenium.By bySelector)

    • textContentOf

      public java.lang.String textContentOf​(WithLocator locator)
      Return the text value of a given element

    • textContentOf

      public java.lang.String textContentOf​(WithByLocator locator)

    • textContentOf

      public java.lang.String textContentOf​(java.lang.String xpathOrCssSelector, java.lang.Object... arguments)

    • textContentOf

      public java.lang.String textContentOf​(org.openqa.selenium.By bySelector)

    • $$

      public ListOfWebElementFacades $$​(java.lang.String xpathOrCssSelector, java.lang.Object... arguments)

    • $$

      public ListOfWebElementFacades $$​(org.openqa.selenium.By bySelector)

    • 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​(org.openqa.selenium.By selector)

    • find

      public <T extends WebElementFacade> T find​(WithByLocator selector)

    • find

      public <T extends WebElementFacade> T find​(WithLocator selector)

    • find

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

    • findBy

      public <T extends WebElementFacade> T findBy​(java.util.List<java.lang.String> selectors)

    • findNested

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

    • find

      public <T extends WebElementFacade> T find​(java.lang.String selector)

    • findNested

      public <T extends WebElementFacade> T findNested​(java.lang.String... selectors)

    • findFirst

      public java.util.Optional<WebElementFacade> findFirst​(java.lang.String xpathOrCSSSelector)

    • findFirst

      public java.util.Optional<WebElementFacade> findFirst​(org.openqa.selenium.By bySelector)

    • findEach

      public java.util.stream.Stream<WebElementFacade> findEach​(org.openqa.selenium.By bySelector)

    • findEach

      public java.util.stream.Stream<WebElementFacade> findEach​(WithByLocator bySelector)

    • findEach

      public java.util.stream.Stream<WebElementFacade> findEach​(WithLocator bySelector)

    • findEach

      public java.util.stream.Stream<WebElementFacade> findEach​(org.openqa.selenium.By... bySelectors)
      FindEach will return a stream of WebElementFacades matching the described nested structure. Only the last selector will return a list; the initial selectors will be used to locate the list of elements.
      Parameters:
      bySelectors -
      Returns:

    • findEach

      public java.util.stream.Stream<WebElementFacade> findEach​(java.lang.String... xpathOrCssSelectors)

    • findNestedElements

      public ListOfWebElementFacades findNestedElements​(java.lang.String... xpathOrCssSelectors)

    • findEach

      public java.util.stream.Stream<WebElementFacade> findEach​(java.lang.String xpathOrCSSSelector)

    • findAll

      public ListOfWebElementFacades findAll​(org.openqa.selenium.By bySelector)

    • findAll

      public ListOfWebElementFacades findAll​(WithLocator bySelector)

    • findAll

      public ListOfWebElementFacades findAll​(WithByLocator bySelector)

    • element

      public <T extends WebElementFacade> T element​(java.lang.String xpathOrCssSelector, java.lang.Object... arguments)
      Provides a fluent API for querying web elements.

    • findBy

      public <T extends WebElementFacade> T findBy​(java.lang.String xpathOrCssSelector, java.lang.Object... arguments)

    • findFirst

      public java.util.Optional<WebElementFacade> findFirst​(java.lang.String xpathOrCssSelector, java.lang.Object... arguments)

    • findAll

      public ListOfWebElementFacades findAll​(java.lang.String xpathOrCssSelector, java.lang.Object... arguments)

    • containsElements

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

    • containsElements

      public boolean containsElements​(java.lang.String xpathOrCssSelector, java.lang.Object... arguments)

    • 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()

    • driverIsJQueryCompatible

      protected boolean driverIsJQueryCompatible()

    • inRadioButtonGroup

      public RadioButtonGroup inRadioButtonGroup​(java.lang.String name)

    • driverIsInstantiated

      protected boolean driverIsInstantiated()

    • waitForWithRefresh

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

    • waitForCondition

      public SerenityFluentWait waitForCondition()

    • waitFor

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

    • waitFor

      public WebElementFacade waitFor​(WebElementFacade webElement)

    • waitForElement

      public WebElementFacadeWait waitForElement()

    • getAlert

      public org.openqa.selenium.Alert getAlert()

    • withAction

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

    • fluent

      protected ThucydidesFluentAdapter fluent()

    • moveTo

      public <T extends WebElementFacade> T moveTo​(java.lang.String xpathOrCssSelector, java.lang.Object... arguments)

    • 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