ExtWebDriver (Extensions for WebDriver 1.5.5 API)

All Superinterfaces:

org.openqa.selenium.SearchContext, org.openqa.selenium.WebDriver

All Known Implementing Classes:

DefaultExtWebDriver
```
public interface ExtWebDriver
extends org.openqa.selenium.WebDriver
```
ExtWebDriver provides extensions to the WebDriver API to support the widget framework and permit changes to the implementing configuration

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ExtWebDriver.StaleWindowIdListException` StaleWindowIdListException will be thrown when the stored window ids cannot be usefully compared with the current window ids

Nested classes/interfaces inherited from interface org.openqa.selenium.WebDriver
org.openqa.selenium.WebDriver.ImeHandler, org.openqa.selenium.WebDriver.Navigation, org.openqa.selenium.WebDriver.Options, org.openqa.selenium.WebDriver.TargetLocator, org.openqa.selenium.WebDriver.Timeouts, org.openqa.selenium.WebDriver.Window

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`back()` Simulates browser Back button
`void`	`cancelNativeDialog()` Clicks cancel on the open confirmation dialog attached to the current window
`void`	`closeCurrentBrowser()` Closes the browser window, but does not kill IEDriverServer.exe, use this if you changed browsers mid-session and want to close the window.
`void`	`confirmNativeDialog()` Clicks ok on the open alert dialog OR confirmation dialog attached to the current window
`void`	`currentWindowMaximize()` Maximizes the current browser window
`void`	`eval(String javaScript)` Executes JavaScript
`String`	`evaluateXpath(String XPath)` Evaluates an XPath in JavaScript to return a string value based on the resulting node(s) or XPath function results
`void`	`focus()` Request focus for the active window with the current WebDriver
`void`	`forward()` Simulates browser Forward button
`String[]`	`getAllWindowIds()` Retrieves the windowHandle IDs
`String`	`getBrowserName()` Retrieves the name of the browser currently being operated by the webdriver
`String`	`getBrowserVersion()` Retrieves the version of the browser currently being operated by the webdriver
`Map<String,String>`	`getGeneratedHtmlSource()` Retrieves current state of the DOM in HTML format for each of the document's frames.
`String`	`getHtmlSource()` Returns the original HTML source of the current frame
`long`	`getMaxRequestTimeout()` Gets the timeout used by default when waiting on actions
`String`	`getNativeDialogText()` Retrieves the text of the open native dialog attached to the current window
`String`	`getSessionId()` Gets the id of the current session
`String`	`getWindowId()` Returns the current window handle ID
`org.openqa.selenium.WebDriver`	`getWrappedDriver()` Gets the underlying WebDriver instance
`int`	`getXpathCount(String XPath)` Returns the count of nodes that would be returned by an XPath expression
`boolean`	`isFocusOnClick()` Indicates the current setting for setting window focus as part of a click action
`boolean`	`isJavascriptClickMode()` Indicates the current setting for clicking on interactive elements
`boolean`	`isJavascriptTypeMode()` Indicates the current setting for entry of text in input fields
`void`	`open(String url)` Opens the browser
`void`	`refresh()` Reloads the current URL
`void`	`selectFrame(IElement iframeElement)` Selects a new frame from within the current frame
`void`	`selectLastFrame()` Selects the previously selected frame
`String`	`selectPopupWindow()` Sets the most recently opened browser window as the active windwo for the current WebDriver.
`void`	`selectWindow(String windowId)` Sets the active window for the current WebDriver
`void`	`setClickMode(boolean useJavaScript)` Configures the use of JavaScript for clicking on interactive elements, rather than relying on the native WebDriver methods
`void`	`setFocusOnClick(boolean doFocus)` One of several options to determine if the focus method should actually focus
`void`	`setMaxRequestTimeout(String timeout)` Sets the maximum timeout value for actions
`void`	`setSessionId(String id)` Sets the current session to be used for all actions on ExtWebDdriver and Widgets
`void`	`setTypeMode(boolean useJavaScript)` Configures the use of JavaScript for entry of input fields, rather than relying on the native WebDriver methods
`void`	`setWrappedDriver(org.openqa.selenium.WebDriver wd)` Replaces the underlying WebDriver instance
`void`	`storeCurrentWindowIds()` Stores handles for all existing windows for later comparison
`void`	`unselectFrame()` Selects the top most frame of the current window
`void`	`windowScroll(int i, int j)` Scrolls the current browser window to specific position
`void`	`windowScrollBy(int i, int j)` Scrolls the current browser by specific amount

Methods inherited from interface org.openqa.selenium.WebDriver
close, findElement, findElements, get, getCurrentUrl, getPageSource, getTitle, getWindowHandle, getWindowHandles, manage, navigate, quit, switchTo

- Method Detail
  - setWrappedDriver
```
void setWrappedDriver(org.openqa.selenium.WebDriver wd)
```
    Replaces the underlying WebDriver instance
    
    Parameters:
    
    wd - the new WebDriver instance
  - setTypeMode
```
void setTypeMode(boolean useJavaScript)
```
    Configures the use of JavaScript for entry of input fields, rather than relying on the native WebDriver methods
    
    Parameters:
    
    useJavaScript - true to enable the use of JavaScript, default is false
  - isJavascriptTypeMode
```
boolean isJavascriptTypeMode()
```
    Indicates the current setting for entry of text in input fields
    
    Returns:
    
    true if JavaScript is currently being used rather than native WebDriver methods
  - setClickMode
```
void setClickMode(boolean useJavaScript)
```
    Configures the use of JavaScript for clicking on interactive elements, rather than relying on the native WebDriver methods
    
    Parameters:
    
    useJavaScript - true to enable the use of JavaScript, default is false
  - isJavascriptClickMode
```
boolean isJavascriptClickMode()
```
    Indicates the current setting for clicking on interactive elements
    
    Returns:
    
    true if JavaScript is currently being used rather than native WebDriver methods
  - setFocusOnClick
```
void setFocusOnClick(boolean doFocus)
```
    One of several options to determine if the focus method should actually focus
    
    Parameters:
    
    doFocus - true to force focus to the window as part of the click action
    
    See Also:
    
    focus()
  - isFocusOnClick
```
boolean isFocusOnClick()
```
    Indicates the current setting for setting window focus as part of a click action
    
    Returns:
    
    true if focus will be set as part of click actions
  - setMaxRequestTimeout
```
void setMaxRequestTimeout(String timeout)
```
    Sets the maximum timeout value for actions
    
    Parameters:
    
    timeout - String representation milliseconds
  - open
```
void open(String url)
```
    Opens the browser
    
    Parameters:
    
    url - the web address for initial navigation
  - back
```
void back()
```
    Simulates browser Back button
  - closeCurrentBrowser
```
void closeCurrentBrowser()
```
    Closes the browser window, but does not kill IEDriverServer.exe, use this if you changed browsers mid-session and want to close the window. if you are using IEDriverServer.exe to run your tests you must use close() if you are done with the WebDriver session or execution will hang.
    
    See Also:
    
    WebDriver.close()
  - forward
```
void forward()
```
    Simulates browser Forward button
  - refresh
```
void refresh()
```
    Reloads the current URL
  - storeCurrentWindowIds
```
void storeCurrentWindowIds()
```
    Stores handles for all existing windows for later comparison
    
    See Also:
    
    selectPopupWindow()
  - focus
```
void focus()
```
    Request focus for the active window with the current WebDriver
  - selectWindow
```
void selectWindow(String windowId)
```
    Sets the active window for the current WebDriver
    
    Parameters:
    
    windowId - the window id string
  - selectPopupWindow
```
String selectPopupWindow()
                  throws ExtWebDriver.StaleWindowIdListException
