org.bithill.selenium.resolving

Class Page

java.lang.Object

org.bithill.selenium.resolving.Resolvable

org.bithill.selenium.resolving.Page

All Implemented Interfaces:

AutoCloseable

public abstract class Page
extends Resolvable
implements AutoCloseable

An abstraction of a tested page.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.logging.log4j.Logger	log
protected SiteConfig	siteConfig Configuration for the web site the page is part of.

Constructor Summary

Constructors

Constructor and Description
Page(WebDriverHandle driverHandle)

Method Summary

Modifier and Type	Method and Description
protected abstract Page	checkOpened() Checks that the desired pages is opened.
void	close()
protected String[]	getPageUrlParams()
SiteConfig	getSiteConfig()
Page	open() Opens the web page associated with this Page class.
protected String	pageUrl() Provides Page URL.
void	setPageUrlParams(String... pageUrlParams)
void	takeScreenshot() Takes a screenshot in PNG format and saves it to the current directory directory.
void	takeScreenshot(String screenshotFileName) Takes a screenshot in PNG format and saves it to disk.

Methods inherited from class org.bithill.selenium.resolving.Resolvable

getDriver, getDriverHandle, getParent, getPlaceholders, getSelf, getWait, getWait, isContainer, loadData, prepareForResolving, resolve, resolve, setDriverHandle, setIsContainer, setParent, setPlaceholders, setSelf, setWait, setWait

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.logging.log4j.Logger log

siteConfig

protected SiteConfig siteConfig

Configuration for the web site the page is part of.

Constructor Detail

Page

public Page(WebDriverHandle driverHandle)

Method Detail

getSiteConfig

public SiteConfig getSiteConfig()

getPageUrlParams

protected String[] getPageUrlParams()

setPageUrlParams

public void setPageUrlParams(String... pageUrlParams)

open

public Page open()

Opens the web page associated with this Page class.

Returns:

an instance of Page sub-class

pageUrl

protected String pageUrl()

Provides Page URL.

Returns:

Page URL as application of pageUrlParams to Site URL/ By default it only concatenates pageUrlParams to Site URL.

close

public void close()

Specified by:

close in interface AutoCloseable

checkOpened

protected abstract Page checkOpened()

Checks that the desired pages is opened. The page is considered successfully open when this methods does not throw an exception.

Returns:

the reference to the Page when check is successful

Throws:

InvalidPageException - when the page check fails

takeScreenshot

public void takeScreenshot(String screenshotFileName)

Takes a screenshot in PNG format and saves it to disk.

The target directory is set via SiteConfig. The used WebDriver must implement TakesScreenshot interface.

Parameters:

screenshotFileName - path to a resulting screenshot file

takeScreenshot

public void takeScreenshot()

Takes a screenshot in PNG format and saves it to the current directory directory. The screenshot is named after the Page class and time-stamped.