org.safs.selenium.webdriver.lib

Class WDLibrary

java.lang.Object

org.safs.selenium.webdriver.lib.SearchObject

org.safs.selenium.webdriver.lib.WDLibrary

public class WDLibrary
extends SearchObject

NOV 19, 2013 (Carl Nagle) Initial release.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WDLibrary.RBT This class represents a Robot, which can do work locally (thru local org.safs.robot.Robot) or remotely (thru a RMI agent).
static class	WDLibrary.WD_XMLHttpRequest Implements XMLHttpRequest, through WDLibrary to execute javascript JavaScriptFunctions.sendHttpRequest(Map) to handle HTTP Request.

Nested classes/interfaces inherited from class org.safs.selenium.webdriver.lib.SearchObject

SearchObject.BrowserWindow, SearchObject.DefaultJSEventListener, SearchObject.DOJO, SearchObject.FrameElement, SearchObject.GenericJSEventListener, SearchObject.HTML, SearchObject.SAP, SearchObject.SwitchFramesResults

Field Summary

Fields

Modifier and Type	Field and Description
static WDLibrary.WD_XMLHttpRequest	AJAX An instance of WD_XMLHttpRequest, used to send HTTP request.
protected static boolean	debug
static int	DEFAULT_TIMEOUT_WAIT_ALERT The timeout in seconds to wait for the alert's presence. The default value is 2 seconds.
static int	DEFAULT_TIMEOUT_WAIT_CLICK 2 seconds to wait for a click action finished on page.
static int	DEFAULT_TIMEOUT_WAIT_ROBOT_CLICK 10 seconds to wait for a Robot click action finished on page.
static boolean	DEFAUT_AUTOSCROLL 'true', the default value for scrolling the web-element into view automatically before performing click ation on it.
static boolean	enableClickListenerFailures Default true.
protected static InputKeysParser	keysparser
static int	MOUSE_BUTTON_LEFT InputEvent.BUTTON1_MASK
static int	MOUSE_BUTTON_MIDDLE InputEvent.BUTTON2_MASK
static int	MOUSE_BUTTON_RIGHT InputEvent.BUTTON3_MASK
static int	TIMEOUT_NOWAIT 0, means no waiting.
static int	TIMEOUT_WAIT_FOREVER -1, means wait for ever
static int	timeoutCheckAlertForClick time (in seconds) to check if an Alert is present on page before clicking.
static int	timeoutWaitAlert time (in seconds) to wait for an Alert appear on page.
static int	timeoutWaitClick time (in seconds) to wait for a click action finished on page.
static int	timeoutWaitRobotClick time (in seconds) to wait for a Robot click action finished on page.

Fields inherited from class org.safs.selenium.webdriver.lib.SearchObject

assignSeparator, childSeparator, CSS_CLASS_DOJO_DIJIT_PREFIX, CSS_CLASS_SAP_PREFIX, CSS_CLASS_SEPARATOR, CSS_SELECTOR_BY_CLASSNAME, CSS_SELECTOR_BY_ID, DEFAULT_IGNORE_CASE, DEFAULT_JS_EXECUTION_DELAY, DEFAULT_JS_TIMEOUT, DEFAULT_PARTIAL_MATCH, DOMAIN_DOJO, DOMAIN_HTML, DOMAIN_SAP, escapeChar, IGNORED_NONUI_TAGS, INVALID_INDEX, jsEventListenerMap, jsEventListenerWaitingThreadMap, lastBrowserWindow, lastFrame, lastJS, lastUsedWD, lastVisitedURL, MATCHED_ONE_TIME, MATCHED_ZERO_TIMES, propertySeparator, qulifierSeparator, SEARCH_CRITERIA_CLASS, SEARCH_CRITERIA_CLASS_CONTAINS, SEARCH_CRITERIA_CONTAINS_SUFFIX, SEARCH_CRITERIA_CSS, SEARCH_CRITERIA_FRAMEID, SEARCH_CRITERIA_FRAMEINDEX, SEARCH_CRITERIA_FRAMENAME, SEARCH_CRITERIA_FRAMEXPATH, SEARCH_CRITERIA_ID, SEARCH_CRITERIA_IFRAMEID, SEARCH_CRITERIA_INDEX, SEARCH_CRITERIA_ITEMINDEX, SEARCH_CRITERIA_LINK, SEARCH_CRITERIA_NAME, SEARCH_CRITERIA_PARTIALLINK, SEARCH_CRITERIA_PATH, SEARCH_CRITERIA_PROPERTY, SEARCH_CRITERIA_PROPERTY_CONTAINS, SEARCH_CRITERIA_TAG, SEARCH_CRITERIA_TEXT, SEARCH_CRITERIA_TITLE, SEARCH_CRITERIA_TYPE, SEARCH_CRITERIA_XPATH, TAG_FRAME, TAG_IFRAME, TEXT_VALUE_ATTRIBUTES, XPATH_CHILD_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
WDLibrary()

Method Summary

