org.safs.selenium.webdriver

Class SeleniumPlus.Misc

java.lang.Object

org.safs.SAFSPlus.DriverCommand

org.safs.SAFSPlus.Misc

org.safs.selenium.webdriver.SeleniumPlus.Misc

Enclosing class:

SeleniumPlus

public static class SeleniumPlus.Misc
extends SAFSPlus.Misc

Convenience class for miscellaneous Driver Commands.
This is a sub-class of SAFSPlus.Misc and it provides more convenient wrapper APIs related to Selenium.
The class SAFSPlus.Misc is a sub-class of DriverCommand.

See Also:

SAFSPlus.Misc, SAFSPlus.DriverCommand

Constructor Summary

Constructors

Constructor and Description
Misc()

Method Summary

Modifier and Type	Method and Description
static boolean	AlertAccept(java.lang.String... optionals) Accept (Clicking OK button) the Alert Dialog associated with a browser. This command will wait 2 seconds by default for the presence of Alert.
static boolean	AlertDismiss(java.lang.String... optionals) Dismiss (Clicking Cancel button) the Alert Dialog associated with a browser. This command will wait 2 seconds by default for the presence of Alert.
static int	GetCheckAlertTimeout() Get the current 'Check Alert Timeout' value.
static boolean	IsAlertPresent(java.lang.String... optionals) Test the presence of an Alert Dialog associated with a browser. This command will wait 2 seconds by default for the presence of Alert.
static void	SetCheckAlertTimeout(int seconds) Set the 'Check Alert Timeout'.
static boolean	SetClickCapture(boolean on) Turn on/off 'click capture'. Note: Calling this will not write success/failure message into the test log.

Methods inherited from class org.safs.SAFSPlus.Misc

GetAppMapValue, GetAppMapValue, GetAppMapValue, GetMillisBetweenRecords, IsComponentExists, isExpressionsOn, ResolveExpression, SwitchWindow

Methods inherited from class org.safs.SAFSPlus.DriverCommand

AssignClipboardVariable, CallJUnit, CallRemote, CallScript, CaptureMousePositionOnScreen, ClearAllVariables, ClearAppMapCache, ClearArrayVariables, ClearClipboard, CloseApplication, CloseApplicationMap, CopyVariableValueEx, Delay, Expressions, GetRegistryKeyValue, GetRegistryKeyValue, GetSystemDate, GetSystemDateTime, GetSystemTime, GetURL, Highlight, LaunchApplication, OnGUIExistsGotoBlockID, OnGUINotExistGotoBlockID, Pause, SaveClipboardToFile, SaveURLToFile, ScrollWheel, SendMail, SetApplicationMap, SetClipboard, SetImageDebug, SetImageFuzzyMatching, SetMillisBetweenRecords, SetMultipleThreadSearch, SetVariableValueEx, SetVariableValues, StartWebBrowser, StopWebBrowser, TakeScreenShot, TakeScreenShot, UseWebBrowser, VerifyClipboardToFile, VerifyURLContent, VerifyURLToFile, WaitForGUI, WaitForGUI, WaitForGUIGone, WaitForPropertyValue, WaitForPropertyValueGone, WaitForRegistryKeyExists, WaitForRegistryKeyValue

Methods inherited from class java.lang.Object

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

Constructor Detail

Misc

public Misc()

Method Detail

SetClickCapture

public static boolean SetClickCapture(boolean on)

Turn on/off 'click capture'.
Note: Calling this will not write success/failure message into the test log.

To make sure that 'click' action happens, we use 'ClickCapture' to monitor 'click event' of the target component. But sometimes for some reason, even click does happen, the 'ClickCapture' cannot receive the 'click event' and this will cause different kinds of troubles. At this situation, to avoid this problem 'click capture' could be turned off.
Later, we could always to turn on 'click capture' to guarantee that click happens.

Parameters:

on - boolean, if true then the 'click capture' will be turned on; otherwise turned off.

Returns:

boolean, true if succeed.

IsAlertPresent

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

Test the presence of an Alert Dialog associated with a browser.
This command will wait 2 seconds by default for the presence of Alert.

Parameters:

optionals - String

optionals[0] timeoutWaitAlertPresence int, timeout in seconds to wait for the presence of Alert. If not provided, default is 2 seconds.
optionals[0] 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 if the Alert exist

Throws:

SeleniumPlusException - if there is any un-expected error.

See Also:

SAFSPlus#StartWebBrowser(String, String, String...)

Example:

 
 1) boolean success = IsAlertPresent();//Test the presence of Alert (belongs to current browser) with 2 seconds timeout.
 2) boolean success = IsAlertPresent("0");//Test the presence of Alert (belongs to current browser) immediately
 3) boolean success = IsAlertPresent("5", "browser-id");//Test the presence of Alert (belongs to browser identified by "browser-id"),
                                                        //before that it will wait 5 seconds for the presence of the Alert
 

AlertAccept

public static boolean AlertAccept(java.lang.String... optionals)

Accept (Clicking OK button) the Alert Dialog associated with a browser.
This command will wait 2 seconds by default for the presence of Alert.

Parameters:

optionals - String

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

See Also:

SAFSPlus#StartWebBrowser(String, String, String...)

Example:

 
 1) boolean success = AlertAccept();//Close Alert (belongs to current browser) by clicking the OK button
 2) boolean success = AlertAccept("5");//Close Alert (belongs to current browser) by clicking the OK button,
                                       //before that it will wait 5 seconds for the presence of the Alert
 3) boolean success = AlertAccept("5", "browser-id");//Close Alert (belongs to browser identified by "browser-id") by clicking the OK button,
                                                     //before that it will wait 5 seconds for the presence of the Alert
 

AlertDismiss

public static boolean AlertDismiss(java.lang.String... optionals)

Dismiss (Clicking Cancel button) the Alert Dialog associated with a browser.
This command will wait 2 seconds by default for the presence of Alert.

Parameters:

optionals - String

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

See Also:

SAFSPlus#StartWebBrowser(String, String, String...)

Example:

 
 1) boolean success = AlertAccept();//Close Alert (belongs to current browser) by clicking the Cancel button
 2) boolean success = AlertAccept("5");//Close Alert (belongs to current browser) by clicking the Cancel button,
                                       //before that it will wait 5 seconds for the presence of the Alert
 3) boolean success = AlertAccept("5", "browser-id");//Close Alert (belongs to browser identified by "browser-id") by clicking the Cancel button,
                                                     //before that it will wait 5 seconds for the presence of the Alert
 

SetCheckAlertTimeout

public static void SetCheckAlertTimeout(int seconds)

Set the 'Check Alert Timeout'. Usually, it is used to expand the time to wait for the 'Alert Box' popping up. By default, the 'Check Alert Timeout' is 0.

Parameters:

seconds - int, the value of time to set.

GetCheckAlertTimeout

public static int GetCheckAlertTimeout()

Get the current 'Check Alert Timeout' value.