DefaultExtWebDriver (Extensions for WebDriver 1.5.5 API)

java.lang.Object
- org.finra.jtaf.ewd.impl.DefaultExtWebDriver

All Implemented Interfaces:

ExtWebDriver, HighlightProvider, org.openqa.selenium.SearchContext, org.openqa.selenium.WebDriver
```
public class DefaultExtWebDriver
extends Object
implements ExtWebDriver, HighlightProvider
```
DefaultExtWebDriver is the default implementation of the ExtWebDriver interface to support more advanced window and frame handling on top of WebDriver

Nested Class Summary
- Nested classes/interfaces inherited from interface org.finra.jtaf.ewd.ExtWebDriver
  ExtWebDriver.StaleWindowIdListException
- 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

Constructor Summary

Constructors
Constructor and Description

DefaultExtWebDriver()
Constructor for ExtWebDriver

Constructors
Constructor and Description
`DefaultExtWebDriver()` Constructor for ExtWebDriver

Method Summary

All Methods Instance Methods Concrete 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`	`close()`
`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 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
`org.openqa.selenium.WebElement`	`findElement(org.openqa.selenium.By arg0)`
`List<org.openqa.selenium.WebElement>`	`findElements(org.openqa.selenium.By arg0)`
`void`	`focus()` Request focus for the active window with the current WebDriver
`void`	`forward()` Simulates browser Forward button
`void`	`get(String arg0)`
`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
`String`	`getCurrentUrl()`
`Map<String,String>`	`getGeneratedHtmlSource()` Retrieves current state of the DOM in HTML format for each of the document's frames.
`String`	`getHighlightColor(String highlightMode)` Get the highlight color based on mode
`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`	`getPageSource()`
`String`	`getSessionId()` Gets the id of the current session
`String`	`getTitle()`
`String`	`getWindowHandle()`
`Set<String>`	`getWindowHandles()`
`String`	`getWindowId()` Returns the current window handle ID
`org.openqa.selenium.WebDriver`	`getWrappedDriver()` Gets the underlying WebDriver instance
`int`	`getXpathCount(String string)` 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`	`isHighlight()`
`boolean`	`isJavascriptClickMode()` Indicates the current setting for clicking on interactive elements
`boolean`	`isJavascriptTypeMode()` Indicates the current setting for entry of text in input fields
`org.openqa.selenium.WebDriver.Options`	`manage()`
`org.openqa.selenium.WebDriver.Navigation`	`navigate()`
`void`	`open(String url)` Opens the browser
`void`	`quit()`
`void`	`refresh()` Reloads the current URL
`void`	`selectFrame(IElement element)` 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`	`setClientProperties(ClientProperties cp)` Sets the client configuration to use
`void`	`setFocusOnClick(boolean doFocus)` One of several options to determine if the focus method should actually focus
`void`	`setHighlightColors(Map<String,String> colorMap)`
`void`	`setIsHighlight(boolean isHighlight)` Sets whether to highlight elements when performing actions
`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
`org.openqa.selenium.WebDriver.TargetLocator`	`switchTo()`
`void`	`unselectFrame()` Selects the top most frame
`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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultExtWebDriver
```
public DefaultExtWebDriver()
```
    Constructor for ExtWebDriver
- Method Detail
  - setWrappedDriver
```
public void setWrappedDriver(org.openqa.selenium.WebDriver wd)
```
    Description copied from interface: ExtWebDriver
    
    Replaces the underlying WebDriver instance
    
    Specified by:
    
    setWrappedDriver in interface ExtWebDriver
    
    Parameters:
    
    wd - the new WebDriver instance
  - setClientProperties
```
public void setClientProperties(ClientProperties cp)
```
    Sets the client configuration to use
    
    Parameters:
    
    cp - client configuration
  - setTypeMode
```
public void setTypeMode(boolean useJavascript)
```
    Description copied from interface: ExtWebDriver
    
    Configures the use of JavaScript for entry of input fields, rather than relying on the native WebDriver methods
    
    Specified by:
    
    setTypeMode in interface ExtWebDriver
    
    Parameters:
    
    useJavascript - true to enable the use of JavaScript, default is false
  - isJavascriptTypeMode
```
public boolean isJavascriptTypeMode()
```
    Description copied from interface: ExtWebDriver
    
    Indicates the current setting for entry of text in input fields
    
    Specified by:
    
    isJavascriptTypeMode in interface ExtWebDriver
    
    Returns:
    
    true if JavaScript is currently being used rather than native WebDriver methods
  - setClickMode
```
public void setClickMode(boolean useJavascript)
```
    Description copied from interface: ExtWebDriver
    
    Configures the use of JavaScript for clicking on interactive elements, rather than relying on the native WebDriver methods
    
    Specified by:
    
    setClickMode in interface ExtWebDriver
    
    Parameters:
    
    useJavascript - true to enable the use of JavaScript, default is false
  - isJavascriptClickMode
```
public boolean isJavascriptClickMode()
```
    Description copied from interface: ExtWebDriver
    
    Indicates the current setting for clicking on interactive elements
    
    Specified by:
    
    isJavascriptClickMode in interface ExtWebDriver
    
    Returns:
    
    true if JavaScript is currently being used rather than native WebDriver methods
  - setFocusOnClick
```
public void setFocusOnClick(boolean doFocus)
```
    Description copied from interface: ExtWebDriver
    
    One of several options to determine if the focus method should actually focus
    
    Specified by:
    
    setFocusOnClick in interface ExtWebDriver
    
    Parameters:
    
    doFocus - true to force focus to the window as part of the click action
    
    See Also:
    
    ExtWebDriver.focus()
  - isFocusOnClick
```
public boolean isFocusOnClick()
```
    Description copied from interface: ExtWebDriver
    
    Indicates the current setting for setting window focus as part of a click action
    
    Specified by:
    
    isFocusOnClick in interface ExtWebDriver
    
    Returns:
    
    true if focus will be set as part of click actions
  - setIsHighlight
```
public void setIsHighlight(boolean isHighlight)
```
    Description copied from interface: HighlightProvider
    
    Sets whether to highlight elements when performing actions
    
    Specified by:
    
    setIsHighlight in interface HighlightProvider
    
    Parameters:
    
    isHighlight - whether to allow highlight
  - isHighlight
```
public boolean isHighlight()
```
    Specified by:
    
    isHighlight in interface HighlightProvider
  - setHighlightColors
```
public void setHighlightColors(Map<String,String> colorMap)
```
    Specified by:
    
    setHighlightColors in interface HighlightProvider
  - getHighlightColor
```
public String getHighlightColor(String highlightMode)
```
    Description copied from interface: HighlightProvider
    
    Get the highlight color based on mode
    
    Specified by:
    
    getHighlightColor in interface HighlightProvider
    
    Parameters:
    
    highlightMode - the mode for which to get color
    
    Returns:
    
    String the color for the mode
  - open
```
public void open(String url)
```
    Description copied from interface: ExtWebDriver
    
    Opens the browser
    
    Specified by:
    
    open in interface ExtWebDriver
    
    Parameters:
    
    url - the web address for initial navigation
  - back
```
public void back()
```
    Description copied from interface: ExtWebDriver
    
    Simulates browser Back button
    
    Specified by:
    
    back in interface ExtWebDriver
  - closeCurrentBrowser
```
public void closeCurrentBrowser()
```
    Description copied from interface: ExtWebDriver
    
    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.
    
    Specified by:
    
    closeCurrentBrowser in interface ExtWebDriver
    
    See Also:
    
    WebDriver.close()
  - close
```
public void close()
```
    Specified by:
    
    close in interface org.openqa.selenium.WebDriver
  - forward
```
public void forward()
```
    Description copied from interface: ExtWebDriver
    
    Simulates browser Forward button
    
    Specified by:
    
    forward in interface ExtWebDriver
  - refresh
```
public void refresh()
```
    Description copied from interface: ExtWebDriver
    
    Reloads the current URL
    
    Specified by:
    
    refresh in interface ExtWebDriver
  - storeCurrentWindowIds
```
public void storeCurrentWindowIds()
```
    Description copied from interface: ExtWebDriver
    
    Stores handles for all existing windows for later comparison
    
    Specified by:
    
    storeCurrentWindowIds in interface ExtWebDriver
    
    See Also:
    
    ExtWebDriver.selectPopupWindow()
  - focus
```
public void focus()
```
    Description copied from interface: ExtWebDriver
    
    Request focus for the active window with the current WebDriver
    
    Specified by:
    
    focus in interface ExtWebDriver
  - selectWindow
```
public void selectWindow(String windowId)
```
    Description copied from interface: ExtWebDriver
    
    Sets the active window for the current WebDriver
    
    Specified by:
    
    selectWindow in interface ExtWebDriver
    
    Parameters:
    
    windowId - the window id string
  - selectPopupWindow
```
public String selectPopupWindow()
                         throws ExtWebDriver.StaleWindowIdListException
