EventFiringWebDriver

java.lang.Object
- org.openqa.selenium.support.events.EventFiringWebDriver

所有已实现的接口:

HasInputDevices, HasTouchScreen, WrapsDriver, JavascriptExecutor, SearchContext, TakesScreenshot, WebDriver
```
public class EventFiringWebDriver
extends Object
implements WebDriver, JavascriptExecutor, TakesScreenshot, WrapsDriver, HasInputDevices, HasTouchScreen
```
A wrapper around an arbitrary WebDriver instance which supports registering of a WebDriverEventListener, e.g. for logging purposes.

嵌套类概要
- 从接口继承的嵌套类/接口 org.openqa.selenium.WebDriver
  WebDriver.ImeHandler, WebDriver.Navigation, WebDriver.Options, WebDriver.TargetLocator, WebDriver.Timeouts, WebDriver.Window

构造器概要

构造器
构造器和说明

EventFiringWebDriver(WebDriver driver)

构造器
构造器和说明
`EventFiringWebDriver(WebDriver driver)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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.
`TouchScreen`	`getTouch()`
`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 `WebDriver.switchTo()`.
`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)`

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - EventFiringWebDriver
```
public EventFiringWebDriver(WebDriver driver)
```
- 方法详细资料
  - register
```
public EventFiringWebDriver register(WebDriverEventListener eventListener)
```
    参数:
    
    eventListener - the event listener to register
    
    返回:
    
    this for method chaining.
  - unregister
```
public EventFiringWebDriver unregister(WebDriverEventListener eventListener)
```
    参数:
    
    eventListener - the event listener to unregister
    
    返回:
    
    this for method chaining.
  - getWrappedDriver
```
public WebDriver getWrappedDriver()
```
    指定者:
    
    getWrappedDriver 在接口中 WrapsDriver
    
    返回:
    
    The driver that contains this element.
  - get
```
public void get(String url)
```
    从接口复制的说明: 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).
    
    指定者:
    
    get 在接口中 WebDriver
    
    参数:
    
    url - The URL to load. It is best to use a fully qualified URL
  - getCurrentUrl
```
public String getCurrentUrl()
```
    从接口复制的说明: WebDriver
    
    Get a string representing the current URL that the browser is looking at.
    
    指定者:
    
    getCurrentUrl 在接口中 WebDriver
    
    返回:
    
    The URL of the page currently loaded in the browser
  - getTitle
```
public String getTitle()
```
    从接口复制的说明: WebDriver
    
    The title of the current page.
    
    指定者:
    
    getTitle 在接口中 WebDriver
    
    返回:
    
    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)
```
    从接口复制的说明: WebDriver
    
    Find all elements within the current page using the given mechanism. This method is affected by the 'implicit wait' times in force at the time of execution. When implicitly waiting, this method will return as soon as there are more than 0 items in the found collection, or will return an empty list if the timeout is reached.
    
    指定者:
    
    findElements 在接口中 SearchContext
    
    指定者:
    
    findElements 在接口中 WebDriver
    
    参数:
    
    by - The locating mechanism to use
    
    返回:
    
    A list of all WebElements, or an empty list if nothing matches
    
    另请参阅:
    
    By, WebDriver.Timeouts
  - findElement
```
public WebElement findElement(By by)
```
    从接口复制的说明: WebDriver
    
    Find the first WebElement using the given method. This method is affected by the 'implicit wait' times in force at the time of execution. The findElement(..) invocation will return a matching row, or try again repeatedly until the configured timeout is reached. findElement should not be used to look for non-present elements, use WebDriver.findElements(By) and assert zero length response instead.
    
    指定者:
    
    findElement 在接口中 SearchContext
    
    指定者:
    
    findElement 在接口中 WebDriver
    
    参数:
    
    by - The locating mechanism
    
    返回:
    
    The first matching element on the current page
    
    另请参阅:
    
    By, WebDriver.Timeouts
  - getPageSource
```
public String getPageSource()
```
    从接口复制的说明: WebDriver
    
    Get the source of the last loaded page. If the page has been modified after loading (for example, by Javascript) there is no guarantee 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. Think of it as an artist's impression.
    
    指定者:
    
    getPageSource 在接口中 WebDriver
    
    返回:
    
    The source of the current page
  - close
```
public void close()
```
    从接口复制的说明: WebDriver
    
    Close the current window, quitting the browser if it's the last window currently open.
    
    指定者:
    
    close 在接口中 WebDriver
  - quit
```
public void quit()
```
    从接口复制的说明: WebDriver
    
    Quits this driver, closing every associated window.
    
    指定者:
    
    quit 在接口中 WebDriver
  - getWindowHandles
```
public Set<String> getWindowHandles()
```
    从接口复制的说明: 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 WebDriver.switchTo().WebDriver.Options.window()
    
    指定者:
    
    getWindowHandles 在接口中 WebDriver
    
    返回:
    
    A set of window handles which can be used to iterate over all open windows.
  - getWindowHandle
```
public String getWindowHandle()
```
    从接口复制的说明: 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
    
    指定者:
    
    getWindowHandle 在接口中 WebDriver
    
    返回:
    
    the current window handle
  - executeScript
```
public Object executeScript(String script,
                            Object... args)
