org.safs

Class SAFSPlus.Component

java.lang.Object

org.safs.SAFSPlus.Component

Direct Known Subclasses:

SAFSPlus.CheckBox, SAFSPlus.ComboBox, SAFSPlus.EditBox, SAFSPlus.ListView, SAFSPlus.Menu, SAFSPlus.ScrollBar, SAFSPlus.TabControl, SAFSPlus.Tree, SeleniumPlus.Component

Enclosing class:

SAFSPlus

public static class SAFSPlus.Component
extends java.lang.Object

Wrapper class providing APIs to handle GenericMasterFunctions Reference and GenericObjectFunctions Reference, like VerifyProperty, IsPropertyExist etc.

Constructor Summary

Constructors

Constructor and Description
Component()

Method Summary

Modifier and Type	Method and Description
static boolean	AltLeftDrag(Component comp, java.lang.String coordinates) A Alt left mouse drag is performed on the object based on the stored coordinates relative to this object.
static boolean	AssignPropertyVariable(Component comp, java.lang.String property, java.lang.String variable) Assign object property to a variable.
static boolean	CaptureObjectDataToFile(Component comp, java.lang.String fileName, java.lang.String... params) Copy the current contents of a component's data to a file.
static boolean	CapturePropertiesToFile(Component comp, java.lang.String file, java.lang.String... fileEncoding) Copy all of the value properties a test object to a file.
static boolean	CapturePropertyToFile(Component comp, java.lang.String property, java.lang.String file, java.lang.String... fileEncoding) Copy a propertie's value of a test object to to a file.
static boolean	ClearCache(Component comp) Some components like Tree, Menu may have a cache containing their content or time-consuming resource, which will speed up the test.
static boolean	Click(Component comp, java.lang.String... params) Click on any visible component.
static boolean	CtrlAltLeftDrag(Component comp, java.lang.String coordinates) A Ctrl Alt left mouse drag is performed on the object based on the stored coordinates relative to this object.
static boolean	CtrlClick(Component comp, java.lang.String... params) Control-Click on any visible component.
static boolean	CtrlLeftDrag(Component comp, java.lang.String coordinates) A Ctrl left mouse drag is performed on the object based on the stored coordinates relative to this object.
static boolean	CtrlRightClick(Component comp, java.lang.String... params) Control-Right-Click on any visible component.
static boolean	CtrlShiftLeftDrag(Component comp, java.lang.String coordinates) A Ctrl Shift left mouse drag is performed on the object based on the stored coordinates relative to this object.
static boolean	DoubleClick(Component comp, java.lang.String... params) Double-Click on any visible component.
static boolean	DragTo(Component from, Component to, java.lang.String... optionals) A left mouse drag is performed from one object to another object based on the offsets values.
static boolean	ExecuteScript(Component comp, java.lang.String script, java.lang.String... scriptParams) Execute a simple piece of javascript on component synchronously.
static boolean	GetComputedStyle(Component comp, java.lang.String testfile) Save component's computed CSS style to a test file.
static boolean	GetGUIImage(Component comp, java.lang.String fileName, java.lang.String... params) Take a screenshot of windows or component. See Detailed Reference
static boolean	GetTextFromGUI(Component comp, java.lang.String variable, java.lang.String... params) Incorporate OCR technology to detect the text on a GUI component and save the text to a variable.
static boolean	GUIDoesExist(Component comp) Verify the visual existence of a particular window and/or component.
static boolean	GUIDoesNotExist(Component comp) Verify the visual non-existence of a particular window and/or component.
static boolean	HoverMouse(Component comp, java.lang.String... optionals) Hover the mouse over a component.
static boolean	HoverScreenLocation(java.lang.String coordination, java.lang.String... optionals) Hover the mouse over a specified screen location.
static boolean	InputCharacters(Component comp, java.lang.String textvalue) Sends key characters to the specified Component.
static boolean	InputKeys(Component comp, java.lang.String textvalue) Sends keystrokes to the specified Component.
static boolean	IsPropertyExist(Component comp, java.lang.String property) Verify if object's property exists or not.
static boolean	IsPropertyExist(Component comp, java.lang.String property, java.lang.String variable) Verify if object's property exists or not.
static boolean	LeftDrag(Component comp, java.lang.String coordinates) A left mouse drag is performed on the object based on the stored coordinates relative to this object.
static boolean	LocateScreenImage(Component comp, java.lang.String variable, java.lang.String... optionals) Store the location and dimensions of a component.
static boolean	RightClick(Component comp, java.lang.String... params) Right-Click on any visible component.
static boolean	RightDrag(Component comp, java.lang.String coordinates) A right mouse drag is performed on the object based on the stored coordinates relative to this object.
static boolean	SaveTextFromGUI(Component comp, java.lang.String outputFile, java.lang.String... params) Incorporate OCR technology to detect the text on a GUI component and save the text to a file.
static boolean	ShiftClick(Component comp, java.lang.String... params) Shift-Click on any visible component.
static boolean	ShiftLeftDrag(Component comp, java.lang.String coordinates) A Shift left mouse drag is performed on the object based on the stored coordinates relative to this object.
static boolean	ShowOnPage(Component comp, java.lang.String... params) Make the component visible on the page.
static boolean	TypeChars(java.lang.String textvalue) Sends key characters to the current keyboard focus via AWT Robot.
static boolean	TypeEncryption(java.lang.String encryptedDataFile, java.lang.String privateKeyFile) Sends secret-text (such as password) to the current focused Component. See Detailed Reference
static boolean	TypeKeys(java.lang.String textvalue) Sends AWT Robot keystrokes to whatever currently has keyboard focus.
static boolean	VerifyBinaryFileToFile(java.lang.String benchFile, java.lang.String actualFile, java.lang.String... optionals) Verify the current contents of a binary (image) file with a benchmark file.
static boolean	VerifyComputedStyle(Component comp, java.lang.String benchfile) Verify computed CSS style against bench mark.
static boolean	VerifyFileToFile(java.lang.String benchFile, java.lang.String actualFile, java.lang.String... optionals) Verify the current contents of a text file with a benchmark file (same as VerifyTextFileToFile).
static boolean	VerifyGUIImageToFile(Component comp, java.lang.String benchFile, java.lang.String... params) Verify the screen shot of a GUI component with a benchmark image file.
static boolean	VerifyObjectDataToFile(Component comp, java.lang.String benchFile, java.lang.String... params) Verify the current contents of a component's data with a benchmark file.
static boolean	VerifyPropertiesSubsetToFile(Component comp, java.lang.String benchFile, java.lang.String... params) Compare/Verify the value properties of a test object with a benchmark file. Only those property names and values in the benchmark file will be compared.
static boolean	VerifyPropertiesToFile(Component comp, java.lang.String benchFile, java.lang.String... params) Compare/Verify all of the value properties of a test object with a benchmark file.
static boolean	VerifyProperty(Component comp, java.lang.String property, java.lang.String value) Verify object property.
static boolean	VerifyPropertyContains(Component comp, java.lang.String property, java.lang.String containedValue) Verify that the value of an object property contains a string. The property could be attribute or CSS property.
static boolean	VerifyPropertyContains(Component comp, java.lang.String property, java.lang.String containedValue, boolean caseSensitive) Verify that the value of an object property contains a string. The property could be attribute or CSS property.
static boolean	VerifyPropertyToFile(Component comp, java.lang.String property, java.lang.String benchFile, java.lang.String... params) Verify the value of a single object property with a benchmark file.
static boolean	VerifyTextFileToFile(java.lang.String benchFile, java.lang.String actualFile, java.lang.String... optionals) Verify the current contents of a text file with a benchmark file (same as VerifyFileToFile).
static boolean	VerifyValueContains(java.lang.String wholeString, java.lang.String substring, java.lang.String... optionals) Verify that a string value contains a substring.
static boolean	VerifyValueContainsIgnoreCase(java.lang.String wholeString, java.lang.String substring, java.lang.String... optionals) Verify that a string value contains a substring, ignoring case.
static boolean	VerifyValueDoesNotContain(java.lang.String wholeString, java.lang.String substring, java.lang.String... optionals) Verify that a string value does NOT contain a substring.
static boolean	VerifyValues(java.lang.String value1, java.lang.String value2, java.lang.String... optionals) Verify that two string values are identical.
static boolean	VerifyValuesIgnoreCase(java.lang.String value1, java.lang.String value2, java.lang.String... optionals) Verify that two string values are identical, ignoring case.
static boolean	VerifyValuesNotEqual(java.lang.String value1, java.lang.String value2, java.lang.String... optionals) Verify that two string values are NOT identical.

