org.openqa.selenium.support.events
Class EventFiringWebDriver

java.lang.Object
  extended by org.openqa.selenium.support.events.EventFiringWebDriver
All Implemented Interfaces:
HasInputDevices, WrapsDriver, JavascriptExecutor, SearchContext, TakesScreenshot, WebDriver

public class EventFiringWebDriver
extends Object
implements WebDriver, JavascriptExecutor, TakesScreenshot, WrapsDriver, HasInputDevices

A wrapper around an arbitrary WebDriver instance which supports registering of a WebDriverEventListener, e.g. for logging purposes.

Author:
Michael Tamm

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.openqa.selenium.WebDriver
WebDriver.ImeHandler, WebDriver.Navigation, WebDriver.Options, WebDriver.TargetLocator, WebDriver.Timeouts
 
Constructor Summary
EventFiringWebDriver(WebDriver driver)
           
 
Method Summary
 void close()
          Close the current window, quitting the browser if it's the last window currently open.
 Object executeAsyncScript(String script, Object... args)
          Execute an asynchronous piece of JavaScript in the context of the currently selected frame or window.
 Object executeScript(String script, Object... args)
          Executes JavaScript in the context of the currently selected frame or window.
 WebElement findElement(By by)
          Find the first WebElement using the given method.
 List<WebElement> findElements(By by)
          Find all elements within the current page using the given mechanism.
 void get(String url)
          Load a new web page in the current browser window.
 String getCurrentUrl()
          Get a string representing the current URL that the browser is looking at.
 Keyboard getKeyboard()
           
 Mouse getMouse()
           
 String getPageSource()
          Get the source of the last loaded page.
<X> X
getScreenshotAs(OutputType<X> target)
          Capture the screenshot and store it in the specified location.
 String getTitle()
          The title of the current page.
 String getWindowHandle()
          Return an opaque handle to this window that uniquely identifies it within this driver instance.
 Set<String> getWindowHandles()
          Return a set of window handles which can be used to iterate over all open windows of this webdriver instance by passing them to #switchTo().window(String)
 WebDriver getWrappedDriver()
           
 WebDriver.Options manage()
          Gets the Option interface
 WebDriver.Navigation navigate()
          An abstraction allowing the driver to access the browser's history and to navigate to a given URL.
 void quit()
          Quits this driver, closing every associated window.
 EventFiringWebDriver register(WebDriverEventListener eventListener)
           
 WebDriver.TargetLocator switchTo()
          Send future commands to a different frame or window.
 EventFiringWebDriver unregister(WebDriverEventListener eventListener)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EventFiringWebDriver

public EventFiringWebDriver(WebDriver driver)
Method Detail

register

public EventFiringWebDriver register(WebDriverEventListener eventListener)
Returns:
this for method chaining.

unregister

public EventFiringWebDriver unregister(WebDriverEventListener eventListener)
Returns:
this for method chaining.

getWrappedDriver

public WebDriver getWrappedDriver()
Specified by:
getWrappedDriver in interface WrapsDriver
Returns:
The driver that contains this element.

get

public void get(String url)
Description copied from interface: WebDriver
Load a new web page in the current browser window. This is done using an HTTP GET operation, and the method will block until the load is complete. This will follow redirects issued either by the server or as a meta-redirect from within the returned HTML. Should a meta-redirect "rest" for any duration of time, it is best to wait until this timeout is over, since should the underlying page change whilst your test is executing the results of future calls against this interface will be against the freshly loaded page. Synonym for WebDriver.Navigation.to(String).

Specified by:
get in interface WebDriver
Parameters:
url - The URL to load. It is best to use a fully qualified URL

getCurrentUrl

public String getCurrentUrl()
Description copied from interface: WebDriver
Get a string representing the current URL that the browser is looking at.

Specified by:
getCurrentUrl in interface WebDriver
Returns:
The URL of the page currently loaded in the browser

getTitle

public String getTitle()
Description copied from interface: WebDriver
The title of the current page.

Specified by:
getTitle in interface WebDriver
Returns:
The title of the current page, with leading and trailing whitespace stripped, or null if one is not already set

findElements

public List<WebElement> findElements(By by)
Description copied from interface: WebDriver
Find all elements within the current page using the given mechanism.

Specified by:
findElements in interface SearchContext
Specified by:
findElements in interface WebDriver
Parameters:
by - The locating mechanism to use
Returns:
A list of all WebElements, or an empty list if nothing matches
See Also:
By

findElement

public WebElement findElement(By by)
Description copied from interface: WebDriver
Find the first WebElement using the given method.

Specified by:
findElement in interface SearchContext
Specified by:
findElement in interface WebDriver
Parameters:
by - The locating mechanism
Returns:
The first matching element on the current page

getPageSource

public String getPageSource()
Description copied from interface: WebDriver
Get the source of the last loaded page. If the page has been modified after loading (for example, by Javascript) there is no guarentee that the returned text is that of the modified page. Please consult the documentation of the particular driver being used to determine whether the returned text reflects the current state of the page or the text last sent by the web server. The page source returned is a representation of the underlying DOM: do not expect it to be formatted or escaped in the same way as the response sent from the web server.

Specified by:
getPageSource in interface WebDriver
Returns:
The source of the current page

close