Modifier and Type	Method and Description
static void	alignToBottom(org.openqa.selenium.WebElement element) Align the bottom of webelement to the bottom of browser.
static void	alignToTop(org.openqa.selenium.WebElement element) Align the top of webelement to the top of browser.
static void	altLeftDrag(org.openqa.selenium.WebElement we, java.awt.Point start, java.awt.Point end) Perform a left-drag from start point to end point relative to webelement (LeftUp corner) with the "ALT" key pressed during the drag.
static java.awt.image.BufferedImage	captureBrowserArea(java.awt.Rectangle rectangle) Capture the image on browser according to the rectangle relative to the browser.
static void	captureScreen(java.lang.String image) Capture entire current HTML page
static void	captureScreen(org.openqa.selenium.WebElement we, java.lang.String imgName, java.lang.String fileformat) Capture component image
static void	checkKnownIssue(java.lang.String keyword) Check some known issue for a certain keyword.
static void	clearClipboard() Clear the clipboard on local machine or on machine where the RMI server is running.
static void	click(org.openqa.selenium.WebElement clickable, org.openqa.selenium.Keys specialKey, java.lang.String... optional) Click(Mouse Left Button) the WebElement at center with a special key pressed.
static void	click(org.openqa.selenium.WebElement clickable, java.awt.Point offset, org.openqa.selenium.Keys specialKey, int mouseButtonNumber, java.lang.String... optional) Click the WebElement at a certain coordination with a special key pressed. Firstly it will try to get webelement's location and use Robot to click.
static void	click(org.openqa.selenium.WebElement clickable, java.awt.Point offset, java.lang.String... optional) Click(Mouse Left Button) the WebElement at a certain coordination.
static void	click(org.openqa.selenium.WebElement clickable, java.lang.String... optional) Click(Mouse Left Button) - Click on WebElement or WebDriver object at the center
static boolean	clickUnverified(org.openqa.selenium.WebElement component, java.awt.Point offset, java.lang.String... optional) Click a component with an offset.
static void	closeAlert(boolean accept, java.lang.String... optionals) Close the Alert-Modal-Dialog associated with a certain browser identified by ID. It will get the cached webdriver according to the browser's id, and close the 'alert' through that webdriver. Note:This API will NOT change the current WebDriver.
static void	closeBrowser() Close the Browser/WebDriver associated with the last WebElement accessed.
(package private) static java.lang.CharSequence	convertToCharacter(RobotKeyEvent event) Convert a SAFS RobotKeyEvent to a standard CharSequence character.
static org.openqa.selenium.Keys	convertToKeys(int keycode) Convert a Java KEYCODE to a Selenium WebDriver Keys Enum
static org.openqa.selenium.Keys	convertToKeys(RobotKeyEvent event) Convert a SAFS RobotKeyEvent to a Selenium WebDriver Keys Enum
static void	ctrlAltLeftDrag(org.openqa.selenium.WebElement we, java.awt.Point start, java.awt.Point end) Perform a left-drag from start point to end point relative to webelement (LeftUp corner) with the "CONTROL" and "ALT" key pressed during the drag.
static void	ctrlLeftDrag(org.openqa.selenium.WebElement we, java.awt.Point start, java.awt.Point end) Perform a left-drag from start point to end point relative to webelement (LeftUp corner) with the "CONTROL" key pressed during the drag.
static void	ctrlShiftLeftDrag(org.openqa.selenium.WebElement we, java.awt.Point start, java.awt.Point end) Perform a left-drag from start point to end point relative to webelement (LeftUp corner) with the "CONTROL" and "SHIFT" key pressed during the drag.
static void	doubleClick(org.openqa.selenium.WebElement clickable, org.openqa.selenium.Keys specialKey, java.lang.String... optional) Double-Click(Mouse Left Button) the WebElement at the center with a special key pressed.
static void	doubleClick(org.openqa.selenium.WebElement clickable, java.awt.Point offset, org.openqa.selenium.Keys specialKey, int mouseButtonNumber, java.lang.String... optional) Double-Click the WebElement at a certain coordination with a special key pressed. Firstly it will try to get webelement's location and use Robot to double click.
static void	doubleClick(org.openqa.selenium.WebElement clickable, java.awt.Point offset, java.lang.String... optional) Double-Click(Mouse Left Button) the WebElement at a certain coordination.
static void	doubleClick(org.openqa.selenium.WebElement clickable, java.lang.String... optional) Double-Click(Mouse Left Button) the WebElement at the center.
static void	fireMouseEvent(MouseEvent event) Attempts to fire (dispatchEvent) a MouseEvent.
static boolean	focus(org.openqa.selenium.WebElement element) Attempt to SetFocus on the WebElement.
static java.lang.String	getBrowserName()
static java.lang.String	getBrowserName(org.openqa.selenium.WebDriver driver)
static java.lang.String	getBrowserVersion()
static org.openqa.selenium.WebDriver	getBrowserWithID(java.lang.String id) Retrieves the WebDriver/Browser with the given id.
static org.openqa.selenium.WebDriver	getBrowserWithTitle(java.lang.String title) Retrieves the WebDriver/Browser with the given title.
static java.lang.Object	getClipboard(java.awt.datatransfer.DataFlavor dataFlavor) Get the content from the clipboard on local machine or on machine where the RMI server is running.
static java.util.Map<java.lang.String,java.lang.String>	getCssValues(org.openqa.selenium.WebElement element) Get css values of the object
static int	getDelayBetweenKeystrokes() Gets the current delay in milliseconds between Robot keystrokes for both local and remote servers.
static java.lang.String	getDriverVersion()
static java.awt.Point	getElementOffsetScreenLocation(org.openqa.selenium.WebElement element, java.lang.String offsetX, java.lang.String offsetY) Given the element, and the (offsetX, offsetY) relative to element.
static java.awt.Point	getLocation(org.openqa.selenium.WebElement webelement) Get the web-element's location relative to the browser.
static java.awt.Point	getLocation(org.openqa.selenium.WebElement webelement, boolean useOnPageFirstly) Get the web-element's location relative to the browser client area.
static java.lang.String	getPlatform()
static java.util.Map<java.lang.String,java.lang.Object>	getProperties(org.openqa.selenium.WebElement element) Retrieve all properties of an element--attributes, css values, property fields and certain property methods.
static java.lang.String	getProperty(org.openqa.selenium.WebElement element, java.lang.String property) get the value of a property.
static java.awt.Rectangle	getRectangleOnScreen(org.openqa.selenium.WebElement we) Get the screen rectangle for a WebElement object.
static java.awt.Point	getScreenLocation(org.openqa.selenium.WebElement webelement) Get the absolute coordination on the screen of the webelement object. Hope Selenium will give this function one day!
static com.sebuilder.interpreter.Script	getSeleniumBuilderScript(java.lang.String path) Load a SeBuilder JSON Script from the provided path so it can be started or run.
static int	getTimeoutCheckAlertForClick()
static com.sebuilder.interpreter.webdriverfactory.WebDriverFactory	getWebDriverAsWebDriverFactory()
static void	highlightElement(org.openqa.selenium.WebElement element) Deprecated. it is replaced by SearchObject.highlight(WebElement).
static void	inputChars(org.openqa.selenium.WebElement we, java.lang.String keystrokes) Does NOT clear any existing text in the control, but does attempt to insure the window/control has focus.
static void	inputKeys(org.openqa.selenium.WebElement we, java.lang.String keystrokes) Does NOT clear any existing text in the control, but does attempt to insure the window/control has focus.
static void	inputKeysSAFS2Selenium(org.openqa.selenium.WebElement we, java.lang.String keystrokes) Does NOT clear any existing text in the control, but does attempt to insure the window/control has focus.
static boolean	inside(org.openqa.selenium.WebElement element, java.awt.Point p) Check if the point is inside of the boundary of WebElement.
static boolean	isAlertPresent(java.lang.String... optionals) Test the presence of Alert-Modal-Dialog associated with a certain browser identified by ID. It will get the cached webdriver according to the browser's id, and get the 'alert' through that webdriver. Note:This API will NOT change the current WebDriver.
static boolean	isChrome(org.openqa.selenium.WebDriver driver)
static boolean	isFireFox(org.openqa.selenium.WebDriver driver)
static boolean	isHtmlUnit(org.openqa.selenium.WebDriver driver)
static boolean	isInternetExplorer(org.openqa.selenium.WebDriver driver)
static boolean	isLeftMouseButton(int buttonNumber)
static boolean	isLocationInBounds(org.openqa.selenium.Point p, org.openqa.selenium.Dimension bounds) check if the point p locates in the Dimension.
static boolean	isMiddleMouseButton(int buttonNumber)
static boolean	isPointInBounds(org.openqa.selenium.Point p, org.openqa.selenium.Dimension bounds) check if the Point p locates inside the Dimension.
static boolean	isRightMouseButton(int buttonNumber)
static boolean	isSafari(org.openqa.selenium.WebDriver driver)
static boolean	isShowOnPage(org.openqa.selenium.WebElement element)
static boolean	isShowOnPage(org.openqa.selenium.WebElement element, org.openqa.selenium.Point offset) To check if a certain point of web-element is shown on the page. If the point is not given or it is out of boundary of web-element, method will check if the web-element is fully shown on the page.
static void	keyDown(org.openqa.selenium.Keys keycode) Press down a Key by Selenium's Actions API.
static void	keyPress(int keycode) Press down a Key by Java Robot.
static void	keyRelease(int keycode) Release a Key by Java Robot.
static void	keyUp(org.openqa.selenium.Keys keycode) Release a Key by Selenium's Actions API.
static java.util.List<GenericProcessMonitor.ProcessInfo>	killChromeDriver(java.lang.String host) Kill the process 'chromedriver.exe'.
static java.util.List<GenericProcessMonitor.ProcessInfo>	killIEDriverServer(java.lang.String host) Kill the process 'IEDriverServer.exe'.
static void	leftDrag(org.openqa.selenium.WebElement we, java.awt.Point start, java.awt.Point end) Perform a left-drag from start point to end point relative to webelement (LeftUp corner).
static void	main(java.lang.String[] args) Before running this method, please read java doc of test_ajax_call(String)
static void	maximizeBrowserWindow() Maximize current browser window
static void	minimizeBrowserWindow() This implementation does NOT really minimize the window, it is a workaround. Note: set the size to (0,0) can NOT minimize the window.
static void	mouseHover(org.openqa.selenium.WebElement we, java.awt.Point point, int millisStay)
static void	mouseWheel(int wheelAmt) Scroll the mouse wheel by Java Robot.
static void	resizeBrowserWindow(int width, int height) Resize current browser window
static void	rightclick(org.openqa.selenium.WebElement clickable, org.openqa.selenium.Keys specialKey, java.lang.String... optional) Click(Mouse Right Button) the WebElement at center with a special key pressed.
static void	rightclick(org.openqa.selenium.WebElement clickable, java.awt.Point offset, java.lang.String... optional) Click(Mouse Right Button) the WebElement at a certain coordination.
static void	rightclick(org.openqa.selenium.WebElement clickable, java.lang.String... optional) Click(Mouse Right Button) - Click on WebElement or WebDriver object at the center
static void	rightDrag(org.openqa.selenium.WebElement we, java.awt.Point start, java.awt.Point end) Perform a right-drag from start point to end point relative to webelement (LeftUp corner).
static boolean	runSeleniumBuilderScript(java.lang.String path, org.apache.commons.logging.Log log, boolean allowClose) Run a SeBuilder JSON Script explicitly using the existing WebDriver instance.
static boolean	runSeleniumBuilderScript(java.lang.String path, org.apache.commons.logging.Log log, com.sebuilder.interpreter.webdriverfactory.WebDriverFactory driverFactory, java.util.HashMap<java.lang.String,java.lang.String> webDriverConfig, java.util.Map<java.lang.String,java.lang.String> initialVars, boolean allowClose) Run a SeBuilder JSON Script.
static void	scrollBrowserWindowBy(int x, int y, org.openqa.selenium.WebElement element) scroll browser window by x and/or y number of pixels.
static void	scrollBrowserWindowTo(int x, int y, org.openqa.selenium.WebElement element) scroll browser window to x and/or y scroll position.
static void	setClipboard(java.lang.String content) Set content to the clipboard on local machine or on machine where the RMI server is running.
static void	setDelayBetweenKeystrokes(int millisDelay) Sets a delay in milliseconds between Robot keystrokes for both local and remote servers.
static void	setPositionBrowserWindow(int x, int y) Set position of current browser window.
static void	setTimeoutCheckAlertForClick(int timeoutCheckAlertForClick)
static void	setWaitReaction(boolean wait) Set if wait for reaction to "input keys/chars" for both local and remote servers.
static void	setWaitReaction(boolean wait, int tokenLength, int dealyForToken, int dealy) Set if wait for reaction to "input keys/chars" for both local and remote servers.
static void	shiftLeftDrag(org.openqa.selenium.WebElement we, java.awt.Point start, java.awt.Point end) Perform a left-drag from start point to end point relative to webelement (LeftUp corner) with the "SHIFT" key pressed during the drag.
static boolean	showOnPage(org.openqa.selenium.WebElement element) Try to show the webelement on the browser's page.
static boolean	showOnPage(org.openqa.selenium.WebElement element, java.lang.String... optional) Try to show the webelement on the browser's page. First, try to see if the web-element is already shown on page, if not shown on the page then it will try to move the web-element to show it on page. Finally, if the passed in parameter verify is true, it will return true only if the element is shown on the page; if the passed in parameter verify is false, it will always return true.
static void	startBrowser(java.lang.String BrowserName, java.lang.String Url, java.lang.String Id, int timeout, boolean isRemote) Start browser
static void	startBrowser(java.lang.String BrowserName, java.lang.String Url, java.lang.String Id, int timeout, boolean isRemote, java.util.Map<java.lang.String,java.lang.Object> extraParameters) Start browser
static void	stopBrowser(java.lang.String ID) Close browser (close all windows associated) indicated by ID.
(package private) static int	toJavaKeyCode(org.openqa.selenium.Keys key)
static boolean	windowSetFocus(java.lang.String titleRegExp) Set a specific Window matching the provided title to be the foreground window.
static boolean	windowSetFocus(org.openqa.selenium.WebDriver adriver) Attempt to SetFocus on the topmost window for the provided WebDriver.
static boolean	windowSetFocus(org.openqa.selenium.WebElement element) Attempt to SetFocus on the topmost window containing the WebElement.