Methods inherited from class java.lang.Object

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

Constructor Detail

Component

public Component()

Method Detail

AssignPropertyVariable

public static boolean AssignPropertyVariable(Component comp,
                                             java.lang.String property,
                                             java.lang.String variable)

Assign object property to a variable. The property could be attribute or CSS property.

Parameters:

comp - -- Component (from App Map) to get property.

property - -- attribute or CSS property.

variable - -- the name of the variable to receive the proeprty value.

Returns:

true on success.

Example:

 
 String labelVar = "labelVar";
 Component.AssignPropertyVariable(Map.AUT.Lable,"textContent", labelVar);
 String label = SAFSPlus.GetVariableValue(labelVar);
 
 

CaptureObjectDataToFile

public static boolean CaptureObjectDataToFile(Component comp,
                                              java.lang.String fileName,
                                              java.lang.String... params)

Copy the current contents of a component's data to a file.

Parameters:

comp - Component, (from App Map) to retrieve data.

fileName - String, The file containing the component's data.

params - optional

params[0] encoding String, The file encoding

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = Component.CaptureObjectDataToFile(Map.SampleApp.ListView, "listview.dat");
 boolean success = Component.CaptureObjectDataToFile(Map.SampleApp.ListView, "listview.dat", "utf-8");
 boolean success = Component.CaptureObjectDataToFile(Map.SampleApp.ListView, "d:\testproj\test\listview.dat");
 
 

CapturePropertiesToFile

public static boolean CapturePropertiesToFile(Component comp,
                                              java.lang.String file,
                                              java.lang.String... fileEncoding)

Copy all of the value properties a test object to a file.

Parameters:

comp - Component (from App Map) to retrieve all properties.

file - String, to store all properties

fileEncoding - String, the encoding of the file. optional, default is the system-encoding.

Returns:

True on success, a file will be created into Actuals dir

Example:

 
 Component.CapturePropertiesToFile(Map.Google.SignIn, "singin.properties");
 Component.CapturePropertiesToFile(Map.Google.SignIn, "singin.properties", "UTF-8");
 
 

CapturePropertyToFile

public static boolean CapturePropertyToFile(Component comp,
                                            java.lang.String property,
                                            java.lang.String file,
                                            java.lang.String... fileEncoding)

Copy a propertie's value of a test object to to a file.

Parameters:

property - String, the property name to get value

comp - Component (from App Map) to retrieve property's value

fileEncoding - String, the encoding of the file. optional, default is the system-encoding.

Returns:

boolean, True on success and a file will be created into Actuals dir

Example:

 
 Component.CapturePropertyToFile(Map.Google.SignIn, "display", "singin.dispaly.dat");
 Component.CapturePropertyToFile(Map.Google.SignIn, "color", "singin.color.dat", "UTF-8");
 
 

ClearCache

public static boolean ClearCache(Component comp)

Some components like Tree, Menu may have a cache containing their content or time-consuming
resource, which will speed up the test. But the cache may contain obsolete objects, and they will
affect the test, to use component's latest data, user needs call this method to clear the cache

Parameters:

comp - -- Component (from App Map) from which to clear the cache.

Returns:

-- True if the component's cache has been cleared.

Example:

 
 boolean success = Tree.ClickTextNode(Map.Google.Tree, "Root->Child1->GrandChild");
 Component.ClearCache(Map.Google.Tree);
 boolean success = Tree.CaptureTreeDataToFile(Map.Google.Tree, "D:\data\tree.dat");
 
 

Click

public static boolean Click(Component comp,
                            java.lang.String... params)

Click on any visible component.

See Detailed Reference

Parameters:

comp - -- Component (from App Map) to Click

params - optional

• params[0] X,Y coordinate. Example: "50,50", or "AppMapSubkey" defined in App Map
  For SE+, params[0] X,Y coordinate also support percentage format for X, or Y. Example: "20%,30%", "20%,30", "20,30%".
  
• params[1] auto-scroll boolean if the component will be scrolled into view automatically before clicking. if not provided, the default value is true.

Returns:

true if successfully executed, false otherwise.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 1) boolean success = Click(Map.Google.Apps);//Click at the center
 2) boolean success = Click(Map.Google.Apps,"20,20");//Click at the coordinate (20,20)
 3) boolean success = Click(Map.Google.Apps,"20%,30%"); // Click at the coordinate: its X value equals 20% width of component, its Y value equals 30% height of component.
 4) boolean success = Click(Map.Google.Apps,"AppMapSubkey");//Click at the coordinate defined by entry "AppMapSubkey" in App Map.
 5) boolean success = Click(Map.Google.Apps,"20,20", "false");//Click at the coordinate (20,20), and web-element will not be scrolled into view automatically
  // one of the above and then,
 int rc = prevResults.getStatusCode();      // if useful
 String info = prevResults.getStatusInfo(); // if useful
 

 Pay attention: If you use percentage format in SE+, you'd better use 'Misc.Expressions(false);' first.

 "AppMapSubkey" is expected to be an AppMap entry in an "Apps" section in the App Map.
 See Detailed Reference
 

DragTo

public static boolean DragTo(Component from,
                             Component to,
                             java.lang.String... optionals)

A left mouse drag is performed from one object to another object based on the offsets values.

See Detailed Reference

Parameters:

from - Component, the component (from App Map) relative to which to calculate start coordinates to drag

to - Component, the component (from App Map) relative to which to calculate end coordinates to drag

params - optional

params[0] offsets String, indicating the offset relative to component in percentage or in pixel, like "20%,10%, %50, %60", "30, 55, 70, 80", or even "20%,10%, 70, 80". If not provided, then "50%, 50%, 50%, 50%" will be used as default value, which means the drag point is the center of the component.
params[1] fromSubItem String, as text. e.g tree node or list item or any sub main component's item.
params[2] toSubItem String, as text. e.g tree node or list item or any sub main component item.
params[3] pause int, time in milliseconds to hold the mouse button at the "to component" area before releasing. The default value is DriverConstant.DEFAULT_SAFS_TEST_DND_RELEASE_DELAY .

Returns:

true if successfully executed, false otherwise.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = DragTo(Map.Google.Apps, Map.Google.Area);//Left-Drag from center of component Map.Google.Apps to center of component Map.Google.Area
 boolean success = DragTo(Map.Google.Apps, Map.Google.Area, "20%,10%, %50, %60");//Left-Drag from (20%,10%) of component Map.Google.Apps to (%50, %60) of component Map.Google.Area
 boolean success = DragTo(Map.Google.Apps, Map.Google.Area, "", "", "", "2000");//Left-Drag from center of component Map.Google.Apps to center of component Map.Google.Area, and hold the mouse button for 2 seconds at the component Map.Google.Area
 //one of the above and then,
 int rc = prevResults.getStatusCode();      // if useful
 String info = prevResults.getStatusInfo(); // if useful
 

 

ExecuteScript

public static boolean ExecuteScript(Component comp,
                                    java.lang.String script,
                                    java.lang.String... scriptParams)

Execute a simple piece of javascript on component synchronously. See Detailed Reference

If the script will return a string value, call SAFSPlus.prevResults.getStatusInfo() to get it.
Object result is NOT supported yet.
This is currently ONLY supported for Selenium WebDriver Engine.

Parameters:

comp - org.safs.model.Component, (from generated Map.java).
In your script you reference this DOM Element as 'arguments[0]'.

script - String, the javascript to execute.

scriptParams - optional, Script arguments must be a number, a boolean, a String, DOM Element, or a List of any combination of the above. An exception will be thrown if the arguments do not meet these criteria. The arguments will be made available to the JavaScript via the "arguments" variable.

scriptParams[0] : Passed to the script as 'arguments[1]', if used.
scriptParams[1] : Passed to the script as 'arguments[2]', if used.
... more script's parameter

