uk.ac.ox.cs.diadem.webapi.dom.impl

Class WebDriverBrowserImpl

java.lang.Object

uk.ac.ox.cs.diadem.webapi.dom.impl.AbstractWebBrowser<org.openqa.selenium.firefox.FirefoxDriver>

uk.ac.ox.cs.diadem.webapi.dom.impl.WebDriverBrowserImpl

All Implemented Interfaces:

AutoCloseable, MiniBrowser, WebBrowser

public class WebDriverBrowserImpl
extends AbstractWebBrowser<org.openqa.selenium.firefox.FirefoxDriver>

Author:

Giovanni Grasso (giovannigrasso@gmail.com) Oxford University, Department of Computer Science

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebDriverBrowserImpl.GeoLocation

Nested classes/interfaces inherited from interface uk.ac.ox.cs.diadem.webapi.WebBrowser

WebBrowser.ContentType, WebBrowser.Options

Nested classes/interfaces inherited from interface uk.ac.ox.cs.diadem.webapi.MiniBrowser

MiniBrowser.Advice

Field Summary

Fields inherited from class uk.ac.ox.cs.diadem.webapi.dom.impl.AbstractWebBrowser

locationEmpty

Constructor Summary

Constructors

Constructor and Description
WebDriverBrowserImpl(PlatformConfiguration platformConfiguration, RunConfiguration runOptionsConfiguration, JavaScriptConfiguration javaScriptConfiguration)

Method Summary

Modifier and Type	Method and Description
void	addLocationListener(BrowserLocationListener listener)
void	addOpenNewWindowListener(OpenNewWindowListener openNewWindowListener)
void	addProgressListener(BrowserProgressListener listener)
void	addStatusTextListener(BrowserStatusTextListener listener)
void	addTitleListener(BrowserTitleListener listener)
void	back() Forces back button on the browser
void	back(boolean waitUntilLoaded) Forces back button on the browser
void	cleanCache() Removes allElements cache entries
void	close() Closes the browser.
void	enableSilentPromptService(boolean b) if enabled, blocks allElements javascript alerts and popups.
Object	evaluate(String script) Returns the result, if any, of executing the specified java script.
boolean	executeJavaScript(String script)
void	forward(boolean waitUntilLoaded) Forces forward button on the browser
WebActionExecutor	getActionExecutor() Returns a WebActionExecutor if available for this implementation, or null otherwise
AdviceProcessor	getAdviceProcessor()
protected org.openqa.selenium.firefox.FirefoxDriver	getBrowser()
DOMWindow	getContentDOMWindow() Return the top-level dom window associated to this browser
WebBrowserBuilder.Engine	getEngine()
String	getLocationURL() Returns the URL of the resource that the web browser is currently displaying, or null if no navigation to any url has been performed yet.
DOMWindow	getWindow() Return the top-level dom window associated to this browser.
Object	getWindowFrame() INTERNAL API SUBJECT TO CHANGE Return the Window frame used by the underlying browser instantiated.
DOMXPathEvaluator	getXPathEvaluator()
boolean	isBackEnabled()
boolean	isForwardEnabled()
JSUtils	js()
WebBrowser.Options	manageOptions() General option configuration
void	navigate(String uRI) Navigate to the given URL and waits until the new page is fully loaded (listen to "load" JavaScript event)
void	navigate(String uRI, boolean waitUntilLoaded) Navigate to the given URL.
void	navigate(URI uri)
int	navigateAndStatus(URI uri) Uses MiniBrowser.navigate(URI) to navigates on the page and returns the HTTP status code (which might require another page fetching in case of BrowserFactory.Engine.WEBDRIVER_FF)
void	refresh()
void	removeAllCookies() Removes allElements cookies
void	removeLocationListener(BrowserLocationListener listener)
void	removeOpenNewWindowListener(OpenNewWindowListener listener)
void	removeProgressListener(BrowserProgressListener listener)
void	removeStatusTextListener(BrowserStatusTextListener listener)
void	removeTitleListener(BrowserTitleListener listener)
void	saveDocument(String name) For debug only, not rely on it as it can be removed from here.
void	setDialogsService(DialogsService service) Sets a new DialogsService.
void	setPageLoadingTimeout(long time, TimeUnit unit) Set the timeout for page loading.
void	setWindowPosition(int x, int y) Sets the position of the browser window.
void	setWindowSize(int width, int height) Sets the dimension of the browser window, overriding the default values.
void	setZoom(int zoomRatio) Set the zoom ratio, currenlty works only on Mozilla
void	shutdown() Kills the current browser and allElements other instances, closing the application.
void	stop()
DOMWindow	switchToDefaultContent() http://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/WebDriver.TargetLocator.html Selects either the first frame on the page, or the main document when a page contains iframes.
DOMWindow	switchToFrame(DOMElement frameElement) Select a frame using its previously located elements
File	takeScreenshot() Returns a file (created in the temporary file location as indicated by the browser) with a screenshot of the current browser window.