```
    Sets the most recently opened browser window as the active windwo for the current WebDriver. Assumes that storeCurrentWindowIds() was called before the window opened and that only one window has opened since.
    
    Returns:
    
    the Id of the newly opened window
    
    Throws:
    
    ExtWebDriver.StaleWindowIdListException - when the difference between the stored window ids and the current window ids is more than one window
  - getAllWindowIds
```
String[] getAllWindowIds()
```
    Retrieves the windowHandle IDs
    
    Returns:
    
    array of current window ids
  - getWindowId
```
String getWindowId()
```
    Returns the current window handle ID
    
    Returns:
    
    the window Id for the active window for the webdriver
  - currentWindowMaximize
```
void currentWindowMaximize()
```
    Maximizes the current browser window
  - windowScroll
```
void windowScroll(int i,
                  int j)
```
    Scrolls the current browser window to specific position
    
    Parameters:
    
    i - Horizontal position
    
    j - Vertical position
  - windowScrollBy
```
void windowScrollBy(int i,
                    int j)
```
    Scrolls the current browser by specific amount
    
    Parameters:
    
    i - Horizontal scroll amount
    
    j - Vertical scroll amount
  - eval
```
void eval(String javaScript)
```
    Executes JavaScript
    
    Parameters:
    
    javaScript - the script to execute
  - getHtmlSource
```
String getHtmlSource()
```
    Returns the original HTML source of the current frame
    
    Returns:
    
    original HTML source of the current frame
  - getGeneratedHtmlSource
```
Map<String,String> getGeneratedHtmlSource()
```
    Retrieves current state of the DOM in HTML format for each of the document's frames.
    
    Returns:
    
    A map of HTMLs. Each key describes the location of the FRAME relative to the root DOM. The value is the HTML associated with the key. A key example is FRAME[root-2-1], which identifies the IFRAME that is the 1st IFRAME found underneath the 2nd IFRAME underneath the root DOM.
  - selectFrame
```
void selectFrame(IElement iframeElement)
          throws Exception