Returns:

true if no errors were encountered.

See Also:

#executeScript(String, Object...), #executeAsyncScript(String, Object...)

Example:

 
 SAFSPlus.ExecuteScript(
     Map.Google.SignIn,                       // The DOM Element passed as 'arguments[0]' to the script.
     "arguments[0].innerHTML=arguments[1];",  // Script to set the DOM Elements innerHTML value.
     "my text value");                        // The value passed as 'arguments[1]' to set to innerHTML.

 SAFSPlus.ExecuteScript(
     Map.Google.SignIn,                       // The DOM Element passed as 'arguments[0]' to the script.
     "return arguments[0].innerHTML;");       // A script to return the DOM Elements innerHTML.

  // scriptResult should get the innerHTML value returned.
 String scriptResult = SAFSPlus.prevResults.getStatusInfo();
 
 

GetTextFromGUI

public static boolean GetTextFromGUI(Component comp,
                                     java.lang.String variable,
                                     java.lang.String... params)

Incorporate OCR technology to detect the text on a GUI component and save the text to a variable. See Detailed Reference
This requires that SAFS-OCR has been installed.

Parameters:

comp - Component (from App Map) from which to retrieve text.

variable - String, The name of the variable to receive detected text.

params - optional

params[0] SubArea String, indicating partial image of the component to capture, it can be app map subkey referring a subarea or the subarea itself like "5,10, %50, %60"
params[1] OCRId String, indicating the OCR used to recognize text. TOCR or GORC
params[2] LangId String, representing the language in use for selected OCR to recognize text. "en", "cn" etc.
params[3] ScaleRatio float, indicating the scale ratio for resizing the original image. "1.5"

Returns:

boolean, True on success and the text will be saved to a variable

Example:

 
 Component.GetTextFromGUI(Map.Google.SignIn, "signinText");
 String value = SAFSPlus.GetVariableValue("signinText");
 Component.GetTextFromGUI(Map.Google.SignIn, "signinText", "", "GOCR");
 Component.GetTextFromGUI(Map.Google.SignIn, "signinText", "5,10, %50, %60", "TOCR", "en", "1.5");
 Component.GetTextFromGUI(Map.Google.SignIn, quote("signin-partial"), "0, 0, 70%, 100%", "GOCR");
 //"subarea" is defined in map file
 //[SignIn]
 //subarea=="0,0,50%,50%"
 Component.GetTextFromGUI(Map.Google.SignIn,"SignInPartialText", "subarea");
 //or
 //"subarea" is defined in map file
 //[ApplicationConstants]
 //subarea=="0,0,50%,50%"
 Component.GetTextFromGUI(Map.Google.SignIn, "SignInPartialText", Map.subarea, "TOCR");
 
 

GetGUIImage

public static boolean GetGUIImage(Component comp,
                                  java.lang.String fileName,
                                  java.lang.String... params)

Take a screenshot of windows or component.
See Detailed Reference

Parameters:

comp - Component, the component to get its image.

fileName - String, the file name to store image. Suggest to save as .png image.
It can be relative or absolute. If it is relative, the file will be stored to TestDirectory "Actuals".
Supported file extensions are ".jpeg", ".tif", ".gif", ".png", ".pnm", ".bmp" etc.
If the file extension is not supported, then suffix ".bmp" will be appended to filename.

params - optional

params[1] SubArea String, (x1,y1,x2,y2) indicating partial image of the component to capture, such as "0,0,50%,50%",
it can be app map subkey under component name.
params[2] FilteredAreas String, (x1,y1,x2,y2 x1,y1,x2,y2) a set of areas to filter the current GUI image.
it has a prefix "Filter", and followed by a set of subareas. Such as "Filter=0,0,5,5 50%,50%,15,15"
Multiple areas are separated by a space character. The filtered area is covered by black.

Returns:

boolean, true on success; false otherwise

Example:

 
 GetGUIImage(Map.Google.SignIn,"SignIn");//will be saved at <testProject>\Actuals\SignIn.bmp
 GetGUIImage(Map.Google.SignIn,"c:/temp/SignIn.gif");

 //Following example will store part of the SingIn image,
 GetGUIImage(Map.Google.SignIn,"SignInPartial.png", "0,0,50%,50%");
 //"subarea" is defined in map file
 //[SignIn]
 //subarea="0,0,50%,50%"
 GetGUIImage(Map.Google.SignIn,"SignInPartial.png", "subarea");
 //or
 //"subarea" is defined in map file
 //[ApplicationConstants]
 //subarea="0,0,50%,50%"
 GetGUIImage(Map.Google.SignIn,"SignInPartial.png", Map.subarea);
 GetGUIImage(Map.Google.SignIn,"SignInPartial.png", Map.subarea());

 //Filter the SingIn image and save it
 GetGUIImage(Map.Google.SignIn,"SignInFiltered.gif", "", quote("Filter=0,0,10,10 60,60,10,10"));
 //"filterAreas" is defined in map file
 //[SignIn]
 //filterAreas="Filter=0,0,10,10 60,60,10,10"
 GetGUIImage(Map.Google.SignIn,"SignInFiltered.gif", "", "filterAreas");
 //"filterAreas" is defined in map file
 //[ApplicationConstants]
 //filterAreas="Filter=0,0,10,10 60,60,10,10"
 GetGUIImage(Map.Google.SignIn,"SignInFiltered.gif", "", Map.filterAreas);
 GetGUIImage(Map.Google.SignIn,"SignInFiltered.gif", "", Map.filterAreas());
 
 

GUIDoesExist

public static boolean GUIDoesExist(Component comp)

Verify the visual existence of a particular window and/or component. See Detailed Reference

Parameters:

comp - -- Component (from App Map).

Returns:

boolean, true if GUI exists; false if GUI does not exist or execution fail.

Example:

 
 Component.GUIDoesExist(Map.AUT.EditBox);
 
 

GUIDoesNotExist

public static boolean GUIDoesNotExist(Component comp)

Verify the visual non-existence of a particular window and/or component. See Detailed Reference

Parameters:

comp - -- Component (from App Map).

Returns:

boolean, true if GUI does not exist; false if GUI does exist or execution fail.

Example:

 
 Component.GUIDoesNotExist(Map.AUT.EditBox);
 
 

HoverMouse

public static boolean HoverMouse(Component comp,
                                 java.lang.String... optionals)

Hover the mouse over a component. See Detailed Reference

Parameters:

comp - org.safs.model.Component, the component to hover.

optionals -

optionals[0] coordination String, The offset from center of component, such as "200;400", or a mapKey defined under "ComponentName" or "ApplicationConstants" in map file.
optionals[1] hoverTime 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.

Returns:

true if hover succeeds, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = Component.HoverMouse(Map.AUT.EditBox);//hover at the center of EditBox for 2 seconds
 boolean success = Component.HoverMouse(Map.AUT.EditBox, "", String.valueOf(Constants.TIMEOUT_HOVERMOUSE_STAY_FOREVER));//hover at the center of EditBox forever.
 boolean success = Component.HoverMouse(Map.AUT.EditBox, "50, 30", "1000");//hover at (50,30) of EditBox for 1 second
 boolean success = Component.HoverMouse(Map.AUT.EditBox, "locKey", "3000");//locKey="500, 300" defined in map file under "EditBox" or "ApplicationConstants"
 
 

InputKeys

public static boolean InputKeys(Component comp,
                                java.lang.String textvalue)

Sends keystrokes to the specified Component.

This supports special key characters like:

     {Enter} = ENTER Key
     {Tab} = TAB Key
     ^ = CONTROL Key with another key ( "^s" = CONTROL + s )
     % = ALT Key with another key ( "%F" = ALT + F )
     + = SHIFT Key with another key ( "+{Enter}" = SHIFT + ENTER )
 

We are generally providing this support through our generic InputKeys Support.

Parameters:

comp - -- Component (from App Map).

textvalue - -- to send via input to the Component.

Returns:

See Also:

Component.inputKeys(String), SAFSPlus.quote(String)

Example:

 
 Component.InputKeys(Map.AUT.EditBox, quote("^a"));//"Ctrl+a" Select all text of this EditBox
 
 