Methods inherited from class org.safs.selenium.webdriver.lib.SearchObject

_switchFrames, addJavaScriptEventListener, addWebDriver, checkCSSClassName, checkNotNull, clearHighlight, containFrameRS, containTagRS, executeAsyncScript, executeJavaScriptOnWebElement, executeScript, executeScript, findElement, findElements, generateFullGenericXPath, generateGenericXPath, generateSAFSFrameRecognition, generateUniqueName, getAllWindowTitles, getBoolean, getCssSelector, getDescription, getFirstQualifierPair, getFrameWebElement, getIDForWebDriver, getJS, getJsExecutionDelay, getJsTimeout, getLastBrowserWindow, getLastFrame, getLastVisitedURL, getMatchedObject, getMatchedObjects, getNthWebElement, getObject, getObject, getObjectByMultiAttributes, getObjectByQualifier, getObjectByText, getObjectByTitle, getObjectByXpathAndQualifiers, getObjectForDomain, getObjects, getObjectsByMultiAttributes, getObjectsByQualifier, getObjectsByText, getObjectsByTitle, getObjectsByXpathAndQualifiers, getObjectsForDomain, getParentWebElement, getSubItem, getTagQualifierValue, getText, getThrowableMessages, getValue, getWebDriver, getWebDriver, getWebDriverWithTitle, getWebElement, getWebElementProperty, getXpathCondition, highlight, highlight, highlightThenClear, isDisplayed, isDojoDomain, isFrameRS, isFrameWebElement, isIgnoredNonUITag, isSAPDomain, isStale, isValidBrowserID, isValidFrameRS, isVisible, js_cleanError, js_executeWithTimeout, js_getErrorCode, js_getErrorObject, js_getGlobalBoolVariable, js_getGlobalVariable, js_initError, js_initialize, js_setErrorCode, js_setErrorObject, js_setGlobalBoolVariable, js_setGlobalVariable, pageHasChanged, reconnectLastWebDriver, refreshJSExecutor, removeJavaScriptEventListener, removeWebDriver, resetXPathObjectCache, retrieveFrameRS, setJsExecutionDelay, setJsTimeout, setLastFrame, shutdown, switchFrame, switchWindow, switchWindow, switchWindow, switchWindow, useBrowser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MOUSE_BUTTON_LEFT

public static final int MOUSE_BUTTON_LEFT

InputEvent.BUTTON1_MASK

See Also:

Constant Field Values

MOUSE_BUTTON_MIDDLE

public static final int MOUSE_BUTTON_MIDDLE

InputEvent.BUTTON2_MASK

See Also:

Constant Field Values

MOUSE_BUTTON_RIGHT

public static final int MOUSE_BUTTON_RIGHT

InputEvent.BUTTON3_MASK

See Also:

Constant Field Values

debug

protected static boolean debug

DEFAULT_TIMEOUT_WAIT_CLICK

public static final int DEFAULT_TIMEOUT_WAIT_CLICK

2 seconds to wait for a click action finished on page.

See Also:

Constant Field Values

DEFAULT_TIMEOUT_WAIT_ALERT

public static final int DEFAULT_TIMEOUT_WAIT_ALERT

The timeout in seconds to wait for the alert's presence.
The default value is 2 seconds.

See Also:

Constant Field Values

TIMEOUT_NOWAIT

public static final int TIMEOUT_NOWAIT

0, means no waiting.

See Also:

Constant Field Values

TIMEOUT_WAIT_FOREVER

public static final int TIMEOUT_WAIT_FOREVER

-1, means wait for ever

See Also:

Constant Field Values

DEFAULT_TIMEOUT_WAIT_ROBOT_CLICK

public static final int DEFAULT_TIMEOUT_WAIT_ROBOT_CLICK

10 seconds to wait for a Robot click action finished on page.

See Also:

Constant Field Values

timeoutWaitClick

public static int timeoutWaitClick

time (in seconds) to wait for a click action finished on page.

timeoutWaitAlert

public static int timeoutWaitAlert

time (in seconds) to wait for an Alert appear on page.

timeoutCheckAlertForClick

public static int timeoutCheckAlertForClick

time (in seconds) to check if an Alert is present on page before clicking. The default value is set to TIMEOUT_NOWAIT, means we check immediately without waiting for presence of Alert.

timeoutWaitRobotClick

public static int timeoutWaitRobotClick

time (in seconds) to wait for a Robot click action finished on page.

keysparser

protected static InputKeysParser keysparser

enableClickListenerFailures

public static boolean enableClickListenerFailures

Default true. Set to true if we want an Exception to be thrown when we perform a Click and attempt to verify through event listeners that the Click actually happened. The problem is, that so many Click verifications fail due to the page and or WebElement going stale or being overwritten that Click verifications issue failures even though the Click was successful.

Set to 'false' when you wish to avoid these types of failures.

DEFAUT_AUTOSCROLL

public static final boolean DEFAUT_AUTOSCROLL

'true', the default value for scrolling the web-element into view automatically before performing click ation on it.

See Also:

Constant Field Values

AJAX

public static WDLibrary.WD_XMLHttpRequest AJAX

An instance of WD_XMLHttpRequest, used to send HTTP request.

Constructor Detail

WDLibrary

public WDLibrary()

Method Detail

isLeftMouseButton

public static boolean isLeftMouseButton(int buttonNumber)

isMiddleMouseButton

public static boolean isMiddleMouseButton(int buttonNumber)

isRightMouseButton

public static boolean isRightMouseButton(int buttonNumber)

getTimeoutCheckAlertForClick

public static int getTimeoutCheckAlertForClick()

setTimeoutCheckAlertForClick

public static void setTimeoutCheckAlertForClick(int timeoutCheckAlertForClick)

click

public static void click(org.openqa.selenium.WebElement clickable,
                         java.lang.String... optional)
                  throws SeleniumPlusException

Click(Mouse Left Button) - Click on WebElement or WebDriver object at the center

Parameters:

clickable - WebElement, as WebElement obj

optional - String[], the optional parameters

• optional[0] autoscroll boolean, if the component will be scrolled into view automatically before clicking. if not provided, the default value is true.

Throws:

SeleniumPlusException

click

public static void click(org.openqa.selenium.WebElement clickable,
                         org.openqa.selenium.Keys specialKey,
                         java.lang.String... optional)
                  throws SeleniumPlusException

