me.alb_i986.selenium.tinafw.ui

Class PageHelper

java.lang.Object

me.alb_i986.selenium.tinafw.ui.PageHelper

public class PageHelper
extends Object

Static class providing some helper functions that solve common problems concerning Selenium WebDriver. The static methods are grouped in static nested classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PageHelper.Form Static class providing some helper functions that solve common problems concerning forms.
static class	PageHelper.Navigation Helper methods about navigating the web app, e.g.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_EXPLICIT_WAIT_TIMEOUT_SECONDS The default timeout in seconds used by waitUntil(ExpectedCondition, WebDriver).

Constructor Summary

Constructors

Constructor and Description
PageHelper()

Method Summary

Modifier and Type	Method and Description
static void	assertElementIsNotDisplayed(org.openqa.selenium.By locator, org.openqa.selenium.WebDriver driver) Explicitly wait until the given element is visible.
static <T> T	assertExpectedCondition(org.openqa.selenium.support.ui.ExpectedCondition<T> condition, org.openqa.selenium.WebDriver driver) Explicitly wait until the given expected condition is met.
static org.openqa.selenium.WebElement	findOrRefresh(org.openqa.selenium.By locator, org.openqa.selenium.WebDriver driver) Implicitly wait for an element.
static void	hitKeys(org.openqa.selenium.WebDriver driver, CharSequence keys) Typical use is to simulate hitting ESCAPE or ENTER.
static void	hoverMouseOver(org.openqa.selenium.WebElement element, org.openqa.selenium.WebDriver driver)
static org.openqa.selenium.WebElement	loopFindOrRefresh(int maxRefreshes, org.openqa.selenium.By locator, org.openqa.selenium.WebDriver driver) Implicitly wait for an element.
static <T> T	waitUntil(org.openqa.selenium.support.ui.ExpectedCondition<T> expectedCondition, org.openqa.selenium.WebDriver driver) Generic explicit wait, taking an ExpectedCondition as a parameter.
static <T> T	waitUntil(org.openqa.selenium.support.ui.ExpectedCondition<T> expectedCondition, org.openqa.selenium.WebDriver driver, long timeOutInSeconds) Generic explicit wait, taking an ExpectedCondition as a parameter.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXPLICIT_WAIT_TIMEOUT_SECONDS

public static final int DEFAULT_EXPLICIT_WAIT_TIMEOUT_SECONDS

The default timeout in seconds used by waitUntil(ExpectedCondition, WebDriver).

See Also:

Config.getExplicitWait()

Constructor Detail

PageHelper

public PageHelper()

Method Detail

waitUntil

public static <T> T waitUntil(org.openqa.selenium.support.ui.ExpectedCondition<T> expectedCondition,
                              org.openqa.selenium.WebDriver driver)

Generic explicit wait, taking an ExpectedCondition as a parameter. Times out after DEFAULT_EXPLICIT_WAIT_TIMEOUT_SECONDS seconds.

Parameters:

expectedCondition -

driver -

Returns:

whatever WebDriverWait#until returns

See Also:

waitUntil(ExpectedCondition, WebDriver, long)

waitUntil

public static <T> T waitUntil(org.openqa.selenium.support.ui.ExpectedCondition<T> expectedCondition,
                              org.openqa.selenium.WebDriver driver,
                              long timeOutInSeconds)

Generic explicit wait, taking an ExpectedCondition as a parameter. Times out after the given number of seconds.

Parameters:

expectedCondition -

driver -

timeOutInSeconds -

Returns:

whatever WebDriverWait#until returns

Throws:

org.openqa.selenium.TimeoutException - if the timeout expires

See Also:

FluentWait.until(com.google.common.base.Function)

assertExpectedCondition

public static <T> T assertExpectedCondition(org.openqa.selenium.support.ui.ExpectedCondition<T> condition,
                                            org.openqa.selenium.WebDriver driver)

Explicitly wait until the given expected condition is met. Throw AssertionError if the wait times out.

Parameters:

condition -

driver -

Returns:

whatever #waitUntil returns

Throws:

AssertionError - if the condition is not met

assertElementIsNotDisplayed

public static void assertElementIsNotDisplayed(org.openqa.selenium.By locator,
                                               org.openqa.selenium.WebDriver driver)

Explicitly wait until the given element is visible. If it is, throw AssertionError; else, do nothing.

Parameters:

locator -

driver -

Throws:

AssertionError - if element is visible

findOrRefresh

public static org.openqa.selenium.WebElement findOrRefresh(org.openqa.selenium.By locator,
                                                           org.openqa.selenium.WebDriver driver)

Implicitly wait for an element. Then, if the element cannot be found, refresh the page and try finding the element once again. Finally, return the element.

Returns:

the element identified by the given locator; null if the element is not found after the last iteration

See Also:

loopFindOrRefresh(int, By, WebDriver)

loopFindOrRefresh

public static org.openqa.selenium.WebElement loopFindOrRefresh(int maxRefreshes,
                                                               org.openqa.selenium.By locator,
                                                               org.openqa.selenium.WebDriver driver)

Implicitly wait for an element. Then, if the element cannot be found, refresh the page. Try finding the element again, reiterating for maxRefreshes times or until the element is found. Finally, return the element.

Parameters:

maxRefreshes - max num of iterations of the loop

locator - the locator for the element we want to find

driver -

Returns:

the element identified by the given locator; null if the element is not found after the last iteration

hoverMouseOver

public static void hoverMouseOver(org.openqa.selenium.WebElement element,
                                  org.openqa.selenium.WebDriver driver)

hitKeys

public static void hitKeys(org.openqa.selenium.WebDriver driver,
                           CharSequence keys)

Typical use is to simulate hitting ESCAPE or ENTER.

Parameters:

driver -

keys -

See Also:

Actions.sendKeys(CharSequence...)