Class EventFiringWebDriver
- java.lang.Object
-
- org.openqa.selenium.support.events.EventFiringWebDriver
-
- All Implemented Interfaces:
HasCapabilities
,Interactive
,JavascriptExecutor
,SearchContext
,TakesScreenshot
,WebDriver
,WrapsDriver
@Deprecated public class EventFiringWebDriver extends java.lang.Object implements WebDriver, JavascriptExecutor, TakesScreenshot, WrapsDriver, Interactive, HasCapabilities
Deprecated.UseEventFiringDecorator
andWebDriverListener
insteadA wrapper around an arbitraryWebDriver
instance which supports registering of aWebDriverEventListener
, e.g. for logging purposes.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.openqa.selenium.WebDriver
WebDriver.Navigation, WebDriver.Options, WebDriver.TargetLocator, WebDriver.Timeouts, WebDriver.Window
-
-
Constructor Summary
Constructors Constructor Description EventFiringWebDriver(WebDriver driver)
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
close()
Deprecated.Close the current window, quitting the browser if it's the last window currently open.java.lang.Object
executeAsyncScript(java.lang.String script, java.lang.Object... args)
Deprecated.Execute an asynchronous piece of JavaScript in the context of the currently selected frame or window.java.lang.Object
executeScript(java.lang.String script, java.lang.Object... args)
Deprecated.Executes JavaScript in the context of the currently selected frame or window.WebElement
findElement(By by)
Deprecated.Find the firstWebElement
using the given method.java.util.List<WebElement>
findElements(By by)
Deprecated.Find all elements within the current page using the given mechanism.void
get(java.lang.String url)
Deprecated.Load a new web page in the current browser window.Capabilities
getCapabilities()
Deprecated.java.lang.String
getCurrentUrl()
Deprecated.Get a string representing the current URL that the browser is looking at.java.lang.String
getPageSource()
Deprecated.Get the source of the last loaded page.<X> X
getScreenshotAs(OutputType<X> target)
Deprecated.Capture the screenshot and store it in the specified location.java.lang.String
getTitle()
Deprecated.Get the title of the current page.java.lang.String
getWindowHandle()
Deprecated.Return an opaque handle to this window that uniquely identifies it within this driver instance.java.util.Set<java.lang.String>
getWindowHandles()
Deprecated.Return a set of window handles which can be used to iterate over all open windows of this WebDriver instance by passing them toWebDriver.switchTo()
.WebDriver.Options.window()
WebDriver
getWrappedDriver()
Deprecated.WebDriver.Options
manage()
Deprecated.Gets the Option interfaceWebDriver.Navigation
navigate()
Deprecated.An abstraction allowing the driver to access the browser's history and to navigate to a given URL.void
perform(java.util.Collection<Sequence> actions)
Deprecated.void
quit()
Deprecated.Quits this driver, closing every associated window.EventFiringWebDriver
register(WebDriverEventListener eventListener)
Deprecated.void
resetInputState()
Deprecated.WebDriver.TargetLocator
switchTo()
Deprecated.Send future commands to a different frame or window.EventFiringWebDriver
unregister(WebDriverEventListener eventListener)
Deprecated.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.openqa.selenium.JavascriptExecutor
executeScript, getPinnedScripts, pin, unpin
-
-
-
-
Constructor Detail
-
EventFiringWebDriver
public EventFiringWebDriver(WebDriver driver)
Deprecated.
-
-
Method Detail
-
register
public EventFiringWebDriver register(WebDriverEventListener eventListener)
Deprecated.- Parameters:
eventListener
- the event listener to register- Returns:
- this for method chaining.
-
unregister
public EventFiringWebDriver unregister(WebDriverEventListener eventListener)
Deprecated.- Parameters:
eventListener
- the event listener to unregister- Returns:
- this for method chaining.
-
getWrappedDriver
public WebDriver getWrappedDriver()
Deprecated.- Specified by:
getWrappedDriver
in interfaceWrapsDriver
- Returns:
- The driver that contains this element.
-
get
public void get(java.lang.String url)
Deprecated.Description copied from interface:WebDriver
Load a new web page in the current browser window. This is done using an HTTP POST operation, and the method will block until the load is complete (with the default 'page load strategy'. 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 forWebDriver.Navigation.to(String)
.See W3C WebDriver specification for more details.
- Specified by:
get
in interfaceWebDriver
- Parameters:
url
- The URL to load. Must be a fully qualified URL- See Also:
PageLoadStrategy
-
getCurrentUrl
public java.lang.String getCurrentUrl()
Deprecated.Description copied from interface:WebDriver
Get a string representing the current URL that the browser is looking at.See W3C WebDriver specification for more details.
- Specified by:
getCurrentUrl
in interfaceWebDriver
- Returns:
- The URL of the page currently loaded in the browser
-
getTitle
public java.lang.String getTitle()
Deprecated.Description copied from interface:WebDriver
Get the title of the current page.See W3C WebDriver specification for more details.
-
findElements
public java.util.List<WebElement> findElements(By by)
Deprecated.Description copied from interface: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.See W3C WebDriver specification for more details.
- Specified by:
findElements
in interfaceSearchContext
- Specified by:
findElements
in interfaceWebDriver
- Parameters:
by
- The locating mechanism to use- Returns:
- A list of all matching
WebElement
s, or an empty list if nothing matches - See Also:
By
,WebDriver.Timeouts
-
findElement
public WebElement findElement(By by)
Deprecated.Description copied from interface:WebDriver
Find the firstWebElement
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.See W3C WebDriver specification for more details.
- Specified by:
findElement
in interfaceSearchContext
- Specified by:
findElement
in interfaceWebDriver
- Parameters:
by
- The locating mechanism to use- Returns:
- The first matching element on the current page
- See Also:
By
,WebDriver.Timeouts
-
getPageSource
public java.lang.String getPageSource()
Deprecated.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 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.See W3C WebDriver specification for more details.
- Specified by:
getPageSource
in interfaceWebDriver
- Returns:
- The source of the current page
-
close
public void close()
Deprecated.Description copied from interface:WebDriver
Close the current window, quitting the browser if it's the last window currently open.See W3C WebDriver specification for more details.
-
quit
public void quit()
Deprecated.Description copied from interface:WebDriver
Quits this driver, closing every associated window.
-
getWindowHandles
public java.util.Set<java.lang.String> getWindowHandles()
Deprecated.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 toWebDriver.switchTo()
.WebDriver.Options.window()
See W3C WebDriver specification for more details.
- Specified by:
getWindowHandles
in interfaceWebDriver
- Returns:
- A set of window handles which can be used to iterate over all open windows.
-
getWindowHandle
public java.lang.String getWindowHandle()
Deprecated.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 dateSee W3C WebDriver specification for more details.
- Specified by:
getWindowHandle
in interfaceWebDriver
- Returns:
- the current window handle
-
executeScript
public java.lang.Object executeScript(java.lang.String script, java.lang.Object... args)
Deprecated.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:- 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.
- For a map, return a Map<String, Object> with values following the rules above.
- 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"
- Specified by:
executeScript
in interfaceJavascriptExecutor
- Parameters:
script
- The JavaScript to executeargs
- The arguments to the script. May be empty- Returns:
- One of Boolean, Long, Double, String, List, Map or WebElement. Or null.
-
executeAsyncScript
public java.lang.Object executeAsyncScript(java.lang.String script, java.lang.Object... args)
Deprecated.Description copied from interface:JavascriptExecutor
Execute an asynchronous piece of JavaScript in the context of the currently selected frame or window. Unlike executingsynchronous 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.
- For a map, return a Map<String, Object> with values following the rules above.
- 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.scriptTimeout(java.time.Duration)
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.
- Specified by:
executeAsyncScript
in interfaceJavascriptExecutor
- Parameters:
script
- The JavaScript to execute.args
- The arguments to the script. May be empty.- Returns:
- One of Boolean, Long, String, List, Map, WebElement, or null.
- See Also:
WebDriver.Timeouts.scriptTimeout(java.time.Duration)
-
getScreenshotAs
public <X> X getScreenshotAs(OutputType<X> target) throws WebDriverException
Deprecated.Description copied from interface:TakesScreenshot
Capture the screenshot and store it in the specified location.For a W3C-conformant WebDriver or WebElement, this behaves as stated in W3C WebDriver specification.
For a non-W3C-conformant WebDriver, 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
- The entire content of the HTML element
- The visible portion of the HTML element
- Specified by:
getScreenshotAs
in interfaceTakesScreenshot
- 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()
Deprecated.Description copied from interface:WebDriver
Send future commands to a different frame or window.- Specified by:
switchTo
in interfaceWebDriver
- Returns:
- A TargetLocator which can be used to select a frame or window
- See Also:
WebDriver.TargetLocator
-
navigate
public WebDriver.Navigation navigate()
Deprecated.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 interfaceWebDriver
- Returns:
- A
WebDriver.Navigation
that allows the selection of what to do next
-
manage
public WebDriver.Options manage()
Deprecated.Description copied from interface:WebDriver
Gets the Option interface- Specified by:
manage
in interfaceWebDriver
- Returns:
- An option interface
- See Also:
WebDriver.Options
-
perform
public void perform(java.util.Collection<Sequence> actions)
Deprecated.- Specified by:
perform
in interfaceInteractive
-
resetInputState
public void resetInputState()
Deprecated.- Specified by:
resetInputState
in interfaceInteractive
-
getCapabilities
public Capabilities getCapabilities()
Deprecated.- Specified by:
getCapabilities
in interfaceHasCapabilities
- Returns:
- The capabilities of the current driver.
-
-