SeleniumWComponentsWebDriver (wcomponents-test-lib 1.5.1 API)

java.lang.Object
- com.github.bordertech.wcomponents.test.selenium.driver.SeleniumWComponentsWebDriver<T>

Type Parameters:

T - - the type of backing WebDriver class.

All Implemented Interfaces:

org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebDriver
```
public class SeleniumWComponentsWebDriver<T extends org.openqa.selenium.WebDriver>
extends Object
implements org.openqa.selenium.WebDriver, org.openqa.selenium.TakesScreenshot
```
WComponent utility class to wrap a Selenium WebDriver.

This class will automatically wait for the WComponents UI to finish loading (including JavaScript and AJAX) where appropriate.

Since:

1.2.0

Author:

Joshua Barclay, Mark Reeves

Nested Class Summary
- 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
`SeleniumWComponentsWebDriver()` No-arg constructor to support creation via other frameworks.
`SeleniumWComponentsWebDriver(T driver)` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearUserContext()` Clear the user context on the session.
`void`	`close()` .
`SeleniumWComponentWebElement`	`findElement(org.openqa.selenium.By by)` .
`SeleniumWComponentWebElement`	`findElement(org.openqa.selenium.By by, boolean pageWait)`
`SeleniumWComponentWebElement`	`findElement(ByWComponent by)` Find a WComponent that was created in the same JVM as the servlet.
`SeleniumWComponentWebElement`	`findElement(ByWComponent by, boolean pageWait)` Find a WComponent that was created in the same JVM as the servlet.
`SeleniumWComponentWebElement`	`findElementImmediate(org.openqa.selenium.By by)` Find immediate with no polling.
`List<org.openqa.selenium.WebElement>`	`findElements(org.openqa.selenium.By by)` .
`List<org.openqa.selenium.WebElement>`	`findElements(org.openqa.selenium.By by, boolean pageWait)`
`List<org.openqa.selenium.WebElement>`	`findElements(ByWComponent by)` Find WComponents that were created in the same JVM as the servlet.
`List<org.openqa.selenium.WebElement>`	`findElements(ByWComponent by, boolean pageWait)` Find WComponents that were created in the same JVM as the servlet.
`List<org.openqa.selenium.WebElement>`	`findElementsImmediate(org.openqa.selenium.By by)` Find immediate with no polling.
`SeleniumWCheckBoxWebElement`	`findWCheckBox(org.openqa.selenium.By by)` Find a WCheckBox by the given criteria.
`SeleniumWCheckBoxSelectWebElement`	`findWCheckBoxSelect(org.openqa.selenium.By by)` Find a WCheckBoxSelect by the given criteria.
`SeleniumWSelectWebElement`	`findWDropdown(org.openqa.selenium.By by)` Find a WDropdown by the given criteria.
`SeleniumWEmailFieldWebElement`	`findWEmailField(org.openqa.selenium.By by)` Find a WEmailField by the given criteria.
`SeleniumWLabelWebElement`	`findWLabel(org.openqa.selenium.By by)` Find a WLabel by the given criteria.
`SeleniumWLabelWebElement`	`findWLabelWithPartialText(String text)` Find a WLabel containing given text.
`SeleniumWLabelWebElement`	`findWLabelWithPartialText(String text, int idx)` Find a WLabel containing given text.
`SeleniumWMessageBoxWebElement`	`findWMessageBox(org.openqa.selenium.By by)` Find a WMessageBox by the given criteria.
`SeleniumWMessagesWebElement`	`findWMessages(org.openqa.selenium.By by)` Find a WMessages by the given criteria.
`SeleniumWMultiDropdownWebElement`	`findWMultiDropdown(org.openqa.selenium.By by)` Fins a WMultiDropdown by the given criteria.
`SeleniumWSelectWebElement`	`findWMultiSelect(org.openqa.selenium.By by)` Find a WMultiSelect by the given criteria.
`SeleniumWMultiSelectPairWebElement`	`findWMultiSelectPair(org.openqa.selenium.By by)` Find a WMultiSelectPair by the given criteria.
`SeleniumWPhoneNumberFieldWebElement`	`findWPhoneNumberField(org.openqa.selenium.By by)` Find a WEmailField by the given criteria.
`SeleniumWRadioButtonWebElement`	`findWRadioButton(org.openqa.selenium.By by)` Find a WRadioButton by the given criteria.
`SeleniumWRadioButtonSelectWebElement`	`findWRadioButtonSelect(org.openqa.selenium.By by)` Find a WRadioButtonSelect by the given criteria.
`SeleniumWSelectWebElement`	`findWSingleSelect(org.openqa.selenium.By by)` Find a WSingleSelect by the given criteria.
`SeleniumWTableWebElement`	`findWTable(org.openqa.selenium.By by)` Find a WTable by the given criteria.
`SeleniumWTextAreaWebElement`	`findWTextArea(org.openqa.selenium.By by)` Find a WTextArea by the given criteria.
`SeleniumWTextFieldWebElement`	`findWTextField(org.openqa.selenium.By by)` Find a WTextField by the given criteria.
`void`	`get(String url)` .
`String`	`getCurrentUrl()` .
`SeleniumWDialogWebElement`	`getDialog()` Get the dialog.
`T`	`getDriver()` Directly expose the driver for any special APIs.
`String`	`getPageSource()` .
`<X> X`	`getScreenshotAs(org.openqa.selenium.OutputType<X> target)` Capture a screenshot if the backing driver supports it.
`String`	`getSessionId()`
`String`	`getTitle()` .
`UIContext`	`getUserContextForSession()`
`String`	`getWindowHandle()` .
`Set<String>`	`getWindowHandles()` .
`boolean`	`hasSession()`
`boolean`	`isOpenDialog()` Is there an open dialog on the screen?
`org.openqa.selenium.WebDriver.Options`	`manage()` .
`org.openqa.selenium.WebDriver.Navigation`	`navigate()` .
`org.openqa.selenium.WebDriver.Navigation`	`navigate(boolean wait)` Navigate with an option to wait for the current page to be ready first.
`void`	`newSession()` Start a new session, using the current URL.
`void`	`newSession(String url)` Start a new session with the given URL.
`void`	`quit()` .
`org.openqa.selenium.WebDriver.TargetLocator`	`switchTo()` .
`org.openqa.selenium.WebDriver.TargetLocator`	`switchTo(boolean wait)` Call switchTo after an optional check of pageReady.
`void`	`waitForPageReady()` Wait until the page is fully loaded (including AJAX and timers).
`protected SeleniumWComponentWebElement`	`wrapElement(org.openqa.selenium.WebElement element)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SeleniumWComponentsWebDriver
```
public SeleniumWComponentsWebDriver()
```
    No-arg constructor to support creation via other frameworks.
    
    This implementation will be backed by the driver implementation configured in ParameterizedWebDriverType
  - SeleniumWComponentsWebDriver
