WebDriverTestingEngineImpl (JWebUnit 3.3 API)

java.lang.Object
- net.sourceforge.jwebunit.webdriver.WebDriverTestingEngineImpl

All Implemented Interfaces:

ITestingEngine
```
public class WebDriverTestingEngineImpl
extends Object
implements ITestingEngine
```
Acts as the wrapper for Webdriver access. A testing engine is initialized with a given URL, and maintains conversational state as the dialog progresses through link navigation, form submission, etc.

Author:

Julien Henry

Constructor Summary

Constructors
Constructor and Description

WebDriverTestingEngineImpl()

Constructors
Constructor and Description
`WebDriverTestingEngineImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`beginAt(URL aInitialURL, TestContext aTestContext)` Open the browser at an initial URL.
`void`	`checkCheckbox(String checkBoxName)` Select a specified checkbox.
`void`	`checkCheckbox(String checkBoxName, String checkBoxValue)` Select a specified checkbox.
`void`	`clickButton(String buttonId)` Click the indicated button.
`void`	`clickButtonWithText(String buttonValueText)` Clicks a button with `text` of the value attribute.
`void`	`clickElementByXPath(String xpath)` Click element with given xpath.
`void`	`clickLink(String anID)` Navigate by submitting a request based on a link with a given ID.
`void`	`clickLinkWithExactText(String linkText, int index)` Navigate by clicking a link with the exact specified text.
`void`	`clickLinkWithImage(String imageFileName, int index)` Navigate by submitting a request based on a link with a given image file name.
`void`	`clickLinkWithText(String linkText, int index)` Navigate by submitting a request based on a link containing the specified text.
`void`	`clickRadioOption(String radioGroup, String radioOptionValue)` Clicks a radio option.
`void`	`closeBrowser()` Close the browser and check if there is no pending Javascript alert, confirm or prompt.
`void`	`closeWindow()` Close the current window.
`protected String`	`escapeQuotes(String toEscape)` Copied from `Select`
`protected String`	`formSelector()`
`Map<String,String>`	`getAllHeaders()` Get all distinct response headers.
`List<String>`	`getComments()` Get all the comments in a document, as a list of strings.
`List<javax.servlet.http.Cookie>`	`getCookies()` Get all cookies.
`String`	`getElementAttributByXPath(String xpath, String attribut)` Get attribut value of the given element.
`IElement`	`getElementByID(String id)` Get an element wrapper for a given ID.
`IElement`	`getElementByXPath(String xpath)` Get an element wrapper for a given xpath.
`List<IElement>`	`getElementsByXPath(String xpath)` Get a list of all elements that match the given xpath.
`String`	`getElementTextByXPath(String xpath)` Get text of the given element.
`String`	`getHeader(String name)` Get a particular header or null.
`String`	`getHiddenFieldValue(String paramName)` Return the current value of a hidden input element with name `paramName`.
`InputStream`	`getInputStream()` Gets the last server response as input stream.
`InputStream`	`getInputStream(URL url)` Gets the input stream for a given URL - can be used to test images or other resources without changing the current navigation context.
`String`	`getPageSource()` Return the source of the current page (like in a browser).
`String`	`getPageText()` Return the string representation of the current page, encoded as specified by the current `TestContext`.
`String`	`getPageTitle()` Return the page title of the current response page, encoded as specified by the current `TestContext`.
`URL`	`getPageURL()` Get the location of the current page.
`List<HttpHeader>`	`getResponseHeaders()` Get all response headers.
`String[]`	`getSelectedOptions(String selectName)` Return the values of the currently selected items in a select box.
`String[]`	`getSelectedOptions(String selectName, int index)` Return the values of the currently selected items in the Nth select box with the provided name.
`String`	`getSelectedRadio(String radioGroup)` Return the currently selected radio button.
`String`	`getSelectOptionLabelForValue(String selectName, int index, String optionValue)` Get the label for a given option of the Nth select box with the specified name.
`String`	`getSelectOptionLabelForValue(String selectName, String optionValue)` Get the label for a given option of a select box.
`String`	`getSelectOptionValueForLabel(String selectName, int index, String optionLabel)` Get the value for a given option of the Nth select box with the specified name.
`String`	`getSelectOptionValueForLabel(String selectName, String optionLabel)` Get the value for a given option of a select box.
`String[]`	`getSelectOptionValues(String selectName)` Return a string array of select box option values.
`String[]`	`getSelectOptionValues(String selectName, int index)` Return a string array of option values for the Nth select box with the specified name.
`String`	`getServerResponse()` Return the response of the server for the current page.
`int`	`getServerResponseCode()` Get the request response code.
`Table`	`getTable(String tableSummaryNameOrId)` Each framework have it's own way to represent a Table.
`String`	`getTextFieldValue(String paramName)` Return the current value of a text field with name `paramName`.
`int`	`getWindowCount()` Get the number of opened Windows.
`void`	`gotoFrame(String frameNameOrId)` Make the frame with the given name or ID active in the current conversation.
`void`	`gotoPage(URL url)` Simulate user typing a new URL in the browser.
`void`	`gotoRootWindow()` Make the root window active.
`void`	`gotoWindow(int windowID)` Goto window with the given Javascript ID.
`void`	`gotoWindow(String windowName)` Make the window with the given name active.
`void`	`gotoWindowByTitle(String title)` Goto first window with the given title.
`boolean`	`hasButton(String buttonId)` Checks if a button with `id` is present.
`boolean`	`hasButtonWithText(String text)` Checks if a button with `text` is present.
`boolean`	`hasElement(String anID)` Test if element with given id exists.
`boolean`	`hasElementByXPath(String xpath)` Test if element with given xpath exists.
`boolean`	`hasForm()` Check whether the current page contains a form.
`boolean`	`hasForm(String nameOrID)` Return true if the current page contains a specific form.
`boolean`	`hasForm(String nameOrID, int index)` Return true if the current page contains a specific form.
`boolean`	`hasFormParameterNamed(String paramName)` Return true if a form input element is present on the current form.
`boolean`	`hasFrame(String frameNameOrId)` Test if the given frame is present.
`boolean`	`hasLink(String anId)` Return true if a link is present in the current response with the specified id.
`boolean`	`hasLinkWithExactText(String linkText, int index)` Return true if a link is present in the current page containing the exact specified text.
`boolean`	`hasLinkWithImage(String imageFileName, int index)` Return true if a link is present with a given image based on filename of image.
`boolean`	`hasLinkWithText(String linkText, int index)` Return true if a link is present in the current response containing the specified text.
`boolean`	`hasRadioOption(String radioGroup, String radioOptionValue)` Checks if a radio group contains the indicated option.
`boolean`	`hasResetButton()` Checks if the current form contains a reset button.
`boolean`	`hasResetButton(String nameOrID)` Checks if the current form contains a specific reset button.
`boolean`	`hasSelectOption(String selectName, int index, String optionLabel)` Test if the Nth select box has the given option (by label).
`boolean`	`hasSelectOption(String selectName, String optionLabel)` Test if a select box has the given option (by label).
`boolean`	`hasSelectOptionValue(String selectName, int index, String optionValue)` Test if the Nth select box has the given option (by value).
`boolean`	`hasSelectOptionValue(String selectName, String optionValue)` Test if a select box has the given option (by value).
`boolean`	`hasSubmitButton()` Checks if the current form contains a submit button.
`boolean`	`hasSubmitButton(String nameOrID)` Checks if the current form contains a specific submit button.
`boolean`	`hasSubmitButton(String nameOrID, String value)` Checks if the current form contains a specific submit button.
`boolean`	`hasTable(String tableSummaryNameOrId)` Check if the Table object representing a specified table exists.
`boolean`	`hasWindow(String windowName)` Test if the window with the given name is present.
`boolean`	`hasWindowByTitle(String windowTitle)` Test if window with the given title is present.
`boolean`	`isCheckboxSelected(String checkBoxName)` Determines if the checkbox is selected.
`boolean`	`isCheckboxSelected(String checkBoxName, String checkBoxValue)` Determines if the checkbox is selected.
`boolean`	`isMatchInElement(String elementID, String regexp)` Return true if a given regexp is contained within the specified element.
`boolean`	`isTextInElement(String elementID, String text)` Return true if a given string is contained within the specified element.
`void`	`reset()` Reset the current form with the default reset button.
`void`	`selectOptions(String selectName, int index, String[] optionValues)` Select option(s) of the Nth select box by value.
`void`	`selectOptions(String selectName, String[] optionValues)` Select option(s) of a select box by value.
`void`	`setExpectedJavaScriptAlert(JavascriptAlert[] alerts)` Tell the testing engine that the given alert boxes are expected in the given order.
`void`	`setExpectedJavaScriptConfirm(JavascriptConfirm[] confirms)` Tell the testing engine that the given confirm boxes are expected in the given order.
`void`	`setExpectedJavaScriptPrompt(JavascriptPrompt[] prompts)` Tell the testing engine that the given prompt boxes are expected in the given order.
`void`	`setHiddenField(String inputName, String text)` Fill hidden field with the provided text.
`void`	`setIgnoreFailingStatusCodes(boolean ignore)` Should the tester ignore failing status codes (300+)?
`void`	`setScriptingEnabled(boolean value)` Enable or disable Javascript support.
`void`	`setTestContext(TestContext testContext)`
`void`	`setTextField(String inputName, String text)` Fill a text, password or textarea field with the provided text.
`void`	`setThrowExceptionOnScriptError(boolean value)` Set whether or not to throw an exception on Javascript errors.
`void`	`setTimeout(int milliseconds)` Set the timeout for the request.
`void`	`setWorkingForm(int index)` Set the form on the current page that the client wishes to work with explicitly by index in the page.
`void`	`setWorkingForm(String nameOrId, int index)` Set the form on the current page that the client wishes to work with explicitly by either the form name or id (match by id is attempted first).
`void`	`submit()` Submit the current form with the default submit button.
`void`	`submit(String nameOrID)` Submit the current form with the specifed submit button.
`void`	`submit(String buttonName, String buttonValue)` Submit the current form with the specifed submit button (by name and value).
`void`	`uncheckCheckbox(String checkBoxName)` Deselect a specified checkbox.
`void`	`uncheckCheckbox(String checkBoxName, String value)` Deselect a specified checkbox.
`void`	`unselectOptions(String selectName, int index, String[] optionValues)` Unselect option(s) of the Nth select box with the specified name by value.
`void`	`unselectOptions(String selectName, String[] optionValues)` Unselect option(s) of a select box by value.

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

- Constructor Detail
  - WebDriverTestingEngineImpl
```
public WebDriverTestingEngineImpl()
```
- Method Detail
  - beginAt
```
public void beginAt(URL aInitialURL,
                    TestContext aTestContext)
             throws TestingEngineResponseException