public void close()
Description copied from interface: WebDriver
Close the current window, quitting the browser if it's the last window currently open.

Specified by:
close in interface WebDriver

quit

public void quit()
Description copied from interface: WebDriver
Quits this driver, closing every associated window.

Specified by:
quit in interface WebDriver

getWindowHandles

public Set<String> getWindowHandles()
Description copied from interface: WebDriver
Return a set of window handles which can be used to iterate over all open windows of this webdriver instance by passing them to #switchTo().window(String)

Specified by:
getWindowHandles in interface WebDriver
Returns:
A set of window handles which can be used to iterate over all open windows.

getWindowHandle

public String getWindowHandle()
Description copied from interface: WebDriver
Return an opaque handle to this window that uniquely identifies it within this driver instance. This can be used to switch to this window at a later date

Specified by:
getWindowHandle in interface WebDriver

executeScript

public Object executeScript(String script,
                            Object... args)
Description copied from interface: JavascriptExecutor
Executes JavaScript in the context of the currently selected frame or window. The script fragment provided will be executed as the body of an anonymous function.

Within the script, use document to refer to the current document. Note that local variables will not be available once the script has finished executing, though global variables will persist.

If the script has a return value (i.e. if the script contains a return statement), then the following steps will be taken:

Arguments must be a number, a boolean, a String, WebElement, or a List of any combination of the above. An exception will be thrown if the arguments do not meet these criteria. The arguments will be made available to the JavaScript via the "arguments" magic variable, as if the function were called via "Function.apply"

Specified by:
executeScript in interface JavascriptExecutor
Parameters:
script - The JavaScript to execute
args - The arguments to the script. May be empty
Returns:
One of Boolean, Long, String, List or WebElement. Or null.

executeAsyncScript

public Object executeAsyncScript(String script,
                                 Object... args)
Description copied from interface: JavascriptExecutor
Execute an asynchronous piece of JavaScript in the context of the currently selected frame or window. Unlike executing synchronous JavaScript, scripts executed with this method must explicitly signal they are finished by invoking the provided callback. This callback is always injected into the executed function as the last argument.

The first argument passed to the callback function will be used as the script's result. This value will be handled as follows:

Example #1: Performing a sleep in the browser under test.

   long start = System.currentTimeMillis();
   ((JavascriptExecutor) driver).executeAsyncScript(
       "window.setTimeout(arguments[arguments.length - 1], 500);");
   System.out.println(
       "Elapsed time: " + System.currentTimeMillis() - start);
 

Example #2: Synchronizing a test with an AJAX application:

   WebElement composeButton = driver.findElement(By.id("compose-button"));
   composeButton.click();
   ((JavascriptExecutor) driver).executeAsyncScript(
       "var callback = arguments[arguments.length - 1];" +
       "mailClient.getComposeWindowWidget().onload(callback);");
   driver.switchTo().frame("composeWidget");
   driver.findElement(By.id("to")).sendKeys("bog@example.com");
 

Example #3: Injecting a XMLHttpRequest and waiting for the result:

   Object response = ((JavascriptExecutor) driver).executeAsyncScript(
       "var callback = arguments[arguments.length - 1];" +
       "var xhr = new XMLHttpRequest();" +
       "xhr.open('GET', '/resource/data.json', true);" +
       "xhr.onreadystatechange = function() {" +
       "  if (xhr.readyState == 4) {" +
       "    callback(xhr.responseText);" +
       "  }" +
       "}" +
       "xhr.send();");
   JSONObject json = new JSONObject((String) response);
   assertEquals("cheese", json.getString("food"));
 

Specified by:
executeAsyncScript in interface JavascriptExecutor
Parameters:
script - The JavaScript to execute.
args - The arguments to the script. May be empty.
Returns:
One of Boolean, Long, String, List, WebElement, or null.

getScreenshotAs

public <X> X getScreenshotAs(OutputType<X> target)
                  throws WebDriverException
Description copied from interface: TakesScreenshot
Capture the screenshot and store it in the specified location.

Specified by:
getScreenshotAs in interface TakesScreenshot
Type Parameters:
X - Return type for getScreenshotAs.
Parameters:
target - target type, @see OutputType
Returns:
Object in which is stored information about the screenshot.
Throws:
WebDriverException - on failure.

switchTo

public WebDriver.TargetLocator switchTo()
Description copied from interface: WebDriver
Send future commands to a different frame or window.

Specified by:
switchTo in interface WebDriver
Returns:
A TargetLocator which can be used to select a frame or window
See Also:
WebDriver.TargetLocator

navigate

public WebDriver.Navigation navigate()
Description copied from interface: WebDriver
An abstraction allowing the driver to access the browser's history and to navigate to a given URL.

Specified by:
navigate in interface WebDriver
Returns:
A WebDriver.Navigation that allows the selection of what to do next

manage

public WebDriver.Options manage()
Description copied from interface: WebDriver
Gets the Option interface

Specified by:
manage in interface WebDriver
Returns:
An option interface
See Also:
WebDriver.Options

getKeyboard

public Keyboard getKeyboard()
Specified by:
getKeyboard in interface HasInputDevices

getMouse

public Mouse getMouse()
Specified by:
getMouse in interface HasInputDevices


Copyright © 2011. All Rights Reserved.