```
public SeleniumWComponentsWebDriver(T driver)
```
    Default constructor.
    
    Parameters:
    
    driver - the backing web driver.
- Method Detail
  - newSession
```
public void newSession()
```
    Start a new session, using the current URL. For WComponents application this should reload the first page.
  - hasSession
```
public boolean hasSession()
```
    Returns:
    
    true if an active session exists, else false.
  - newSession
```
public void newSession(String url)
```
    Start a new session with the given URL.
    
    Parameters:
    
    url - the URL of the page to load.
  - getSessionId
```
public String getSessionId()
```
    Returns:
    
    the session ID for the driver, or null if no session.
  - getDriver
```
public T getDriver()
```
    Directly expose the driver for any special APIs.
    
    Returns:
    
    the actual backing driver implementation.
  - waitForPageReady
```
public void waitForPageReady()
```
    Wait until the page is fully loaded (including AJAX and timers).
  - isOpenDialog
```
public boolean isOpenDialog()
```
    Is there an open dialog on the screen?
    
    Returns:
    
    true if an open dialog exists, else false.
  - getDialog
```
public SeleniumWDialogWebElement getDialog()
```
    Get the dialog.
    
    Returns:
    
    the dialog component.
  - get
```
public void get(String url)
```
    .
    
    Specified by:
    
    get in interface org.openqa.selenium.WebDriver
  - getCurrentUrl
```
public String getCurrentUrl()
```
    .
    
    Specified by:
    
    getCurrentUrl in interface org.openqa.selenium.WebDriver
  - getTitle
```
public String getTitle()
```
    .
    
    Specified by:
    
    getTitle in interface org.openqa.selenium.WebDriver
  - findWTextArea
