com.ttdev.wicketpagetest

Class WicketSelenium

java.lang.Object

com.ttdev.wicketpagetest.WicketSelenium

Direct Known Subclasses:

WicketSeleniumDriver

public class WicketSelenium
extends Object

This class is a wrapper around Selenium that adds some handy functions for Wicket-generated HTML pages. In particular, it allows you to wait for Ajax processing to be completed. This way, you don't need to use WebDriverWait which is more complicated and error-prone.

Author:

Kent Tong, Andy Chu

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	WAIT_TIMEOUT_IN_SECONDS

Constructor Summary

Constructors

Constructor and Description
WicketSelenium(Configuration cfg, org.openqa.selenium.WebDriver selenium)

Method Summary

Modifier and Type	Method and Description
void	clear(org.openqa.selenium.By elementLocator) Clear the value of the text input element located by the specified locator.
void	click(org.openqa.selenium.By elementLocator) Click the element located by the specified locator.
org.openqa.selenium.WebElement	findElement(org.openqa.selenium.By locator) Get the WebElement located by the specified locator.
org.openqa.selenium.WebElement	findWicketElement(String path) Locate the HTML slot of a Wicket component using the specified path.
org.openqa.selenium.WebDriver	getSelenium() Get the underlying Selenium WebDriver.
String	getText(org.openqa.selenium.By elementLocator) Get the body text of the element located by the specified locator.
String	getValue(org.openqa.selenium.By elementLocator) Get the value of the "value" attribute of the element located by the specified locator.
void	openBookmarkablePage(Class<? extends org.apache.wicket.Page> pageClass) Open a bookmarkable Wicket page.
void	openBreadCrumbPanel(org.apache.wicket.extensions.breadcrumb.panel.IBreadCrumbPanelFactory factory) Open a BreadCrumbPanel created by the IBreadCrumbPanelFactory in a page
void	openComponent(ComponentFactory factory) Open a page containing ONLY the Component created by the specified ComponentFactory.
void	openHomePage() Open the home page of the Wicket application.
void	openMountedPage(String mountPoint, org.apache.wicket.request.mapper.parameter.PageParameters parameters) Open a mounted Wicket page.
void	openNonBookmarkablePage(Class<? extends org.apache.wicket.Page> pageClass, Object... constructorArgs) Open a non-bookmarkable Wicket page.
void	sendKeys(org.openqa.selenium.By elementLocator, CharSequence... keysToSend) Send the keys to the element located by the specified locator.
void	setPreferredLocale(Locale locale)
void	setResponsePageMarker() It tells the server side to include a random string as the marker (a cookie) in the response page.
void	setResponsePageMarker(String marker) It tells the server side to include a page marker as a cookie in the next response page, so that you can then call waitForMarkedPage() to wait for it.
void	subscribeAjaxDoneHandler()
void	switchDefaultLocale()
void	waitForMarkedPage() It waits until the browser sees a page with the page marker.
void	waitUntilAjaxDone() It waits until the Wicket Ajax processing has completed.

Methods inherited from class java.lang.Object

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

Field Detail

WAIT_TIMEOUT_IN_SECONDS

protected static final int WAIT_TIMEOUT_IN_SECONDS

See Also:

Constant Field Values

Constructor Detail

WicketSelenium

public WicketSelenium(Configuration cfg,
                      org.openqa.selenium.WebDriver selenium)

Method Detail

subscribeAjaxDoneHandler

public void subscribeAjaxDoneHandler()

waitUntilAjaxDone

public void waitUntilAjaxDone()

It waits until the Wicket Ajax processing has completed. It does that by waiting until all the Wicket Ajax channels to become idle. This method heavily depends on the Wicket internal Ajax implementation and thus is subject to changes.

setResponsePageMarker

public void setResponsePageMarker()

It tells the server side to include a random string as the marker (a cookie) in the response page. See setResponsePageMarker(String).