```
    Description copied from interface: ITestingEngine
    
    Open the browser at an initial URL.
    
    Specified by:
    
    beginAt in interface ITestingEngine
    
    Parameters:
    
    aInitialURL - Initial URL
    
    aTestContext - Test context
    
    Throws:
    
    TestingEngineResponseException - If something bad happend (404)
  - setTestContext
```
public void setTestContext(TestContext testContext)
```
  - closeBrowser
```
public void closeBrowser()
                  throws ExpectedJavascriptAlertException,
                         ExpectedJavascriptConfirmException,
                         ExpectedJavascriptPromptException
```
    Description copied from interface: ITestingEngine
    
    Close the browser and check if there is no pending Javascript alert, confirm or prompt.
    
    Specified by:
    
    closeBrowser in interface ITestingEngine
    
    Throws:
    
    ExpectedJavascriptAlertException - If there is pending Javascript alert ITestingEngine.setExpectedJavaScriptAlert(JavascriptAlert[])
    
    ExpectedJavascriptConfirmException - If there is pending Javascript confirm ITestingEngine.setExpectedJavaScriptConfirm(JavascriptConfirm[])
    
    ExpectedJavascriptPromptException - If there is pending Javascript prompt ITestingEngine.setExpectedJavaScriptPrompt(JavascriptPrompt[])
  - gotoPage
```
public void gotoPage(URL url)
              throws TestingEngineResponseException