TypeKeys

public static boolean TypeKeys(java.lang.String textvalue)

Sends AWT Robot keystrokes to whatever currently has keyboard focus. This is intended to work for both local and remote Selenium Servers (when Remote RMI is properly enabled).

This supports special key characters like:

     {Enter} = ENTER Key
     {Tab} = TAB Key
     ^ = CONTROL Key with another key ( "^s" = CONTROL + s )
     % = ALT Key with another key ( "%F" = ALT + F )
     + = SHIFT Key with another key ( "+{Enter}" = SHIFT + ENTER )
 

We are generally providing special key support through our generic InputKeys Support.

Parameters:

textvalue - -- to send via Robot to the current keyboard focus.

Returns:

See Also:

TypeChars(String), SAFSPlus.quote(String)

Example:

 
 Component.TypeKeys(quote("^a"));//"Ctrl+a" Select all text of this EditBox
 
 

InputCharacters

public static boolean InputCharacters(Component comp,
                                      java.lang.String textvalue)

Sends key characters to the specified Component.

Parameters:

comp - -- Component (from App Map).

textvalue - -- to send via input to the Component.

Returns:

See Also:

Component.inputKeys(String), SAFSPlus.quote(String)

Example:

 
 Component.InputCharacters(Map.AUT.EditBox, "Test Value");
 Component.InputCharacters(Map.AUT.EditBox, quote("UTF-8"));
 Component.InputCharacters(Map.AUT.EditBox, quote("^NotVariable"));
 
 

TypeChars

public static boolean TypeChars(java.lang.String textvalue)

Sends key characters to the current keyboard focus via AWT Robot. This is intended to work for both local and remote Selenium Servers (when Remote RMI is properly enabled).

Parameters:

textvalue - -- to send via input by AWT Robot.

Returns:

See Also:

TypeKeys(String), SAFSPlus.quote(String)

Example:

 
 Component.TypeChars("Test Value");
 Component.TypeChars(quote("UTF-8"));
 Component.TypeChars(quote("^NotVariable"));
 
 

TypeEncryption

public static boolean TypeEncryption(java.lang.String encryptedDataFile,
                                     java.lang.String privateKeyFile)

Sends secret-text (such as password) to the current focused Component.
See Detailed Reference

Parameters:

encryptedDataFile - String, the file containing 'encrypted data' to send to the current focused Component.

privateKeyFile - String, the file containing 'private key' to decrypt the 'encrypted data'

Returns:

true on success

See Also:

Robot.inputChars(String), RSA

Example:

 //D:\secretPath\private.key contains "private key", which is generated by RSA
 //C:\safs\passwords\encrypted.pass contains the encrypted-data, which is encrypted by RSA with publickey
 
 SeleniumPlus.TypeEncryption("C:\safs\passwords\encrypted.pass", "D:\secretPath\private.key" );
 
 

IsPropertyExist

public static boolean IsPropertyExist(Component comp,
                                      java.lang.String property,
                                      java.lang.String variable)

Verify if object's property exists or not.

Parameters:

comp - -- Component (from App Map) to get property's existence.

property - -- attribute or CSS property.

variable - -- the name of the variable to receive the proeprty's existence.

Returns:

true on success, "true" or "false" will be saved to a variable according to the existence of property.

Example:

 
 String PropertyExistVariable = "PropertyExistVariable";
 Component.IsPropertyExist(Map.AUT.Lable,"textContent", PropertyExistVariable);
 String existence = SAFSPlus.GetVariableValue(PropertyExistVariable);
 
 

IsPropertyExist

public static boolean IsPropertyExist(Component comp,
                                      java.lang.String property)
                               throws SeleniumPlusException

Verify if object's property exists or not.

Parameters:

comp - -- Component (from App Map) to get property's existence.

property - -- attribute or CSS property.

Returns:

boolean, true if property exists. false otherwise.

Throws:

SeleniumPlusException - if the execution fails.

Example:

 
 boolean existence = Component.IsPropertyExist(Map.AUT.Lable,"textContent");
 
 

LocateScreenImage

public static boolean LocateScreenImage(Component comp,
                                        java.lang.String variable,
                                        java.lang.String... optionals)

Store the location and dimensions of a component. See Detailed Reference

Parameters:

variable - String, The root name of the collection of variables to receive the location and dimensions.
variable=x y w h [space delimited values]
variable.x=x
variable.y=y
variable.w=w
variable.h=h

optionals -

optionals[0] relativeTo String, "screen" or "parent". Default is "screen".

Returns:

true if the location and dimensions are stored successfully to variable, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 String variable = "editboxRect";
 boolean success = Component.LocateScreenImage(Map.AUT.EditBox, variable);//EditBox's screen location and dimension will be store to variable "editboxRect"
 String rect = GetVariableValue(variable);
 String x = GetVariableValue(variable+".x");
 String y = GetVariableValue(variable+".y");
 String w = GetVariableValue(variable+".w");
 String h = GetVariableValue(variable+".h");
 boolean success = Component.LocateScreenImage(Map.AUT.EditBox, variable, RELATIVE_TO_PARENT);//EditBox's relative location and dimension will be store to variable "editboxRect"
 
 

SaveTextFromGUI

public static boolean SaveTextFromGUI(Component comp,
                                      java.lang.String outputFile,
                                      java.lang.String... params)

Incorporate OCR technology to detect the text on a GUI component and save the text to a file. See Detailed Reference
This requires that SAFS-OCR has been installed.

Parameters:

comp - Component (from App Map) from which to retrieve text.

outputFile - String, The name of the file to store detected text.

params - optional

params[0] SubArea String, indicating partial image of the component to capture, it can be app map subkey referring a subarea or the subarea itself like "5,10, %50, %60"
params[1] OCRId String, indicating the OCR used to recognize text. TOCR or GORC
params[2] LangId String, representing the language in use for selected OCR to recognize text. "en", "cn" etc.
params[3] ScaleRatio float, indicating the scale ratio for resizing the original image. "1.5"

Returns:

boolean, True on success and the text will be saved to a file.

Example:

 
 Component.SaveTextFromGUI(Map.Google.SignIn, "signin.txt");
 Component.SaveTextFromGUI(Map.Google.SignIn, "D:\data\test\signin.txt");
 Component.SaveTextFromGUI(Map.Google.SignIn, "signin.txt", "", "GOCR");
 Component.SaveTextFromGUI(Map.Google.SignIn, "signin.txt", "5,10, %50, %60", "TOCR", "en", "1.5");
 Component.SaveTextFromGUI(Map.Google.SignIn, quote("signin-partial.txt"), "0, 0, 70%, 100%", "GOCR");
 //"subarea" is defined in map file
 //[SignIn]
 //subarea=="0,0,50%,50%"
 Component.SaveTextFromGUI(Map.Google.SignIn,"SignInPartialText.txt", "subarea");
 //or
 //"subarea" is defined in map file
 //[ApplicationConstants]
 //subarea=="0,0,50%,50%"
 Component.SaveTextFromGUI(Map.Google.SignIn, "D:\data\test\SignInPartialText.txt", Map.subarea, "TOCR");
 
 

VerifyComputedStyle

public static boolean VerifyComputedStyle(Component comp,
                                          java.lang.String benchfile)

Verify computed CSS style against bench mark. If there is no benchmark file found then the test will fail. User responsibility to copy bench mark to the project benchmark folder.

Parameters:

comp - -- Component (from App Map) to verify computed CSS style.

benchfile - -- benchmark json file name from the project benchmark dir or User specify full path.

Returns:

-- True on success or A file will be created into Actuals dir on failure.

Example:

 
 Component.VerifyComputedStyle(Map.Google.SignIn,"benmarkfile.json");
 Component.VerifyComputedStyle(Map.Google.SignIn,"c:\\temp\\file.json");
 
 

GetComputedStyle

public static boolean GetComputedStyle(Component comp,
                                       java.lang.String testfile)

Save component's computed CSS style to a test file.

Parameters:

comp - -- Component (from App Map) to verify computed CSS style.

testfile - -- test json file name from the project test dir or User specify full path.

Returns:

-- True on success