```
    Description copied from interface: ExtWebDriver
    
    Sets the most recently opened browser window as the active windwo for the current WebDriver. Assumes that ExtWebDriver.storeCurrentWindowIds() was called before the window opened and that only one window has opened since.
    
    Specified by:
    
    selectPopupWindow in interface ExtWebDriver
    
    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
```
public String[] getAllWindowIds()
```
    Description copied from interface: ExtWebDriver
    
    Retrieves the windowHandle IDs
    
    Specified by:
    
    getAllWindowIds in interface ExtWebDriver
    
    Returns:
    
    array of current window ids
  - getWindowId
```
public String getWindowId()
```
    Returns the current window handle ID
    
    Specified by:
    
    getWindowId in interface ExtWebDriver
    
    Returns:
    
    the window handle ID
  - currentWindowMaximize
```
public void currentWindowMaximize()
```
    Maximizes the browser window
    
    Specified by:
    
    currentWindowMaximize in interface ExtWebDriver
  - windowScroll
```
public void windowScroll(int i,
                         int j)
```
    Scrolls the current browser window to specific position
    
    Specified by:
    
    windowScroll in interface ExtWebDriver
    
    Parameters:
    
    i - Horizontal position
    
    j - Vertical position
  - windowScrollBy
```
public void windowScrollBy(int i,
                           int j)