```
    Description copied from interface: ITestingEngine
    
    Simulate user typing a new URL in the browser.
    
    Specified by:
    
    gotoPage in interface ITestingEngine
    
    Parameters:
    
    url - Full URL of the page.
    
    Throws:
    
    TestingEngineResponseException - If something bad happend (404)
  - setScriptingEnabled
```
public void setScriptingEnabled(boolean value)
```
    Description copied from interface: ITestingEngine
    
    Enable or disable Javascript support.
    
    Specified by:
    
    setScriptingEnabled in interface ITestingEngine
    
    Parameters:
    
    value - true to enable Javascript.
  - setThrowExceptionOnScriptError
```
public void setThrowExceptionOnScriptError(boolean value)
```
    Description copied from interface: ITestingEngine
    
    Set whether or not to throw an exception on Javascript errors.
    
    Specified by:
    
    setThrowExceptionOnScriptError in interface ITestingEngine
    
    Parameters:
    
    value - true to throw an exception on Javascript errors.
  - getCookies
```
public List<javax.servlet.http.Cookie> getCookies()
```
    Description copied from interface: ITestingEngine
    
    Get all cookies.
    
    Specified by:
    
    getCookies in interface ITestingEngine
    
    Returns:
    
    List of javax.servlet.http.Cookie.
  - hasWindow
```
public boolean hasWindow(String windowName)
```
    Description copied from interface: ITestingEngine
    
    Test if the window with the given name is present.
    
    Specified by:
    
    hasWindow in interface ITestingEngine
    
    Parameters:
    
    windowName - Name of the window.
    
    Returns:
    
    true if the Window exists.
  - hasWindowByTitle
```
public boolean hasWindowByTitle(String windowTitle)
```
    Description copied from interface: ITestingEngine
    
    Test if window with the given title is present.
    
    Specified by:
    
    hasWindowByTitle in interface ITestingEngine
    
    Parameters:
    
    windowTitle - Title of the window.
    
    Returns:
    
    true if the Window exists.
  - gotoWindow
```
public void gotoWindow(String windowName)
```
    Description copied from interface: ITestingEngine
    
    Make the window with the given name active.
    
    Specified by:
    
    gotoWindow in interface ITestingEngine
    
    Parameters:
    
    windowName - Name of the window
  - gotoWindowByTitle
```
public void gotoWindowByTitle(String title)
```
    Description copied from interface: ITestingEngine
    
    Goto first window with the given title.
    
    Specified by:
    
    gotoWindowByTitle in interface ITestingEngine
    
    Parameters:
    
    title - Title of the window
  - gotoWindow
```
public void gotoWindow(int windowID)
```
    Description copied from interface: ITestingEngine
    
    Goto window with the given Javascript ID.
    
    Specified by:
    
    gotoWindow in interface ITestingEngine
    
    Parameters:
    
    windowID - Javascript ID of the window
  - gotoRootWindow
```
public void gotoRootWindow()
```
    Description copied from interface: ITestingEngine
    
    Make the root window active. Used to reset the effect of ITestingEngine.gotoFrame(String).
    
    Specified by:
    
    gotoRootWindow in interface ITestingEngine
  - getWindowCount
```
public int getWindowCount()
```
    Description copied from interface: ITestingEngine
    
    Get the number of opened Windows.
    
    Specified by:
    
    getWindowCount in interface ITestingEngine
    
    Returns:
    
    Number of opened Windows.
  - closeWindow
```
public void closeWindow()
```
    Description copied from interface: ITestingEngine
    
    Close the current window.
    
    Specified by:
    
    closeWindow in interface ITestingEngine
  - hasFrame
```
public boolean hasFrame(String frameNameOrId)
```
    Description copied from interface: ITestingEngine
    
    Test if the given frame is present.
    
    Specified by:
    
    hasFrame in interface ITestingEngine
    
    Parameters:
    
    frameNameOrId - Name or ID of the frame. ID is checked first.
    
    Returns:
    
    true if the frame exists.
  - gotoFrame
```
public void gotoFrame(String frameNameOrId)
```
    Description copied from interface: ITestingEngine
    
    Make the frame with the given name or ID active in the current conversation.
    
    Specified by:
    
    gotoFrame in interface ITestingEngine
    
    Parameters:
    
    frameNameOrId - Name or ID of the frame. ID is checked first.
  - setWorkingForm
```
public void setWorkingForm(int index)
```
    Description copied from interface: ITestingEngine
    
    Set the form on the current page that the client wishes to work with explicitly by index in the page.
    
    Specified by:
    
    setWorkingForm in interface ITestingEngine
    
    Parameters:
    
    index - The 0-based index, when more than one form with the same name is expected.
  - setWorkingForm
```
public void setWorkingForm(String nameOrId,
                           int index)
```
    Description copied from interface: ITestingEngine
    
    Set the form on the current page that the client wishes to work with explicitly by either the form name or id (match by id is attempted first).
    
    Specified by:
    
    setWorkingForm in interface ITestingEngine
    
    Parameters:
    
    nameOrId - name or id of the form to be worked with.
    
    index - The 0-based index, when more than one form with the same name is expected.
  - formSelector
```
protected String formSelector()
```
  - hasForm
```
public boolean hasForm()
```
    Description copied from interface: ITestingEngine
    
    Check whether the current page contains a form.
    
    Specified by:
    
    hasForm in interface ITestingEngine
    
    Returns:
    
    true if there is at least a form.
  - hasForm
```
public boolean hasForm(String nameOrID)
```
    Description copied from interface: ITestingEngine
    
    Return true if the current page contains a specific form.
    
    Specified by:
    
    hasForm in interface ITestingEngine
    
    Parameters:
    
    nameOrID - name of id of the form to check for.
    
    Returns:
    
    true if there is at least a form.
  - hasForm
```
public boolean hasForm(String nameOrID,
                       int index)
