public class GenericObjectFunctions
extends java.lang.Object
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
ALTLEFTDRAG_KEYWORD
"AltLeftDrag"
|
static java.lang.String |
CLICK_KEYWORD
"Click"
|
static java.lang.String |
CLICKSCREENIMAGE_KEYWORD
"ClickScreenImage"
|
static java.lang.String |
CLICKSCREENLOCATION_KEYWORD
"ClickScreenLocation"
|
static java.lang.String |
CLICKSCREENPOINT_KEYWORD
"ClickScreenPoint"
|
static java.lang.String |
COMPARESTOREDDATA_KEYWORD
"CompareStoredData"
|
static java.lang.String |
COMPARESTOREDPROPERTIES_KEYWORD
"CompareStoredProperties"
|
static java.lang.String |
CTRLALTLEFTDRAG_KEYWORD
"CtrlAltLeftDrag"
|
static java.lang.String |
CTRLCLICK_KEYWORD
"CtrlClick"
|
static java.lang.String |
CTRLCLICKSCREENIMAGE_KEYWORD
"CtrlClickScreenImage"
|
static java.lang.String |
CTRLLEFTDRAG_KEYWORD
"CtrlLeftDrag"
|
static java.lang.String |
CTRLRIGHTCLICK_KEYWORD
"CtrlRightClick"
|
static java.lang.String |
CTRLRIGHTCLICKSCREENIMAGE_KEYWORD
"CtrlRightClickScreenImage"
|
static java.lang.String |
CTRLSHIFTLEFTDRAG_KEYWORD
"CtrlShiftLeftDrag"
|
static java.lang.String |
DOUBLECLICK_KEYWORD
"DoubleClick"
|
static java.lang.String |
DOUBLECLICKSCREENIMAGE_KEYWORD
"DoubleClickScreenImage"
|
static java.lang.String |
DOUBLECLICKSCREENLOCATION_KEYWORD
"DoubleClickScreenLocation"
|
static java.lang.String |
DOUBLECLICKSCREENPOINT_KEYWORD
"DoubleClickScreenPoint"
|
static java.lang.String |
DOUBLETAP_KEYWORD
"DoubleTap"
|
static java.lang.String |
DRAGTO_KEYWORD
"DragTo"
|
static java.lang.String |
FLICK_KEYWORD
"Flick"
|
static java.lang.String |
FLICKDOWN_KEYWORD
"FlickDown"
|
static java.lang.String |
FLICKLEFT_KEYWORD
"FlickLeft"
|
static java.lang.String |
FLICKRIGHT_KEYWORD
"FlickRight"
|
static java.lang.String |
FLICKUP_KEYWORD
"FlickUp"
|
static java.lang.String |
HSCROLLTO_KEYWORD
"HScrollTo"
|
static java.lang.String |
JAVAMENUSELECT_KEYWORD
"JavaMenuSelect"
|
static java.lang.String |
LEFTDRAG_KEYWORD
"LeftDrag"
|
static java.lang.String |
MOUSECLICK_KEYWORD
"MouseClick"
|
static java.lang.String |
MULTICLICK_KEYWORD
"MultiClick"
|
static java.lang.String |
MULTICLICKSCREENIMAGE_KEYWORD
"MultiClickScreenImage"
|
static java.lang.String |
PRESS_KEYWORD
"Press"
|
static java.lang.String |
RIGHTCLICK_KEYWORD
"RightClick"
|
static java.lang.String |
RIGHTCLICKSCREENIMAGE_KEYWORD
"RightClickScreenImage"
|
static java.lang.String |
RIGHTCLICKSCREENLOCATION_KEYWORD
"RightClickScreenLocation"
|
static java.lang.String |
RIGHTCLICKSCREENPOINT_KEYWORD
"RightClickScreenPoint"
|
static java.lang.String |
RIGHTDRAG_KEYWORD
"RightDrag"
|
static java.lang.String |
SHIFTCLICK_KEYWORD
"ShiftClick"
|
static java.lang.String |
SHIFTCLICKSCREENIMAGE_KEYWORD
"ShiftClickScreenImage"
|
static java.lang.String |
SHIFTLEFTDRAG_KEYWORD
"ShiftLeftDrag"
|
static java.lang.String |
TAP_KEYWORD
"Tap"
|
static java.lang.String |
TWOFINGERTAP_KEYWORD
"TwoFingerTap"
|
static java.lang.String |
VERIFYIMAGE_KEYWORD
"VerifyImage"
|
static java.lang.String |
VSCROLLTO_KEYWORD
"VScrollTo"
|
| Modifier and Type | Method and Description |
|---|---|
static ComponentFunction |
altLeftDrag(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey)
An ALT left mouse drag is performed on the object based on the stored coordinates.
|
static ComponentFunction |
click(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
A single click on an object.
|
static ComponentFunction |
click(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey,
java.lang.String autoScroll)
A single click on an object.
|
static ComponentFunction |
clickScreenImage(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubKey)
Same as Click.
|
static ComponentFunction |
clickScreenLocation(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey)
Click a specified screen location.
|
static ComponentFunction |
clickScreenPoint(java.lang.String winname,
java.lang.String compname,
java.lang.String coords)
(Deprecated) Click a specified screen location.
|
static ComponentFunction |
compareStoredData(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Performs a GenericObjectVP CompareData on an object.
|
static ComponentFunction |
compareStoredData(java.lang.String winname,
java.lang.String compname,
java.lang.String vPAsset,
java.lang.String addParams)
Performs a GenericObjectVP CompareData on an object.
|
static ComponentFunction |
compareStoredProperties(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Performs a GenericObjectVP CompareProperties on an object.
|
static ComponentFunction |
compareStoredProperties(java.lang.String winname,
java.lang.String compname,
java.lang.String vPAsset,
java.lang.String addParams)
Performs a GenericObjectVP CompareProperties on an object.
|
static ComponentFunction |
ctrlAltLeftDrag(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey)
CTRL ALT left mouse drag is performed on the object based on the stored coordinates.
|
static ComponentFunction |
ctrlClick(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
A CTRL-click on an object.
|
static ComponentFunction |
ctrlClick(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey,
java.lang.String autoScroll)
A CTRL-click on an object.
|
static ComponentFunction |
ctrlClickScreenImage(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubKey)
Same as CtrlClick.
|
static ComponentFunction |
ctrlLeftDrag(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey)
A CTRL left mouse drag is performed on the object based on the stored coordinates.
|
static ComponentFunction |
ctrlRightClick(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
A CTRL-Right click on an object.
|
static ComponentFunction |
ctrlRightClick(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey,
java.lang.String autoScroll)
A CTRL-Right click on an object.
|
static ComponentFunction |
ctrlRightClickScreenImage(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubKey)
Same as CtrlRightClick.
|
static ComponentFunction |
ctrlShiftLeftDrag(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey)
A CTRL SHIFT left mouse drag is performed on the object based on the stored coordinates.
|
static ComponentFunction |
doubleClick(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
A double click on an object.
|
static ComponentFunction |
doubleClick(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey,
java.lang.String autoScroll)
A double click on an object.
|
static ComponentFunction |
doubleClickScreenImage(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubKey)
Same as DoubleClick.
|
static ComponentFunction |
doubleClickScreenLocation(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey)
DoubleClick a specified screen location.
|
static ComponentFunction |
doubleClickScreenPoint(java.lang.String winname,
java.lang.String compname,
java.lang.String coords)
(Deprecated) DoubleClick a specified screen location.
|
static ComponentFunction |
doubleTap(java.lang.String winname,
java.lang.String compname)
A double-tap on a touchscreen object.
|
static ComponentFunction |
dragTo(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
A left mouse drag is performed from one object to another object based
on the offsets values.
|
static ComponentFunction |
dragTo(java.lang.String winname,
java.lang.String compname,
java.lang.String toWindow,
java.lang.String toComponent,
java.lang.String offsets,
java.lang.String fromSubItem,
java.lang.String toSubItem,
java.lang.String pause)
A left mouse drag is performed from one object to another object based
on the offsets values.
|
static ComponentFunction |
flick(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
A user-defined flick or swipe on a touchscreen object.
|
static ComponentFunction |
flick(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubKey,
java.lang.String duration,
java.lang.String touches,
java.lang.String repeat)
A user-defined flick or swipe on a touchscreen object.
|
static ComponentFunction |
flickDown(java.lang.String winname,
java.lang.String compname,
java.lang.String repeat)
A flick or swipe on a touchscreen object from top-to-bottom.
|
static ComponentFunction |
flickLeft(java.lang.String winname,
java.lang.String compname,
java.lang.String repeat)
A flick or swipe on a touchscreen object from right-to-left.
|
static ComponentFunction |
flickRight(java.lang.String winname,
java.lang.String compname,
java.lang.String repeat)
A flick or swipe on a touchscreen object from left-to-right.
|
static ComponentFunction |
flickUp(java.lang.String winname,
java.lang.String compname,
java.lang.String repeat)
A flick or swipe on a touchscreen object from bottom-to-top.
|
static GenericObjectFunctions |
getInstance()
public Singleton to access class static methods via instance
|
static ComponentFunction |
hScrollTo(java.lang.String winname,
java.lang.String compname,
java.lang.String pOSITION)
Attempts to perform an HScrollTo on an object.
|
static ComponentFunction |
javaMenuSelect(java.lang.String winname,
java.lang.String compname,
java.lang.String javaMenuItem)
Select a JAVA Menu Item according to a stored text value.
|
static ComponentFunction |
leftDrag(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey)
A left mouse drag is performed on the object based on the stored coordinates.
|
static ComponentFunction |
mouseClick(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey)
A single click on an object by mouse event.
|
static ComponentFunction |
multiClick(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Multiple clicks on an object.
|
static ComponentFunction |
multiClick(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey,
java.lang.String clickCount)
Multiple clicks on an object.
|
static ComponentFunction |
multiClickScreenImage(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Same as MULTICLICK.
|
static ComponentFunction |
multiClickScreenImage(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey,
java.lang.String clickCount)
Same as MULTICLICK.
|
static ComponentFunction |
press(java.lang.String winname,
java.lang.String compname,
java.lang.String duration)
Press a touchscreen object for a number of seconds--0 seconds by default.
|
static ComponentFunction |
rightClick(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
A right click on an object.
|
static ComponentFunction |
rightClick(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey,
java.lang.String autoScroll)
A right click on an object.
|
static ComponentFunction |
rightClickScreenImage(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubKey)
Same as RightClick.
|
static ComponentFunction |
rightClickScreenLocation(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey)
RightClick a specified screen location.
|
static ComponentFunction |
rightClickScreenPoint(java.lang.String winname,
java.lang.String compname,
java.lang.String coords)
(Deprecated) RightClick a specified screen location.
|
static ComponentFunction |
rightDrag(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey)
A right mouse drag is performed on the object based on the stored coordinates.
|
static ComponentFunction |
shiftClick(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
A SHIFT click on an object.
|
static ComponentFunction |
shiftClick(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey,
java.lang.String autoScroll)
A SHIFT click on an object.
|
static ComponentFunction |
shiftClickScreenImage(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubKey)
Same as ShiftClick.
|
static ComponentFunction |
shiftLeftDrag(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey)
A SHIFT left mouse drag is performed on the object based on the stored coordinates.
|
static ComponentFunction |
tap(java.lang.String winname,
java.lang.String compname)
A single Tap on a touchscreen object.
|
static ComponentFunction |
twoFingerTap(java.lang.String winname,
java.lang.String compname)
A two-finger tap on a touchscreen object.
|
static ComponentFunction |
verifyImage(java.lang.String winname,
java.lang.String compname,
java.lang.String vPAsset)
Performs a GenericObjectVP CompareImage OR a RegionImageVP on an object.
|
static ComponentFunction |
vScrollTo(java.lang.String winname,
java.lang.String compname,
java.lang.String pOSITION)
Attempts to perform a VScrollTo on an object.
|
public static final java.lang.String ALTLEFTDRAG_KEYWORD
public static final java.lang.String CLICK_KEYWORD
public static final java.lang.String CLICKSCREENIMAGE_KEYWORD
public static final java.lang.String CLICKSCREENLOCATION_KEYWORD
public static final java.lang.String CLICKSCREENPOINT_KEYWORD
public static final java.lang.String COMPARESTOREDDATA_KEYWORD
public static final java.lang.String COMPARESTOREDPROPERTIES_KEYWORD
public static final java.lang.String CTRLALTLEFTDRAG_KEYWORD
public static final java.lang.String CTRLCLICK_KEYWORD
public static final java.lang.String CTRLCLICKSCREENIMAGE_KEYWORD
public static final java.lang.String CTRLLEFTDRAG_KEYWORD
public static final java.lang.String CTRLRIGHTCLICK_KEYWORD
public static final java.lang.String CTRLRIGHTCLICKSCREENIMAGE_KEYWORD
public static final java.lang.String CTRLSHIFTLEFTDRAG_KEYWORD
public static final java.lang.String DOUBLECLICK_KEYWORD
public static final java.lang.String DOUBLECLICKSCREENIMAGE_KEYWORD
public static final java.lang.String DOUBLECLICKSCREENLOCATION_KEYWORD
public static final java.lang.String DOUBLECLICKSCREENPOINT_KEYWORD
public static final java.lang.String DOUBLETAP_KEYWORD
public static final java.lang.String DRAGTO_KEYWORD
public static final java.lang.String FLICK_KEYWORD
public static final java.lang.String FLICKDOWN_KEYWORD
public static final java.lang.String FLICKLEFT_KEYWORD
public static final java.lang.String FLICKRIGHT_KEYWORD
public static final java.lang.String FLICKUP_KEYWORD
public static final java.lang.String HSCROLLTO_KEYWORD
public static final java.lang.String JAVAMENUSELECT_KEYWORD
public static final java.lang.String LEFTDRAG_KEYWORD
public static final java.lang.String MOUSECLICK_KEYWORD
public static final java.lang.String MULTICLICK_KEYWORD
public static final java.lang.String MULTICLICKSCREENIMAGE_KEYWORD
public static final java.lang.String PRESS_KEYWORD
public static final java.lang.String RIGHTCLICK_KEYWORD
public static final java.lang.String RIGHTCLICKSCREENIMAGE_KEYWORD
public static final java.lang.String RIGHTCLICKSCREENLOCATION_KEYWORD
public static final java.lang.String RIGHTCLICKSCREENPOINT_KEYWORD
public static final java.lang.String RIGHTDRAG_KEYWORD
public static final java.lang.String SHIFTCLICK_KEYWORD
public static final java.lang.String SHIFTCLICKSCREENIMAGE_KEYWORD
public static final java.lang.String SHIFTLEFTDRAG_KEYWORD
public static final java.lang.String TAP_KEYWORD
public static final java.lang.String TWOFINGERTAP_KEYWORD
public static final java.lang.String VERIFYIMAGE_KEYWORD
public static final java.lang.String VSCROLLTO_KEYWORD
public static GenericObjectFunctions getInstance()
public static ComponentFunction altLeftDrag(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey)
An ALT left mouse drag is performed on the object based on the stored coordinates.
The coordinate lookup is done with the component name(Field #3) of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow GenericItem AltLeftDrag DragName
#1 above will contain a GenericItem entry in the MainWindow section with
normal recognition information for it . GenericItem will also have it's
own section in the Application Map in which there will be an entry like:
DragName="15,30,60,90" OR
DragName="Coords=15,30,60,90"
This will tell RFT to locate the GenericItem Window object and an ALT left mouse drag
from coordinates 15,30 to 60,90.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:NO
Name of the AppMap subkey to lookup or literal text to use for an ALT left mouse drag.public static ComponentFunction click(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey, java.lang.String autoScroll)
A single click on an object.
By default, clicks on the center of the component.
We can also click on any part of an object, or any point relative to an object
based on a provided x,y coordinate or other component-specific parameters.
For SE+, the coordinate can be percentage format, like "20%,30%". This percentage format
indicates the point (20% width of component, 30% height of component) relative to the object.
The object to be clicked is first given context and then a click is
generated at the coordinates. Thus, a subitem or object can be
referenced by name even though it is only recognized via coordinates.
The coordinate lookup is done with the component name of the record AND
Field #5 or by providing the literal text of the coordinates, where supported.
Typical Data Table records:
(1) t MainWindow MainWindow Click
(2) t MainWindow MainWindow Click AnObject
(3) t MainWindow FolderTree Click Node1
(4) t MainWindow MainWindow Click "50,200"
(5) t MainWindow MainWindow Click "Coords=50,200"
For SE+, the Data Table records can be:
(6) t MainWindow MainWindow Click "50%,20%"
(7) t MainWindow MainWindow Click "50,20%"
#2 above will contain an AnObject="3,10" entry in the MainWindow section
of the Application Map to click at x=3, y=10 in the MainWindow.
#3 above will contain a FolderTree entry in the MainWindow section with
normal recognition information for it. FolderTree will also have it's
own section in the Application Map in which there will be an entry like
Node1="15,30". This will tell Robot to locate the FolderTree Generic
object and click at the coordinates specified by the reference.
#4 and #5 above show using literal text instead of an App Map entry to specify
where to click relative to the item.
#6 and #7 above show using percentage format in SE+. #6 will click at position,
where the X value equals 50% width of component, its Y value equals 20% height of component,
relative to the object. #7 will click at position, where the X value equals 50,
its Y value equals 20% height of component, relative to the object.
Rational Robot no longer requires the AppMapSubKey be provided and will
attempt to use the string as literal text if no AppMapSubKey is found in
the current App Map. Robot also no longer assumes the AppMapSubKey value
or the literal value is presenting coordinate information. This allows
components that can accept parameters other than coordinates, like table
row/col values or ImageMap areas to be specified.
If the value is deduced to contain coordinates, but is not prefixed with
"Coords=" text, then Robot will add the prefix. Otherwise, the text value
will remain unmodified.
This is the direction we expect all tools to follow going forward.
Engines should also attempt to support coordinates separated by alternate separators.
The most common separators that should be supported would be:
"," (comma) Example: "50,200"
";" (semi-colon) Example: "50;200"
" " (space) Example: "50 200"
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries as well as literal text coordinates.
For IOS: Any optional coordinates MUST be specified as an integer number between
0-100. 0 represents the extreme left (or top), while 100 represents the extreme
right (or bottom). IOS does not use absolute coordinates, but relative coordinates
representing a percentage of the element width or height.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:YES
(Optional)Name of the AppMap subkey to lookup or the literal text to use for the click.autoScroll - Optional:YES
(Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.public static ComponentFunction click(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
A single click on an object.
By default, clicks on the center of the component.
We can also click on any part of an object, or any point relative to an object
based on a provided x,y coordinate or other component-specific parameters.
For SE+, the coordinate can be percentage format, like "20%,30%". This percentage format
indicates the point (20% width of component, 30% height of component) relative to the object.
The object to be clicked is first given context and then a click is
generated at the coordinates. Thus, a subitem or object can be
referenced by name even though it is only recognized via coordinates.
The coordinate lookup is done with the component name of the record AND
Field #5 or by providing the literal text of the coordinates, where supported.
Typical Data Table records:
(1) t MainWindow MainWindow Click
(2) t MainWindow MainWindow Click AnObject
(3) t MainWindow FolderTree Click Node1
(4) t MainWindow MainWindow Click "50,200"
(5) t MainWindow MainWindow Click "Coords=50,200"
For SE+, the Data Table records can be:
(6) t MainWindow MainWindow Click "50%,20%"
(7) t MainWindow MainWindow Click "50,20%"
#2 above will contain an AnObject="3,10" entry in the MainWindow section
of the Application Map to click at x=3, y=10 in the MainWindow.
#3 above will contain a FolderTree entry in the MainWindow section with
normal recognition information for it. FolderTree will also have it's
own section in the Application Map in which there will be an entry like
Node1="15,30". This will tell Robot to locate the FolderTree Generic
object and click at the coordinates specified by the reference.
#4 and #5 above show using literal text instead of an App Map entry to specify
where to click relative to the item.
#6 and #7 above show using percentage format in SE+. #6 will click at position,
where the X value equals 50% width of component, its Y value equals 20% height of component,
relative to the object. #7 will click at position, where the X value equals 50,
its Y value equals 20% height of component, relative to the object.
Rational Robot no longer requires the AppMapSubKey be provided and will
attempt to use the string as literal text if no AppMapSubKey is found in
the current App Map. Robot also no longer assumes the AppMapSubKey value
or the literal value is presenting coordinate information. This allows
components that can accept parameters other than coordinates, like table
row/col values or ImageMap areas to be specified.
If the value is deduced to contain coordinates, but is not prefixed with
"Coords=" text, then Robot will add the prefix. Otherwise, the text value
will remain unmodified.
This is the direction we expect all tools to follow going forward.
Engines should also attempt to support coordinates separated by alternate separators.
The most common separators that should be supported would be:
"," (comma) Example: "50,200"
";" (semi-colon) Example: "50;200"
" " (space) Example: "50 200"
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries as well as literal text coordinates.
For IOS: Any optional coordinates MUST be specified as an integer number between
0-100. 0 represents the extreme left (or top), while 100 represents the extreme
right (or bottom). IOS does not use absolute coordinates, but relative coordinates
representing a percentage of the element width or height.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction clickScreenImage(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubKey)
Same as Click.
The keyword is simply provided as a means to differentiate
Object-Based Testing from Image-Based Testing in your tests.
However, this differentiation is not required.
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries as well as literal text coordinates.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubKey - Optional:YES
(Optional) AppMapSubKey type of use as documented in the CLICK command.public static ComponentFunction clickScreenLocation(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey)
Click a specified screen location.
Click a specified screen location.
We can click on any screen location based on stored x,y
coordinates or hardcoded literal values. The Window:Component fields
can be anything at all and will be ignored if they do not exist in the app map,
or if the retrieved app map data does not contain coordinate data.
Thus, an item or object can be referenced by name even though it is only
known via coordinates.
If the Window:Component AppMap lookup does NOT contain coordinate data and is ignored, then
the AppMapSubKey field is REQUIRED and is expected to contain a reference or literal
text containing absolute screen coordinates.
If the Window:Component AppMap lookup DOES contain coordinate data, this data is treated as
the absolute screen coordinates to be used. The AppMapSubKey field becomes OPTIONAL and
coordinate data in the field is treated as a relative offset added to the absolute values
found for the Window:Component.
Any AppMapSubKey lookup is done with the Component name in the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow Component ClickScreenLocation
(2) t MainWindow MainWindow ClickScreenLocation AnObject
(3) t MainWindow MainWindow ClickScreenLocation 50,80
(4) t AnyWin AnyComp ClickScreenLocation Node1
#1 above will contain a blank as it's 5th field. Because the AppMapSubKey
field is blank, the [MainWindow] section of the AppMap MUST have a Component item with valid
absolute screen coordinates for the click.
#2 above will contain an AnObject="Coords=50,80" entry in the [MainWindow] section
of the AppMap. If there is a MainWindow component in the AppMap with valid screen coordinates
then the click will occur with a relative offset of 50,80 from those absolute screen
coordinates. Otherwise, the click will occur at absolute screen coordinates 50,80.
#3 If there is a MainWindow component in the [MainWindow] section of the AppMap with valid screen
coordinates then the click will occur with a relative offset of 50,80 from those absolute
screen coordinates. Otherwise, the click will occur at absolute screen coordinates 50,80.
#4 above will contain no valid AnyWin:AnyComp coordinate data and
those fields will be ignored. However, Node1 MUST exist in the
Application Map [AnyComp] section to provide absolute screen coordinates for the click.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:YES
(Sometimes Optional)Name of the AppMap subkey to locate in the AppMap.public static ComponentFunction clickScreenPoint(java.lang.String winname, java.lang.String compname, java.lang.String coords)
(Deprecated) Click a specified screen location.
(Deprecated) Click a specified screen location. See ClickScreenLocation
for the preferred method to click on screen coordinates.
We can click on any screen location based on literal text x,y
coordinates retrieved from Field #5. Window and Component names and App Map entries are
completely ignored. So the user can put anything in those fields that might help test readability.
It is not recommended to hardcode screen coordinates in the test table in this way.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.coords - Optional:NO
The hardcoded X,Y screen coordinates--or the result of an expression--that provides the
absolute screen coordinates to click.public static ComponentFunction compareStoredData(java.lang.String winname, java.lang.String compname, java.lang.String vPAsset, java.lang.String addParams)
Performs a GenericObjectVP CompareData on an object.
THE BENCHMARK VP MUST ALREADY EXIST AND BE AN ASSET OF THE CURRENTLY
RUNNING SCRIPT.
Modified VP parameter information can be added to the standard
VP=VPName by including the VPName reference in the application map
in a section defined for the object. If this is done, the value
retrieved from the application map will be appended to VP=VPName.
The required semicolon for this append will be provided by this routine.
Example 1: Perform a standard HTMLImage CompareData. To perform
a basic CompareData the name "StoredVP" will not exist in the app map:
The Step File call:
BrowserWindow AnHTMLImage CompareStoredData StoredVP
This will produce a CompareData VP with "VP=StoredVP;Wait=2,10".
The StoredVP baseline MUST already exist as an asset of the
currently running script.
Example 2: Perform a HTMLImage CompareData providing addition
parameter information (such as ExpectedResult=FAIL). To do this the
HTMLImage object must have its own section in the app map and an item
with the same name as the StoredVP. The value of that item will be
appended to the standard VP argument with a semicolon.
Part of App Map:
[BrowserWindow]
BrowserWindow=WindowTag=WEBBrowser
AnHTMLImage=;\;Type=HTMLImage;Index=1
...
[AnHTMLImage]
StoredVP=ExpectedResult=FAIL;Wait=3,30
The Step File call:
BrowserWindow AnHTMLImage CompareStoredData StoredVP
This will produce a CompareData VP with all the parameters appended
like this: "VP=StoredVP;ExpectedResult=FAIL;Wait=3,30".
NOTE:When stored parameters are found in the app map then the default Wait=
parameter used in the standard compare is no longer provided. If you still
need a Wait= parameter, then it must be included in the stored parameters.
The StoredVP baseline MUST already exist as an asset of the
currently running script.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.vPAsset - Optional:NO
Name of the pre-existing VP asset stored in the currently running script.addParams - Optional:YES
Additional parameter name used for lookup, or as literal text.public static ComponentFunction compareStoredData(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Performs a GenericObjectVP CompareData on an object.
THE BENCHMARK VP MUST ALREADY EXIST AND BE AN ASSET OF THE CURRENTLY
RUNNING SCRIPT.
Modified VP parameter information can be added to the standard
VP=VPName by including the VPName reference in the application map
in a section defined for the object. If this is done, the value
retrieved from the application map will be appended to VP=VPName.
The required semicolon for this append will be provided by this routine.
Example 1: Perform a standard HTMLImage CompareData. To perform
a basic CompareData the name "StoredVP" will not exist in the app map:
The Step File call:
BrowserWindow AnHTMLImage CompareStoredData StoredVP
This will produce a CompareData VP with "VP=StoredVP;Wait=2,10".
The StoredVP baseline MUST already exist as an asset of the
currently running script.
Example 2: Perform a HTMLImage CompareData providing addition
parameter information (such as ExpectedResult=FAIL). To do this the
HTMLImage object must have its own section in the app map and an item
with the same name as the StoredVP. The value of that item will be
appended to the standard VP argument with a semicolon.
Part of App Map:
[BrowserWindow]
BrowserWindow=WindowTag=WEBBrowser
AnHTMLImage=;\;Type=HTMLImage;Index=1
...
[AnHTMLImage]
StoredVP=ExpectedResult=FAIL;Wait=3,30
The Step File call:
BrowserWindow AnHTMLImage CompareStoredData StoredVP
This will produce a CompareData VP with all the parameters appended
like this: "VP=StoredVP;ExpectedResult=FAIL;Wait=3,30".
NOTE:When stored parameters are found in the app map then the default Wait=
parameter used in the standard compare is no longer provided. If you still
need a Wait= parameter, then it must be included in the stored parameters.
The StoredVP baseline MUST already exist as an asset of the
currently running script.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction compareStoredProperties(java.lang.String winname, java.lang.String compname, java.lang.String vPAsset, java.lang.String addParams)
Performs a GenericObjectVP CompareProperties on an object.
Performs a GenericObjectVP CompareProperties on an object.
THE BENCHMARK VP MUST ALREADY EXIST AND BE AN ASSET OF THE CURRENTLY
RUNNING SCRIPT.
Modified VP parameter information can be added to the standard
VP=VPName by including the VPName reference in the application map
in a section defined for the object. If this is done, the value
retrieved from the application map will be appended to VP=VPName.
The required semicolon for this append will be provided by this routine.
Example 1: Perform a standard HTMLImage CompareProperties. To perform
a basic CompareProperties the name "StoredVP" will not exist in the app map:
The Step File call:
BrowserWindow AnHTMLImage CompareStoredProperties StoredVP
This will produce a VP with "VP=StoredVP;Wait=2,10".
The StoredVP baseline MUST already exist as an asset of the
currently running script.
Example 2: Perform a HTMLImage CompareProperties providing addition
parameter information (such as ExpectedResult=FAIL). To do this the
HTMLImage object must have its own section in the app map and an item
with the same name as the StoredVP. The value of that item will be
appended to the standard VP argument with a semicolon.
Part of App Map:
[BrowserWindow]
BrowserWindow=WindowTag=WEBBrowser
AnHTMLImage=;\;Type=HTMLImage;Index=1
...
[AnHTMLImage]
StoredVP=ExpectedResult=FAIL;Wait=3,30
The Step File call:
BrowserWindow AnHTMLImage CompareStoredProperties StoredVP
This will produce a VP with all the parameters appended
like this: "VP=StoredVP;ExpectedResult=FAIL;Wait=3,30".
NOTE:When stored parameters are found in the app map then the default Wait=
parameter used in the standard compare is no longer provided. If you still
need a Wait= parameter, then it must be included in the stored parameters.
The StoredVP baseline MUST already exist as an asset of the
currently running script.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.vPAsset - Optional:NO
Name of the pre-existing VP asset stored in the currently running script.addParams - Optional:YES
Additional parameter name used for lookup, or as literal text.public static ComponentFunction compareStoredProperties(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Performs a GenericObjectVP CompareProperties on an object.
Performs a GenericObjectVP CompareProperties on an object.
THE BENCHMARK VP MUST ALREADY EXIST AND BE AN ASSET OF THE CURRENTLY
RUNNING SCRIPT.
Modified VP parameter information can be added to the standard
VP=VPName by including the VPName reference in the application map
in a section defined for the object. If this is done, the value
retrieved from the application map will be appended to VP=VPName.
The required semicolon for this append will be provided by this routine.
Example 1: Perform a standard HTMLImage CompareProperties. To perform
a basic CompareProperties the name "StoredVP" will not exist in the app map:
The Step File call:
BrowserWindow AnHTMLImage CompareStoredProperties StoredVP
This will produce a VP with "VP=StoredVP;Wait=2,10".
The StoredVP baseline MUST already exist as an asset of the
currently running script.
Example 2: Perform a HTMLImage CompareProperties providing addition
parameter information (such as ExpectedResult=FAIL). To do this the
HTMLImage object must have its own section in the app map and an item
with the same name as the StoredVP. The value of that item will be
appended to the standard VP argument with a semicolon.
Part of App Map:
[BrowserWindow]
BrowserWindow=WindowTag=WEBBrowser
AnHTMLImage=;\;Type=HTMLImage;Index=1
...
[AnHTMLImage]
StoredVP=ExpectedResult=FAIL;Wait=3,30
The Step File call:
BrowserWindow AnHTMLImage CompareStoredProperties StoredVP
This will produce a VP with all the parameters appended
like this: "VP=StoredVP;ExpectedResult=FAIL;Wait=3,30".
NOTE:When stored parameters are found in the app map then the default Wait=
parameter used in the standard compare is no longer provided. If you still
need a Wait= parameter, then it must be included in the stored parameters.
The StoredVP baseline MUST already exist as an asset of the
currently running script.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction ctrlAltLeftDrag(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey)
CTRL ALT left mouse drag is performed on the object based on the stored coordinates.
The coordinate lookup is done with the component name(Field #3) of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow GenericItem CtrlAltLeftDrag DragName
#1 above will contain a GenericItem entry in the MainWindow section with
normal recognition information for it . GenericItem will also have it's
own section in the Application Map in which there will be an entry like:
DragName="15,30,60,90" OR
DragName="Coords=15,30,60,90"
This will tell RFT to locate the GenericItem Window object and CTRL ALT left mouse drag
from coordinates 15,30 to 60,90.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:NO
Name of the AppMap subkey to lookup or literal text to use for the CTRL ALT left mouse drag.public static ComponentFunction ctrlClick(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey, java.lang.String autoScroll)
A CTRL-click on an object.
By default we should click the center of the object.
We can also CTRL-click on any part of an object based on a stored x,y
coordinate. The object containing the coordinate is first given
context and then a CTRL-click is generated at the coordinate. Thus, an item
or object can be referenced by name even though it is only recognized
via coordinates.
The coordinate lookup is done with the component name of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow MainWindow CtrlClick
(2) t MainWindow MainWindow CtrlClick AnObject
(3) t MainWindow ToolItem CtrlClick PrintTool
#2 above will contain an AnObject="3,10" entry in the MainWindow section
of the Application Map to CTRL-click at x=3, y=10 in the MainWindow. For SE+, the
coordinate can be percentage format, like "20%,30%". This percentage format indicates
the point (20% width of component, 30% height of component) relative to the object.
#3 above will contain a ToolItem entry in the MainWindow section with
normal recognition information for it . ToolItem will also have it's
own section in the Application Map in which there will be an entry like
PrintTool="15,30". This will tell Robot to locate the PrintTool Window
object and CTRL-click at the coordinates specified by the reference.
Engines should also attempt to support coordinates separated by alternate separators.
The most common separators that should be supported would be:
"," (comma) Example: "50,200"
";" (semi-colon) Example: "50;200"
" " (space) Example: "50 200"
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:YES
(Optional) Name of the AppMap subkey to lookup and use for the CTRL-click.autoScroll - Optional:YES
(Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.public static ComponentFunction ctrlClick(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
A CTRL-click on an object.
By default we should click the center of the object.
We can also CTRL-click on any part of an object based on a stored x,y
coordinate. The object containing the coordinate is first given
context and then a CTRL-click is generated at the coordinate. Thus, an item
or object can be referenced by name even though it is only recognized
via coordinates.
The coordinate lookup is done with the component name of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow MainWindow CtrlClick
(2) t MainWindow MainWindow CtrlClick AnObject
(3) t MainWindow ToolItem CtrlClick PrintTool
#2 above will contain an AnObject="3,10" entry in the MainWindow section
of the Application Map to CTRL-click at x=3, y=10 in the MainWindow. For SE+, the
coordinate can be percentage format, like "20%,30%". This percentage format indicates
the point (20% width of component, 30% height of component) relative to the object.
#3 above will contain a ToolItem entry in the MainWindow section with
normal recognition information for it . ToolItem will also have it's
own section in the Application Map in which there will be an entry like
PrintTool="15,30". This will tell Robot to locate the PrintTool Window
object and CTRL-click at the coordinates specified by the reference.
Engines should also attempt to support coordinates separated by alternate separators.
The most common separators that should be supported would be:
"," (comma) Example: "50,200"
";" (semi-colon) Example: "50;200"
" " (space) Example: "50 200"
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction ctrlClickScreenImage(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubKey)
Same as CtrlClick.
The keyword is simply provided as a means to differentiate
Object-Based Testing from Image-Based Testing in your tests.
However, this differentiation is not required.
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries as well as literal text coordinates.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubKey - Optional:YES
(Optional) AppMapSubKey type of use as documented in the CLICK command.public static ComponentFunction ctrlLeftDrag(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey)
A CTRL left mouse drag is performed on the object based on the stored coordinates.
The coordinate lookup is done with the component name(Field #3) of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow GenericItem CtrlLeftDrag DragName
#1 above will contain a GenericItem entry in the MainWindow section with
normal recognition information for it . GenericItem will also have it's
own section in the Application Map in which there will be an entry like:
DragName="15,30,60,90" OR
DragName="Coords=15,30,60,90"
This will tell RFT to locate the GenericItem Window object and CTRL left drag
from coordinates 15,30 to 60,90.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:NO
Name of the AppMap subkey to lookup or literal text to use for the CTRL left mouse drag.public static ComponentFunction ctrlRightClick(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey, java.lang.String autoScroll)
A CTRL-Right click on an object.
By default we should click the center of the object.
We can also CTRL-Right-Click on any part of an object based on a stored x,y
coordinate. The object containing the coordinate is first given
context and then a CTRL-Right-Click is generated at the coordinate. Thus, an item
or object can be referenced by name even though it is only recognized
via coordinates.
The coordinate lookup is done with the component name of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow MainWindow CtrlRightClick
(2) t MainWindow MainWindow CtrlRightClick AnObject
(3) t MainWindow ToolItem CtrlRightClick PrintTool
#2 above will contain an AnObject="3,10" entry in the MainWindow section
of the Application Map to CTRL-click at x=3, y=10 in the MainWindow. For SE+, the
coordinate can be percentage format, like "20%,30%". This percentage format indicates
the point (20% width of component, 30% height of component) relative to the object.
#3 above will contain a ToolItem entry in the MainWindow section with
normal recognition information for it . ToolItem will also have it's
own section in the Application Map in which there will be an entry like
PrintTool="15,30". This will tell Robot to locate the PrintTool Window
object and CTRL-Right-Click at the coordinates specified by the reference.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:YES
(Optional) Name of the AppMap subkey to lookup and use for the CTRL-Right-Click.autoScroll - Optional:YES
(Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.public static ComponentFunction ctrlRightClick(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
A CTRL-Right click on an object.
By default we should click the center of the object.
We can also CTRL-Right-Click on any part of an object based on a stored x,y
coordinate. The object containing the coordinate is first given
context and then a CTRL-Right-Click is generated at the coordinate. Thus, an item
or object can be referenced by name even though it is only recognized
via coordinates.
The coordinate lookup is done with the component name of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow MainWindow CtrlRightClick
(2) t MainWindow MainWindow CtrlRightClick AnObject
(3) t MainWindow ToolItem CtrlRightClick PrintTool
#2 above will contain an AnObject="3,10" entry in the MainWindow section
of the Application Map to CTRL-click at x=3, y=10 in the MainWindow. For SE+, the
coordinate can be percentage format, like "20%,30%". This percentage format indicates
the point (20% width of component, 30% height of component) relative to the object.
#3 above will contain a ToolItem entry in the MainWindow section with
normal recognition information for it . ToolItem will also have it's
own section in the Application Map in which there will be an entry like
PrintTool="15,30". This will tell Robot to locate the PrintTool Window
object and CTRL-Right-Click at the coordinates specified by the reference.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction ctrlRightClickScreenImage(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubKey)
Same as CtrlRightClick.
The keyword is simply provided as a means to differentiate
Object-Based Testing from Image-Based Testing in your tests.
However, this differentiation is not required.
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries as well as literal text coordinates.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubKey - Optional:YES
(Optional) AppMapSubKey type of use as documented in the CLICK command.public static ComponentFunction ctrlShiftLeftDrag(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey)
A CTRL SHIFT left mouse drag is performed on the object based on the stored coordinates.
The coordinate lookup is done with the component name(Field #3) of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow GenericItem CtrlShiftLeftDrag DragName
#1 above will contain a GenericItem entry in the MainWindow section with
normal recognition information for it . GenericItem will also have it's
own section in the Application Map in which there will be an entry like:
DragName="15,30,60,90" OR
DragName="Coords=15,30,60,90"
This will tell RFT to locate the GenericItem Window object and CTRL SHIFT left mouse drag
from coordinates 15,30 to 60,90.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:NO
Name of the AppMap subkey to lookup or literal text to use for the CTRL SHIFT left mouse drag.public static ComponentFunction doubleClick(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey, java.lang.String autoScroll)
A double click on an object.
By default we should click the center of the object.
We can also double click on any part of an object based on a stored
x,y coordinate. The object containing the coordinate is first given
context and then a double click is generated at the coordinate. Thus,
an item or object can be referenced by name even though it is only
recognized via coordinates.
The coordinate lookup is done with the component name of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow MainWindow DoubleClick
(2) t MainWindow MainWindow DoubleClick AnObject
(3) t MainWindow FolderTree DoubleClick Node1
#2 above will contain an AnObject="3,10" entry in the MainWindow section
of the Application Map to double click at x=3, y=10 in the MainWindow. For SE+, the coordinate
can be percentage format, like "20%,30%". This percentage format indicates
the point (20% width of component, 30% height of component) relative to the object.
#3 above will contain a FolderTree entry in the MainWindow section with
normal recognition information for it . FolderTree will also have it's
own section in the Application Map in which there will be an entry like
Node1="15,30". This will tell Robot to locate the FolderTree
object and double click at the coordinates specified by the reference.
Engines should also attempt to support coordinates separated by alternate separators.
The most common separators that should be supported would be:
"," (comma) Example: "50,200"
";" (semi-colon) Example: "50;200"
" " (space) Example: "50 200"
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries as well as literal text coordinates.
For IOS: Any optional coordinates MUST be specified as an integer number between
0-100. 0 represents the extreme left (or top), while 100 represents the extreme
right (or bottom). IOS does not use absolute coordinates, but relative coordinates
representing a percentage of the element width or height.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:YES
(Optional) Name of the AppMap subkey to lookup or the literal text to use for the double click.autoScroll - Optional:YES
(Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.public static ComponentFunction doubleClick(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
A double click on an object.
By default we should click the center of the object.
We can also double click on any part of an object based on a stored
x,y coordinate. The object containing the coordinate is first given
context and then a double click is generated at the coordinate. Thus,
an item or object can be referenced by name even though it is only
recognized via coordinates.
The coordinate lookup is done with the component name of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow MainWindow DoubleClick
(2) t MainWindow MainWindow DoubleClick AnObject
(3) t MainWindow FolderTree DoubleClick Node1
#2 above will contain an AnObject="3,10" entry in the MainWindow section
of the Application Map to double click at x=3, y=10 in the MainWindow. For SE+, the coordinate
can be percentage format, like "20%,30%". This percentage format indicates
the point (20% width of component, 30% height of component) relative to the object.
#3 above will contain a FolderTree entry in the MainWindow section with
normal recognition information for it . FolderTree will also have it's
own section in the Application Map in which there will be an entry like
Node1="15,30". This will tell Robot to locate the FolderTree
object and double click at the coordinates specified by the reference.
Engines should also attempt to support coordinates separated by alternate separators.
The most common separators that should be supported would be:
"," (comma) Example: "50,200"
";" (semi-colon) Example: "50;200"
" " (space) Example: "50 200"
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries as well as literal text coordinates.
For IOS: Any optional coordinates MUST be specified as an integer number between
0-100. 0 represents the extreme left (or top), while 100 represents the extreme
right (or bottom). IOS does not use absolute coordinates, but relative coordinates
representing a percentage of the element width or height.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction doubleClickScreenImage(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubKey)
Same as DoubleClick.
The keyword is simply provided as a means to differentiate
Object-Based Testing from Image-Based Testing in your tests.
However, this differentiation is not required.
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries as well as literal text coordinates.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubKey - Optional:YES
(Optional) AppMapSubKey as documented in the CLICK command.public static ComponentFunction doubleClickScreenLocation(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey)
DoubleClick a specified screen location.
DoubleClick a specified screen location.
We can click on any screen location based on stored x,y
coordinates or hardcoded literal values. The Window:Component fields
can be anything at all and will be ignored if they do not exist in the app map,
or if the retrieved app map data does not contain coordinate data.
Thus, an item or object can be referenced by name even though it is only
known via coordinates.
If the Window:Component AppMap lookup does NOT contain coordinate data and is ignored, then
the AppMapSubKey field is REQUIRED and is expected to contain a reference or literal
text containing absolute screen coordinates.
If the Window:Component AppMap lookup DOES contain coordinate data, this data is treated as
the absolute screen coordinates to be used. The AppMapSubKey field becomes OPTIONAL and
coordinate data in the field is treated as a relative offset added to the absolute values
found for the Window:Component.
Any AppMapSubKey lookup is done with the Component name in the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow Component DoubleClickScreenLocation
(2) t MainWindow MainWindow DoubleClickScreenLocation AnObject
(3) t MainWindow MainWindow DoubleClickScreenLocation 50,80
(4) t AnyWin AnyComp DoubleClickScreenLocation Node1
#1 above will contain a blank as it's 5th field. Because the AppMapSubKey
field is blank, the [MainWindow] section of the AppMap MUST have a Component item with valid
absolute screen coordinates for the click.
#2 above will contain an AnObject="Coords=50,80" entry in the [MainWindow] section
of the AppMap. If there is a MainWindow component in the AppMap with valid screen coordinates
then the click will occur with a relative offset of 50,80 from those absolute screen
coordinates. Otherwise, the click will occur at absolute screen coordinates 50,80.
#3 If there is a MainWindow component in the [MainWindow] section of the AppMap with valid screen
coordinates then the click will occur with a relative offset of 50,80 from those absolute
screen coordinates. Otherwise, the click will occur at absolute screen coordinates 50,80.
#4 above will contain no valid AnyWin:AnyComp coordinate data and
those fields will be ignored. However, Node1 MUST exist in the
Application Map [AnyComp] section to provide absolute screen coordinates for the click.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:YES
(Sometimes Optional)Name of the AppMap subkey to locate in the AppMap.public static ComponentFunction doubleClickScreenPoint(java.lang.String winname, java.lang.String compname, java.lang.String coords)
(Deprecated) DoubleClick a specified screen location.
(Deprecated) DoubleClick a specified screen location. See DoubleClickScreenLocation
for the preferred method to click on screen coordinates.
We can click on any screen location based on literal text x,y
coordinates retrieved from Field #5. Window and Component names and App Map entries are
completely ignored. So the user can put anything in those fields that might help test readability.
It is not recommended to hardcode screen coordinates in the test table in this way.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.coords - Optional:NO
The hardcoded X,Y screen coordinates--or the result of an expression--that provides the
absolute screen coordinates to click.public static ComponentFunction doubleTap(java.lang.String winname, java.lang.String compname)
A double-tap on a touchscreen object. Use keyword "DoubleClick" syntax and parameters.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.public static ComponentFunction dragTo(java.lang.String winname, java.lang.String compname, java.lang.String toWindow, java.lang.String toComponent, java.lang.String offsets, java.lang.String fromSubItem, java.lang.String toSubItem, java.lang.String pause)
A left mouse drag is performed from one object to another object based
on the offsets values.
Drag will be performed from component (from-component) to another
to-component. Offsets value are the drag object select location. The
location (drag and release) calucate by X and Y percentage
cordination. DragTo also supports sub item of component and sub item
of to-component.
The coordination specify by offsets value. First two values are
for from-component and another are for to-component.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.toWindow - Optional:NOToWindow object.toComponent - Optional:NOToComponent object.offsets - Optional:YES
Drag and release location of from-component and to-component.
Offsets syntax will be "50%,50%,70%,70%"", where first two percentages are for from-component
and second two are for to-component. If offsets are not specified then center will be used.
Default value, both components center.fromSubItem - Optional:YESText of from-component's sub item.toSubItem - Optional:YESText of to-component's sub item.pause - Optional:YESPause time in millisecond to hold the button before releasing.public static ComponentFunction dragTo(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
A left mouse drag is performed from one object to another object based
on the offsets values.
Drag will be performed from component (from-component) to another
to-component. Offsets value are the drag object select location. The
location (drag and release) calucate by X and Y percentage
cordination. DragTo also supports sub item of component and sub item
of to-component.
The coordination specify by offsets value. First two values are
for from-component and another are for to-component.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction flick(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubKey, java.lang.String duration, java.lang.String touches, java.lang.String repeat)
A user-defined flick or swipe on a touchscreen object.
The user would use this command if they need to customize parameters like:
Number of fingers used: default=1,
Start and ending offsets within the object: defaults=90;50;10;50
How long (in seconds) to complete the flick from start to end: default=1.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubKey - Optional:YES DefaultVal:90;50;10;50
Optional AppMap SubKey (or literal text) containing x1,y1,x2,y2 flick offsets within the object.duration - Optional:YES DefaultVal:1
Optional number of seconds (0 to N) to press on the object.touches - Optional:YES DefaultVal:1
Optional number of touches or fingers to use.repeat - Optional:YES DefaultVal:1
Optional number of times to repeat the operation.public static ComponentFunction flick(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
A user-defined flick or swipe on a touchscreen object.
The user would use this command if they need to customize parameters like:
Number of fingers used: default=1,
Start and ending offsets within the object: defaults=90;50;10;50
How long (in seconds) to complete the flick from start to end: default=1.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction flickDown(java.lang.String winname, java.lang.String compname, java.lang.String repeat)
A flick or swipe on a touchscreen object from top-to-bottom.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.repeat - Optional:YES DefaultVal:1
Optional number of times to repeat the operation.public static ComponentFunction flickLeft(java.lang.String winname, java.lang.String compname, java.lang.String repeat)
A flick or swipe on a touchscreen object from right-to-left.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.repeat - Optional:YES DefaultVal:1
Optional number of times to repeat the operation.public static ComponentFunction flickRight(java.lang.String winname, java.lang.String compname, java.lang.String repeat)
A flick or swipe on a touchscreen object from left-to-right.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.repeat - Optional:YES DefaultVal:1
Optional number of times to repeat the operation.public static ComponentFunction flickUp(java.lang.String winname, java.lang.String compname, java.lang.String repeat)
A flick or swipe on a touchscreen object from bottom-to-top.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.repeat - Optional:YES DefaultVal:1
Optional number of times to repeat the operation.public static ComponentFunction hScrollTo(java.lang.String winname, java.lang.String compname, java.lang.String pOSITION)
Attempts to perform an HScrollTo on an object.
Attempts to perform an HScrollTo on an object. The input record
specifies the absolute position to scroll to.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.pOSITION - Optional:NO
Integer value that specifies the absolute position to scroll to.public static ComponentFunction javaMenuSelect(java.lang.String winname, java.lang.String compname, java.lang.String javaMenuItem)
Select a JAVA Menu Item according to a stored text value.
Select a JAVA Menu Item according to a stored text value.
Until JavaMenu objects are routed elsewhere, we will handle
the menu selection here.
Each menuItem acted upon is given a name in the AppMap under
the name provided for the Menu.
The menuitem lookup is done with the component\menu name of
the record AND Field #5.
Typical Data Table records:
t JavaWindow MainMenu JavaMenuSelect FileOpen
The example will contain a FileOpen="Path=File->Open" entry in
the MainMenu section of the Application Map to select File->Open
menuItem from the menu of the MainWindow.
MainMenu will also be an entry in the MainWindow section with
normal recognition information for it. This will tell Robot to
locate the MainMenu Generic Object prior to the menu selection.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.javaMenuItem - Optional:NO
Name of the Java menuitem to lookup and use for the selection.public static ComponentFunction leftDrag(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey)
A left mouse drag is performed on the object based on the stored coordinates.
For components that are unrecognized, we can make a mouse drag in these
to draw fields(rectangles) or do drag and drop, based on stored x,y start
and end coordinates. The object containing the starting coordinates is first
given context and then a left mouse drag is performed with the stored coordinates.
The coordinate lookup is done with the component name(Field #3) of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow GenericItem LeftDrag DragName
#1 above will contain a GenericItem entry in the MainWindow section with
normal recognition information for it . GenericItem will also have it's
own section in the Application Map in which there will be an entry like:
DragName="15,30,60,90" OR
DragName="Coords=15,30,60,90"
This will tell Robot to locate the GenericItem Window object and left drag
from coordinates 15,30 to 60,90.
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries as well as literal text coordinates.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:NO
Name of the AppMap subkey to lookup or literal text to use for the left mouse drag.public static ComponentFunction mouseClick(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey)
A single click on an object by mouse event. It uses low level mouse event to click on an object.
By default, mouse click on the center of the component.
We can also mouse click on any part of an object, or any point relative to an object
based on a provided x,y coordinate or other component-specific parameters.
The object to be mouse clicked is first given context and then a mouse click is
generated at the coordinates. Thus, a subitem or object can be
referenced by name even though it is only recognized via coordinates.
The coordinate lookup is done with the component name of the record AND
Field #5 or by providing the literal text of the coordinates, where supported.
Typical Data Table records:
(1) t MainWindow MainWindow MouseClick
(2) t MainWindow MainWindow MouseClick AnObject
(3) t MainWindow FolderTree MouseClick Node1
(4) t MainWindow MainWindow MouseClick "50,200"
(5) t MainWindow MainWindow MouseClick "Coords=50,200"
#2 above will contain an AnObject="3,10" entry in the MainWindow section
of the Application Map to mouse click at x=3, y=10 in the MainWindow.
#3 above will contain a FolderTree entry in the MainWindow section with
normal recognition information for it. FolderTree will also have it's
own section in the Application Map in which there will be an entry like
Node1="15,30". This will tell Robot to locate the FolderTree Generic
object and mouse click at the coordinates specified by the reference.
#4 and #5 above show using literal text instead of an App Map entry to specify
where to mouse click relative to the item.
Rational Robot no longer requires the AppMapSubKey be provided and will
attempt to use the string as literal text if no AppMapSubKey is found in
the current App Map. Robot also no longer assumes the AppMapSubKey value
or the literal value is presenting coordinate information. This allows
components that can accept parameters other than coordinates, like table
row/col values or ImageMap areas to be specified.
If the value is deduced to contain coordinates, but is not prefixed with
"Coords=" text, then Robot will add the prefix. Otherwise, the text value
will remain unmodified.
This is the direction we expect all tools to follow going forward.
Engines should also attempt to support coordinates separated by alternate separators.
The most common separators that should be supported would be:
"," (comma) Example: "50,200"
";" (semi-colon) Example: "50;200"
" " (space) Example: "50 200"
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:YES
(Optional)Name of the AppMap subkey to lookup or the literal text to use for the click.public static ComponentFunction multiClick(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey, java.lang.String clickCount)
Multiple clicks on an object.
By default, clicks on the center of the component 3 times.
Use the optional ClickCount parameter to specify the desired number of clicks.
We can also click on any part of an object, or any point relative to an object
based on a provided x,y coordinate or other component-specific parameters.
The object to be clicked is first given context and then the clicks are
generated at the coordinates. Thus, a subitem or object can be
referenced by name even though it is only recognized via coordinates.
The optional coordinate lookup is done with the component name of the record AND
Field #5 or by providing the literal text of the coordinates, where supported.
Typical Data Table records with relative references:
(1) t MainWindow MainWindow MultiClick
(2) t MainWindow MainWindow MultiClick AnObject
(3) t MainWindow FolderTree MultiClick Node1 "4"
(4) t MainWindow MainWindow MultiClick "50,200" "3"
(5) t MainWindow MainWindow MultiClick "Coords=50,200" "2"
#1 above should click 3 times (default) at the center (default) of the MainWindow.
#2 above will contain an AnObject="3,10" entry in the MainWindow section
of the Application Map to click 3 times (default) at x=3, y=10 in the MainWindow.
#3 above will contain a FolderTree entry in the MainWindow section with
normal recognition information for it. FolderTree will also have it's
own section in the Application Map in which there will be an entry like
Node1="15,30". This will tell the runtime to locate the FolderTree Generic
object and click 3 times (default) at the coordinates specified by the reference.
#4 and #5 above show using literal text instead of an App Map entry to specify
where to click relative to the item. The item will be clicked 3 times and 2 times,
respectively
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries as well as literal text coordinates.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:YES
(Optional)Name of the AppMap subkey to lookup or the literal text to use for the clicks.clickCount - Optional:YES DefaultVal:3
Optional number of times (1 to N) to click the item.public static ComponentFunction multiClick(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Multiple clicks on an object.
By default, clicks on the center of the component 3 times.
Use the optional ClickCount parameter to specify the desired number of clicks.
We can also click on any part of an object, or any point relative to an object
based on a provided x,y coordinate or other component-specific parameters.
The object to be clicked is first given context and then the clicks are
generated at the coordinates. Thus, a subitem or object can be
referenced by name even though it is only recognized via coordinates.
The optional coordinate lookup is done with the component name of the record AND
Field #5 or by providing the literal text of the coordinates, where supported.
Typical Data Table records with relative references:
(1) t MainWindow MainWindow MultiClick
(2) t MainWindow MainWindow MultiClick AnObject
(3) t MainWindow FolderTree MultiClick Node1 "4"
(4) t MainWindow MainWindow MultiClick "50,200" "3"
(5) t MainWindow MainWindow MultiClick "Coords=50,200" "2"
#1 above should click 3 times (default) at the center (default) of the MainWindow.
#2 above will contain an AnObject="3,10" entry in the MainWindow section
of the Application Map to click 3 times (default) at x=3, y=10 in the MainWindow.
#3 above will contain a FolderTree entry in the MainWindow section with
normal recognition information for it. FolderTree will also have it's
own section in the Application Map in which there will be an entry like
Node1="15,30". This will tell the runtime to locate the FolderTree Generic
object and click 3 times (default) at the coordinates specified by the reference.
#4 and #5 above show using literal text instead of an App Map entry to specify
where to click relative to the item. The item will be clicked 3 times and 2 times,
respectively
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries as well as literal text coordinates.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction multiClickScreenImage(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey, java.lang.String clickCount)
Same as MULTICLICK.
The keyword is simply provided as a means to differentiate
Object-Based Testing from Image-Based Testing in your tests.
However, this differentiation is not required.
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries as well as literal text coordinates.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:YES
(Optional)Name of the AppMap subkey to lookup or the literal text to use for the clicks.clickCount - Optional:YES DefaultVal:3
Optional number of times (1 to N) to click the item.public static ComponentFunction multiClickScreenImage(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Same as MULTICLICK.
The keyword is simply provided as a means to differentiate
Object-Based Testing from Image-Based Testing in your tests.
However, this differentiation is not required.
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries as well as literal text coordinates.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction press(java.lang.String winname, java.lang.String compname, java.lang.String duration)
Press a touchscreen object for a number of seconds--0 seconds by default.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.duration - Optional:YES DefaultVal:0
Optional number of seconds (0 to N) to press on the object.public static ComponentFunction rightClick(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey, java.lang.String autoScroll)
A right click on an object.
By default we should click on the center of the object.
We can also right click on any part of an object based on a stored x,y
coordinate. The object containing the coordinate is first given
context and then a right click is generated at the coordinate. Thus, an item
or object can be referenced by name even though it is only recognized
via coordinates.
The coordinate lookup is done with the component name of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow MainWindow RightClick
(2) t MainWindow MainWindow RightClick AnObject
(3) t MainWindow ToolItem RightClick PrintTool
#2 above will contain an AnObject="3,10" entry in the MainWindow section
of the Application Map to right click at x=3, y=10 in the MainWindow. For SE+, the
coordinate can be percentage format, like "20%,30%". This percentage format indicates
the point (20% width of component, 30% height of component) relative to the object.
#3 above will contain a ToolItem entry in the MainWindow section with
normal recognition information for it . ToolItem will also have it's
own section in the Application Map in which there will be an entry like
PrintTool="15,30". This will tell Robot to locate the PrintTool Window
object and right click at the coordinates specified by the reference.
Engines should also attempt to support coordinates separated by alternate separators.
The most common separators that should be supported would be:
"," (comma) Example: "50,200"
";" (semi-colon) Example: "50;200"
" " (space) Example: "50 200"
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries as well as literal text coordinates.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:YES
(Optional) Name of the AppMap subkey to lookup or the literal text to use for the right click.autoScroll - Optional:YES
(Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.public static ComponentFunction rightClick(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
A right click on an object.
By default we should click on the center of the object.
We can also right click on any part of an object based on a stored x,y
coordinate. The object containing the coordinate is first given
context and then a right click is generated at the coordinate. Thus, an item
or object can be referenced by name even though it is only recognized
via coordinates.
The coordinate lookup is done with the component name of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow MainWindow RightClick
(2) t MainWindow MainWindow RightClick AnObject
(3) t MainWindow ToolItem RightClick PrintTool
#2 above will contain an AnObject="3,10" entry in the MainWindow section
of the Application Map to right click at x=3, y=10 in the MainWindow. For SE+, the
coordinate can be percentage format, like "20%,30%". This percentage format indicates
the point (20% width of component, 30% height of component) relative to the object.
#3 above will contain a ToolItem entry in the MainWindow section with
normal recognition information for it . ToolItem will also have it's
own section in the Application Map in which there will be an entry like
PrintTool="15,30". This will tell Robot to locate the PrintTool Window
object and right click at the coordinates specified by the reference.
Engines should also attempt to support coordinates separated by alternate separators.
The most common separators that should be supported would be:
"," (comma) Example: "50,200"
";" (semi-colon) Example: "50;200"
" " (space) Example: "50 200"
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries as well as literal text coordinates.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction rightClickScreenImage(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubKey)
Same as RightClick.
The keyword is simply provided as a means to differentiate
Object-Based Testing from Image-Based Testing in your tests.
However, this differentiation is not required.
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries as well as literal text coordinates.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubKey - Optional:YES
(Optional) AppMapSubKey or literal text as documented in the CLICK command.public static ComponentFunction rightClickScreenLocation(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey)
RightClick a specified screen location.
RightClick a specified screen location.
We can click on any screen location based on stored x,y
coordinates or hardcoded literal values. The Window:Component fields
can be anything at all and will be ignored if they do not exist in the app map,
or if the retrieved app map data does not contain coordinate data.
Thus, an item or object can be referenced by name even though it is only
known via coordinates.
If the Window:Component AppMap lookup does NOT contain coordinate data and is ignored, then
the AppMapSubKey field is REQUIRED and is expected to contain a reference or literal
text containing absolute screen coordinates.
If the Window:Component AppMap lookup DOES contain coordinate data, this data is treated as
the absolute screen coordinates to be used. The AppMapSubKey field becomes OPTIONAL and
coordinate data in the field is treated as a relative offset added to the absolute values
found for the Window:Component.
Any AppMapSubKey lookup is done with the Component name in the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow Component RightClickScreenLocation
(2) t MainWindow MainWindow RightClickScreenLocation AnObject
(3) t MainWindow MainWindow RightClickScreenLocation 50,80
(4) t AnyWin AnyComp RightClickScreenLocation Node1
#1 above will contain a blank as it's 5th field. Because the AppMapSubKey
field is blank, the [MainWindow] section of the AppMap MUST have a Component item with valid
absolute screen coordinates for the click.
#2 above will contain an AnObject="Coords=50,80" entry in the [MainWindow] section
of the AppMap. If there is a MainWindow component in the AppMap with valid screen coordinates
then the click will occur with a relative offset of 50,80 from those absolute screen
coordinates. Otherwise, the click will occur at absolute screen coordinates 50,80.
#3 If there is a MainWindow component in the [MainWindow] section of the AppMap with valid screen
coordinates then the click will occur with a relative offset of 50,80 from those absolute
screen coordinates. Otherwise, the click will occur at absolute screen coordinates 50,80.
#4 above will contain no valid AnyWin:AnyComp coordinate data and
those fields will be ignored. However, Node1 MUST exist in the
Application Map [AnyComp] section to provide absolute screen coordinates for the click.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:YES
(Sometimes Optional)Name of the AppMap subkey to locate in the AppMap.public static ComponentFunction rightClickScreenPoint(java.lang.String winname, java.lang.String compname, java.lang.String coords)
(Deprecated) RightClick a specified screen location.
(Deprecated) RightClick a specified screen location. See RightClickScreenLocation
for the preferred method to click on screen coordinates.
We can click on any screen location based on literal text x,y
coordinates retrieved from Field #5. Window and Component names and App Map entries are
completely ignored. So the user can put anything in those fields that might help test readability.
It is not recommended to hardcode screen coordinates in the test table in this way.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.coords - Optional:NO
The hardcoded X,Y screen coordinates--or the result of an expression--that provides the
absolute screen coordinates to click.public static ComponentFunction rightDrag(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey)
A right mouse drag is performed on the object based on the stored coordinates.
For components that are unrecognized, we can make a mouse drag in these
to draw fields(rectangles) or do drag and drop, based on stored x,y start
and end coordinates. The object containing the starting coordinates is first
given context and then a right mouse drag is performed with the stored coordinates.
The coordinate lookup is done with the component name(Field #3) of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow GenericItem RightDrag DragName
#1 above will contain a GenericItem entry in the MainWindow section with
normal recognition information for it . GenericItem will also have it's
own section in the Application Map in which there will be an entry like:
DragName="15,30,60,90" OR
DragName="Coords=15,30,60,90"
This will tell Robot to locate the GenericItem Window object and right drag
from coordinates 15,30 to 60,90.
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries as well as literal text coordinates.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:NO
Name of the AppMap subkey to lookup or literal text to use for the right mouse drag.public static ComponentFunction shiftClick(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey, java.lang.String autoScroll)
A SHIFT click on an object.
By default we should click on the center of the object.
We can SHIFT click on any part of an object based on a stored x,y
coordinate. The object containing the coordinate is first given
context and then a SHIFT click is generated at the coordinate. Thus, an item
or object can be referenced by name even though it is only recognized
via coordinates.
The coordinate lookup is done with the component name of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow MainWindow ShiftClick
(2) t MainWindow MainWindow ShiftClick AnObject
(3) t MainWindow ToolItem ShiftClick PrintTool
#2 above will contain an AnObject="3,10" entry in the MainWindow section
of the Application Map to SHIFT click at x=3, y=10 in the MainWindow. For SE+, the
coordinate can be percentage format, like "20%,30%". This percentage format indicates
the point (20% width of component, 30% height of component) relative to the object.
#3 above will contain a ToolItem entry in the MainWindow section with
normal recognition information for it . ToolItem will also have it's
own section in the Application Map in which there will be an entry like
PrintTool="15,30". This will tell Robot to locate the PrintTool Window
object and SHIFT click at the coordinates specified by the reference.
Engines should also attempt to support coordinates separated by alternate separators.
The most common separators that should be supported would be:
"," (comma) Example: "50,200"
";" (semi-colon) Example: "50;200"
" " (space) Example: "50 200"
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:YES
(Optional) Name of the AppMap subkey to lookup and use for the SHIFT click.autoScroll - Optional:YES
(Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.public static ComponentFunction shiftClick(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
A SHIFT click on an object.
By default we should click on the center of the object.
We can SHIFT click on any part of an object based on a stored x,y
coordinate. The object containing the coordinate is first given
context and then a SHIFT click is generated at the coordinate. Thus, an item
or object can be referenced by name even though it is only recognized
via coordinates.
The coordinate lookup is done with the component name of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow MainWindow ShiftClick
(2) t MainWindow MainWindow ShiftClick AnObject
(3) t MainWindow ToolItem ShiftClick PrintTool
#2 above will contain an AnObject="3,10" entry in the MainWindow section
of the Application Map to SHIFT click at x=3, y=10 in the MainWindow. For SE+, the
coordinate can be percentage format, like "20%,30%". This percentage format indicates
the point (20% width of component, 30% height of component) relative to the object.
#3 above will contain a ToolItem entry in the MainWindow section with
normal recognition information for it . ToolItem will also have it's
own section in the Application Map in which there will be an entry like
PrintTool="15,30". This will tell Robot to locate the PrintTool Window
object and SHIFT click at the coordinates specified by the reference.
Engines should also attempt to support coordinates separated by alternate separators.
The most common separators that should be supported would be:
"," (comma) Example: "50,200"
";" (semi-colon) Example: "50;200"
" " (space) Example: "50 200"
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction shiftClickScreenImage(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubKey)
Same as ShiftClick.
The keyword is simply provided as a means to differentiate
Object-Based Testing from Image-Based Testing in your tests.
However, this differentiation is not required.
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries as well as literal text coordinates.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubKey - Optional:YES
(Optional) AppMapSubKey type of use as documented in the CLICK command.public static ComponentFunction shiftLeftDrag(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey)
A SHIFT left mouse drag is performed on the object based on the stored coordinates.
The coordinate lookup is done with the component name(Field #3) of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow GenericItem ShiftLeftDrag DragName
#1 above will contain a GenericItem entry in the MainWindow section with
normal recognition information for it . GenericItem will also have it's
own section in the Application Map in which there will be an entry like:
DragName="15,30,60,90" OR
DragName="Coords=15,30,60,90"
This will tell RFT to locate the GenericItem Window object and SHIFT left drag
from coordinates 15,30 to 60,90.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:NO
Name of the AppMap subkey to lookup or literal text to use for the SHIFT left mouse drag.public static ComponentFunction tap(java.lang.String winname, java.lang.String compname)
A single Tap on a touchscreen object. Use keyword "Click" syntax and parameters.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.public static ComponentFunction twoFingerTap(java.lang.String winname, java.lang.String compname)
A two-finger tap on a touchscreen object.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.public static ComponentFunction verifyImage(java.lang.String winname, java.lang.String compname, java.lang.String vPAsset)
Performs a GenericObjectVP CompareImage OR a RegionImageVP on an object.
Performs a GenericObjectVP CompareImage OR a RegionImageVP on an object.
The benchmark VP must already exist and be an asset of the currently
running script.
A RegionImageVP can be accomplished by having the name of the VP as an item
under the component in the application map. The item's value must be
the coordinate values required by the RegionImageVP (i.e. "65,100,200,250").
Example 1: Perform a GenericObjectVP CompareImage
MainWindow SomeGenericObject VerifyImage StoredVP
(no StoredVP item found in the app map under SomeGenericObject)
The named VP (StoredVP) must not exist in the application map. The
entire panel/object of SomeGenericObject will be captured and compared
against the StoredVP baseline which must already exist as an asset of the
currently running script.
Example 2: Perform a RegionImageVP on a particular area of the screen
MainWindow SomeGenericObject VerifyImage StoredVP
(StoredVP found as:
"65,100,200,250" OR
"Coords=65,100,200,250"
in the SomeGenericObject section of the app map)
The named VP (StoredVP) is found to exist in the application map as a
subitem in the SomeGenericObject section of the map. This causes
the routine to attempt a RegionImageVP using the map's value of the StoredVP
item as the coordinates for the region to capture. StoredVP is ALSO the
name of the VP which must already exist as an asset of the currently
running script.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.vPAsset - Optional:NO
Name of the pre-existing VP asset stored in the currently running script.public static ComponentFunction vScrollTo(java.lang.String winname, java.lang.String compname, java.lang.String pOSITION)
Attempts to perform a VScrollTo on an object.
Attempts to perform a VScrollTo on an object. The input record
specifies the absolute position to scroll to.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.pOSITION - Optional:NO
Integer value that specifies the absolute position to scroll to.Copyright © SAS Institute. All Rights Reserved.