```
public SeleniumWTextAreaWebElement findWTextArea(org.openqa.selenium.By by)
```
    Find a WTextArea by the given criteria.
    
    Parameters:
    
    by - the By selector.
    
    Returns:
    
    the SeleniumWTextAreaWebElement or null if not found.
  - findWTextField
```
public SeleniumWTextFieldWebElement findWTextField(org.openqa.selenium.By by)
```
    Find a WTextField by the given criteria.
    
    Parameters:
    
    by - the By selector.
    
    Returns:
    
    the SeleniumWTextFieldWebElement or null if not found.
  - findWEmailField
```
public SeleniumWEmailFieldWebElement findWEmailField(org.openqa.selenium.By by)
```
    Find a WEmailField by the given criteria.
    
    Parameters:
    
    by - the By selector.
    
    Returns:
    
    the SeleniumWEmailFieldWebElement or null if not found.
  - findWPhoneNumberField
```
public SeleniumWPhoneNumberFieldWebElement findWPhoneNumberField(org.openqa.selenium.By by)
```
    Find a WEmailField by the given criteria.
    
    Parameters:
    
    by - the By selector.
    
    Returns:
    
    the SeleniumWPhoneNumberFieldWebElement or null if not found.
  - findWTable
```
public SeleniumWTableWebElement findWTable(org.openqa.selenium.By by)
```
    Find a WTable by the given criteria.
    
    Parameters:
    
    by - the By selector.
    
    Returns:
    
    the SeleniumWTableWebElement or null if not found.
  - findWCheckBox
```
public SeleniumWCheckBoxWebElement findWCheckBox(org.openqa.selenium.By by)
```
    Find a WCheckBox by the given criteria.
    
    Parameters:
    
    by - the By selector
    
    Returns:
    
    the SeleniumWCheckBoxWebElement or null if not found.
  - findWRadioButton
```
public SeleniumWRadioButtonWebElement findWRadioButton(org.openqa.selenium.By by)
```
    Find a WRadioButton by the given criteria.
    
    Parameters:
    
    by - the By selector
    
    Returns:
    
    the SeleniumWRadioButtonWebElement or null if not found.
  - findWRadioButtonSelect
```
public SeleniumWRadioButtonSelectWebElement findWRadioButtonSelect(org.openqa.selenium.By by)
```
    Find a WRadioButtonSelect by the given criteria.
    
    Parameters:
    
    by - the By selector
    
    Returns:
    
    the SeleniumWRadioButtonSelectWebElement or null if not found.
  - findWDropdown
```
public SeleniumWSelectWebElement findWDropdown(org.openqa.selenium.By by)
```
    Find a WDropdown by the given criteria.
    
    Parameters:
    
    by - the By selector
    
    Returns:
    
    the SeleniumWRadioButtonWebElement or null if not found.
  - findWSingleSelect
```
public SeleniumWSelectWebElement findWSingleSelect(org.openqa.selenium.By by)
```
    Find a WSingleSelect by the given criteria.
    
    Parameters:
    
    by - the By selector
    
    Returns:
    
    the SeleniumWRadioButtonWebElement or null if not found.
  - findWMessages
```
public SeleniumWMessagesWebElement findWMessages(org.openqa.selenium.By by)
```
    Find a WMessages by the given criteria.
    
    Parameters:
    
    by - the By selector
    
    Returns:
    
    the SeleniumWMessagesWebElement
  - findWMessageBox
```
public SeleniumWMessageBoxWebElement findWMessageBox(org.openqa.selenium.By by)
```
    Find a WMessageBox by the given criteria.
    
    Parameters:
    
    by - the By selector
    
    Returns:
    
    the SeleniumWMessageBoxWebElement
  - findWMultiDropdown
```
public SeleniumWMultiDropdownWebElement findWMultiDropdown(org.openqa.selenium.By by)
```
    Fins a WMultiDropdown by the given criteria.
    
    Parameters:
    
    by - the By selector
    
    Returns:
    
    the SeleniumWMultiDropdownWebElement
  - findWMultiSelect
```
public SeleniumWSelectWebElement findWMultiSelect(org.openqa.selenium.By by)
```
    Find a WMultiSelect by the given criteria.
    
    Parameters:
    
    by - the By selector
    
    Returns:
    
    the SeleniumWRadioButtonWebElement
  - findWMultiSelectPair