```
    Description copied from interface: ITestingEngine
    
    Return true if the current page contains a specific form.
    
    Specified by:
    
    hasForm in interface ITestingEngine
    
    Parameters:
    
    nameOrID - name of id of the form to check for.
    
    index - The 0-based index, when more than one form with the same name is expected.
    
    Returns:
    
    true if there is at least a form.
  - hasFormParameterNamed
```
public boolean hasFormParameterNamed(String paramName)
```
    Description copied from interface: ITestingEngine
    
    Return true if a form input element is present on the current form.
    
    Specified by:
    
    hasFormParameterNamed in interface ITestingEngine
    
    Parameters:
    
    paramName - name of the input element to check for
    
    Returns:
    
    true if there is at least a form parameter.
  - getTextFieldValue
```
public String getTextFieldValue(String paramName)
```
    Description copied from interface: ITestingEngine
    
    Return the current value of a text field with name paramName. Text fields are input text, input password and textarea
    
    Specified by:
    
    getTextFieldValue in interface ITestingEngine
    
    Parameters:
    
    paramName - name of the text field element.
    
    Returns:
    
    Text content of the text field.
  - getHiddenFieldValue
```
public String getHiddenFieldValue(String paramName)
```
    Description copied from interface: ITestingEngine
    
    Return the current value of a hidden input element with name paramName.
    
    Specified by:
    
    getHiddenFieldValue in interface ITestingEngine
    
    Parameters:
    
    paramName - name of the hidden input element.
    
    Returns:
    
    Value of the hidden input.
  - setTextField
```
public void setTextField(String inputName,
                         String text)
```
    Description copied from interface: ITestingEngine
    
    Fill a text, password or textarea field with the provided text.
    
    Specified by:
    
    setTextField in interface ITestingEngine
    
    Parameters:
    
    inputName - name of the text, password or textarea element
    
    text - value to type in the field.
  - setHiddenField
```
public void setHiddenField(String inputName,
                           String text)
```
    Description copied from interface: ITestingEngine
    
    Fill hidden field with the provided text.
    
    Specified by:
    
    setHiddenField in interface ITestingEngine
    
    Parameters:
    
    inputName - name of the hidden element
    
    text - value to set in the hidden field.
  - getSelectOptionValues
```
public String[] getSelectOptionValues(String selectName)
```
    Description copied from interface: ITestingEngine
    
    Return a string array of select box option values. Exemple:
    Should return [Component_1_a, Component_1_b, Component_3, Component_4, Component_5]
    
    Specified by:
    
    getSelectOptionValues in interface ITestingEngine
    
    Parameters:
    
    selectName - name of the select box.
    
    Returns:
    
    Array of select options values.
  - getSelectOptionValues
```
public String[] getSelectOptionValues(String selectName,
                                      int index)
```
    Description copied from interface: ITestingEngine
    
    Return a string array of option values for the Nth select box with the specified name.
    
    Specified by:
    
    getSelectOptionValues in interface ITestingEngine
    
    Parameters:
    
    selectName - name of the select box.
    
    index - the 0-based index used when more than one select with the same name is expected.
    
    Returns:
    
    Array of select options values.
  - getSelectedOptions
```
public String[] getSelectedOptions(String selectName)
```
    Description copied from interface: ITestingEngine
    
    Return the values of the currently selected items in a select box.
    
    Specified by:
    
    getSelectedOptions in interface ITestingEngine
    
    Parameters:
    
    selectName - name of the select box.
  - getSelectedOptions
```
public String[] getSelectedOptions(String selectName,
                                   int index)
```
    Description copied from interface: ITestingEngine
    
    Return the values of the currently selected items in the Nth select box with the provided name.
    
    Specified by:
    
    getSelectedOptions in interface ITestingEngine
    
    Parameters:
    
    selectName - name of the select box.
    
    index - the 0-based index used when more than one select with the same name is expected.
  - getSelectOptionLabelForValue
```
public String getSelectOptionLabelForValue(String selectName,
                                           String optionValue)
```
    Description copied from interface: ITestingEngine
    
    Get the label for a given option of a select box.
    
    Specified by:
    
    getSelectOptionLabelForValue in interface ITestingEngine
    
    Parameters:
    
    selectName - name of the select box.
    
    optionValue - label of the option.
  - getSelectOptionLabelForValue
```
public String getSelectOptionLabelForValue(String selectName,
                                           int index,
                                           String optionValue)
```
    Description copied from interface: ITestingEngine
    
    Get the label for a given option of the Nth select box with the specified name.
    
    Specified by:
    
    getSelectOptionLabelForValue in interface ITestingEngine
    
    Parameters:
    
    selectName - name of the select box.
    
    index - the 0-based index used when more than one select with the same name is expected.
    
    optionValue - label of the option.
  - getSelectOptionValueForLabel
```
public String getSelectOptionValueForLabel(String selectName,
                                           String optionLabel)
```
    Description copied from interface: ITestingEngine
    
    Get the value for a given option of a select box.
    
    Specified by:
    
    getSelectOptionValueForLabel in interface ITestingEngine
    
    Parameters:
    
    selectName - name of the select box.
    
    optionLabel - label of the option.
  - getSelectOptionValueForLabel
```
public String getSelectOptionValueForLabel(String selectName,
                                           int index,
                                           String optionLabel)
```
    Description copied from interface: ITestingEngine
    
    Get the value for a given option of the Nth select box with the specified name.
    
    Specified by:
    
    getSelectOptionValueForLabel in interface ITestingEngine
    
    Parameters:
    
    selectName - name of the select box.
    
    index - the 0-based index used when more than one select with the same name is expected.
    
    optionLabel - label of the option.
  - selectOptions
```
public void selectOptions(String selectName,
                          String[] optionValues)
```
    Description copied from interface: ITestingEngine
    
    Select option(s) of a select box by value.
    
    Specified by:
    
    selectOptions in interface ITestingEngine
    
    Parameters:
    
    selectName - name of the select box.
    
    optionValues - values of the options to select.
  - selectOptions
```
public void selectOptions(String selectName,
                          int index,
                          String[] optionValues)
```
    Description copied from interface: ITestingEngine
    
    Select option(s) of the Nth select box by value.
    
    Specified by:
    
    selectOptions in interface ITestingEngine
    
    Parameters:
    
    selectName - name of the select box.
    
    index - the 0-based index of the select element when multiple select elements are expected.
    
    optionValues - values of the options to select.
  - unselectOptions
```
public void unselectOptions(String selectName,
                            String[] optionValues)