```
    Scrolls the current browser by specific amount
    
    Specified by:
    
    windowScrollBy in interface ExtWebDriver
    
    Parameters:
    
    i - Horizontal scroll amount
    
    j - Vertical scroll amount
  - eval
```
public void eval(String javaScript)
```
    Description copied from interface: ExtWebDriver
    
    Executes JavaScript
    
    Specified by:
    
    eval in interface ExtWebDriver
    
    Parameters:
    
    javaScript - the script to execute
  - getHtmlSource
```
public String getHtmlSource()
```
    Description copied from interface: ExtWebDriver
    
    Returns the original HTML source of the current frame
    
    Specified by:
    
    getHtmlSource in interface ExtWebDriver
    
    Returns:
    
    original HTML source of the current frame
  - getGeneratedHtmlSource
```
public Map<String,String> getGeneratedHtmlSource()
```
    Description copied from interface: ExtWebDriver
    
    Retrieves current state of the DOM in HTML format for each of the document's frames.
    
    Specified by:
    
    getGeneratedHtmlSource in interface ExtWebDriver
    
    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
```
public void selectFrame(IElement element)
                 throws Exception
```
    Description copied from interface: ExtWebDriver
    
    Selects a new frame from within the current frame
    
    Specified by:
    
    selectFrame in interface ExtWebDriver
    
    Parameters:
    
    element - the object representing the iframe element to select
    
    Throws:
    
    Exception
  - unselectFrame
```
public void unselectFrame()
```
    Selects the top most frame
    
    Specified by:
    
    unselectFrame in interface ExtWebDriver
  - selectLastFrame
```
public void selectLastFrame()
```
    Description copied from interface: ExtWebDriver
    
    Selects the previously selected frame
    
    Specified by:
    
    selectLastFrame in interface ExtWebDriver
  - evaluateXpath
```
public String evaluateXpath(String xpath)
                     throws Exception