Click(Mouse Left Button) the WebElement at center with a special key pressed.

Parameters:

clickable - WebElement, the WebElement to click on

specialKey - Keys, the special key to press during the click

optional - String[], the optional parameters

• optional[0] autoscroll boolean, if the component will be scrolled into view automatically before clicking. if not provided, the default value is true.

Throws:

SeleniumPlusException

click

public static void click(org.openqa.selenium.WebElement clickable,
                         java.awt.Point offset,
                         java.lang.String... optional)
                  throws SeleniumPlusException

Click(Mouse Left Button) the WebElement at a certain coordination.

Parameters:

clickable - WebElement, the WebElement to click on

offset - Point, the coordination relative to this WebElement to click at

optional - String[], the optional parameters

• optional[0] autoscroll boolean, if the component will be scrolled into view automatically before clicking. if not provided, the default value is true.

Throws:

SeleniumPlusException

rightclick

public static void rightclick(org.openqa.selenium.WebElement clickable,
                              java.lang.String... optional)
                       throws SeleniumPlusException

Click(Mouse Right Button) - Click on WebElement or WebDriver object at the center

Parameters:

clickable - WebElement, as WebElement obj

optional - String[], the optional parameters

• optional[0] autoscroll boolean, if the component will be scrolled into view automatically before clicking. if not provided, the default value is true.

Throws:

SeleniumPlusException

rightclick

public static void rightclick(org.openqa.selenium.WebElement clickable,
                              org.openqa.selenium.Keys specialKey,
                              java.lang.String... optional)
                       throws SeleniumPlusException

Click(Mouse Right Button) the WebElement at center with a special key pressed.

Parameters:

clickable - WebElement, the WebElement to click on

specialKey - Keys, the special key to presse during the click

optional - String[], the optional parameters

• optional[0] autoscroll boolean, if the component will be scrolled into view automatically before clicking. if not provided, the default value is true.

Throws:

SeleniumPlusException

rightclick

public static void rightclick(org.openqa.selenium.WebElement clickable,
                              java.awt.Point offset,
                              java.lang.String... optional)
                       throws SeleniumPlusException

Click(Mouse Right Button) the WebElement at a certain coordination.

Parameters:

clickable - WebElement, the WebElement to click on

offset - Point, the coordination relative to this WebElement to click at

optional - String[], the optional parameters

• optional[0] autoscroll boolean, if the component will be scrolled into view automatically before clicking. if not provided, the default value is true.

Throws:

SeleniumPlusException

inside

public static boolean inside(org.openqa.selenium.WebElement element,
                             java.awt.Point p)

Check if the point is inside of the boundary of WebElement.

Parameters:

element - WebElement, The element to get boundary to check with.

p - Point, The point to check.

Returns:

boolean, true if the point is inside of the boundary of WebElement

click

public static void click(org.openqa.selenium.WebElement clickable,
                         java.awt.Point offset,
                         org.openqa.selenium.Keys specialKey,
                         int mouseButtonNumber,
                         java.lang.String... optional)
                  throws SeleniumPlusException

Click the WebElement at a certain coordination with a special key pressed.
Firstly it will try to get webelement's location and use Robot to click. At the same
time, it will listen to a 'javascript mouse down' event to find out if the click really
happened; If not, it will try to use Selenium's API to do the work.
If the click point is outside of the boundary of the WebElement, which means we are going
to click on the sibling component. At this situation, our click-listener will never receive
the click event, we will turn off the click-listener.

Parameters:

clickable - WebElement, the WebElement to click on

offset - Point, the coordination relative to this WebElement to click at.
if the offset is null, then click at the center.

specialKey - Keys, the special key to press during the click

mouseButtonNumber - int, the mouse-button-number representing right, middle, or left button. it can be MOUSE_BUTTON_LEFT or MOUSE_BUTTON_RIGHT.
MOUSE_BUTTON_MIDDLE NOT supported yet.

optional - String[], the optional parameters

• optional[0] autoscroll boolean, if the component will be scrolled into view automatically before clicking. if not provided, the default value is true.

Throws:

SeleniumPlusException

doubleClick

public static void doubleClick(org.openqa.selenium.WebElement clickable,
                               java.awt.Point offset,
                               org.openqa.selenium.Keys specialKey,
                               int mouseButtonNumber,
                               java.lang.String... optional)
                        throws SeleniumPlusException

Double-Click the WebElement at a certain coordination with a special key pressed.
Firstly it will try to get webelement's location and use Robot to double click. At the same
time, it will listen to a 'javascript mouse down' event to find out if the double click really
happened; If not, it will try to use Selenium's API to do the work.
If the click point is outside of the boundary of the WebElement, which means we are going
to click on the sibling component. At this situation, our click-listener will never receive
the click event, we will turn off the click-listener.

Parameters:

clickable - WebElement, the WebElement to click on

offset - Point, the coordination relative to this WebElement to click at.
if the offset is null, then click at the center.

specialKey - Keys, the special key to press during the click

mouseButtonNumber - int, the mouse-button-number representing right, middle, or left button. it can be MOUSE_BUTTON_LEFT
MOUSE_BUTTON_MIDDLE and MOUSE_BUTTON_RIGHT NOT supported yet.

optional - String[], the optional parameters

• optional[0] autoscroll boolean, if the component will be scrolled into view automatically before clicking. if not provided, the default value is true.

Throws:

SeleniumPlusException

doubleClick

public static void doubleClick(org.openqa.selenium.WebElement clickable,
                               java.lang.String... optional)
                        throws SeleniumPlusException

Double-Click(Mouse Left Button) the WebElement at the center.

Parameters:

clickable - WebElement, the WebElement to click on

optional - String[], the optional parameters

• optional[0] autoscroll boolean, if the component will be scrolled into view automatically before clicking. if not provided, the default value is true.

Throws:

SeleniumPlusException

doubleClick

public static void doubleClick(org.openqa.selenium.WebElement clickable,
                               org.openqa.selenium.Keys specialKey,
                               java.lang.String... optional)
                        throws SeleniumPlusException

Double-Click(Mouse Left Button) the WebElement at the center with a special key pressed.

Parameters:

clickable - WebElement, the WebElement to click on

specialKey - Keys, the special key to press during the click

optional - String[], the optional parameters

• optional[0] autoscroll boolean, if the component will be scrolled into view automatically before clicking. if not provided, the default value is true.

Throws:

SeleniumPlusException

doubleClick

public static void doubleClick(org.openqa.selenium.WebElement clickable,
                               java.awt.Point offset,
                               java.lang.String... optional)
                        throws SeleniumPlusException

Double-Click(Mouse Left Button) the WebElement at a certain coordination.

Parameters:

clickable - WebElement, the WebElement to click on

offset - Point, the coordination relative to this WebElement to click at

optional - String[], the optional parameters

• optional[0] autoscroll boolean, if the component will be scrolled into view automatically before clicking. if not provided, the default value is true.

Throws:

SeleniumPlusException

getLocation

public static java.awt.Point getLocation(org.openqa.selenium.WebElement webelement)
                                  throws SeleniumPlusException

Get the web-element's location relative to the browser. If the web-element is inside frames, the frame's location will also be added.
Note: The location got by this method might be slightly shifted. To get more accurate location, please call getLocation(WebElement, boolean) with 2th parameter given as false.

Parameters:

webelement - WebElement, the element to get location

Returns:

Point, the element's location inside a browser

Throws:

SeleniumPlusException

See Also:

#getLocation(WebElement, boolean)}

getLocation

public static java.awt.Point getLocation(org.openqa.selenium.WebElement webelement,
                                         boolean useOnPageFirstly)
                                  throws SeleniumPlusException

Get the web-element's location relative to the browser client area. If the web-element is inside frames, the frame's location will also be added.
Note: If the 2th parameter is given false, you might get a more accurate location.

Parameters:

webelement - WebElement, the element to get location

useOnPageFirstly - boolean, There are 2 ways to get element's location relative to the page: one is Coordinates.onPage(), the other is WebElement.getLocation(). it seems that the 2th method (WebElement.getLocation()) is more accurate. But historically, we called Coordinates.onPage() in first place.
If this parameter is true, Coordinates.onPage() will be used firstly as before.
Otherwise, WebElement.getLocation() will be used directly

Returns:

Point, the element's location relative to the browser client area

Throws:

SeleniumPlusException

getScreenLocation

public static java.awt.Point getScreenLocation(org.openqa.selenium.WebElement webelement)
                                        throws SeleniumPlusException

Get the absolute coordination on the screen of the webelement object.
Hope Selenium will give this function one day!