Example:

 
 Component.GetComputedStyle(Map.Google.SignIn,"testfile.json");
 Component.GetComputedStyle(Map.Google.SignIn,"c:\\temp\\file.json");
 
 

VerifyGUIImageToFile

public static boolean VerifyGUIImageToFile(Component comp,
                                           java.lang.String benchFile,
                                           java.lang.String... params)

Verify the screen shot of a GUI component with a benchmark image file. See Detailed Reference

Parameters:

comp - Component, the component to get its image.

benchFile - String, the benchmark file name. Suggest to compare with .png image.
It can be relative or absolute. If it is relative, the file will be found at BenchDirectory "Benchmarks".
Supported file extensions are ".jpeg", ".tif", ".gif", ".png", ".pnm", ".bmp" etc.
If the file extension is not supported, then suffix ".bmp" will be appended to filename.

params - optional

params[1] SubArea String, indicating partial image of the component to capture, such as "0,0,50%,50%",
it can be app map subkey under component name.
params[2] PercentageTolerance int, the percentage of bits need to be matched. it is between 0 and 100.
100 means only all bits of images match, the images will be considered matched.
0 means even no bits match, the images will be considered matched.
params[3] UUIDFlag boolean, set to quote("UUID=False") to prevent runtime Test/Actual filenames appended with Universally Unique IDs
This essentially allows the runtime Test/Actual filename to be the same as the Benchmark.
params[4] FilteredAreas String, a set of areas to filter the current GUI image and the bench image before comparing.
it has a prefix "Filter", and followed by a set of subareas. Such as "Filter=0,0,5,5 50%,50%,15,15"
Multiple areas are separated by a space character. The filtered area is covered by black.

Returns:

boolean, true if verification success; false otherwise

Example:

 
 VerifyGUIImageToFile(Map.Google.SignIn,"SignIn");//will be compared with file <testProject>\Benchmarks\SignIn.bmp
 VerifyGUIImageToFile(Map.Google.SignIn,"c:/benchDir/SignIn.gif");
 VerifyGUIImageToFile(Map.Google.SignIn,"c:/benchDir/SignIn.gif", "", "", quote("UUID=False"));// Simple output filename, no UUID.
 VerifyGUIImageToFile(Map.Google.SignIn,"c:/benchDir/SignIn.gif", "", "95");//if 95% bits match, the verification will pass.

 //Following example will verify part of the SingIn image,
 GetGUIImage(Map.Google.SignIn,"SignInPartial.png", quote("0,0,50%,50%"));
 //"subarea" is defined in map file
 //[SignIn]
 //subarea="0,0,50%,50%"
 VerifyGUIImageToFile(Map.Google.SignIn,"SignInPartial.png", "subarea");
 //or
 //"subarea" is defined in map file
 //[ApplicationConstants]
 //subarea="0,0,50%,50%"
 VerifyGUIImageToFile(Map.Google.SignIn,"SignInPartial.png", Map.subarea);
 VerifyGUIImageToFile(Map.Google.SignIn,"SignInPartial.png", Map.subarea());

 //Filter the SingIn image and the bench image at certain areas and compare them
 VerifyGUIImageToFile(Map.Google.SignIn,"c:/benchDir/SignIn.gif", "", "", "", quote("Filter=0,0,10,10 60,60,10,10"));
 //"filterAreas" is defined in map file
 //[SignIn]
 //filterAreas="Filter=0,0,10,10 60,60,10,10"
 VerifyGUIImageToFile(Map.Google.SignIn,"c:/benchDir/SignIn.gif", "", "", "", "filterAreas");
 //"filterAreas" is defined in map file
 //[ApplicationConstants]
 //filterAreas="Filter=0,0,10,10 60,60,10,10"
 VerifyGUIImageToFile(Map.Google.SignIn,"c:/benchDir/SignIn.gif", "", "", "", Map.filterAreas);
 VerifyGUIImageToFile(Map.Google.SignIn,"c:/benchDir/SignIn.gif", "", "", "", Map.filterAreas());
 
 

VerifyProperty

public static boolean VerifyProperty(Component comp,
                                     java.lang.String property,
                                     java.lang.String value)

Verify object property. The property could be attribute or CSS property.

Parameters:

comp - -- Component (from App Map) to verify property.

property - -- attribute or CSS property.

value - -- property value to be verified.

Returns:

true on success.

VerifyPropertyContains

public static boolean VerifyPropertyContains(Component comp,
                                             java.lang.String property,
                                             java.lang.String containedValue)

Verify that the value of an object property contains a string.
The property could be attribute or CSS property.

Parameters:

comp - Component, (from App Map) to verify property.

property - String, attribute or CSS property.

containedValue - String, property value to be verified.

Returns:

true on success.

VerifyPropertyContains

public static boolean VerifyPropertyContains(Component comp,
                                             java.lang.String property,
                                             java.lang.String containedValue,
                                             boolean caseSensitive)

Verify that the value of an object property contains a string.
The property could be attribute or CSS property.

Parameters:

comp - Component, (from App Map) to verify property.

property - String, attribute or CSS property.

containedValue - String, property value to be verified.

caseSensitive - boolean, if the comparison is case-sensitive or not.

Returns:

true on success.

Example:

 
 Component.VerifyPropertyContains(Map.Google.SignIn, "font-family", "Helvetica");
 Component.VerifyPropertyContains(Map.Google.SignIn, "font-family", "HELVETICA", false);
 
 

VerifyPropertyToFile

public static boolean VerifyPropertyToFile(Component comp,
                                           java.lang.String property,
                                           java.lang.String benchFile,
                                           java.lang.String... params)

Verify the value of a single object property with a benchmark file.

Parameters:

comp - Component, (from App Map) to verify property.

property - String, attribute or CSS property to verify.

benchFile - String, The file containing the value of the property to compare.

params - --

params[0] -- optional -- The file encoding.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = Component.VerifyPropertyToFile(Map.Google.SignIn, "font-family", "bench.font.family.dat");
 boolean success = Component.VerifyPropertyToFile(Map.Google.SignIn, "font-family", "bench.font.family.dat", "utf-8");
 
 

VerifyPropertiesToFile

public static boolean VerifyPropertiesToFile(Component comp,
                                             java.lang.String benchFile,
                                             java.lang.String... params)

Compare/Verify all of the value properties of a test object with a benchmark file.

Parameters:

comp - Component, (from App Map) to verify property.

benchFile - String, The file containing the values of the properties to compare.

params - --

params[0] -- optional -- The file encoding.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = Component.VerifyPropertiesToFile(Map.Google.SignIn, "signin.properties");
 boolean success = Component.VerifyPropertiesToFile(Map.Google.SignIn, "signin.properties", "utf-8");
 
 

VerifyPropertiesSubsetToFile

public static boolean VerifyPropertiesSubsetToFile(Component comp,
                                                   java.lang.String benchFile,
                                                   java.lang.String... params)

Compare/Verify the value properties of a test object with a benchmark file.
Only those property names and values in the benchmark file will be compared.

Parameters:

comp - Component, (from App Map) to verify property.

benchFile - String, The file containing the value of the properties to compare.

params - --

params[0] -- optional -- The file encoding.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = Component.VerifyPropertiesSubsetToFile(Map.Google.SignIn, "signinSubset.properties");
 boolean success = Component.VerifyPropertiesSubsetToFile(Map.Google.SignIn, "signinSubset.properties", "utf-8");
 
 

VerifyObjectDataToFile

public static boolean VerifyObjectDataToFile(Component comp,
                                             java.lang.String benchFile,
                                             java.lang.String... params)

Verify the current contents of a component's data with a benchmark file.

Parameters:

comp - Component, (from App Map) to retrieve data.

benchFile - String, The benchmark file containing the date to compare.

params - optional--

params[0] -- The file encoding.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = Component.VerifyObjectDataToFile(Map.SampleApp.ListView, "listview.dat");
 boolean success = Component.VerifyObjectDataToFile(Map.SampleApp.ListView, "listview.dat", "utf-8");
 boolean success = Component.VerifyObjectDataToFile(Map.SampleApp.ListView, "d:\testproj\bench\listview.dat");
 
 

ShowOnPage

public static boolean ShowOnPage(Component comp,
                                 java.lang.String... params)