```
    Description copied from interface: ITestingEngine
    
    Unselect option(s) of a select box by value.
    
    Specified by:
    
    unselectOptions in interface ITestingEngine
    
    Parameters:
    
    selectName - name of the select box.
    
    optionValues - vaules of the options to unselect.
  - unselectOptions
```
public void unselectOptions(String selectName,
                            int index,
                            String[] optionValues)
```
    Description copied from interface: ITestingEngine
    
    Unselect option(s) of the Nth select box with the specified name by value.
    
    Specified by:
    
    unselectOptions in interface ITestingEngine
    
    Parameters:
    
    selectName - name of the select box.
    
    index - the 0-based index of the select element when multiple select elements are expected.
    
    optionValues - vaules of the options to unselect.
  - hasSelectOption
```
public boolean hasSelectOption(String selectName,
                               String optionLabel)
```
    Description copied from interface: ITestingEngine
    
    Test if a select box has the given option (by label).
    
    Specified by:
    
    hasSelectOption in interface ITestingEngine
    
    Parameters:
    
    selectName - name of the select box.
    
    optionLabel - label of the option.
    
    Returns:
    
    true if a select box has the given option (by label).
  - hasSelectOptionValue
```
public boolean hasSelectOptionValue(String selectName,
                                    String optionValue)
```
    Description copied from interface: ITestingEngine
    
    Test if a select box has the given option (by value).
    
    Specified by:
    
    hasSelectOptionValue in interface ITestingEngine
    
    Parameters:
    
    selectName - name of the select box.
    
    optionValue - value of the option.
    
    Returns:
    
    true if a select box has the given option (by value).
  - hasSelectOption
```
public boolean hasSelectOption(String selectName,
                               int index,
                               String optionLabel)
```
    Description copied from interface: ITestingEngine
    
    Test if the Nth select box has the given option (by label).
    
    Specified by:
    
    hasSelectOption in interface ITestingEngine
    
    Parameters:
    
    selectName - name of the select box.
    
    index - the 0-based index of the select element when multiple select elements are expected.
    
    optionLabel - label of the option.
    
    Returns:
    
    true if a select box has the given option (by label).
  - hasSelectOptionValue
```
public boolean hasSelectOptionValue(String selectName,
                                    int index,
                                    String optionValue)
```
    Description copied from interface: ITestingEngine
    
    Test if the Nth select box has the given option (by value).
    
    Specified by:
    
    hasSelectOptionValue in interface ITestingEngine
    
    Parameters:
    
    selectName - name of the select box.
    
    index - the 0-based index of the select element when multiple select elements are expected.
    
    optionValue - value of the option.
    
    Returns:
    
    true if a select box has the given option (by value).
  - isCheckboxSelected
```
public boolean isCheckboxSelected(String checkBoxName)
```
    Description copied from interface: ITestingEngine
    
    Determines if the checkbox is selected.
    
    Specified by:
    
    isCheckboxSelected in interface ITestingEngine
    
    Parameters:
    
    checkBoxName - name of the checkbox.
    
    Returns:
    
    true if the first checkbox with given name is selected.
  - isCheckboxSelected
```
public boolean isCheckboxSelected(String checkBoxName,
                                  String checkBoxValue)
```
    Description copied from interface: ITestingEngine
    
    Determines if the checkbox is selected.
    
    Specified by:
    
    isCheckboxSelected in interface ITestingEngine
    
    Parameters:
    
    checkBoxName - name attribut of the checkbox.
    
    checkBoxValue - value attribut of the checkbox.
    
    Returns:
    
    true if the first checkbox with given name and value is selected.
  - checkCheckbox
```
public void checkCheckbox(String checkBoxName)
```
    Description copied from interface: ITestingEngine
    
    Select a specified checkbox. If the checkbox is already checked then the checkbox will stay checked.
    
    Specified by:
    
    checkCheckbox in interface ITestingEngine
    
    Parameters:
    
    checkBoxName - name of checkbox to be selected.
  - checkCheckbox
```
public void checkCheckbox(String checkBoxName,
                          String checkBoxValue)
```
    Description copied from interface: ITestingEngine
    
    Select a specified checkbox. If the checkbox is already checked then the checkbox will stay checked.
    
    Specified by:
    
    checkCheckbox in interface ITestingEngine
    
    Parameters:
    
    checkBoxName - name of checkbox to be selected.
    
    checkBoxValue - value of the checkbox (to differenciate checkboxes with the same name).
  - uncheckCheckbox
```
public void uncheckCheckbox(String checkBoxName)
```
    Description copied from interface: ITestingEngine
    
    Deselect a specified checkbox. If the checkbox is already unchecked then the checkbox will stay unchecked.
    
    Specified by:
    
    uncheckCheckbox in interface ITestingEngine
    
    Parameters:
    
    checkBoxName - name of checkbox to be deselected.
  - uncheckCheckbox
```
public void uncheckCheckbox(String checkBoxName,
                            String value)
```
    Description copied from interface: ITestingEngine
    
    Deselect a specified checkbox. If the checkbox is already unchecked then the checkbox will stay unchecked.
    
    Specified by:
    
    uncheckCheckbox in interface ITestingEngine
    
    Parameters:
    
    checkBoxName - name of checkbox to be deselected.
    
    value - value of the checkbox (to differenciate checkboxes with the same name).
  - clickRadioOption
```
public void clickRadioOption(String radioGroup,
                             String radioOptionValue)
```
    Description copied from interface: ITestingEngine
    
    Clicks a radio option. Asserts that the radio option exists first.
    
    Specified by:
    
    clickRadioOption in interface ITestingEngine
    
    Parameters:
    
    radioGroup - name of the radio group.
    
    radioOptionValue - value of the option to check for.
  - hasRadioOption
```
public boolean hasRadioOption(String radioGroup,
                              String radioOptionValue)
