SeleniumAssist (TestOptimal 6.0.24 API)

java.lang.Object
- com.testoptimal.plugin.selenium.WebDriverAssist
- - com.testoptimal.plugin.selenium.SeleniumAssist

```
public class SeleniumAssist
extends WebDriverAssist
```
Collection of a set of assistance functions to handle some complex UI actions. These functions should only be called after Selenium webdriver has started. You would call functions in this class with:
```
   $SELENIUM.assist().'funcName'(...)
 
```
Author:

yxl01

Constructor Summary

Constructors
Constructor and Description

SeleniumAssist(org.openqa.selenium.WebDriver webDriver_p, MbtScriptExecutor scriptExec_p)

Constructors
Constructor and Description
`SeleniumAssist(org.openqa.selenium.WebDriver webDriver_p, MbtScriptExecutor scriptExec_p)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptAlert()` accept the alert dialog window by clicking on "OK" button.
`boolean`	`containsText(String text_p)` returns true if current window/frame/page contains the text specified (case insensitive).
`boolean`	`dismissAlert()` dismiss the alert/confirm dialog by clicking on close or "cancel" button.
`String`	`getAlertText()` returns the message in the alert pop-up dialog if present.
`org.openqa.selenium.WebElement`	`highlightElement(org.openqa.selenium.By locator_p, String color_p, long millis_p)` highlight element(s) by changing its border color temporarily for a duration specified in milliseconds.
`boolean`	`isAlertPresent()` returns true if the alert dialog has been displayed(triggered).
`List<org.openqa.selenium.WebElement>`	`listIFrames()` returns a list of iframes in current window
`Object`	`runJS(String javascript_p)` executes javascript on current window/frame.
`Object`	`scrollBy(int x_delta_p, int y_delta_p)` scrolls window by the x and y pixels specified.
`Object`	`scrollTo(int x_p, int y_p)` scrolls window to the x,y coordinates specified.
`org.openqa.selenium.support.ui.Select`	`selectOptionByIndex(org.openqa.selenium.By locator_p, int index_p)` selects an option for the Select element by option index (0-based).
`org.openqa.selenium.support.ui.Select`	`selectOptionByText(org.openqa.selenium.By locator_p, String text_p)` selects an option for the Select element by matching the option display text.
`org.openqa.selenium.support.ui.Select`	`selectOptionByValue(org.openqa.selenium.By locator_p, String value_p)` selects an option for the Select element by matching the value attribute.
`String`	`selectWindowByIndex(int idx_p)`
`org.openqa.selenium.WebElement`	`sendKey(org.openqa.selenium.By locator_p, String keyString_p)` type the string to the first element found with locator_p.
`org.openqa.selenium.WebElement`	`setCheckbox(org.openqa.selenium.By locator_p, boolean checked_p)` sets the checkbox.
`org.openqa.selenium.WebDriver.Timeouts`	`setImplicitWait(long millis_p)` sets the implicitWait parameter for WebDriver.
`void`	`setWindowSize(int width_p, int height_p)` sets the browser window size to the specified dimension: width and height.
`org.openqa.selenium.WebElement`	`type(org.openqa.selenium.By locator_p, String keyString_p, String shiftCtrlAlt_p)` type the string to the first element found with locator_p with the option to have shift/control/alt key pressed.

Methods inherited from class com.testoptimal.plugin.selenium.WebDriverAssist
click, click, click, doubleClick, dragAndDrop, mouseDown, mouseOver, mouseUp, rightClick, snapScreen, waitForElement, waitForElementAttr, waitForElementEnabled, waitForElementText

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

- Constructor Detail
  - SeleniumAssist
```
public SeleniumAssist(org.openqa.selenium.WebDriver webDriver_p,
                      MbtScriptExecutor scriptExec_p)
```
- Method Detail
  - getAlertText
```
public String getAlertText()
```
    returns the message in the alert pop-up dialog if present. blank if not.
    
    Returns:
    
    alert dialog text
  - isAlertPresent
```
public boolean isAlertPresent()
```
    returns true if the alert dialog has been displayed(triggered).
    
    Returns:
    
    true if alert is present
  - acceptAlert
```
public boolean acceptAlert()
```
    accept the alert dialog window by clicking on "OK" button.
    
    Returns:
    
    true if alert is found and accepted. false if alert not found.
  - dismissAlert
```
public boolean dismissAlert()
```
    dismiss the alert/confirm dialog by clicking on close or "cancel" button.
    
    Returns:
    
    true if alert is dismissed. false if alert not present.
  - containsText
```
public boolean containsText(String text_p)
```
    returns true if current window/frame/page contains the text specified (case insensitive).
    
    Parameters:
    
    text_p -
    
    Returns:
    
    true if matching text found
  - selectWindowByIndex