```
    从接口复制的说明: 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:
    - For an HTML element, this method returns a WebElement
    - For a decimal, a Double is returned
    - For a non-decimal number, a Long is returned
    - For a boolean, a Boolean is returned
    - For all other cases, a String is returned.
    - For an array, return a List<Object> with each object following the rules above. We support nested lists.
    - Unless the value is null or there is no return value, in which null is returned
    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"
    指定者:
    
    executeScript 在接口中 JavascriptExecutor
    
    参数:
    
    script - The JavaScript to execute
    
    args - The arguments to the script. May be empty
    
    返回:
    
    One of Boolean, Long, Double, String, List or WebElement. Or null.
  - executeAsyncScript
```
public Object executeAsyncScript(String script,
                                 Object... args)
```
    从接口复制的说明: 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:
    - For an HTML element, this method returns a WebElement
    - For a number, a Long is returned
    - For a boolean, a Boolean is returned
    - For all other cases, a String is returned.
    - For an array, return a List<Object> with each object following the rules above. We support nested lists.
    - Unless the value is null or there is no return value, in which null is returned
    The default timeout for a script to be executed is 0ms. In most cases, including the examples below, one must set the script timeout WebDriver.Timeouts.setScriptTimeout(long, java.util.concurrent.TimeUnit) beforehand to a value sufficiently large enough.
    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 JsonParser().parse((String) response);
   assertEquals("cheese", json.get("food").getAsString());
 
```
    Script 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" variable.
    指定者:
    
    executeAsyncScript 在接口中 JavascriptExecutor
    
    参数:
    
    script - The JavaScript to execute.
    
    args - The arguments to the script. May be empty.
    
    返回:
    
    One of Boolean, Long, String, List, WebElement, or null.
    
    另请参阅:
    
    WebDriver.Timeouts.setScriptTimeout(long, java.util.concurrent.TimeUnit)
  - getScreenshotAs
```
public <X> X getScreenshotAs(OutputType<X> target)
                      throws WebDriverException
```
    从接口复制的说明: TakesScreenshot
    Capture the screenshot and store it in the specified location.
    For WebDriver extending TakesScreenshot, this makes a best effort depending on the browser to return the following in order of preference:
    - Entire page
    - Current window
    - Visible portion of the current frame
    - The screenshot of the entire display containing the browser
    For WebElement extending TakesScreenshot, this makes a best effort depending on the browser to return the following in order of preference: - The entire content of the HTML element - The visible portion of the HTML element
    指定者:
    
    getScreenshotAs 在接口中 TakesScreenshot
    
    类型参数:
    
    X - Return type for getScreenshotAs.
    
    参数:
    
    target - target type, @see OutputType
    
    返回:
    
    Object in which is stored information about the screenshot.
    
    抛出:
    
    WebDriverException - on failure.
  - switchTo
```
public WebDriver.TargetLocator switchTo()
```
    从接口复制的说明: WebDriver
    
    Send future commands to a different frame or window.
    
    指定者:
    
    switchTo 在接口中 WebDriver
    
    返回:
    
    A TargetLocator which can be used to select a frame or window
    
    另请参阅:
    
    WebDriver.TargetLocator
  - navigate
```
public WebDriver.Navigation navigate()
```
    从接口复制的说明: WebDriver
    
    An abstraction allowing the driver to access the browser's history and to navigate to a given URL.
    
    指定者:
    
    navigate 在接口中 WebDriver
    
    返回:
    
    A WebDriver.Navigation that allows the selection of what to do next
  - manage
```
public WebDriver.Options manage()
```
    从接口复制的说明: WebDriver
    
    Gets the Option interface
    
    指定者:
    
    manage 在接口中 WebDriver
    
    返回:
    
    An option interface
    
    另请参阅:
    
    WebDriver.Options
  - getKeyboard
```
public Keyboard getKeyboard()
```
    指定者:
    
    getKeyboard 在接口中 HasInputDevices
  - getMouse
```
public Mouse getMouse()
```
    指定者:
    
    getMouse 在接口中 HasInputDevices
  - getTouch
```
public TouchScreen getTouch()
```
    指定者:
    
    getTouch 在接口中 HasTouchScreen

类 EventFiringWebDriver

嵌套类概要

从接口继承的嵌套类/接口 org.openqa.selenium.WebDriver

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

EventFiringWebDriver

方法详细资料

register

unregister

getWrappedDriver

get

getCurrentUrl

getTitle

findElements

findElement

getPageSource

close

quit

getWindowHandles

getWindowHandle

executeScript

executeAsyncScript

getScreenshotAs

switchTo

navigate

manage

getKeyboard

getMouse

getTouch