com.github.wiselenium.core.pagefactory

Class Page<T extends Page<T>>

java.lang.Object

org.openqa.selenium.support.ui.LoadableComponent<T>

com.github.wiselenium.core.pagefactory.Page<T>

Type Parameters:

T - The page type.

All Implemented Interfaces:

ScreenShooting<T>, WiseQuery, WiseRoot<T>, org.openqa.selenium.internal.WrapsDriver

public class Page<T extends Page<T>>
extends org.openqa.selenium.support.ui.LoadableComponent<T>
implements WiseRoot<T>, org.openqa.selenium.internal.WrapsDriver

Basic implementation of a common Page. Should be extended to reflect your own page services.
It extends LoadableComponent, so you can easily take advantage of its loading resources just by overriding the empty load() and isLoaded() methods.
It has a constructor that takes a WebDriver as only argument and another no-arg constructor, allowing you to extend and initialize it with the WisePageFactory with either constructor you prefer.

Since:

0.1.0

Author:

Andre Ricardo Schaffer

Constructor Summary

Constructors

Constructor and Description
Page()
Page(org.openqa.selenium.WebDriver driver)

Method Summary

Methods

Modifier and Type	Method and Description
T	and() Returns this page instance in order to allow chain calls in a more fluent way.
Object	executeScript(String script) Executes a script on the page.
<E> E	findElement(Class<E> clazz, org.openqa.selenium.By by) Finds the first element within the current context using the given mechanism.
<E> List<E>	findElements(Class<E> clazz, org.openqa.selenium.By by) Finds all elements within the current context using the given mechanism.
T	get(String url) Loads a new web page in the current browser window using a HTTP GET operation.
String	getCurrentUrl() Retrieves the current URL that the browser is looking at.
String	getPageSource() Retrieves the source of the page rendered in the browser.
String	getTitle() Retrieves the title of the current page.
org.openqa.selenium.WebDriver	getWrappedDriver()
<E> E	initNextPage(Class<E> clazz) Instantiates the next page of the user navigation and initialize its elements.
protected void	isLoaded()
protected void	load()
T	takeScreenShot(String fileName) Takes a screenshot of the webDriver page and saves it into a file.
org.openqa.selenium.support.ui.WebDriverWait	waitFor(long timeOutInSeconds) A helper method for the WebDriverWait.WebDriverWait(org.openqa.selenium.WebDriver, long).
org.openqa.selenium.support.ui.WebDriverWait	waitFor(long timeOutInSeconds, long sleepInMillis) A helper method for the WebDriverWait.WebDriverWait(org.openqa.selenium.WebDriver, long, long).

Methods inherited from class org.openqa.selenium.support.ui.LoadableComponent

get

Methods inherited from class java.lang.Object

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

Constructor Detail

Page

public Page()

Page

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

Parameters:

driver - The driver to be encapsulated within the page.

Method Detail

and

public T and()

Returns this page instance in order to allow chain calls in a more fluent way.

Returns:

This page instance.

Since:

0.1.0

executeScript

public Object executeScript(String script)

Executes a script on the page.

Parameters:

script - The script to be executed.

Returns:

The result of the script.

Since:

0.1.0

findElement

public <E> E findElement(Class<E> clazz,
                org.openqa.selenium.By by)

Description copied from interface: WiseQuery

Finds the first element within the current context using the given mechanism.

Specified by:

findElement in interface WiseQuery

Type Parameters:

E - The type of the element.

Parameters:

clazz - The class of the element. Must be either WebElement or a type annotated with Field, Container or Frame. Will lookup for its implementation class following ClasspathUtil.findImplementationClass(Class) rules.

by - The locating mechanism to use.

Returns:

The element decorated or null if it shouldn't be decorated because the type didn't respect the clazz parameter specification.

findElements

public <E> List<E> findElements(Class<E> clazz,
                       org.openqa.selenium.By by)

Description copied from interface: WiseQuery

Finds all elements within the current context using the given mechanism.

Specified by:

findElements in interface WiseQuery

Type Parameters:

E - The type of the elements.

Parameters:

clazz - The class of the elements. Must be either WebElement or a type annotated with Field, Container or Frame. Will lookup for its implementation class following ClasspathUtil.findImplementationClass(Class) rules.

by - The locating mechanism to use.

Returns:

The elements decorated or an empty list if it shouldn't be decorated because the type didn't respect the clazz parameter specification.

get

public T get(String url)

Loads a new web page in the current browser window using a HTTP GET operation.

Parameters:

url - The URL to load. It is best to use a fully qualified URL.

Returns:

This page object.

Since:

0.1.0

getCurrentUrl

public String getCurrentUrl()

Retrieves the current URL that the browser is looking at.

Returns:

The current URL.

Since:

0.1.0

getPageSource

public String getPageSource()

Retrieves the source of the page rendered in the browser.

Returns:

The source of the page.

Since:

0.1.0

getTitle

public String getTitle()

Retrieves the title of the current page.

Returns:

The title of the current page, or null if one is not set.

Since:

0.1.0

getWrappedDriver

public org.openqa.selenium.WebDriver getWrappedDriver()

Specified by:

getWrappedDriver in interface org.openqa.selenium.internal.WrapsDriver

initNextPage

public <E> E initNextPage(Class<E> clazz)

Instantiates the next page of the user navigation and initialize its elements.

Type Parameters:

E - The type of the page.

Parameters:

clazz - The class of the page.

Returns:

An instance of the next page of the user navigation.

Since:

0.1.0

takeScreenShot

public T takeScreenShot(String fileName)

Description copied from interface: ScreenShooting

Takes a screenshot of the webDriver page and saves it into a file.

Specified by:

takeScreenShot in interface ScreenShooting<T extends Page<T>>

Parameters:

fileName - The name of the screenshot file.

Returns:

This instance in order to allow chain calls.

waitFor

public org.openqa.selenium.support.ui.WebDriverWait waitFor(long timeOutInSeconds)

Description copied from interface: WiseRoot

A helper method for the WebDriverWait.WebDriverWait(org.openqa.selenium.WebDriver, long).

Specified by:

waitFor in interface WiseRoot<T extends Page<T>>

Parameters:

timeOutInSeconds - The timeout in seconds.

Returns:

A WebDriverWait.

waitFor

public org.openqa.selenium.support.ui.WebDriverWait waitFor(long timeOutInSeconds,
                                                   long sleepInMillis)

Description copied from interface: WiseRoot

A helper method for the WebDriverWait.WebDriverWait(org.openqa.selenium.WebDriver, long, long).

Specified by:

waitFor in interface WiseRoot<T extends Page<T>>

Parameters:

timeOutInSeconds - The timeout in seconds.

Returns:

A WebDriverWait.

isLoaded

protected void isLoaded()

Specified by:

isLoaded in class org.openqa.selenium.support.ui.LoadableComponent<T extends Page<T>>

load

protected void load()

Specified by:

load in class org.openqa.selenium.support.ui.LoadableComponent<T extends Page<T>>