Parameters:

webelement - WebElement, a selenium webelement object

Returns:

Point, the absolute coordination on the screen of the webelement object.

Throws:

SeleniumPlusException

convertToKeys

public static org.openqa.selenium.Keys convertToKeys(RobotKeyEvent event)

Convert a SAFS RobotKeyEvent to a Selenium WebDriver Keys Enum

Parameters:

event - RobotKeyEvent

Returns:

Keys enum for (primarily) non-printable (control) characters, or null.

convertToKeys

public static org.openqa.selenium.Keys convertToKeys(int keycode)

Convert a Java KEYCODE to a Selenium WebDriver Keys Enum

Parameters:

keycode - int, a java keycode

Returns:

Keys enum for (primarily) non-printable (control) characters, or null.

convertToCharacter

static java.lang.CharSequence convertToCharacter(RobotKeyEvent event)

Convert a SAFS RobotKeyEvent to a standard CharSequence character.

Parameters:

event -

Returns:

CharSequence character, or null.

inputKeysSAFS2Selenium

public static void inputKeysSAFS2Selenium(org.openqa.selenium.WebElement we,
                                          java.lang.String keystrokes)
                                   throws SeleniumPlusException

Does NOT clear any existing text in the control, but does attempt to insure the window/control has focus.
Purpose: inputKeys

Bypasses attempts to use AWT Robot for keystrokes. Attempts to convert SAFS keystrokes to Selenium low-level Actions keystrokes.

Parameters:

we - WebElement to send SAFS keystrokes (or plain text).

keystrokes - SAFS keystrokes or plain text to type.

Throws:

SeleniumPlusException - if we are unable to process the keystrokes successfully.

keyPress

public static void keyPress(int keycode)
                     throws SeleniumPlusException

Press down a Key by Java Robot. Call keyRelease(int) to release the key.

Parameters:

keycode - int, keycode to press (e.g. KeyEvent.VK_A)

Throws:

SeleniumPlusException - if fail

See Also:

keyRelease(int)

keyRelease

public static void keyRelease(int keycode)
                       throws SeleniumPlusException

Release a Key by Java Robot. Release the key pressed by keyPress(int).

Parameters:

keycode - int, keycode to release (e.g. KeyEvent.VK_A)

Throws:

SeleniumPlusException - if fail

See Also:

keyPress(int)

mouseWheel

public static void mouseWheel(int wheelAmt)
                       throws SeleniumPlusException

Scroll the mouse wheel by Java Robot.

Parameters:

wheelAmt - int, the wheel amount to scroll.

Throws:

SeleniumPlusException - if fail

keyDown

public static void keyDown(org.openqa.selenium.Keys keycode)
                    throws SeleniumPlusException

Press down a Key by Selenium's Actions API. Call keyUp(Keys) to release the key.

Parameters:

keycode - Keys, keycode to press (e.g. Keys.CONTROL)

Throws:

SeleniumPlusException - if fail

See Also:

keyUp(Keys)

keyUp

public static void keyUp(org.openqa.selenium.Keys keycode)
                  throws SeleniumPlusException

Release a Key by Selenium's Actions API. Release the key pressed by keyDown(Keys).

Parameters:

keycode - Keys, keycode to release (e.g. Keys.CONTROL)

Throws:

SeleniumPlusException - if fail

See Also:

keyDown(Keys)

setDelayBetweenKeystrokes

public static void setDelayBetweenKeystrokes(int millisDelay)
                                      throws SeleniumPlusException

Sets a delay in milliseconds between Robot keystrokes for both local and remote servers.

Parameters:

millisDelay - between keystrokes.

Throws:

SeleniumPlusException - if we are unable to process the keystrokes successfully.

See Also:

Robot.setMillisBetweenKeystrokes(int)

getDelayBetweenKeystrokes

public static int getDelayBetweenKeystrokes()
                                     throws SeleniumPlusException

Gets the current delay in milliseconds between Robot keystrokes for both local and remote servers.

Throws:

SeleniumPlusException - if we are unable to process the keystrokes successfully.

See Also:

Robot.setMillisBetweenKeystrokes(int)

setWaitReaction

public static void setWaitReaction(boolean wait)
                            throws SeleniumPlusException

Set if wait for reaction to "input keys/chars" for both local and remote servers.

Parameters:

wait - boolean if wait or not.

Throws:

SeleniumPlusException - if fail.

See Also:

Robot.setWaitReaction(boolean)

setWaitReaction

public static void setWaitReaction(boolean wait,
                                   int tokenLength,
                                   int dealyForToken,
                                   int dealy)
                            throws SeleniumPlusException

Set if wait for reaction to "input keys/chars" for both local and remote servers.

Parameters:

wait - boolean, if wait or not.

tokenLength - int, the length of a token. Only if the string is longer than this then we wait the reaction after input-keys a certain time indicated by the parameter dealyForToken.

dealyForToken - int, The delay in millisecond to wait the reaction after input-keys for the string as long as a token.

dealy - int, The constant delay in millisecond to wait the reaction after input-keys.

Throws:

SeleniumPlusException - if fail.

See Also:

Robot.setWaitReaction(boolean, int, int, int)

inputKeys

public static void inputKeys(org.openqa.selenium.WebElement we,
                             java.lang.String keystrokes)
                      throws SeleniumPlusException

Does NOT clear any existing text in the control, but does attempt to insure the window/control has focus.
Purpose: inputKeys

Attempts to use AWT Robot for keystrokes for both local and remote servers. If the remote server does NOT have an RMI Server running to receive the request, then we will attempt to convert SAFS keystrokes to Selenium Actions keystrokes and try that way.

Parameters:

we - WebElement to send SAFS keystrokes; if null, the keystrokes will be sent to the focused element.

keystrokes - in SAFS format to type.

Throws:

SeleniumPlusException - if we are unable to process the keystrokes successfully.

See Also:

Robot.inputKeys(String), #inputKeysSAFS2Selenium(WebElement)

inputChars

public static void inputChars(org.openqa.selenium.WebElement we,
                              java.lang.String keystrokes)
                       throws SeleniumPlusException

Does NOT clear any existing text in the control, but does attempt to insure the window/control has focus.
Purpose: inputCharacters

Parameters:

we - WebElement to send characters; if null, the keystrokes will be sent to the focused element.

keystrokes/plain - text to type.

Throws:

SeleniumPlusException - if we are unable to process the keystrokes successfully.

See Also:

Robot.inputKeys(String)

clearClipboard

public static void clearClipboard()
                           throws SeleniumPlusException

Clear the clipboard on local machine or on machine where the RMI server is running.

Throws:

SeleniumPlusException

setClipboard

public static void setClipboard(java.lang.String content)
                         throws SeleniumPlusException

Set content to the clipboard on local machine or on machine where the RMI server is running.

Parameters:

content - String, the content to set to clipboard

Throws:

SeleniumPlusException

getClipboard

public static java.lang.Object getClipboard(java.awt.datatransfer.DataFlavor dataFlavor)
                                     throws SeleniumPlusException

Get the content from the clipboard on local machine or on machine where the RMI server is running.

Parameters:

dataFlavor - DataFlavor, the data flavor for the content in clipboard

Returns:

Object, the content of the clipboard

Throws:

SeleniumPlusException

getRectangleOnScreen

public static java.awt.Rectangle getRectangleOnScreen(org.openqa.selenium.WebElement we)
                                               throws SeleniumPlusException

Get the screen rectangle for a WebElement object.

Parameters:

we - WebElement, the webelement object to get screen rectangle

Returns:

Rectangle, the screen rectangle of a webelement object

Throws:

SeleniumPlusException

toJavaKeyCode

static int toJavaKeyCode(org.openqa.selenium.Keys key)
                  throws SeleniumPlusException

Parameters:

key - Keys, the selenium Keys value

Returns:

int the value of java KeyEvent

Throws:

SeleniumPlusException

captureScreen

public static void captureScreen(java.lang.String image)
                          throws SeleniumPlusException

Capture entire current HTML page

Parameters:

image - - Image full path with name.

Throws:

SeleniumPlusException

mouseHover

public static void mouseHover(org.openqa.selenium.WebElement we,
                              java.awt.Point point,
                              int millisStay)
                       throws SeleniumPlusException

Parameters:

we - WebElement, the component to hover mouse

point - Point, the position relative to the component to hover the mouse

millisStay - int, in milliseconds, the period to hover the mouse; the mouse will be moved out of screen if it expires.
if it equals Constants.TIMEOUT_HOVERMOUSE_STAY_FOREVER, then the mouse will always stay there forever.

