com.github.bordertech.wcomponents.test.selenium.driver

Class SeleniumWComponentsWebDriver<T extends org.openqa.selenium.WebDriver>

java.lang.Object

com.github.bordertech.wcomponents.test.selenium.driver.SeleniumWComponentsWebDriver<T>

Type Parameters:

T - - the type of backing WebDriver class.

All Implemented Interfaces:

org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebDriver

public class SeleniumWComponentsWebDriver<T extends org.openqa.selenium.WebDriver>
extends Object
implements org.openqa.selenium.WebDriver, org.openqa.selenium.TakesScreenshot

WComponent utility class to wrap a Selenium WebDriver.

This class will automatically wait for the WComponents UI to finish loading (including JavaScript and AJAX) where appropriate.

Since:

1.2.0

Author:

Joshua Barclay

Nested Class Summary

Nested classes/interfaces inherited from interface org.openqa.selenium.WebDriver

org.openqa.selenium.WebDriver.ImeHandler, org.openqa.selenium.WebDriver.Navigation, org.openqa.selenium.WebDriver.Options, org.openqa.selenium.WebDriver.TargetLocator, org.openqa.selenium.WebDriver.Timeouts, org.openqa.selenium.WebDriver.Window

Constructor Summary

Constructors

Constructor and Description
SeleniumWComponentsWebDriver() No-arg constructor to support creation via other frameworks.
SeleniumWComponentsWebDriver(T driver) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() .
SeleniumWComponentWebElement	findElement(org.openqa.selenium.By by) .
SeleniumWComponentWebElement	findElement(ByWComponent by) Find a WComponent that was created in the same JVM as the servlet.
List<org.openqa.selenium.WebElement>	findElements(org.openqa.selenium.By by) .
List<org.openqa.selenium.WebElement>	findElements(ByWComponent by) Find WComponents that were created in the same JVM as the servlet.
SeleniumWEmailFieldWebElement	findWEmailField(org.openqa.selenium.By by) Find a WEmailField by the given criteria.
SeleniumWPhoneNumberFieldWebElement	findWPhoneNumberField(org.openqa.selenium.By by) Find a WEmailField by the given criteria.
SeleniumWTableWebElement	findWTable(org.openqa.selenium.By by) Find a WTable by the given criteria.
SeleniumWTextAreaWebElement	findWTextArea(org.openqa.selenium.By by) Find a WTextArea by the given criteria.
SeleniumWTextFieldWebElement	findWTextField(org.openqa.selenium.By by) Find a WTextField by the given criteria.
void	get(String url) .
String	getCurrentUrl() .
SeleniumWDialogWebElement	getDialog() Get the dialog.
T	getDriver() Directly expose the driver for any special APIs.
String	getPageSource() .
<X> X	getScreenshotAs(org.openqa.selenium.OutputType<X> target) Capture a screenshot if the backing driver supports it.
String	getSessionId()
String	getTitle() .
String	getWindowHandle() .
Set<String>	getWindowHandles() .
boolean	hasSession()
boolean	isOpenDialog() Is there an open dialog on the screen?
org.openqa.selenium.WebDriver.Options	manage() .
org.openqa.selenium.WebDriver.Navigation	navigate() .
void	newSession() Start a new session, using the current URL.
void	newSession(String url) Start a new session with the given URL.
void	quit() .
org.openqa.selenium.WebDriver.TargetLocator	switchTo() .
void	waitForPageReady() Wait until the page is fully loaded (including AJAX and timers).

Methods inherited from class java.lang.Object

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

Constructor Detail

SeleniumWComponentsWebDriver

public SeleniumWComponentsWebDriver()

No-arg constructor to support creation via other frameworks.

This implementation will be backed by the driver implementation configured in ParameterizedWebDriverType

SeleniumWComponentsWebDriver

public SeleniumWComponentsWebDriver(T driver)

Default constructor.

Parameters:

driver - the backing web driver.

Method Detail

newSession

public void newSession()

Start a new session, using the current URL. For WComponents application this should reload the first page.

hasSession

public boolean hasSession()

Returns:

true if an active session exists, else false.

newSession

public void newSession(String url)

Start a new session with the given URL.

Parameters:

url - the URL of the page to load.

getSessionId

public String getSessionId()

Returns:

the session ID for the driver, or null if no session.

getDriver

public T getDriver()

Directly expose the driver for any special APIs.

Returns:

the actual backing driver implementation.

waitForPageReady

public void waitForPageReady()

Wait until the page is fully loaded (including AJAX and timers).