Make the component visible on the page.

Parameters:

comp - Component, (from App Map) to be visible on page.

params - optional

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

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 //Try to make Map.SampleApp.EditBox becomes visible on page
 boolean success = Component.ShowOnPage(Map.SampleApp.EditBox);
 //Try to make Map.SampleApp.EditBox becomes visible on page and verify that it is shown.
 boolean success = Component.ShowOnPage(Map.SampleApp.EditBox, "true");
 
 

HoverScreenLocation

public static boolean HoverScreenLocation(java.lang.String coordination,
                                          java.lang.String... optionals)

Hover the mouse over a specified screen location.

See Detailed Reference

Parameters:

coordination - String, The screen location, such as "200;400", or a mapKey defined under "ApplicationConstants" in map file

optionals -

optionals[0] hoverTime int, milliseconds to hover

Returns:

true if hover succeeds, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = SAFSPlus.HoverScreenLocation("500, 300", "20");
 boolean success = SAFSPlus.HoverScreenLocation("locKey", "20");//locKey="500, 300" defined in map file under "ApplicationConstants"
 
 

VerifyBinaryFileToFile

public static boolean VerifyBinaryFileToFile(java.lang.String benchFile,
                                             java.lang.String actualFile,
                                             java.lang.String... optionals)

Verify the current contents of a binary (image) file with a benchmark file.

See Detailed Reference

Parameters:

benchFile - String, File used as the comparison benchmark.

actualFile - String, File used as the comparison file under test.

optionals -

optionals[0] FilterMode String, one of FileUtilities.FilterMode. FilterMode.TOLERANCE is valid only when the binary files are images.
optionals[1] FilterOptions int, if the FilterMode is FilterMode.TOLERANCE, a number between 0 and 100, the percentage of bits need to be the same. 100 means only 100% match, 2 images will be considered matched; 0 means even no bits match, 2 images will be considered matched.
other type, if the FilterMode is FilterMode.XXX

Returns:

true if the 2 files contain the same content, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = SAFSPlus.VerifyBinaryFileToFile("signIn.png", "signIn.png");
 boolean success = SAFSPlus.VerifyBinaryFileToFile("c:\bench\signIn.png", "d:\test\signIn.png");
 boolean success = SAFSPlus.VerifyBinaryFileToFile("c:\bench\signIn.png", "d:\test\signIn.png", FilterMode.TOLERANCE.name, "90");
 
 

VerifyFileToFile

public static boolean VerifyFileToFile(java.lang.String benchFile,
                                       java.lang.String actualFile,
                                       java.lang.String... optionals)

Verify the current contents of a text file with a benchmark file (same as VerifyTextFileToFile).

See Detailed Reference

Parameters:

benchFile - String, File used as the comparison benchmark.

actualFile - String, File used as the comparison file under test.

optionals - -- NOT used yet

Returns:

true if the 2 files contain the same content, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = SAFSPlus.VerifyFileToFile("benchFile.txt", "actualFile.txt");
 boolean success = SAFSPlus.VerifyFileToFile("c:\bench\benchFile.txt", "d:\test\actualFile.txt");
 
 

VerifyTextFileToFile

public static boolean VerifyTextFileToFile(java.lang.String benchFile,
                                           java.lang.String actualFile,
                                           java.lang.String... optionals)

Verify the current contents of a text file with a benchmark file (same as VerifyFileToFile).

See Detailed Reference

Parameters:

benchFile - String, File used as the comparison benchmark.

actualFile - String, File used as the comparison file under test.

optionals - -- NOT used yet

Returns:

true if the 2 files contain the same content, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = SAFSPlus.VerifyTextFileToFile("benchFile.txt", "actualFile.txt");
 boolean success = SAFSPlus.VerifyTextFileToFile("c:\bench\benchFile.txt", "d:\test\actualFile.txt");
 
 

VerifyValueContains

public static boolean VerifyValueContains(java.lang.String wholeString,
                                          java.lang.String substring,
                                          java.lang.String... optionals)

Verify that a string value contains a substring.

See Detailed Reference

Parameters:

wholeString - String, the string value to verify.

substring - String, the substring

optionals -

optionals[0] String, Set to "SuppressValue" to prevent the logging of ugly multi-line values

Returns:

true if a string value does contain a substring, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 String labelVar = "labelVariable";
 Component.AssignPropertyVariable(Map.AUT.Lable,"textContent", labelVar);
 String label = SAFSPlus.GetVariableValue(labelVar);
 boolean success = SAFSPlus.VerifyValueContains(label, "labelContent");
 //or
 boolean success = SAFSPlus.VerifyValueContains("^"+labelVar, "labelContent");
 
 

VerifyValueContainsIgnoreCase

public static boolean VerifyValueContainsIgnoreCase(java.lang.String wholeString,
                                                    java.lang.String substring,
                                                    java.lang.String... optionals)

Verify that a string value contains a substring, ignoring case.

See Detailed Reference

Parameters:

wholeString - String, the string value to verify.

substring - String, the substring

optionals -

optionals[0] String, Set to "SuppressValue" to prevent the logging of ugly multi-line values

Returns:

true if a string value does contain a substring ignoring case, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 String labelVar = "labelVariable";
 Component.AssignPropertyVariable(Map.AUT.Lable,"textContent", labelVar);
 boolean success = SAFSPlus.VerifyValueContainsIgnoreCase("^"+labelVar, "subcontent");
 
 

VerifyValueDoesNotContain

public static boolean VerifyValueDoesNotContain(java.lang.String wholeString,
                                                java.lang.String substring,
                                                java.lang.String... optionals)

Verify that a string value does NOT contain a substring.

See Detailed Reference

Parameters:

wholeString - String, the string value to verify.

substring - String, the substring

optionals -

optionals[0] String, Set to "SuppressValue" to prevent the logging of ugly multi-line values

Returns:

true if a string value does NOT contain a substring, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 String labelVar = "labelVariable";
 Component.AssignPropertyVariable(Map.AUT.Lable,"textContent", labelVar);
 boolean success = SAFSPlus.VerifyValueDoesNotContain("^"+labelVar, "substr");
 
 

VerifyValues

public static boolean VerifyValues(java.lang.String value1,
                                   java.lang.String value2,
                                   java.lang.String... optionals)

Verify that two string values are identical.

See Detailed Reference

Parameters:

value1 - String, the first value to compare.

value2 - String, the second value to compare.

optionals -

optionals[0] String, Set to "SuppressValue" to prevent the logging of ugly multi-line values

Returns:

true if the two values do equal, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 String labelVar = "labelVariable";
 Component.AssignPropertyVariable(Map.AUT.Lable,"textContent", labelVar);
 String label = SAFSPlus.GetVariableValue(labelVar);
 boolean success = SAFSPlus.VerifyValues(label, "labelContent");
 //or
 boolean success = SAFSPlus.VerifyValues("^"+labelVar, "labelContent");
 
 

VerifyValuesIgnoreCase

public static boolean VerifyValuesIgnoreCase(java.lang.String value1,
                                             java.lang.String value2,
                                             java.lang.String... optionals)

Verify that two string values are identical, ignoring case.

See Detailed Reference

Parameters:

value1 - String, the first value to compare.

value2 - String, the second value to compare.

optionals -

optionals[0] String, Set to "SuppressValue" to prevent the logging of ugly multi-line values

Returns:

true if the two values do equal, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 String labelVar = "labelVariable";
 Component.AssignPropertyVariable(Map.AUT.Lable,"textContent", labelVar);
 boolean success = SAFSPlus.VerifyValuesIgnoreCase("^"+labelVar, "labelcontent");
 
 

VerifyValuesNotEqual

public static boolean VerifyValuesNotEqual(java.lang.String value1,
                                           java.lang.String value2,
                                           java.lang.String... optionals)

Verify that two string values are NOT identical.

See Detailed Reference

Parameters:

value1 - String, the first value to compare.

value2 - String, the second value to compare.

optionals -

optionals[0] String, Set to "SuppressValue" to prevent the logging of ugly multi-line values

Returns:

true if the two values do NOT equal, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 String labelVar = "labelVariable";
 Component.AssignPropertyVariable(Map.AUT.Lable,"textContent", labelVar);
 boolean success = SAFSPlus.VerifyValuesNotEqual("^"+labelVar, "labelContent");
 
 

CtrlClick

public static boolean CtrlClick(Component comp,
                                java.lang.String... params)

Control-Click on any visible component.

See Detailed Reference

Parameters:

comp - -- Component (from App Map) to Click

params - optional

• params[0] X,Y coordinate. Example: "50,50", or "AppMapSubkey" defined in App Map
  For SE+, params[0] X,Y coordinate also support percentage format for X, or Y. Example: "20%,30%", "20%,30", "20,30%".
  
• params[1] auto-scroll boolean if the component will be scrolled into view automatically before clicking. if not provided, the default value is true.

Returns:

true if successfully executed, false otherwise.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 1) boolean success = CtrlClick(Map.Google.Apps);//Control-Click at the center
 2) boolean success = CtrlClick(Map.Google.Apps,"20,20");//Control-Click at the coordinate (20,20)
 3) boolean success = CtrlClick(Map.Google.Apps,"20%,30%"); // Control-Click at the coordinate: its X value equals 20% width of component, its Y value equals 30% height of component.
 4) boolean success = CtrlClick(Map.Google.Apps,"AppMapSubkey");//Control-Click at the coordinate defined by entry "AppMapSubkey" in App Map.
 5) boolean success = CtrlClick(Map.Google.Apps,"20,20", "false");//Control-Click at the coordinate (20,20) and web-element will not be scrolled into view automatically
  // one of the above and then,
 int rc = prevResults.getStatusCode();      // if useful
 String info = prevResults.getStatusInfo(); // if useful
 

 Pay attention: If you use percentage format in SE+, you'd better use 'Misc.Expressions(false);' first.

 

CtrlRightClick

public static boolean CtrlRightClick(Component comp,
                                     java.lang.String... params)

Control-Right-Click on any visible component.

See Detailed Reference

Parameters:

comp - -- Component (from App Map) to Click

params - optional

• params[0] X,Y coordinate. Example: "50,50", or "AppMapSubkey" defined in App Map
  For SE+, params[0] X,Y coordinate also support percentage format for X, or Y. Example: "20%,30%", "20%,30", "20,30%".
  
• params[1] auto-scroll boolean if the component will be scrolled into view automatically before clicking. if not provided, the default value is true.

Returns:

true if successfully executed, false otherwise.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 1) boolean success = CtrlRightClick(Map.Google.Apps);//Control-Right-Click at the center
 2) boolean success = CtrlRightClick(Map.Google.Apps,"20,20");//Control-Right-Click at the coordinate (20,20)
 3) boolean success = CtrlRightClick(Map.Google.Apps,"20%,30%"); // Control-Right-Click at the coordinate: its X value equals 20% width of component, its Y value equals 30% height of component.
 4) boolean success = CtrlRightClick(Map.Google.Apps,"AppMapSubkey");//Control-Right-Click at the coordinate defined by entry "AppMapSubkey" in App Map.
 5) boolean success = CtrlRightClick(Map.Google.Apps,"20,20", "false");//Control-Right-Click at the coordinate (20,20) and web-element will not be scrolled into view automatically
  // one of the above and then,
 int rc = prevResults.getStatusCode();      // if useful
 String info = prevResults.getStatusInfo(); // if useful
 

 Pay attention: If you use percentage format in SE+, you'd better use 'Misc.Expressions(false);' first.

 

DoubleClick

public static boolean DoubleClick(Component comp,
                                  java.lang.String... params)

Double-Click on any visible component.

See Detailed Reference

Parameters:

comp - -- Component (from App Map) to Click

params - optional

• params[0] X,Y coordinate. Example: "50,50", or "AppMapSubkey" defined in App Map
  For SE+, params[0] X,Y coordinate also support percentage format for X, or Y. Example: "20%,30%", "20%,30", "20,30%".
  
• params[1] auto-scroll boolean if the component will be scrolled into view automatically before clicking. if not provided, the default value is true.

Returns:

true if successfully executed, false otherwise.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 1) boolean success = DoubleClick(Map.Google.Apps);//Double-Click at the center
 2) boolean success = DoubleClick(Map.Google.Apps,"20,20");//Double-Click at the coordinate (20,20)
 3) boolean success = DoubleClick(Map.Google.Apps,"20%,30%"); // Double-Click at the coordinate: its X value equals 20% width of component, its Y value equals 30% height of component.
 4) boolean success = DoubleClick(Map.Google.Apps,"AppMapSubkey");//Double-Click at the coordinate defined by entry "AppMapSubkey" in App Map.
 5) boolean success = DoubleClick(Map.Google.Apps,"20,20", "false");//Double-Click at the coordinate (20,20) and web-element will not be scrolled into view automatically
  // one of the above and then,
 int rc = prevResults.getStatusCode();      // if useful
 String info = prevResults.getStatusInfo(); // if useful
 

 Pay attention: If you use percentage format in SE+, you'd better use 'Misc.Expressions(false);' first.

 

RightClick

public static boolean RightClick(Component comp,
                                 java.lang.String... params)

Right-Click on any visible component.

See Detailed Reference

Parameters:

comp - -- Component (from App Map) to Click

params - optional

• params[0] X,Y coordinate. Example: "50,50", or "AppMapSubkey" defined in App Map
  For SE+, params[0] X,Y coordinate also support percentage format for X, or Y. Example: "20%,30%", "20%,30", "20,30%".
  
• params[1] auto-scroll boolean if the component will be scrolled into view automatically before clicking. if not provided, the default value is true.

Returns:

true if successfully executed, false otherwise.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 1) boolean success = RightClick(Map.Google.Apps);//Right-Click at the center
 2) boolean success = RightClick(Map.Google.Apps,"20,20");//Right-Click at the coordinate (20,20)
 3) boolean success = RightClick(Map.Google.Apps,"20%,30%"); // Right-Click at the coordinate: its X value equals 20% width of component, its Y value equals 30% height of component.
 4) boolean success = RightClick(Map.Google.Apps,"AppMapSubkey");//Right-Click at the coordinate defined by entry "AppMapSubkey" in App Map.
 5) boolean success = RightClick(Map.Google.Apps,"20,20", "false");//Right-Click at the coordinate (20,20) and web-element will not be scrolled into view automatically
  // one of the above and then,
 int rc = prevResults.getStatusCode();      // if useful
 String info = prevResults.getStatusInfo(); // if useful
 

 Pay attention: If you use percentage format in SE+, you'd better use 'Misc.Expressions(false);' first.

 

LeftDrag

public static boolean LeftDrag(Component comp,
                               java.lang.String coordinates)

A left mouse drag is performed on the object based on the stored coordinates relative to this object.

See Detailed Reference

Parameters:

comp - Component, the component (from App Map) relative to which to calculate coordinates to drag

coordinates - String, the relative coordinates. Example: "Coords=3,10,12,20", or "coordsKey" defined in App Map

Returns:

true if successfully executed, false otherwise.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = LeftDrag(Map.Google.Apps,"3,10,12,20");//Left-Drag from (3,10) to (12,20), relative to the Left Up corner of component Map.Google.Apps
 boolean success = LeftDrag(Map.Google.Apps,"Coords=3,10,12,20");//Left-Drag from (3,10) to (12,20), relative to the Left Up corner of component Map.Google.Apps
 boolean success = LeftDrag(Map.Google.Apps,"coordsKey");//"coordsKey" is defined in map file under section [Apps]
 //one of the above and then,
 int rc = prevResults.getStatusCode();      // if useful
 String info = prevResults.getStatusInfo(); // if useful
 

 

ShiftLeftDrag

public static boolean ShiftLeftDrag(Component comp,
                                    java.lang.String coordinates)

A Shift left mouse drag is performed on the object based on the stored coordinates relative to this object.

See Detailed Reference

Parameters:

comp - Component, the component (from App Map) relative to which to calculate coordinates to drag

coordinates - String, the relative coordinates. Example: "Coords=3,10,12,20", or "coordsKey" defined in App Map

Returns:

true if successfully executed, false otherwise.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = ShiftLeftDrag(Map.Google.Apps,"3,10,12,20");//Shift-Left-Drag from (3,10) to (12,20), relative to the Left Up corner of component Map.Google.Apps
 boolean success = ShiftLeftDrag(Map.Google.Apps,"Coords=3,10,12,20");//Shift-Left-Drag from (3,10) to (12,20), relative to the Left Up corner of component Map.Google.Apps
 boolean success = ShiftLeftDrag(Map.Google.Apps,"coordsKey");//"coordsKey" is defined in map file under section [Apps]
 //one of the above and then,
 int rc = prevResults.getStatusCode();      // if useful
 String info = prevResults.getStatusInfo(); // if useful
 

 

CtrlShiftLeftDrag

public static boolean CtrlShiftLeftDrag(Component comp,
                                        java.lang.String coordinates)

A Ctrl Shift left mouse drag is performed on the object based on the stored coordinates relative to this object.

See Detailed Reference

Parameters:

comp - Component, the component (from App Map) relative to which to calculate coordinates to drag

coordinates - String, the relative coordinates. Example: "Coords=3,10,12,20", or "coordsKey" defined in App Map

Returns:

true if successfully executed, false otherwise.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = CtrlShiftLeftDrag(Map.Google.Apps,"3,10,12,20");//Ctrl-Shift-Left-Drag from (3,10) to (12,20), relative to the Left Up corner of component Map.Google.Apps
 boolean success = CtrlShiftLeftDrag(Map.Google.Apps,"Coords=3,10,12,20");//Ctrl-Shift-Left-Drag from (3,10) to (12,20), relative to the Left Up corner of component Map.Google.Apps
 boolean success = CtrlShiftLeftDrag(Map.Google.Apps,"coordsKey");//"coordsKey" is defined in map file under section [Apps]
 //one of the above and then,
 int rc = prevResults.getStatusCode();      // if useful
 String info = prevResults.getStatusInfo(); // if useful
 

 

CtrlLeftDrag

public static boolean CtrlLeftDrag(Component comp,
                                   java.lang.String coordinates)

A Ctrl left mouse drag is performed on the object based on the stored coordinates relative to this object.

See Detailed Reference

Parameters:

comp - Component, the component (from App Map) relative to which to calculate coordinates to drag

coordinates - String, the relative coordinates. Example: "Coords=3,10,12,20", or "coordsKey" defined in App Map

Returns:

true if successfully executed, false otherwise.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = CtrlLeftDrag(Map.Google.Apps,"3,10,12,20");//Ctrl-Left-Drag from (3,10) to (12,20), relative to the Left Up corner of component Map.Google.Apps
 boolean success = CtrlLeftDrag(Map.Google.Apps,"Coords=3,10,12,20");//Ctrl-Left-Drag from (3,10) to (12,20), relative to the Left Up corner of component Map.Google.Apps
 boolean success = CtrlLeftDrag(Map.Google.Apps,"coordsKey");//"coordsKey" is defined in map file under section [Apps]
 //one of the above and then,
 int rc = prevResults.getStatusCode();      // if useful
 String info = prevResults.getStatusInfo(); // if useful
 

 

AltLeftDrag

public static boolean AltLeftDrag(Component comp,
                                  java.lang.String coordinates)

A Alt left mouse drag is performed on the object based on the stored coordinates relative to this object.

See Detailed Reference

Parameters:

comp - Component, the component (from App Map) relative to which to calculate coordinates to drag

coordinates - String, the relative coordinates. Example: "Coords=3,10,12,20", or "coordsKey" defined in App Map

Returns:

true if successfully executed, false otherwise.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = AltLeftDrag(Map.Google.Apps,"3,10,12,20");//Alt-Left-Drag from (3,10) to (12,20), relative to the Left Up corner of component Map.Google.Apps
 boolean success = AltLeftDrag(Map.Google.Apps,"Coords=3,10,12,20");//Alt-Left-Drag from (3,10) to (12,20), relative to the Left Up corner of component Map.Google.Apps
 boolean success = AltLeftDrag(Map.Google.Apps,"coordsKey");//"coordsKey" is defined in map file under section [Apps]
 //one of the above and then,
 int rc = prevResults.getStatusCode();      // if useful
 String info = prevResults.getStatusInfo(); // if useful
 

 

CtrlAltLeftDrag

public static boolean CtrlAltLeftDrag(Component comp,
                                      java.lang.String coordinates)

A Ctrl Alt left mouse drag is performed on the object based on the stored coordinates relative to this object.

See Detailed Reference

Parameters:

comp - Component, the component (from App Map) relative to which to calculate coordinates to drag

coordinates - String, the relative coordinates. Example: "Coords=3,10,12,20", or "coordsKey" defined in App Map

Returns:

true if successfully executed, false otherwise.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = CtrlAltLeftDrag(Map.Google.Apps,"3,10,12,20");//Ctrl-Alt-Left-Drag from (3,10) to (12,20), relative to the Left Up corner of component Map.Google.Apps
 boolean success = CtrlAltLeftDrag(Map.Google.Apps,"Coords=3,10,12,20");//Ctrl-Alt-Left-Drag from (3,10) to (12,20), relative to the Left Up corner of component Map.Google.Apps
 boolean success = CtrlAltLeftDrag(Map.Google.Apps,"coordsKey");//"coordsKey" is defined in map file under section [Apps]
 //one of the above and then,
 int rc = prevResults.getStatusCode();      // if useful
 String info = prevResults.getStatusInfo(); // if useful
 

 

RightDrag

public static boolean RightDrag(Component comp,
                                java.lang.String coordinates)

A right mouse drag is performed on the object based on the stored coordinates relative to this object.

See Detailed Reference

Parameters:

comp - Component, the component (from App Map) relative to which to calculate coordinates to drag

coordinates - String, the relative coordinates. Example: "Coords=3,10,12,20", or "coordsKey" defined in App Map

Returns:

true if successfully executed, false otherwise.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = RightDrag(Map.Google.Apps,"3,10,12,20");//Right-Drag from (3,10) to (12,20), relative to the Left Up corner of component Map.Google.Apps
 boolean success = RightDrag(Map.Google.Apps,"Coords=3,10,12,20");//Right-Drag from (3,10) to (12,20), relative to the Left Up corner of component Map.Google.Apps
 boolean success = RightDrag(Map.Google.Apps,"coordsKey");//"coordsKey" is defined in map file under section [Apps]
 //one of the above and then,
 int rc = prevResults.getStatusCode();      // if useful
 String info = prevResults.getStatusInfo(); // if useful
 

 

ShiftClick

public static boolean ShiftClick(Component comp,
                                 java.lang.String... params)

Shift-Click on any visible component.

See Detailed Reference

Parameters:

comp - -- Component (from App Map) to Click

params - optional

• params[0] X,Y coordinate. Example: "50,50", or "AppMapSubkey" defined in App Map
  For SE+, params[0] X,Y coordinate also support percentage format for X, or Y. Example: "20%,30%", "20%,30", "20,30%".
  
• params[1] auto-scroll boolean if the component will be scrolled into view automatically before clicking. if not provided, the default value is true.

Returns:

true if successfully executed, false otherwise.

Sets prevResults TestRecordHelper to the results received or null if an error occurred.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 1) boolean success = ShiftClick(Map.Google.Apps);//Shift-Click at the center
 2) boolean success = ShiftClick(Map.Google.Apps,"20,20");//Shift-Click at the coordination (20,20)
 3) boolean success = ShiftClick(Map.Google.Apps,"20%,30%"); // Shift-Click at the coordinate: its X value equals 20% width of component, its Y value equals 30% height of component.
 4) boolean success = ShiftClick(Map.Google.Apps,"AppMapSubkey");//Shift-Click at the coordination defined by entry "AppMapSubkey" in App Map.
 5) boolean success = ShiftClick(Map.Google.Apps,"20,20", "false");//Shift-Click at the coordination (20,20) and web-element will not be scrolled into view automatically
  // one of the above and then,
 int rc = prevResults.getStatusCode();      // if useful
 String info = prevResults.getStatusInfo(); // if useful
 

 Pay attention: If you use percentage format in SE+, you'd better use 'Misc.Expressions(false);' first.