Throws:

SeleniumPlusException - if the hover fail

altLeftDrag

public static void altLeftDrag(org.openqa.selenium.WebElement we,
                               java.awt.Point start,
                               java.awt.Point end)
                        throws SeleniumPlusException

Perform a left-drag from start point to end point relative to webelement (LeftUp corner) with the "ALT" key pressed during the drag.

Parameters:

we - WebElement, the component relative to which to drag

start - Point, the start point relative to the webelement

end - Point, the end point relative to the webelement

Throws:

SeleniumPlusException

ctrlAltLeftDrag

public static void ctrlAltLeftDrag(org.openqa.selenium.WebElement we,
                                   java.awt.Point start,
                                   java.awt.Point end)
                            throws SeleniumPlusException

Perform a left-drag from start point to end point relative to webelement (LeftUp corner) with the "CONTROL" and "ALT" key pressed during the drag.

Parameters:

we - WebElement, the component relative to which to drag

start - Point, the start point relative to the webelement

end - Point, the end point relative to the webelement

Throws:

SeleniumPlusException

ctrlLeftDrag

public static void ctrlLeftDrag(org.openqa.selenium.WebElement we,
                                java.awt.Point start,
                                java.awt.Point end)
                         throws SeleniumPlusException

Perform a left-drag from start point to end point relative to webelement (LeftUp corner) with the "CONTROL" key pressed during the drag.

Parameters:

we - WebElement, the component relative to which to drag

start - Point, the start point relative to the webelement

end - Point, the end point relative to the webelement

Throws:

SeleniumPlusException

ctrlShiftLeftDrag

public static void ctrlShiftLeftDrag(org.openqa.selenium.WebElement we,
                                     java.awt.Point start,
                                     java.awt.Point end)
                              throws SeleniumPlusException

Perform a left-drag from start point to end point relative to webelement (LeftUp corner) with the "CONTROL" and "SHIFT" key pressed during the drag.

Parameters:

we - WebElement, the component relative to which to drag

start - Point, the start point relative to the webelement

end - Point, the end point relative to the webelement

Throws:

SeleniumPlusException

shiftLeftDrag

public static void shiftLeftDrag(org.openqa.selenium.WebElement we,
                                 java.awt.Point start,
                                 java.awt.Point end)
                          throws SeleniumPlusException

Perform a left-drag from start point to end point relative to webelement (LeftUp corner) with the "SHIFT" key pressed during the drag.

Parameters:

we - WebElement, the component relative to which to drag

start - Point, the start point relative to the webelement

end - Point, the end point relative to the webelement

Throws:

SeleniumPlusException

rightDrag

public static void rightDrag(org.openqa.selenium.WebElement we,
                             java.awt.Point start,
                             java.awt.Point end)
                      throws SeleniumPlusException

Perform a right-drag from start point to end point relative to webelement (LeftUp corner).

Parameters:

we - WebElement, the component relative to which to drag

start - Point, the start point relative to the webelement

end - Point, the end point relative to the webelement

Throws:

SeleniumPlusException

leftDrag

public static void leftDrag(org.openqa.selenium.WebElement we,
                            java.awt.Point start,
                            java.awt.Point end)
                     throws SeleniumPlusException

Perform a left-drag from start point to end point relative to webelement (LeftUp corner).

Parameters:

we - WebElement, the component relative to which to drag

start - Point, the start point relative to the webelement

end - Point, the end point relative to the webelement

Throws:

SeleniumPlusException

getElementOffsetScreenLocation

public static java.awt.Point getElementOffsetScreenLocation(org.openqa.selenium.WebElement element,
                                                            java.lang.String offsetX,
                                                            java.lang.String offsetY)

Given the element, and the (offsetX, offsetY) relative to element. This function will calculate the offset point screen coordination.

Parameters:

element - WebElement, the element relative to which the coordination will be calculated.

offsetX - String, the offset on x axis, in pixel or in percentage, for example 15 or 30%.

offsetX - String, the offset on y axis, in pixel or in percentage, for example 45 or 50%.

Returns:

Point, the offset point screen coordination; or null if any exception occurred.

captureScreen

public static void captureScreen(org.openqa.selenium.WebElement we,
                                 java.lang.String imgName,
                                 java.lang.String fileformat)
                          throws SeleniumPlusException

Capture component image

Parameters:

we - - WebElement object.

imgName - - Image full path with name

Throws:

java.lang.Exception

SeleniumPlusException

captureBrowserArea

public static java.awt.image.BufferedImage captureBrowserArea(java.awt.Rectangle rectangle)
                                                       throws SeleniumPlusException

Capture the image on browser according to the rectangle relative to the browser.

Parameters:

rectangle - Rectangle, within which to capture the image.

Returns:

BufferedImage, the image within the rectangle on a browser, or the whole browser if rectangle is null.

Throws:

SeleniumPlusException

startBrowser

public static void startBrowser(java.lang.String BrowserName,
                                java.lang.String Url,
                                java.lang.String Id,
                                int timeout,
                                boolean isRemote)
                         throws SeleniumPlusException

Start browser

Parameters:

BrowserName - String, Browser name such as InternetExplorer, Chrome and FireFox.

Url - String, Url including HTTP protocol prefix.

Id - String, Id or Title of the Browser in case of two instances needs.

timeout - String, Implicit time out to be waited before throw exception.

isRemote - String, Start interactive testcase development mode.

Throws:

SeleniumPlusException

See Also:

#startBrowser(String, String, String, int, boolean, Map)}

startBrowser

public static void startBrowser(java.lang.String BrowserName,
                                java.lang.String Url,
                                java.lang.String Id,
                                int timeout,
                                boolean isRemote,
                                java.util.Map<java.lang.String,java.lang.Object> extraParameters)
                         throws SeleniumPlusException

Start browser

Expects System Properties 'selenium.host' and 'selenium.port' to be set.
Otherwise, defaults to 'localhost' on port '4444'.

Parameters:

BrowserName - String, Browser name such as InternetExplorer, Chrome and FireFox.

Url - String, Url including HTTP protocol prefix.

Id - String, Id or Title of the Browser in case of two instances needs.

timeout - String, Implicit time out to be waited before throw exception.

isRemote - String, Start interactive testcase development mode.

extraParameters - Map, can be used to pass more browser parameters, such as a firefox profile to use.

Throws:

SeleniumPlusException

stopBrowser

public static void stopBrowser(java.lang.String ID)
                        throws java.lang.IllegalArgumentException

Close browser (close all windows associated) indicated by ID. If the provided ID is associated with the "current" or "lastUsed" WebDriver the call to removeWebDriver will automatically "pop" the next WebDriver off the stack to be the new "current" or "lastUsed" WebDriver.

Parameters:

ID - String, the id to identify the browser

Throws:

java.lang.IllegalArgumentException - if the provided browser ID is NOT SearchObject.isValidBrowserID(String) or not known as a running instance.

See Also:

SearchObject.removeWebDriver(String)

resizeBrowserWindow

public static void resizeBrowserWindow(int width,
                                       int height)
                                throws SeleniumPlusException

Resize current browser window

Parameters:

width - int, width in pixels

height - int, height in pixels

Throws:

SeleniumPlusException

killChromeDriver

public static java.util.List<GenericProcessMonitor.ProcessInfo> killChromeDriver(java.lang.String host)
                                                                          throws SAFSException

Kill the process 'chromedriver.exe'.

Parameters:

host - String, the name of the machine on which the process 'chromedriver.exe' will be killed.

Returns:

List, a list containing the killed process's id and kill-execution-return-code.

Throws:

SAFSException

killIEDriverServer

public static java.util.List<GenericProcessMonitor.ProcessInfo> killIEDriverServer(java.lang.String host)
                                                                            throws SAFSException

Kill the process 'IEDriverServer.exe'.

Parameters:

host - String, the name of the machine on which the process 'IEDriverServer.exe' will be killed.

Returns:

List, a list containing the killed process's id and kill-execution-return-code.

Throws:

SAFSException

scrollBrowserWindowBy

public static void scrollBrowserWindowBy(int x,
                                         int y,
                                         org.openqa.selenium.WebElement element)
                                  throws SeleniumPlusException

scroll browser window by x and/or y number of pixels. Only works if the associated scrollbar(s) are actually visible. Synonymous to Javascript window.scrollBy(x,y).

Parameters:

x - int, horizontal scrolling in pixels

y - int, vertical scrolling in pixels

element, - scroll the topmost window containing this element.

Throws:

SeleniumPlusException

scrollBrowserWindowTo