```
    Selects a new frame from within the current frame
    
    Parameters:
    
    iframeElement - the object representing the iframe element to select
    
    Throws:
    
    Exception
  - unselectFrame
```
void unselectFrame()
```
    Selects the top most frame of the current window
  - evaluateXpath
```
String evaluateXpath(String XPath)
              throws Exception
```
    Evaluates an XPath in JavaScript to return a string value based on the resulting node(s) or XPath function results
    
    Parameters:
    
    XPath - the XPath to evaluate
    
    Returns:
    
    the string value representing the XPath
    
    Throws:
    
    Exception - if the evaluation of the XPath fails
  - confirmNativeDialog
```
void confirmNativeDialog()
                  throws Exception
```
    Clicks ok on the open alert dialog OR confirmation dialog attached to the current window
    
    Throws:
    
    Exception - if the native dialog does not exist
  - cancelNativeDialog
```
void cancelNativeDialog()
```
    Clicks cancel on the open confirmation dialog attached to the current window
  - getNativeDialogText
```
String getNativeDialogText()
```
    Retrieves the text of the open native dialog attached to the current window
    
    Returns:
    
    the dialog text
  - getBrowserName
```
String getBrowserName()
```
    Retrieves the name of the browser currently being operated by the webdriver
    
    Returns:
    
    the browser name
  - getBrowserVersion
```
String getBrowserVersion()
```
    Retrieves the version of the browser currently being operated by the webdriver
    
    Returns:
    
    the browser version
  - getMaxRequestTimeout
```
long getMaxRequestTimeout()
```
    Gets the timeout used by default when waiting on actions
    
    Returns:
    
    the default max request timeout
  - getWrappedDriver
```
org.openqa.selenium.WebDriver getWrappedDriver()
```
    Gets the underlying WebDriver instance
    
    Returns:
    
    the current WebDriver
  - getXpathCount
```
int getXpathCount(String XPath)
```
    Returns the count of nodes that would be returned by an XPath expression
    
    Parameters:
    
    XPath - the XPAth expression to count
    
    Returns:
    
    the number of nodes which match
  - setSessionId
```
void setSessionId(String id)
```
    Sets the current session to be used for all actions on ExtWebDdriver and Widgets
    
    Parameters:
    
    id - the identifier for the session
  - getSessionId
```
String getSessionId()
```
    Gets the id of the current session
    
    Returns:
    
    the identifier for the session
  - selectLastFrame
```
void selectLastFrame()
```
    Selects the previously selected frame

Interface ExtWebDriver

Nested Class Summary

Nested classes/interfaces inherited from interface org.openqa.selenium.WebDriver

Method Summary

Methods inherited from interface org.openqa.selenium.WebDriver

Method Detail

setWrappedDriver

setTypeMode

isJavascriptTypeMode

setClickMode

isJavascriptClickMode

setFocusOnClick

isFocusOnClick

setMaxRequestTimeout

open

back

closeCurrentBrowser

forward

refresh

storeCurrentWindowIds

focus

selectWindow

selectPopupWindow

getAllWindowIds

getWindowId

currentWindowMaximize

windowScroll

windowScrollBy

eval

getHtmlSource

getGeneratedHtmlSource

selectFrame

unselectFrame

evaluateXpath

confirmNativeDialog

cancelNativeDialog

getNativeDialogText

getBrowserName

getBrowserVersion

getMaxRequestTimeout

getWrappedDriver

getXpathCount

setSessionId

getSessionId

selectLastFrame