setResponsePageMarker

public void setResponsePageMarker(String marker)

It tells the server side to include a page marker as a cookie in the next response page, so that you can then call waitForMarkedPage() to wait for it. This way you can be sure that it is a new page and won't suffer from the StaleElementReferenceException.

Parameters:

marker - the marker to be used

waitForMarkedPage

public void waitForMarkedPage()

It waits until the browser sees a page with the page marker. Usually you don't need to use this method because when you try to get an element and if it is not found, Selenium has been configured to wait a few seconds. But if the response page is the same as the original page, then it won't work as that element will be found but when you try to use it, you will get an StaleElementReferenceException. To work around the problem, call setResponsePageMarker(String) and then call this method.

openBookmarkablePage

public void openBookmarkablePage(Class<? extends org.apache.wicket.Page> pageClass)

Open a bookmarkable Wicket page. That is, it has a no-arg constructor.

Parameters:

pageClass - the class of the page

openMountedPage

public void openMountedPage(String mountPoint,
                            org.apache.wicket.request.mapper.parameter.PageParameters parameters)

Open a mounted Wicket page.

Parameters:

mountPoint - the mount point of the page

parameters - the page parameters

openHomePage

public void openHomePage()

Open the home page of the Wicket application.

openNonBookmarkablePage

public void openNonBookmarkablePage(Class<? extends org.apache.wicket.Page> pageClass,
                                    Object... constructorArgs)

Open a non-bookmarkable Wicket page. That is, its constructor takes one or more arguments.

Parameters:

pageClass - the class of the page

constructorArgs - the constructor arguments

openComponent

public void openComponent(ComponentFactory factory)

Open a page containing ONLY the Component created by the specified ComponentFactory.

Parameters:

factory - the ComponentFactory creating the testing component

openBreadCrumbPanel

public void openBreadCrumbPanel(org.apache.wicket.extensions.breadcrumb.panel.IBreadCrumbPanelFactory factory)

Open a BreadCrumbPanel created by the IBreadCrumbPanelFactory in a page

Parameters:

factory - the IBreadCrumbPanelFactory creating the testing panel

findWicketElement

public org.openqa.selenium.WebElement findWicketElement(String path)

Locate the HTML slot of a Wicket component using the specified path. For the syntax of the path, please see ByWicketIdPath.

Parameters:

path - The path to the Wicket component

Returns:

The corresponding HTML slot

findElement

public org.openqa.selenium.WebElement findElement(org.openqa.selenium.By locator)

Get the WebElement located by the specified locator.

Parameters:

locator - locate the element using this locator

Returns:

the element

getSelenium

public org.openqa.selenium.WebDriver getSelenium()

Get the underlying Selenium WebDriver.

Returns:

the Selenium WebDriver

getText

public String getText(org.openqa.selenium.By elementLocator)

Get the body text of the element located by the specified locator.

Parameters:

elementLocator - locate the element using this locator

Returns:

the body text of that element

getValue

public String getValue(org.openqa.selenium.By elementLocator)

Get the value of the "value" attribute of the element located by the specified locator.

Parameters:

elementLocator - locate the element using this locator

Returns:

the value of the "value" attribute of that element

click

public void click(org.openqa.selenium.By elementLocator)

Click the element located by the specified locator.

Parameters:

elementLocator - locate the element using this locator

sendKeys

public void sendKeys(org.openqa.selenium.By elementLocator,
                     CharSequence... keysToSend)

Send the keys to the element located by the specified locator.

Parameters:

elementLocator - locate the element using this locator

keysToSend - the keys to be sent to that element

clear

public void clear(org.openqa.selenium.By elementLocator)

Clear the value of the text input element located by the specified locator.

Parameters:

elementLocator - locate the element using this locator

setPreferredLocale

public void setPreferredLocale(Locale locale)

switchDefaultLocale

public void switchDefaultLocale()