public static void scrollBrowserWindowTo(int x,
                                         int y,
                                         org.openqa.selenium.WebElement element)
                                  throws SeleniumPlusException

scroll browser window to x and/or y scroll position. Only works if the associated scrollbar(s) are actually visible. Synonymous to Javascript window.scrollTo(x,y).

Parameters:

x - int, horizontal position in pixels

y - int, vertical position in pixels

element, - scroll the topmost window containing this element.

Throws:

SeleniumPlusException

alignToTop

public static void alignToTop(org.openqa.selenium.WebElement element)
                       throws SeleniumPlusException

Align the top of webelement to the top of browser.

Parameters:

element - WebElement, the element to scroll to align with browser's top

Throws:

SeleniumPlusException

alignToBottom

public static void alignToBottom(org.openqa.selenium.WebElement element)
                          throws SeleniumPlusException

Align the bottom of webelement to the bottom of browser.

Parameters:

element - WebElement, the element to scroll to align with browser's bottom

Throws:

SeleniumPlusException

showOnPage

public static boolean showOnPage(org.openqa.selenium.WebElement element)

Try to show the webelement on the browser's page.

Parameters:

element - WebElement, the webelement to show.

Returns:

boolean, true if succeed

showOnPage

public static boolean showOnPage(org.openqa.selenium.WebElement element,
                                 java.lang.String... optional)

Try to show the webelement on the browser's page.
First, try to see if the web-element is already shown on page, if not shown on the page
then it will try to move the web-element to show it on page.
Finally, if the passed in parameter verify is true, it will return true only if the element is shown on the page;
if the passed in parameter verify is false, it will always return true.

Parameters:

element - WebElement, the webelement to show.

params - optional

optionals[0] verify boolean, verify that the component is shown on page. The default value is false.

Returns:

boolean, true if succeed

isShowOnPage

public static boolean isShowOnPage(org.openqa.selenium.WebElement element)

Parameters:

element - WebElement, to check if it is shown on the page

Returns:

boolean true if the web-element is fully shown on the page

isShowOnPage

public static boolean isShowOnPage(org.openqa.selenium.WebElement element,
                                   org.openqa.selenium.Point offset)

To check if a certain point of web-element is shown on the page.
If the point is not given or it is out of boundary of web-element, method will
check if the web-element is fully shown on the page.

Parameters:

element - WebElement, to check if it is shown on the page

offset - Point, the offset from Left-Top of web-element; the point to check. can be null

Returns:

boolean if the offest-point or the full-web-element is shown on the page.

isLocationInBounds

public static boolean isLocationInBounds(org.openqa.selenium.Point p,
                                         org.openqa.selenium.Dimension bounds)

check if the point p locates in the Dimension.

Parameters:

p - Point, relative to the Dimension. Usually the top-left point of an item. see if the Point is inside bounds of 0,0,bounds.width, bounds.height.

bounds - Dimension, the boundary

Returns:

boolean true if the point p locates in the Dimension. A point p on the extreme width or height boundary is NOT in-bounds.

isPointInBounds

public static boolean isPointInBounds(org.openqa.selenium.Point p,
                                      org.openqa.selenium.Dimension bounds)

check if the Point p locates inside the Dimension.

Parameters:

p - Point, point relative to 0,0, bounds.width, bounds.height. Usually this is the bottom-right point test of a boundary.

bounds - Dimension, the boundary

Returns:

boolean true if the point p locates in the Dimension. A point p on the extreme width or height boundary IS considered in-bounds.

setPositionBrowserWindow

public static void setPositionBrowserWindow(int x,
                                            int y)
                                     throws SeleniumPlusException

Set position of current browser window. Synonymous to Javascript window.moveTo().

Parameters:

x - int, x-coordination in pixels

y - int, y-coordination in pixels

Throws:

SeleniumPlusException

maximizeBrowserWindow

public static void maximizeBrowserWindow()
                                  throws SeleniumPlusException

Maximize current browser window

Throws:

SeleniumPlusException

minimizeBrowserWindow

public static void minimizeBrowserWindow()
                                  throws SeleniumPlusException

This implementation does NOT really minimize the window, it is a workaround.
Note: set the size to (0,0) can NOT minimize the window. So move the window out of the screen.
Minimize current browser window

Throws:

SeleniumPlusException

getBrowserWithTitle

public static org.openqa.selenium.WebDriver getBrowserWithTitle(java.lang.String title)
                                                         throws SeleniumPlusException

Retrieves the WebDriver/Browser with the given title. This also makes that WebDriver the "current" or "lastUsedWD".

Parameters:

title -

Returns:

Throws:

SeleniumPlusException

closeBrowser

public static void closeBrowser()
                         throws SeleniumPlusException

Close the Browser/WebDriver associated with the last WebElement accessed. So, we will assume the lastUsedWD is the browser to close. Currently, the call to stopBrowser will set the new lastUsedWD. However, in the future the search algorithms for each component will set the lastUsedWD independently.

Throws:

SeleniumPlusException - if the lastUsed WebDriver is not valid or is null.

See Also:

stopBrowser(String)

getBrowserWithID

public static org.openqa.selenium.WebDriver getBrowserWithID(java.lang.String id)
                                                      throws SeleniumPlusException

Retrieves the WebDriver/Browser with the given id. This also makes that WebDriver the "current" or "lastUsedWD".

Parameters:

id -

Returns:

Throws:

SeleniumPlusException

highlightElement

public static void highlightElement(org.openqa.selenium.WebElement element)
                             throws SeleniumPlusException

Deprecated. it is replaced by SearchObject.highlight(WebElement).

Highlight Element / object

Parameters:

element - to be highlighted

Throws:

SeleniumPlusException

getBrowserName

public static java.lang.String getBrowserName(org.openqa.selenium.WebDriver driver)

Parameters:

driver - -- can be null to use the last used WebDriver session.

Returns:

String of browser name or null if there is no WebDriver session.

See Also:

SelectBrowser.BROWSER_NAME_CHROME, SelectBrowser.BROWSER_NAME_FIREFOX, SelectBrowser.BROWSER_NAME_HTMLUNIT, SelectBrowser.BROWSER_NAME_IE, SelectBrowser.BROWSER_NAME_SAFARI

isHtmlUnit

public static boolean isHtmlUnit(org.openqa.selenium.WebDriver driver)

Parameters:

driver - -- can be null to use last used webdriver session.

Returns:

true if browser name matches BROWSER_NAME_HTMLUNIT

See Also:

getBrowserName(WebDriver), SelectBrowser.BROWSER_NAME_HTMLUNIT

isSafari

public static boolean isSafari(org.openqa.selenium.WebDriver driver)

Parameters:

driver - -- can be null to use last used webdriver session.

Returns:

true if browser name matches BROWSER_NAME_SAFARI

See Also:

getBrowserName(WebDriver), SelectBrowser.BROWSER_NAME_SAFARI

isFireFox

public static boolean isFireFox(org.openqa.selenium.WebDriver driver)

Parameters:

driver - -- can be null to use last used webdriver session.

Returns:

true if browser name matches BROWSER_NAME_FIREFOX

See Also:

getBrowserName(WebDriver), SelectBrowser.BROWSER_NAME_FIREFOX

isInternetExplorer

public static boolean isInternetExplorer(org.openqa.selenium.WebDriver driver)

Parameters:

driver - -- can be null to use last used webdriver session.

Returns:

true if browser name matches BROWSER_NAME_IE

See Also:

getBrowserName(WebDriver), SelectBrowser.BROWSER_NAME_IE

isChrome

public static boolean isChrome(org.openqa.selenium.WebDriver driver)

Parameters:

driver - -- can be null to use last used webdriver session.

Returns:

true if browser name matches BROWSER_NAME_CHROME

See Also:

getBrowserName(WebDriver), SelectBrowser.BROWSER_NAME_CHROME

getSeleniumBuilderScript

public static com.sebuilder.interpreter.Script getSeleniumBuilderScript(java.lang.String path)
                                                                 throws java.io.FileNotFoundException

Load a SeBuilder JSON Script from the provided path so it can be started or run.

Parameters:

path - -- full path to the JSON script.

Returns:

Script

Throws:

java.io.FileNotFoundException - -- if a provided path is null or otherwise invalid

getWebDriverAsWebDriverFactory

public static com.sebuilder.interpreter.webdriverfactory.WebDriverFactory getWebDriverAsWebDriverFactory()

Returns:

the "current" or "lastUsed" WebDriver as a WebDriverFactory usable by the Selenium Builder Interpreter.

runSeleniumBuilderScript