```
    Description copied from interface: ITestingEngine
    
    Checks if a radio group contains the indicated option.
    
    Specified by:
    
    hasRadioOption in interface ITestingEngine
    
    Parameters:
    
    radioGroup - name of the radio group.
    
    radioOptionValue - value of the option to check for.
  - getSelectedRadio
```
public String getSelectedRadio(String radioGroup)
```
    Description copied from interface: ITestingEngine
    
    Return the currently selected radio button.
    
    Specified by:
    
    getSelectedRadio in interface ITestingEngine
    
    Parameters:
    
    radioGroup - name of the radio group.
    
    Returns:
    
    value of the selected radio.
  - hasSubmitButton
```
public boolean hasSubmitButton()
```
    Description copied from interface: ITestingEngine
    
    Checks if the current form contains a submit button.
    
    Specified by:
    
    hasSubmitButton in interface ITestingEngine
  - hasSubmitButton
```
public boolean hasSubmitButton(String nameOrID)
```
    Description copied from interface: ITestingEngine
    Checks if the current form contains a specific submit button.
    A submit button can be the following HTML elements:
    - input type=submit
    - input type=image
    - button type=submit
    Specified by:
    
    hasSubmitButton in interface ITestingEngine
    
    Parameters:
    
    nameOrID - name or id of the button to check for.
  - hasSubmitButton
```
public boolean hasSubmitButton(String nameOrID,
                               String value)
```
    Description copied from interface: ITestingEngine
    Checks if the current form contains a specific submit button.
    A submit button can be the following HTML elements:
    - input type=submit
    - input type=image
    - button type=submit
    Specified by:
    
    hasSubmitButton in interface ITestingEngine
    
    Parameters:
    
    nameOrID - name of id of the button to check for.
    
    value - value of the button
  - submit
```
public void submit()
```
    Description copied from interface: ITestingEngine
    Submit the current form with the default submit button. See #getFormfor an explanation of how the current form is established.
    A submit button can be the following HTML elements:
    - input type=submit
    - input type=image
    - button type=submit
    Specified by:
    
    submit in interface ITestingEngine
  - submit
```
public void submit(String nameOrID)
```
    Description copied from interface: ITestingEngine
    Submit the current form with the specifed submit button. See #getFormfor an explanation of how the current form is established.
    A submit button can be the following HTML elements:
    - input type=submit
    - input type=image
    - button type=submit
    Specified by:
    
    submit in interface ITestingEngine
    
    Parameters:
    
    nameOrID - name of the button to use for submission.
  - submit
```
public void submit(String buttonName,
                   String buttonValue)
```
    Description copied from interface: ITestingEngine
    Submit the current form with the specifed submit button (by name and value). See #getFormfor an explanation of how the current form is established.
    A submit button can be the following HTML elements:
    - input type=submit
    - input type=image
    - button type=submit
    Specified by:
    
    submit in interface ITestingEngine
    
    Parameters:
    
    buttonName - name of the button to use for submission.
    
    buttonValue - value/label of the button to use for submission
  - hasResetButton
```
public boolean hasResetButton()
```
    Description copied from interface: ITestingEngine
    Checks if the current form contains a reset button.
    A reset button can be the following HTML elements:
    - input type=reset
    - button type=reset
    Specified by:
    
    hasResetButton in interface ITestingEngine
  - hasResetButton
```
public boolean hasResetButton(String nameOrID)
```
    Description copied from interface: ITestingEngine
    Checks if the current form contains a specific reset button.
    A reset button can be the following HTML elements:
    - input type=reset
    - button type=reset
    Specified by:
    
    hasResetButton in interface ITestingEngine
    
    Parameters:
    
    nameOrID - name or id of the button to check for.
  - reset
```
public void reset()
```
    Description copied from interface: ITestingEngine
    Reset the current form with the default reset button. See #getFormfor an explanation of how the current form is established.
    A reset button can be the following HTML elements:
    - input type=reset
    - button type=reset
    Specified by:
    
    reset in interface ITestingEngine
  - hasButtonWithText
```
public boolean hasButtonWithText(String text)
```
    Description copied from interface: ITestingEngine
    Checks if a button with text is present.
    A button can be the following HTML elements:
    - input type=button
    - button type=button
    Specified by:
    
    hasButtonWithText in interface ITestingEngine
    
    Parameters:
    
    text - the text of the button (contents of the value attribute).
    
    Returns:
    
    true when the button with text could be found.
  - hasButton
```
public boolean hasButton(String buttonId)
```
    Description copied from interface: ITestingEngine
    Checks if a button with id is present.
    A button can be the following HTML elements:
    - input type=button
    - button type=button
    Specified by:
    
    hasButton in interface ITestingEngine
    
    Parameters:
    
    buttonId - the ID of the button.
    
    Returns:
    
    true when the button with text could be found.
  - clickButton
```
public void clickButton(String buttonId)
```
    Description copied from interface: ITestingEngine
    Click the indicated button.
    A button can be the following HTML elements:
    - input type=button
    - button type=button
    Specified by:
    
    clickButton in interface ITestingEngine
    
    Parameters:
    
    buttonId - the ID of the button.
  - clickButtonWithText
```
public void clickButtonWithText(String buttonValueText)
```
    Description copied from interface: ITestingEngine
    Clicks a button with text of the value attribute.
    A button can be the following HTML elements:
    - input type=button
    - button type=button
    Specified by:
    
    clickButtonWithText in interface ITestingEngine
    
    Parameters:
    
    buttonValueText - the text of the button (contents of the value attribute).
  - getPageURL
```
public URL getPageURL()
```
    Description copied from interface: ITestingEngine
    
    Get the location of the current page.
    
    Specified by:
    
    getPageURL in interface ITestingEngine
    
    Returns:
    
    an URL.
  - getPageText
```
public String getPageText()
```
    Description copied from interface: ITestingEngine
    
    Return the string representation of the current page, encoded as specified by the current TestContext.
    
    Specified by:
    
    getPageText in interface ITestingEngine
    
    Returns:
    
    Visible text in the page.
  - getPageSource
```
public String getPageSource()
```
    Description copied from interface: ITestingEngine
    
    Return the source of the current page (like in a browser).
    
    Specified by:
    
    getPageSource in interface ITestingEngine
    
    Returns:
    
    Source of the page (or HTTP Body as String)
  - getPageTitle
```
public String getPageTitle()
```
    Description copied from interface: ITestingEngine
    
    Return the page title of the current response page, encoded as specified by the current TestContext.
    
    Specified by:
    
    getPageTitle in interface ITestingEngine
    
    Returns:
    
    Title of the page.
  - getServerResponse
```
public String getServerResponse()
```
    Description copied from interface: ITestingEngine
    
    Return the response of the server for the current page.
    
    Specified by:
    
    getServerResponse in interface ITestingEngine
    
    Returns:
    
    HTTP header & body
  - getInputStream
```
public InputStream getInputStream()
```
    Description copied from interface: ITestingEngine
    
    Gets the last server response as input stream.
    
    Specified by:
    
    getInputStream in interface ITestingEngine
  - getInputStream
```
public InputStream getInputStream(URL url)
                           throws TestingEngineResponseException