```
public SeleniumWMultiSelectPairWebElement findWMultiSelectPair(org.openqa.selenium.By by)
```
    Find a WMultiSelectPair by the given criteria.
    
    Parameters:
    
    by - the By selector
    
    Returns:
    
    the SeleniumWMultiSelectPairWebElement
  - findWLabel
```
public SeleniumWLabelWebElement findWLabel(org.openqa.selenium.By by)
```
    Find a WLabel by the given criteria.
    
    Parameters:
    
    by - the By selector
    
    Returns:
    
    the SeleniumWLabelWebElement
  - findWCheckBoxSelect
```
public SeleniumWCheckBoxSelectWebElement findWCheckBoxSelect(org.openqa.selenium.By by)
```
    Find a WCheckBoxSelect by the given criteria.
    
    Parameters:
    
    by - the By selector
    
    Returns:
    
    the SeleniumWCheckBoxSelectWebElement
  - findWLabelWithPartialText
```
public SeleniumWLabelWebElement findWLabelWithPartialText(String text,
                                                          int idx)
```
    Find a WLabel containing given text.
    
    Parameters:
    
    text - the text in the label
    
    idx - the index to apply the selector to get the nth label when there are multiple on a page
    
    Returns:
    
    the label containing the text (if found) at the given index
  - findWLabelWithPartialText
```
public SeleniumWLabelWebElement findWLabelWithPartialText(String text)
```
    Find a WLabel containing given text.
    
    Parameters:
    
    text - the text in the label
    
    Returns:
    
    the label containing the text
  - findElementImmediate
```
public SeleniumWComponentWebElement findElementImmediate(org.openqa.selenium.By by)
```
    Find immediate with no polling.
    
    Parameters:
    
    by - the by condition
    
    Returns:
    
    the matching element
  - findElementsImmediate
```
public List<org.openqa.selenium.WebElement> findElementsImmediate(org.openqa.selenium.By by)
```
    Find immediate with no polling.
    
    Parameters:
    
    by - the by condition
    
    Returns:
    
    the matching element
  - findElements
```
public List<org.openqa.selenium.WebElement> findElements(org.openqa.selenium.By by)
```
    .
    
    Specified by:
    
    findElements in interface org.openqa.selenium.SearchContext
    
    Specified by:
    
    findElements in interface org.openqa.selenium.WebDriver
  - findElements
```
public List<org.openqa.selenium.WebElement> findElements(org.openqa.selenium.By by,
                                                         boolean pageWait)
```
    Parameters:
    
    by - the by condition
    
    pageWait - true if do wait for page ready before doing find
    
    Returns:
    
    the list of matching web elements
  - findElement
```
public SeleniumWComponentWebElement findElement(org.openqa.selenium.By by)
```
    .
    
    Specified by:
    
    findElement in interface org.openqa.selenium.SearchContext
    
    Specified by:
    
    findElement in interface org.openqa.selenium.WebDriver
  - findElement
```
public SeleniumWComponentWebElement findElement(org.openqa.selenium.By by,
                                                boolean pageWait)
```
    Parameters:
    
    by - the match
    
    pageWait - true if wait for page ready before do find
    
    Returns:
    
    the matching element
  - findElements
```
public List<org.openqa.selenium.WebElement> findElements(ByWComponent by)
```
    Find WComponents that were created in the same JVM as the servlet.
    
    This method requires that SeleniumLauncher (or subclass) was used to launch the server.
    
    Parameters:
    
    by - the ByWcomponent to find.
    
    Returns:
    
    the matching WebElement.
  - findElements
```
public List<org.openqa.selenium.WebElement> findElements(ByWComponent by,
                                                         boolean pageWait)
```
    Find WComponents that were created in the same JVM as the servlet.
    
    This method requires that SeleniumLauncher (or subclass) was used to launch the server.
    
    Parameters:
    
    by - the ByWcomponent to find.
    
    pageWait - true if wait for page ready before do find
    
    Returns:
    
    the matching WebElement.
  - findElement
```
public SeleniumWComponentWebElement findElement(ByWComponent by)
```
    Find a WComponent that was created in the same JVM as the servlet.
    
    This method requires that SeleniumLauncher (or subclass) was used to launch the server.
    
    Parameters:
    
    by - the ByWcomponent to find.
    
    Returns:
    
    the matching WebElement.
  - findElement