public static boolean runSeleniumBuilderScript(java.lang.String path,
                                               org.apache.commons.logging.Log log,
                                               com.sebuilder.interpreter.webdriverfactory.WebDriverFactory driverFactory,
                                               java.util.HashMap<java.lang.String,java.lang.String> webDriverConfig,
                                               java.util.Map<java.lang.String,java.lang.String> initialVars,
                                               boolean allowClose)
                                        throws java.io.FileNotFoundException,
                                               java.lang.RuntimeException

Run a SeBuilder JSON Script.

Parameters:

path - - fullpath to JSON script file.

log - - An appropriate logging interface--such as the ApacheLogUtilities we instantiate when launching our Selenium engine.

driverFactory - -- if null, we will use a default Factory that does NOT instantiate a new WebDriver but uses the "current" or "lastUsed" WebDriver ignoring any webDriverConfig that may or may not be provided.

Consult the Selenium Interpreter documentation for any additional info on using the Selenium Builder Interpreter if you are NOT intending to use the current or lastUsed WebDriver.

webDriverConfig - -- can be null if driverFactory is null and we will be using an existing WebDriver.

initialVars - -- can be null.

allowClose - -- set to false to prevent the script from closing the Driver.

Returns:

Throws:

java.io.FileNotFoundException

java.lang.RuntimeException

runSeleniumBuilderScript

public static boolean runSeleniumBuilderScript(java.lang.String path,
                                               org.apache.commons.logging.Log log,
                                               boolean allowClose)
                                        throws java.io.FileNotFoundException,
                                               java.lang.RuntimeException

Run a SeBuilder JSON Script explicitly using the existing WebDriver instance.

Parameters:

path - - fullpath to JSON script file.

log - - An appropriate logging interface--such as the ApacheLogUtilities we instantiate when launching our Selenium engine.

allowClose - -- set to false to prevent the script from closing the Driver.

Returns:

Throws:

java.io.FileNotFoundException

java.lang.RuntimeException

windowSetFocus

public static boolean windowSetFocus(org.openqa.selenium.WebElement element)
                              throws SeleniumPlusException

Attempt to SetFocus on the topmost window containing the WebElement.

Parameters:

element - WebElement from which to get the proper RemoteWebDriver

Returns:

boolean true if the window is focused.

Throws:

SeleniumPlusException - if an error occured during the execution attempt.

See Also:

windowSetFocus(WebDriver)

windowSetFocus

public static boolean windowSetFocus(org.openqa.selenium.WebDriver adriver)
                              throws SeleniumPlusException

Attempt to SetFocus on the topmost window for the provided WebDriver.

Parameters:

adriver - WebDriver from which to get the window title

Returns:

boolean true if the window is focused.

Throws:

SeleniumPlusException - if an error occured during the execution attempt.

See Also:

windowSetFocus(String)

windowSetFocus

public static boolean windowSetFocus(java.lang.String titleRegExp)
                              throws SeleniumPlusException

Set a specific Window matching the provided title to be the foreground window.

Parameters:

titleRegExp - -- title or regular expression matching the target window's caption.

Returns:

true on success

Throws:

SeleniumPlusException

See Also:

NativeWrapper#SetForegroundWindow(String)}

focus

public static boolean focus(org.openqa.selenium.WebElement element)
                     throws SeleniumPlusException

Attempt to SetFocus on the WebElement.

Parameters:

element - WebElement, to get focus.

Returns:

boolean true if the webelement is focused.

Throws:

SeleniumPlusException

getCssValues

public static java.util.Map<java.lang.String,java.lang.String> getCssValues(org.openqa.selenium.WebElement element)

Get css values of the object

Parameters:

element - - WebElement

Returns:

- return map as key and value pair

getProperty

public static java.lang.String getProperty(org.openqa.selenium.WebElement element,
                                           java.lang.String property)
                                    throws SeleniumPlusException

get the value of a property. The property can be an attribute, a css-attribute, a true property field, or certain property methods.

Parameters:

element - WebElement, from which to retrieve the property

property - String, the property name

Returns:

String, the value of the property

Throws:

SeleniumPlusException - if the attribute or property is not found.

See Also:

getProperties(WebElement)

getProperties

public static java.util.Map<java.lang.String,java.lang.Object> getProperties(org.openqa.selenium.WebElement element)
                                                                      throws SeleniumPlusException

Retrieve all properties of an element--attributes, css values, property fields and certain property methods.

Parameters:

element - WebElement, from which to retrieve all properties

Returns:

Map, a set of pair(property, value)

Throws:

SeleniumPlusException

fireMouseEvent

public static void fireMouseEvent(MouseEvent event)
                           throws SeleniumPlusException

Attempts to fire (dispatchEvent) a MouseEvent. The MouseEvent should be suitable and contain all relevant and necessary information for the event. This is typically used to re-fire a MouseEvent that might have been captured with DocumentClickCapture but was not allowed to propagate to the actual element.

Parameters:

event -

Throws:

SeleniumPlusException - on an execution error.

java.lang.NullPointerException - if required parameters in the MouseEvent are null.

getBrowserName

public static java.lang.String getBrowserName()

Returns:

String, the name of the browser where test is running. Or null if something wrong happens.

getBrowserVersion

public static java.lang.String getBrowserVersion()

Returns:

String, the version of the browser where test is running. Or null if something wrong happens.

getPlatform

public static java.lang.String getPlatform()

Returns:

String, the name of the platform where the browser is running. Or null if something wrong happens.

getDriverVersion

public static java.lang.String getDriverVersion()

Returns:

String, the version of 'selenium server' with which the test is running. Or null if something wrong happens.

checkKnownIssue

public static void checkKnownIssue(java.lang.String keyword)
                            throws SeleniumPlusException

Check some known issue for a certain keyword.

Parameters:

keyword - String, the keyword to check for, such like "GetURL"

Throws:

SeleniumPlusException - will be thrown out if a known issue is checked.

clickUnverified

public static boolean clickUnverified(org.openqa.selenium.WebElement component,
                                      java.awt.Point offset,
                                      java.lang.String... optional)

Click a component with an offset. This API will not verify that the click does happen.
If you want to make sure of that, please call #click(WebElement, Point) instead.

Sometimes we want to click without verification, for example, to show an Alert.
With presence of Alert, any call to Selenium API will throw out UnhandledAlertException
and close the Alert automatically. Our API #click(WebElement, Point) will call
Selenium API for verification, so it is unable to open the Alert successfully.

Parameters:

component - WebElement, the component to click

offset - Point, the offset (relative to component) to click at

optional - String[], the optional parameters

• optional[0] autoscroll boolean, if the component will be scrolled into view automatically before clicking. if not provided, the default value is true.

Returns:

boolean true if succeed.

See Also:

#click(WebElement, Point)

closeAlert

public static void closeAlert(boolean accept,
                              java.lang.String... optionals)
                       throws SeleniumPlusException

Close the Alert-Modal-Dialog associated with a certain browser identified by ID.
It will get the cached webdriver according to the browser's id, and close the 'alert' through that webdriver.
Note:This API will NOT change the current WebDriver. SearchObject.getWebDriver() will still return the same object.

Parameters:

accept - boolean, if true then accept (click OK) the alert; otherwise dismiss (click Cancel) the alert.

optionals - String

optionals[0] timeoutWaitAlertPresence int, timeout in seconds to wait for the presence of Alert. If not provided, default is 2 seconds.
optionals[1] browserID String, the ID to get the browser on which the 'alert' will be closed. If not provided, the current browser will be used.

Throws:

SeleniumPlusException, - if WebDriver cannot be got according to the parameter browserID.
if Alert is not present with timeout.

SeleniumPlusException

isAlertPresent

public static boolean isAlertPresent(java.lang.String... optionals)
                              throws SeleniumPlusException

Test the presence of Alert-Modal-Dialog associated with a certain browser identified by ID.
It will get the cached webdriver according to the browser's id, and get the 'alert' through that webdriver.
Note:This API will NOT change the current WebDriver. SearchObject.getWebDriver() will still return the same object.

Parameters:

optionals - String...

optionals[0] timeoutWaitAlertPresence int, timeout in seconds to wait for the presence of Alert. If not provided, default is 2 seconds.
If it is provided as TIMEOUT_NOWAIT, this method will try to get Alert without waiting.
optionals[1] browserID String, the ID to get the browser on which the 'alert' will be closed. If not provided, the current browser will be used.

Returns:

boolean, true if the Alert is present.

Throws:

SeleniumPlusException - if the WebDriver is null

See Also:

waitAlert(String...)

main

public static void main(java.lang.String[] args)

Before running this method, please read java doc of test_ajax_call(String)

Parameters:

args -