```
    Description copied from interface: ITestingEngine
    
    Gets the input stream for a given URL - can be used to test images or other resources without changing the current navigation context.
    
    Specified by:
    
    getInputStream in interface ITestingEngine
    
    Parameters:
    
    url - the url to the resource
    
    Throws:
    
    TestingEngineResponseException
  - hasTable
```
public boolean hasTable(String tableSummaryNameOrId)
```
    Description copied from interface: ITestingEngine
    
    Check if the Table object representing a specified table exists.
    
    Specified by:
    
    hasTable in interface ITestingEngine
    
    Parameters:
    
    tableSummaryNameOrId - summary, name or id of the table.
    
    Returns:
    
    true if table exists.
  - getTable
```
public Table getTable(String tableSummaryNameOrId)
```
    Description copied from interface: ITestingEngine
    
    Each framework have it's own way to represent a Table. Testing engines are responsible for converting to the unified JWebUnit format.
    
    Specified by:
    
    getTable in interface ITestingEngine
    
    Parameters:
    
    tableSummaryNameOrId - summary, name or id of the table to return.
    
    Returns:
    
    unified JWebUnit representation of a table.
  - hasLinkWithText
```
public boolean hasLinkWithText(String linkText,
                               int index)
```
    Description copied from interface: ITestingEngine
    
    Return true if a link is present in the current response containing the specified text.
    
    Specified by:
    
    hasLinkWithText in interface ITestingEngine
    
    Parameters:
    
    linkText - text to check for in links on the response.
    
    index - The 0-based index, when more than one link with the same text is expected.
  - hasLinkWithExactText
```
public boolean hasLinkWithExactText(String linkText,
                                    int index)
```
    Description copied from interface: ITestingEngine
    
    Return true if a link is present in the current page containing the exact specified text. Note. This will call String.trim() to trim all leading / trailing spaces. RFE 996031...
    
    Specified by:
    
    hasLinkWithExactText in interface ITestingEngine
    
    Parameters:
    
    linkText - text to check for in links on the response.
    
    index - The 0-based index, when more than one link with the same text is expected.
  - hasLinkWithImage
```
public boolean hasLinkWithImage(String imageFileName,
                                int index)