```
public String selectWindowByIndex(int idx_p)
```
    Parameters:
    
    idx_p - 0-based index
    
    Returns:
    
    window handle (String) selected or null if window not found
  - setCheckbox
```
public org.openqa.selenium.WebElement setCheckbox(org.openqa.selenium.By locator_p,
                                                  boolean checked_p)
```
    sets the checkbox.
    Example:
```
$SELENIUM.assist().setCheckBox(By.id('F1'), true); 
```
    Parameters:
    
    locator_p - locator to the checkbox element
    
    checked_p - true or false
  - selectOptionByText
```
public org.openqa.selenium.support.ui.Select selectOptionByText(org.openqa.selenium.By locator_p,
                                                                String text_p)
                                                         throws MBTException
```
    selects an option for the Select element by matching the option display text.
    Example:
```
$SELENIUM.assist().selectOptionByText(By.id('F1'),'this is the label text'); 
```
    Parameters:
    
    locator_p - locator for the element
    
    text_p - text string to identify the option
    
    Throws:
    
    MBTException
  - selectOptionByValue
```
public org.openqa.selenium.support.ui.Select selectOptionByValue(org.openqa.selenium.By locator_p,
                                                                 String value_p)
                                                          throws MBTException
```
    selects an option for the Select element by matching the value attribute.
    Example:
```
$SELENIUM.assist().selectOptionByValue(By.id('F1'),'2'); 
```
    Parameters:
    
    locator_p - locator for the element
    
    value_p - text string to match to option value
    
    Throws:
    
    MBTException
  - selectOptionByIndex
```
public org.openqa.selenium.support.ui.Select selectOptionByIndex(org.openqa.selenium.By locator_p,
                                                                 int index_p)
                                                          throws MBTException
```
    selects an option for the Select element by option index (0-based).
    Example:
```
$SELENIUM.assist().selectOptionByText(By.id('F1'), 0); 
```
    Parameters:
    
    locator_p - locator for the element
    
    index_p - 0-based index
    
    Throws:
    
    MBTException
  - type
```
public org.openqa.selenium.WebElement type(org.openqa.selenium.By locator_p,
                                           String keyString_p,
                                           String shiftCtrlAlt_p)
                                    throws Exception
```
    type the string to the first element found with locator_p with the option to have shift/control/alt key pressed. It clears the current value before issuing typing the string into the field.
    Not available for remote testing using selenium/appium/saucelabs servers.
    
    Example:
```
$SELENIUM.assist().type(By.id('F1'),'abc','S'); 
```
    Parameters:
    
    locator_p -
    
    shiftCtrlAlt_p - include char "c" for control key, "a" for alt key and "s" for shift key. For example "cs" to have control and shift keys pressed.
    
    keyString_p -
    
    Throws:
    
    MBTException
    
    Exception
  - sendKey
```
public org.openqa.selenium.WebElement sendKey(org.openqa.selenium.By locator_p,
                                              String keyString_p)
```
    type the string to the first element found with locator_p. The element must be an input field. It does not clear the content/value of the element if it's not empty.
    Example:
```
$SELENIUM.assist().sendKey(By.id('F1'),'abc');
```
    Use the following tokens to simulate special keyboard key:
    [KEYS.BACK_SPACE]
    
    [KEYS.TAB]
    
    [KEYS.CLEAR]
    
    [KEYS.RETURN]
    
    [KEYS.ENTER]
    
    [KEYS.SHIFT]
    
    [KEYS.LEFT_SHIFT]
    
    [KEYS.CONTROL]
    
    [KEYS.LEFT_CONTROL]
    
    [KEYS.ALT]
    
    [KEYS.LEFT_ALT]
    
    [KEYS.PAUSE]
    
    [KEYS.ESCAPE]
    
    [KEYS.SPACE]
    
    [KEYS.PAGE_UP]
    
    [KEYS.PAGE_DOWN]
    
    [KEYS.END]
    
    [KEYS.HOME]
    
    [KEYS.LEFT]
    
    [KEYS.ARROW_LEFT]
    
    [KEYS.UP]
    
    [KEYS.ARROW_UP]
    
    [KEYS.RIGHT]
    
    [KEYS.ARROW_RIGHT]
    
    [KEYS.NULL]
    
    [KEYS.CANCEL]
    
    [KEYS.HELP]
    
    [KEYS.BACK_SPACE]
    
    [KEYS.DOWN]
    
    [KEYS.ARROW_DOWN]
    
    [KEYS.INSERT]
    
    [KEYS.DELETE]
    
    [KEYS.SEMICOLON]
    
    [KEYS.EQUALS]
    
    [KEYS.NUMPAD0]
    
    [KEYS.NUMPAD1]
    
    [KEYS.NUMPAD2]
    
    [KEYS.NUMPAD3]
    
    [KEYS.NUMPAD4]
    
    [KEYS.NUMPAD5]
    
    [KEYS.NUMPAD6]
    
    [KEYS.NUMPAD7]
    
    [KEYS.NUMPAD8]
    
    [KEYS.NUMPAD9]
    
    [KEYS.MULTIPLY]
    
    [KEYS.ADD]
    
    [KEYS.SEPARATOR]
    
    [KEYS.SUBTRACT]
    
    [KEYS.DECIMAL]
    
    [KEYS.DIVIDE]
    
    [KEYS.F1]
    
    [KEYS.F2]
    
    [KEYS.F3]
    
    [KEYS.F4]
    
    [KEYS.F5]
    
    [KEYS.F6]
    
    [KEYS.F7]
    
    [KEYS.F8]
    
    [KEYS.F9]
    
    [KEYS.F10]
    
    [KEYS.F11]
    
    [KEYS.F12]
    
    [KEYS.META]
    
    [KEYS.COMMAND]
    
    [KEYS.ZENKAKU_HANKAKU]
    Key token must be used alone or attached to the end of the string. For example,