```
public SeleniumWComponentWebElement findElement(ByWComponent by,
                                                boolean pageWait)
```
    Find a WComponent that was created in the same JVM as the servlet.
    
    This method requires that SeleniumLauncher (or subclass) was used to launch the server.
    
    Parameters:
    
    by - the ByWcomponent to find.
    
    pageWait - true if wait for page ready before do find
    
    Returns:
    
    the matching WebElement.
  - getPageSource
```
public String getPageSource()
```
    .
    
    Specified by:
    
    getPageSource in interface org.openqa.selenium.WebDriver
  - close
```
public void close()
```
    .
    
    Specified by:
    
    close in interface org.openqa.selenium.WebDriver
  - quit
```
public void quit()
```
    .
    
    Specified by:
    
    quit in interface org.openqa.selenium.WebDriver
  - getWindowHandles
```
public Set<String> getWindowHandles()
```
    .
    
    Specified by:
    
    getWindowHandles in interface org.openqa.selenium.WebDriver
  - getWindowHandle
```
public String getWindowHandle()
```
    .
    
    Specified by:
    
    getWindowHandle in interface org.openqa.selenium.WebDriver
  - switchTo
```
public org.openqa.selenium.WebDriver.TargetLocator switchTo(boolean wait)
```
    Call switchTo after an optional check of pageReady.
    
    Parameters:
    
    wait - if true wait for pageReady before switching
    
    Returns:
    
    the TargetLocator
  - navigate
```
public org.openqa.selenium.WebDriver.Navigation navigate(boolean wait)
```
    Navigate with an option to wait for the current page to be ready first.
    
    Parameters:
    
    wait - if true wait for pageReady before navigating
    
    Returns:
    
    the Navigation
  - switchTo
```
public org.openqa.selenium.WebDriver.TargetLocator switchTo()
```
    .
    
    Specified by:
    
    switchTo in interface org.openqa.selenium.WebDriver
  - navigate
```
public org.openqa.selenium.WebDriver.Navigation navigate()
```
    .
    
    Specified by:
    
    navigate in interface org.openqa.selenium.WebDriver
  - manage
```
public org.openqa.selenium.WebDriver.Options manage()
```
    .
    
    Specified by:
    
    manage in interface org.openqa.selenium.WebDriver
  - getScreenshotAs
```
public <X> X getScreenshotAs(org.openqa.selenium.OutputType<X> target)
```
    Capture a screenshot if the backing driver supports it.
    
    IMPORTANT: This function will log warnings and return null if a screenshot cannot be captured.
    
    Specified by:
    
    getScreenshotAs in interface org.openqa.selenium.TakesScreenshot
    
    Type Parameters:
    
    X - - the output type.
    
    Parameters:
    
    target - - the target output type
    
    Returns:
    
    the screenshot from the driver if captured, or null if an error occurs.
  - getUserContextForSession
```
public UIContext getUserContextForSession()
```
    Returns:
    
    the user context for this session
  - clearUserContext
```
public void clearUserContext()
```
    Clear the user context on the session.
  - wrapElement
```
protected SeleniumWComponentWebElement wrapElement(org.openqa.selenium.WebElement element)
```
    Parameters:
    
    element - the element to wrap
    
    Returns:
    
    the element wrapped as SeleniumWComponentWebElement

Class SeleniumWComponentsWebDriver<T extends org.openqa.selenium.WebDriver>

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SeleniumWComponentsWebDriver

SeleniumWComponentsWebDriver

Method Detail

newSession

hasSession

newSession

getSessionId

getDriver

waitForPageReady

isOpenDialog

getDialog

get

getCurrentUrl

getTitle

findWTextArea

findWTextField

findWEmailField

findWPhoneNumberField

findWTable

findWCheckBox

findWRadioButton

findWRadioButtonSelect

findWDropdown

findWSingleSelect

findWMessages

findWMessageBox

findWMultiDropdown

findWMultiSelect

findWMultiSelectPair

findWLabel

findWCheckBoxSelect

findWLabelWithPartialText

findWLabelWithPartialText

findElementImmediate

findElementsImmediate

findElements

findElements

findElement

findElement

findElements

findElements

findElement

findElement

getPageSource

close

quit

getWindowHandles

getWindowHandle

switchTo

navigate

switchTo

navigate

manage

getScreenshotAs

getUserContextForSession

clearUserContext

wrapElement