```
    Description copied from interface: ITestingEngine
    
    Return true if a link is present with a given image based on filename of image.
    
    Specified by:
    
    hasLinkWithImage in interface ITestingEngine
    
    Parameters:
    
    imageFileName - A suffix of the image's filename; for example, to match "images/my_icon.png", you could just pass in "my_icon.png".
    index - The 0-based index, when more than one link with the same text is expected.
  hasLink public boolean hasLink(String anId) Description copied from interface: ITestingEngine Return true if a link is present in the current response with the specified id. Specified by: hasLink in interface ITestingEngine Parameters: anId - link id to check for. clickLinkWithText public void clickLinkWithText(String linkText, int index) Description copied from interface: ITestingEngine Navigate by submitting a request based on a link containing the specified text. A RuntimeException is thrown if no such link can be found. Specified by: clickLinkWithText in interface ITestingEngine Parameters: linkText - text which link to be navigated should contain. index - The 0-based index, when more than one link with the same text is expected. clickLinkWithExactText public void clickLinkWithExactText(String linkText, int index) Description copied from interface: ITestingEngine Navigate by clicking a link with the exact specified text. A RuntimeException is thrown if no such link can be found. Specified by: clickLinkWithExactText in interface ITestingEngine Parameters: linkText - exact text which link to be navigated should contain. index - The 0-based index, when more than one link with the same text is expected. clickLink public void clickLink(String anID) Description copied from interface: ITestingEngine Navigate by submitting a request based on a link with a given ID. A RuntimeException is thrown if no such link can be found. Specified by: clickLink in interface ITestingEngine Parameters: anID - id of link to be navigated. clickLinkWithImage public void clickLinkWithImage(String imageFileName, int index) Description copied from interface: ITestingEngine Navigate by submitting a request based on a link with a given image file name. A RuntimeException is thrown if no such link can be found. Specified by: clickLinkWithImage in interface ITestingEngine Parameters: imageFileName - A suffix of the image's filename; for example, to match "images/my_icon.png", you could just pass in "my_icon.png". index - The 0-based index, when more than one link with the same text is expected. hasElement public boolean hasElement(String anID) Description copied from interface: ITestingEngine Test if element with given id exists. Specified by: hasElement in interface ITestingEngine Parameters: anID - id of the element. Returns: true if element was found. hasElementByXPath public boolean hasElementByXPath(String xpath) Description copied from interface: ITestingEngine Test if element with given xpath exists. Specified by: hasElementByXPath in interface ITestingEngine Parameters: xpath - xpath of the element. Returns: true if element was found. clickElementByXPath public void clickElementByXPath(String xpath) Description copied from interface: ITestingEngine Click element with given xpath. Specified by: clickElementByXPath in interface ITestingEngine Parameters: xpath - xpath of the element. getElementAttributByXPath public String getElementAttributByXPath(String xpath, String attribut) Description copied from interface: ITestingEngine Get attribut value of the given element. For example, if you have img src="bla.gif" alt="toto", getElementAttributByXPath("//img[@src='bla.gif']", "alt") returns "toto" Specified by: getElementAttributByXPath in interface ITestingEngine Parameters: xpath - xpath of the element. attribut - name of the attribut. Returns: Attribut value or null if the element is not found. getElementTextByXPath public String getElementTextByXPath(String xpath) Description copied from interface: ITestingEngine Get text of the given element. Specified by: getElementTextByXPath in interface ITestingEngine Parameters: xpath - xpath of the element. isTextInElement public boolean isTextInElement(String elementID, String text) Description copied from interface: ITestingEngine Return true if a given string is contained within the specified element. Specified by: isTextInElement in interface ITestingEngine Parameters: elementID - ID of element to inspect. text - text to check for. Returns: true if text was found. isMatchInElement public boolean isMatchInElement(String elementID, String regexp) Description copied from interface: ITestingEngine Return true if a given regexp is contained within the specified element. Specified by: isMatchInElement in interface ITestingEngine Parameters: elementID - Id of element to inspect. regexp - regexp to match. Returns: true if a match is found. setExpectedJavaScriptAlert public void setExpectedJavaScriptAlert(JavascriptAlert[] alerts) throws ExpectedJavascriptAlertException Description copied from interface: ITestingEngine Tell the testing engine that the given alert boxes are expected in the given order. Specified by: setExpectedJavaScriptAlert in interface ITestingEngine Parameters: alerts - Expected alerts. Throws: ExpectedJavascriptAlertException - If there are still unconsummed alert since a previous call of this method. setExpectedJavaScriptConfirm public void setExpectedJavaScriptConfirm(JavascriptConfirm[] confirms) throws ExpectedJavascriptConfirmException Description copied from interface: ITestingEngine Tell the testing engine that the given confirm boxes are expected in the given order. Specified by: setExpectedJavaScriptConfirm in interface ITestingEngine Parameters: confirms - Expected confirms. Throws: ExpectedJavascriptConfirmException - If there are still unconsummed confirm since a previous call of this method. setExpectedJavaScriptPrompt public void setExpectedJavaScriptPrompt(JavascriptPrompt[] prompts) throws ExpectedJavascriptPromptException Description copied from interface: ITestingEngine Tell the testing engine that the given prompt boxes are expected in the given order. Specified by: setExpectedJavaScriptPrompt in interface ITestingEngine Parameters: prompts - Expected prompts. Throws: ExpectedJavascriptPromptException - If there are still unconsummed prompt since a previous call of this method. getElementByXPath public IElement getElementByXPath(String xpath) Description copied from interface: ITestingEngine Get an element wrapper for a given xpath. Specified by: getElementByXPath in interface ITestingEngine Parameters: xpath - XPath to evaluate Returns: The element if found See Also: ITestingEngine.getElementsByXPath(String) getElementByID public IElement getElementByID(String id) Description copied from interface: ITestingEngine Get an element wrapper for a given ID. Specified by: getElementByID in interface ITestingEngine Parameters: id - element ID to find Returns: The element if found getElementsByXPath public List<IElement> getElementsByXPath(String xpath) Description copied from interface: ITestingEngine Get a list of all elements that match the given xpath. Specified by: getElementsByXPath in interface ITestingEngine Parameters: xpath - XPath to evaluate Returns: List of all elements found See Also: ITestingEngine.getElementByXPath(String) getServerResponseCode public int getServerResponseCode() Description copied from interface: ITestingEngine Get the request response code. Specified by: getServerResponseCode in interface ITestingEngine Returns: The request response code. getHeader public String getHeader(String name) Description copied from interface: ITestingEngine Get a particular header or null. Specified by: getHeader in interface ITestingEngine Parameters: name - The header name Returns: The first header value or null getAllHeaders public Map<String,String> getAllHeaders() Description copied from interface: ITestingEngine Get all distinct response headers. In case there are duplicate headers with same name, the last one will be returned. Specified by: getAllHeaders in interface ITestingEngine Returns: The header values stored in a map. setIgnoreFailingStatusCodes public void setIgnoreFailingStatusCodes(boolean ignore) Description copied from interface: ITestingEngine Should the tester ignore failing status codes (300+)? Otherwise, failing status codes will throw an exception. Specified by: setIgnoreFailingStatusCodes in interface ITestingEngine getComments public List<String> getComments() Description copied from interface: ITestingEngine Get all the comments in a document, as a list of strings. Specified by: getComments in interface ITestingEngine setTimeout public void setTimeout(int milliseconds) Description copied from interface: ITestingEngine Set the timeout for the request. A timeout of 0 means an infinite timeout. Specified by: setTimeout in interface ITestingEngine Parameters: milliseconds - the milliseconds in which to timeout, or 0 for infinite wait (the default). getResponseHeaders public List<HttpHeader> getResponseHeaders() Description copied from interface: ITestingEngine Get all response headers. Specified by: getResponseHeaders in interface ITestingEngine Returns: the response headers as a list of HttpHeaders escapeQuotes protected String escapeQuotes(String toEscape) Copied from Select Parameters: toEscape - Returns:

Class WebDriverTestingEngineImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WebDriverTestingEngineImpl

Method Detail

beginAt

setTestContext

closeBrowser

gotoPage

setScriptingEnabled

setThrowExceptionOnScriptError

getCookies

hasWindow

hasWindowByTitle

gotoWindow

gotoWindowByTitle

gotoWindow

gotoRootWindow

getWindowCount

closeWindow

hasFrame

gotoFrame

setWorkingForm

setWorkingForm

formSelector

hasForm

hasForm

hasForm

hasFormParameterNamed

getTextFieldValue

getHiddenFieldValue

setTextField

setHiddenField

getSelectOptionValues

getSelectOptionValues

getSelectedOptions

getSelectedOptions

getSelectOptionLabelForValue

getSelectOptionLabelForValue

getSelectOptionValueForLabel

getSelectOptionValueForLabel

selectOptions

selectOptions

unselectOptions

unselectOptions

hasSelectOption

hasSelectOptionValue

hasSelectOption

hasSelectOptionValue

isCheckboxSelected

isCheckboxSelected

checkCheckbox

checkCheckbox

uncheckCheckbox

uncheckCheckbox

clickRadioOption

hasRadioOption

getSelectedRadio

hasSubmitButton

hasSubmitButton

hasSubmitButton

submit

submit

submit

hasResetButton

hasResetButton

reset

hasButtonWithText

hasButton

clickButton

clickButtonWithText

getPageURL

getPageText

getPageSource

getPageTitle

getServerResponse

getInputStream

getInputStream