Methods inherited from class uk.ac.ox.cs.diadem.webapi.dom.impl.AbstractWebBrowser

getDOMElementByLocator, getURL, navigate, stats

Methods inherited from class java.lang.Object

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

Constructor Detail

WebDriverBrowserImpl

public WebDriverBrowserImpl(PlatformConfiguration platformConfiguration,
                            RunConfiguration runOptionsConfiguration,
                            JavaScriptConfiguration javaScriptConfiguration)
                     throws org.apache.commons.configuration2.ex.ConfigurationException

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

Method Detail

getActionExecutor

public WebActionExecutor getActionExecutor()

Description copied from interface: MiniBrowser

Returns a WebActionExecutor if available for this implementation, or null otherwise

Returns:

manageOptions

public WebBrowser.Options manageOptions()

Description copied from interface: WebBrowser

General option configuration

Returns:

setPageLoadingTimeout

public void setPageLoadingTimeout(long time,
                                  TimeUnit unit)

Description copied from interface: WebBrowser

Set the timeout for page loading. If set, methods like {WebBrowser.navigate(String, boolean) will throw exceptions.

Specified by:

setPageLoadingTimeout in interface WebBrowser

Overrides:

setPageLoadingTimeout in class AbstractWebBrowser<org.openqa.selenium.firefox.FirefoxDriver>

getContentDOMWindow

public DOMWindow getContentDOMWindow()

Return the top-level dom window associated to this browser

Returns:

the top-level dom window associated to this browser

getWindow

public DOMWindow getWindow()

Return the top-level dom window associated to this browser. It is a synonym of WebBrowser.getContentDOMWindow()

Specified by:

getWindow in interface WebBrowser

Overrides:

getWindow in class AbstractWebBrowser<org.openqa.selenium.firefox.FirefoxDriver>

Returns:

the top-level dom window associated to this browser

setWindowSize

public void setWindowSize(int width,
                          int height)

Sets the dimension of the browser window, overriding the default values.

navigate

public void navigate(String uRI)

Navigate to the given URL and waits until the new page is fully loaded (listen to "load" JavaScript event)

navigateAndStatus

public int navigateAndStatus(URI uri)

Description copied from interface: WebBrowser

Uses MiniBrowser.navigate(URI) to navigates on the page and returns the HTTP status code (which might require another page fetching in case of BrowserFactory.Engine.WEBDRIVER_FF)

Returns:

navigate

public void navigate(URI uri)

navigate

public void navigate(String uRI,
                     boolean waitUntilLoaded)

Navigate to the given URL.

waitUntilLoaded - if true, it runs synchronously, waiting for the fully loaded page. This is always the case for the browser WebBrowserBuilder.Engine.WEBDRIVER_FF

getLocationURL

public String getLocationURL()

Returns the URL of the resource that the web browser is currently displaying, or null if no navigation to any url has been performed yet.

close

public void close()

Closes the browser. it has the same effect of closing the DOMWindow calling this #getContentDOMWindow().close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface WebBrowser

Overrides:

close in class AbstractWebBrowser<org.openqa.selenium.firefox.FirefoxDriver>

back

public void back(boolean waitUntilLoaded)

Forces back button on the browser

Parameters:

waitUntilLoaded - if true, it runs synchronously, waiting for the fully loaded page

back

public void back()

Description copied from interface: MiniBrowser

Forces back button on the browser

forward

public void forward(boolean waitUntilLoaded)

Forces forward button on the browser

Parameters:

waitUntilLoaded - if true, it runs synchronously, waiting for the fully loaded page

getXPathEvaluator

public DOMXPathEvaluator getXPathEvaluator()

Returns:

an DOMXPathEvaluator for this browser

addProgressListener

public void addProgressListener(BrowserProgressListener listener)

removeProgressListener

public void removeProgressListener(BrowserProgressListener listener)

addLocationListener

public void addLocationListener(BrowserLocationListener listener)

removeLocationListener

public void removeLocationListener(BrowserLocationListener listener)

addTitleListener

public void addTitleListener(BrowserTitleListener listener)

removeTitleListener

public void removeTitleListener(BrowserTitleListener listener)

addStatusTextListener

public void addStatusTextListener(BrowserStatusTextListener listener)

removeStatusTextListener

public void removeStatusTextListener(BrowserStatusTextListener listener)

getWindowFrame

public Object getWindowFrame()

INTERNAL API SUBJECT TO CHANGE Return the Window frame used by the underlying browser instantiated. For Engine#SWT_MOZILLA it returns a Composite while for Engine#HTMLUNIT it returns the com.gargoylesoftware.htmlunit.WebClient, and for WebDriver returns the underlying driver

Returns:

refresh

public void refresh()

stop

public void stop()

isBackEnabled

public boolean isBackEnabled()

isForwardEnabled

public boolean isForwardEnabled()

evaluate

public Object evaluate(String script)

Returns the result, if any, of executing the specified java script.

setDialogsService

public void setDialogsService(DialogsService service)

Sets a new DialogsService. You can use this method to register your own DialogsService implementation in which you can specify the required behavior during displaying any browser dialog such as alert, confirmation, JavaScript error dialog.

Parameters:

service - the service to set

setZoom

public void setZoom(int zoomRatio)

Set the zoom ratio, currenlty works only on Mozilla

enableSilentPromptService

public void enableSilentPromptService(boolean b)

if enabled, blocks allElements javascript alerts and popups. NOTE: cannot be reverted once enabled on one browser instance

Specified by:

enableSilentPromptService in interface WebBrowser

Overrides:

enableSilentPromptService in class AbstractWebBrowser<org.openqa.selenium.firefox.FirefoxDriver>

Parameters:

b - true to enable

addOpenNewWindowListener

public void addOpenNewWindowListener(OpenNewWindowListener openNewWindowListener)

removeOpenNewWindowListener

public void removeOpenNewWindowListener(OpenNewWindowListener listener)

shutdown

public void shutdown()

Kills the current browser and allElements other instances, closing the application. Use thisWebBrowser.close() to close only the current browser instance.

cleanCache

public void cleanCache()

Removes allElements cache entries

removeAllCookies

public void removeAllCookies()

Removes allElements cookies

executeJavaScript

public boolean executeJavaScript(String script)

saveDocument

public void saveDocument(String name)

Description copied from interface: WebBrowser

For debug only, not rely on it as it can be removed from here.

getEngine

public WebBrowserBuilder.Engine getEngine()

getBrowser

protected org.openqa.selenium.firefox.FirefoxDriver getBrowser()

Specified by:

getBrowser in class AbstractWebBrowser<org.openqa.selenium.firefox.FirefoxDriver>

Returns:

Original web browser enclosed (wrapped) by this class.

js

public JSUtils js()

Specified by:

js in interface WebBrowser

Overrides:

js in class AbstractWebBrowser<org.openqa.selenium.firefox.FirefoxDriver>

setWindowPosition

public void setWindowPosition(int x,
                              int y)

Description copied from interface: WebBrowser

Sets the position of the browser window.

takeScreenshot

public File takeScreenshot()

Description copied from interface: WebBrowser

Returns a file (created in the temporary file location as indicated by the browser) with a screenshot of the current browser window.

Specified by:

takeScreenshot in interface WebBrowser

Overrides:

takeScreenshot in class AbstractWebBrowser<org.openqa.selenium.firefox.FirefoxDriver>

switchToDefaultContent

public DOMWindow switchToDefaultContent()

Description copied from interface: WebBrowser

http://selenium.googlecode.com/svn/trunk/docs/api/java/org/openqa/selenium/WebDriver.TargetLocator.html Selects either the first frame on the page, or the main document when a page contains iframes.

switchToFrame

public DOMWindow switchToFrame(DOMElement frameElement)

Description copied from interface: WebBrowser

Select a frame using its previously located elements

Returns:

the

getAdviceProcessor

public AdviceProcessor getAdviceProcessor()