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

Class AbstractWebBrowser<N>

java.lang.Object

uk.ac.ox.cs.diadem.webapi.dom.impl.AbstractWebBrowser<N>

Type Parameters:

N - Original web browser enclosed (wrapped) by this class.

All Implemented Interfaces:

AutoCloseable, MiniBrowser, WebBrowser

Direct Known Subclasses:

WebDriverBrowserImpl

public abstract class AbstractWebBrowser<N>
extends Object
implements WebBrowser

Author:

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

Nested Class Summary

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

Modifier and Type	Field and Description
protected boolean	locationEmpty TODO describe

Constructor Summary

Constructors

Constructor and Description
AbstractWebBrowser()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the browser.
void	enableSilentPromptService(boolean b) if enabled, blocks allElements javascript alerts and popups.
protected abstract N	getBrowser()
DOMElement	getDOMElementByLocator(String xPathLocator) It returns the DOMElement identified by the given xpath.
URL	getURL() Returns the same as MiniBrowser.getLocationURL() but as a URL.
DOMWindow	getWindow() Return the top-level dom window associated to this browser.
JSUtils	js()
void	navigate(URI uri, boolean waitUntilLoaded) Navigate to the given URI.
void	setPageLoadingTimeout(long time, TimeUnit unit) Set the timeout for page loading.
BrowserStats	stats()
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 java.lang.Object

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

Methods inherited from interface uk.ac.ox.cs.diadem.webapi.WebBrowser

addLocationListener, addOpenNewWindowListener, addProgressListener, addStatusTextListener, addTitleListener, back, cleanCache, evaluate, executeJavaScript, forward, getContentDOMWindow, getEngine, getWindowFrame, getXPathEvaluator, isBackEnabled, isForwardEnabled, manageOptions, navigate, navigateAndStatus, refresh, removeAllCookies, removeLocationListener, removeOpenNewWindowListener, removeProgressListener, removeStatusTextListener, removeTitleListener, saveDocument, setDialogsService, setWindowPosition, setWindowSize, setZoom, shutdown, stop, switchToDefaultContent, switchToFrame

Methods inherited from interface uk.ac.ox.cs.diadem.webapi.MiniBrowser

back, getActionExecutor, getAdviceProcessor, getLocationURL, navigate, navigate

Field Detail

locationEmpty

protected boolean locationEmpty

TODO describe

Constructor Detail

AbstractWebBrowser

public AbstractWebBrowser()

Method Detail

getBrowser

protected abstract N getBrowser()

Returns:

Original web browser enclosed (wrapped) by this class.

getURL

public URL getURL()

Description copied from interface: WebBrowser

Returns the same as MiniBrowser.getLocationURL() but as a URL. Returns null if the URL is not valid.

Specified by:

getURL in interface MiniBrowser

Specified by:

getURL in interface WebBrowser

stats

public BrowserStats stats()

Specified by:

stats in interface WebBrowser

getDOMElementByLocator

public DOMElement getDOMElementByLocator(String xPathLocator)
                                  throws WebAPINoSuchElementException

Description copied from interface: MiniBrowser

It returns the DOMElement identified by the given xpath.

Specified by:

getDOMElementByLocator in interface MiniBrowser

Returns:

the DOMElement

Throws:

WebAPINoSuchElementException - if the element is not found, or the found node is not an element node

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

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

js

public JSUtils js()

Specified by:

js in interface WebBrowser

navigate

public void navigate(URI uri,
                     boolean waitUntilLoaded)

Description copied from interface: WebBrowser

Navigate to the given URI.

Specified by:

navigate in interface WebBrowser

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

enableSilentPromptService

public void enableSilentPromptService(boolean b)

Description copied from interface: WebBrowser

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

Specified by:

enableSilentPromptService in interface WebBrowser

Parameters:

b - true to enable

getWindow

public DOMWindow getWindow()

Description copied from interface: WebBrowser

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

Specified by:

getWindow in interface WebBrowser

Returns:

the top-level dom window associated to this browser

close

public void close()

Description copied from interface: WebBrowser

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