```
    Description copied from interface: ExtWebDriver
    
    Evaluates an XPath in JavaScript to return a string value based on the resulting node(s) or XPath function results
    
    Specified by:
    
    evaluateXpath in interface ExtWebDriver
    
    Parameters:
    
    xpath - the XPath to evaluate
    
    Returns:
    
    the string value representing the XPath
    
    Throws:
    
    Exception - if the evaluation of the XPath fails
  - confirmNativeDialog
```
public void confirmNativeDialog()
                         throws Exception
```
    Description copied from interface: ExtWebDriver
    
    Clicks ok on the open alert dialog OR confirmation dialog attached to the current window
    
    Specified by:
    
    confirmNativeDialog in interface ExtWebDriver
    
    Throws:
    
    Exception - if the native dialog does not exist
  - cancelNativeDialog
```
public void cancelNativeDialog()
```
    Description copied from interface: ExtWebDriver
    
    Clicks cancel on the open confirmation dialog attached to the current window
    
    Specified by:
    
    cancelNativeDialog in interface ExtWebDriver
  - getNativeDialogText
```
public String getNativeDialogText()
```
    Description copied from interface: ExtWebDriver
    
    Retrieves the text of the open native dialog attached to the current window
    
    Specified by:
    
    getNativeDialogText in interface ExtWebDriver
    
    Returns:
    
    the dialog text
  - getBrowserName
```
public String getBrowserName()
```
    Description copied from interface: ExtWebDriver
    
    Retrieves the name of the browser currently being operated by the webdriver
    
    Specified by:
    
    getBrowserName in interface ExtWebDriver
    
    Returns:
    
    the browser name
  - getBrowserVersion
```
public String getBrowserVersion()
```
    Description copied from interface: ExtWebDriver
    
    Retrieves the version of the browser currently being operated by the webdriver
    
    Specified by:
    
    getBrowserVersion in interface ExtWebDriver
    
    Returns:
    
    the browser version
  - findElement
```
public org.openqa.selenium.WebElement findElement(org.openqa.selenium.By arg0)
```
    Specified by:
    
    findElement in interface org.openqa.selenium.SearchContext
    
    Specified by:
    
    findElement in interface org.openqa.selenium.WebDriver
  - findElements
```
public List<org.openqa.selenium.WebElement> findElements(org.openqa.selenium.By arg0)
```
    Specified by:
    
    findElements in interface org.openqa.selenium.SearchContext
    
    Specified by:
    
    findElements in interface org.openqa.selenium.WebDriver
  - get
```
public void get(String arg0)
```
    Specified by:
    
    get in interface org.openqa.selenium.WebDriver
  - getCurrentUrl
```
public String getCurrentUrl()
```
    Specified by:
    
    getCurrentUrl in interface org.openqa.selenium.WebDriver
  - getPageSource
```
public String getPageSource()
```
    Specified by:
    
    getPageSource in interface org.openqa.selenium.WebDriver
  - getTitle
```
public String getTitle()
```
    Specified by:
    
    getTitle in interface org.openqa.selenium.WebDriver
  - getWindowHandle
```
public String getWindowHandle()
```
    Specified by:
    
    getWindowHandle in interface org.openqa.selenium.WebDriver
  - getWindowHandles
```
public Set<String> getWindowHandles()
```
    Specified by:
    
    getWindowHandles in interface org.openqa.selenium.WebDriver
  - manage
```
public org.openqa.selenium.WebDriver.Options manage()
```
    Specified by:
    
    manage in interface org.openqa.selenium.WebDriver
  - navigate
```
public org.openqa.selenium.WebDriver.Navigation navigate()
```
    Specified by:
    
    navigate in interface org.openqa.selenium.WebDriver
  - quit
```
public void quit()
```
    Specified by:
    
    quit in interface org.openqa.selenium.WebDriver
  - switchTo
```
public org.openqa.selenium.WebDriver.TargetLocator switchTo()
```
    Specified by:
    
    switchTo in interface org.openqa.selenium.WebDriver
  - setMaxRequestTimeout
```
public void setMaxRequestTimeout(String timeout)
```
    Description copied from interface: ExtWebDriver
    
    Sets the maximum timeout value for actions
    
    Specified by:
    
    setMaxRequestTimeout in interface ExtWebDriver
    
    Parameters:
    
    timeout - String representation milliseconds
  - getMaxRequestTimeout
```
public long getMaxRequestTimeout()
```
    Description copied from interface: ExtWebDriver
    
    Gets the timeout used by default when waiting on actions
    
    Specified by:
    
    getMaxRequestTimeout in interface ExtWebDriver
    
    Returns:
    
    the default max request timeout
  - getWrappedDriver
```
public org.openqa.selenium.WebDriver getWrappedDriver()
```
    Description copied from interface: ExtWebDriver
    
    Gets the underlying WebDriver instance
    
    Specified by:
    
    getWrappedDriver in interface ExtWebDriver
    
    Returns:
    
    the current WebDriver
  - getXpathCount
```
public int getXpathCount(String string)
```
    Description copied from interface: ExtWebDriver
    
    Returns the count of nodes that would be returned by an XPath expression
    
    Specified by:
    
    getXpathCount in interface ExtWebDriver
    
    Parameters:
    
    string - the XPAth expression to count
    
    Returns:
    
    the number of nodes which match
  - setSessionId
```
public void setSessionId(String id)
```
    Description copied from interface: ExtWebDriver
    
    Sets the current session to be used for all actions on ExtWebDdriver and Widgets
    
    Specified by:
    
    setSessionId in interface ExtWebDriver
    
    Parameters:
    
    id - the identifier for the session
  - getSessionId
```
public String getSessionId()
```
    Description copied from interface: ExtWebDriver
    
    Gets the id of the current session
    
    Specified by:
    
    getSessionId in interface ExtWebDriver
    
    Returns:
    
    the identifier for the session

Class DefaultExtWebDriver

Nested Class Summary

Nested classes/interfaces inherited from interface org.finra.jtaf.ewd.ExtWebDriver

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultExtWebDriver

Method Detail

setWrappedDriver

setClientProperties

setTypeMode

isJavascriptTypeMode

setClickMode

isJavascriptClickMode

setFocusOnClick

isFocusOnClick

setIsHighlight

isHighlight

setHighlightColors

getHighlightColor

open

back

closeCurrentBrowser

close

forward

refresh

storeCurrentWindowIds

focus

selectWindow

selectPopupWindow

getAllWindowIds

getWindowId

currentWindowMaximize

windowScroll

windowScrollBy

eval

getHtmlSource

getGeneratedHtmlSource

selectFrame

unselectFrame

selectLastFrame

evaluateXpath

confirmNativeDialog

cancelNativeDialog

getNativeDialogText

getBrowserName

getBrowserVersion

findElement

findElements

get

getCurrentUrl

getPageSource

getTitle

getWindowHandle

getWindowHandles

manage

navigate

quit

switchTo

setMaxRequestTimeout

getMaxRequestTimeout

getWrappedDriver

getXpathCount

setSessionId

getSessionId