isOpenDialog

public boolean isOpenDialog()

Is there an open dialog on the screen?

Returns:

true if an open dialog exists, else false.

getDialog

public SeleniumWDialogWebElement getDialog()

Get the dialog.

Returns:

the dialog component.

get

public void get(String url)

.

Specified by:

get in interface org.openqa.selenium.WebDriver

getCurrentUrl

public String getCurrentUrl()

.

Specified by:

getCurrentUrl in interface org.openqa.selenium.WebDriver

getTitle

public String getTitle()

.

Specified by:

getTitle in interface org.openqa.selenium.WebDriver

findWTextArea

public SeleniumWTextAreaWebElement findWTextArea(org.openqa.selenium.By by)

Find a WTextArea by the given criteria.

Parameters:

by - the By selector.

Returns:

the SeleniumWTextAreaWebElement or null if not found.

findWTextField

public SeleniumWTextFieldWebElement findWTextField(org.openqa.selenium.By by)

Find a WTextField by the given criteria.

Parameters:

by - the By selector.

Returns:

the SeleniumWTextFieldWebElement or null if not found.

findWEmailField

public SeleniumWEmailFieldWebElement findWEmailField(org.openqa.selenium.By by)

Find a WEmailField by the given criteria.

Parameters:

by - the By selector.

Returns:

the SeleniumWEmailFieldWebElement or null if not found.

findWPhoneNumberField

public SeleniumWPhoneNumberFieldWebElement findWPhoneNumberField(org.openqa.selenium.By by)

Find a WEmailField by the given criteria.

Parameters:

by - the By selector.

Returns:

the SeleniumWPhoneNumberFieldWebElement or null if not found.

findWTable

public SeleniumWTableWebElement findWTable(org.openqa.selenium.By by)

Find a WTable by the given criteria.

Parameters:

by - the By selector.

Returns:

the SeleniumWTableWebElement or null if not found.

findElements

public List<org.openqa.selenium.WebElement> findElements(org.openqa.selenium.By by)

.

Specified by:

findElements in interface org.openqa.selenium.SearchContext

Specified by:

findElements in interface org.openqa.selenium.WebDriver

findElement

public SeleniumWComponentWebElement findElement(org.openqa.selenium.By by)

.

Specified by:

findElement in interface org.openqa.selenium.SearchContext

Specified by:

findElement in interface org.openqa.selenium.WebDriver

findElements

public List<org.openqa.selenium.WebElement> findElements(ByWComponent by)

Find WComponents that were created in the same JVM as the servlet.

This method requires that SeleniumLauncher (or subclass) was used to launch the server.

Parameters:

by - the ByWcomponent to find.

Returns:

the matching WebElement.

findElement

public SeleniumWComponentWebElement findElement(ByWComponent by)

Find a WComponent that was created in the same JVM as the servlet.

This method requires that SeleniumLauncher (or subclass) was used to launch the server.

Parameters:

by - the ByWcomponent to find.

Returns:

the matching WebElement.

getPageSource

public String getPageSource()

.

Specified by:

getPageSource in interface org.openqa.selenium.WebDriver

close

public void close()

.

Specified by:

close in interface org.openqa.selenium.WebDriver

quit

public void quit()

.

Specified by:

quit in interface org.openqa.selenium.WebDriver

getWindowHandles

public Set<String> getWindowHandles()

.

Specified by:

getWindowHandles in interface org.openqa.selenium.WebDriver

getWindowHandle

public String getWindowHandle()

.

Specified by:

getWindowHandle in interface org.openqa.selenium.WebDriver

switchTo

public org.openqa.selenium.WebDriver.TargetLocator switchTo()

.

Specified by:

switchTo in interface org.openqa.selenium.WebDriver

navigate

public org.openqa.selenium.WebDriver.Navigation navigate()

.

Specified by:

navigate in interface org.openqa.selenium.WebDriver

manage

public org.openqa.selenium.WebDriver.Options manage()

.

Specified by:

manage in interface org.openqa.selenium.WebDriver

getScreenshotAs

public <X> X getScreenshotAs(org.openqa.selenium.OutputType<X> target)

Capture a screenshot if the backing driver supports it.

IMPORTANT: This function will log warnings and return null if a screenshot cannot be captured.

Specified by:

getScreenshotAs in interface org.openqa.selenium.TakesScreenshot

Type Parameters:

X - - the output type.

Parameters:

target - - the target output type

Returns:

the screenshot from the driver if captured, or null if an error occurs.