```
 $SELENIUM.assist().sendKey(By.id('F1'),'[KEYS.ENTER]') or
 $SELENIUM.assist().sendKey(By.id('F1'),'abc[KEYS.TAB]');
 
```
  - runJS
```
public Object runJS(String javascript_p)
             throws MBTException
```
    executes javascript on current window/frame. Be sure to use "return xyz" if you wish to receive the return from the call.
    
    Parameters:
    
    javascript_p -
    
    Returns:
    
    object returned from javascript
    
    Throws:
    
    MBTException
  - setWindowSize
```
public void setWindowSize(int width_p,
                          int height_p)
```
    sets the browser window size to the specified dimension: width and height. Inavalid width or height value will default to 1000.
    Example:
```
$SELENIUM.assist().setWindowSize(1000, 2000)
```
    Parameters:
    
    width_p -
    
    height_p -
  - highlightElement
```
public org.openqa.selenium.WebElement highlightElement(org.openqa.selenium.By locator_p,
                                                       String color_p,
                                                       long millis_p)
                                                throws Exception
```
    highlight element(s) by changing its border color temporarily for a duration specified in milliseconds.
    
    Parameters:
    
    locator_p -
    
    color_p - html color code
    
    millis_p - number of milliseconds, 0 for leaving the highlight (note this may affect your application behavior due to style attribute changed)
    
    Returns:
    
    target element
    
    Throws:
    
    Exception
  - listIFrames
```
public List<org.openqa.selenium.WebElement> listIFrames()
```
    returns a list of iframes in current window
    
    Returns:
    
    list of WebElements representing iframes
  - scrollBy
```
public Object scrollBy(int x_delta_p,
                       int y_delta_p)
                throws MBTException
```
    scrolls window by the x and y pixels specified. Use negative number to scroll backwards.
    
    Parameters:
    
    x_delta_p - integer, amount to scroll on x coordinate (horizontal axis), specify 0 for no change.
    
    y_delta_p - integer, amount to scroll on y coordinate (vertical axis), specify 0 for no change.
    
    Throws:
    
    MBTException
  - scrollTo
```
public Object scrollTo(int x_p,
                       int y_p)
                throws MBTException
```
    scrolls window to the x,y coordinates specified. Upper-left corner is (0,0).
    
    Parameters:
    
    x_p - integer, x coordinate (horizontal)
    
    y_p - integer, y coordinate (vertical)
    
    Returns:
    
    object returned from javascript window.scrollTo () call
    
    Throws:
    
    MBTException
  - setImplicitWait
```
public org.openqa.selenium.WebDriver.Timeouts setImplicitWait(long millis_p)
```
    sets the implicitWait parameter for WebDriver. Implicit wait is the maximun amount of WebDriver will wait for the element to appear in the document. This setting applies to WebDriver directly and is used for all operations that require finding an element in the document.
    You may need to use other wait method to supplement this global setting to meet specific needs in different part of the model.
    
    Overrides:
    
    setImplicitWait in class WebDriverAssist
    
    Parameters:
    
    millis_p - number of milliseconds
    
    Returns:
    
    timeout object for more timeout related actions

Class SeleniumAssist

Constructor Summary

Method Summary

Methods inherited from class com.testoptimal.plugin.selenium.WebDriverAssist

Methods inherited from class java.lang.Object

Constructor Detail

SeleniumAssist

Method Detail

getAlertText

isAlertPresent

acceptAlert

dismissAlert

containsText

selectWindowByIndex

setCheckbox

selectOptionByText

selectOptionByValue

selectOptionByIndex

type

sendKey

runJS

setWindowSize

highlightElement

listIFrames

scrollBy

scrollTo

setImplicitWait