public class ListBox extends GenericObject
Modifier | Constructor and Description |
---|---|
protected |
ListBox(java.lang.String compname) |
|
ListBox(java.lang.String winname,
java.lang.String compname)
Constructor
Create an instance of pseudo-component representing
a specific component in a specific window.
|
|
ListBox(Window window,
java.lang.String compname)
Constructor
Create an instance of pseudo-component representing
a specific component in a specific window.
|
Modifier and Type | Method and Description |
---|---|
void |
activatePartialMatch(StepTestTable table,
java.lang.String textValue)
Routine to DblClick and Verify an item according to a partial text match.
|
ComponentFunction |
activatePartialMatch(java.lang.String textValue)
Routine to DblClick and Verify an item according to a partial text match.
|
void |
activateTextItem(StepTestTable table,
java.lang.String textValue)
Routine to DblClick and Verify an item according to its text value.
|
ComponentFunction |
activateTextItem(java.lang.String textValue)
Routine to DblClick and Verify an item according to its text value.
|
void |
activateUnverifiedPartialMatch(StepTestTable table,
java.lang.String textValue)
DblClicks an item according to a partial text match.
|
ComponentFunction |
activateUnverifiedPartialMatch(java.lang.String textValue)
DblClicks an item according to a partial text match.
|
void |
activateUnverifiedTextItem(StepTestTable table,
java.lang.String textValue)
Routine to DblClick an item according to its text value.
|
ComponentFunction |
activateUnverifiedTextItem(java.lang.String textValue)
Routine to DblClick an item according to its text value.
|
void |
captureItemsToFile(StepTestTable table,
java.lang.String[] parameters)
Capture Items To a File specified (if not abs, then to test dir)
Capture Items To a File specified (if not abs, then to test dir)
|
void |
captureItemsToFile(StepTestTable table,
java.lang.String fileName,
java.lang.String fileEncoding)
Capture Items To a File specified (if not abs, then to test dir)
Capture Items To a File specified (if not abs, then to test dir)
|
ComponentFunction |
captureItemsToFile(java.lang.String[] parameters)
Capture Items To a File specified (if not abs, then to test dir)
Capture Items To a File specified (if not abs, then to test dir)
|
ComponentFunction |
captureItemsToFile(java.lang.String fileName,
java.lang.String fileEncoding)
Capture Items To a File specified (if not abs, then to test dir)
Capture Items To a File specified (if not abs, then to test dir)
|
void |
clickColumnIndex(StepTestTable table,
java.lang.String index)
Click a column header based on it's index of list, starting from 1
Click a column header based on it's index of list, starting from 1
|
ComponentFunction |
clickColumnIndex(java.lang.String index)
Click a column header based on it's index of list, starting from 1
Click a column header based on it's index of list, starting from 1
|
void |
clickColumnLabel(StepTestTable table,
java.lang.String label)
Click a column header based on it's label
Click a column header based on it's label
|
ComponentFunction |
clickColumnLabel(java.lang.String label)
Click a column header based on it's label
Click a column header based on it's label
|
void |
clickTextItem(StepTestTable table,
java.lang.String textValue)
Routine to Click a selection according to its text value.
|
ComponentFunction |
clickTextItem(java.lang.String textValue)
Routine to Click a selection according to its text value.
|
void |
extendSelectionToTextItem(StepTestTable table,
java.lang.String textValue)
Routine to Shift+Click and Verify a selection according to its text value.
|
ComponentFunction |
extendSelectionToTextItem(java.lang.String textValue)
Routine to Shift+Click and Verify a selection according to its text value.
|
void |
rightClickTextItem(StepTestTable table,
java.lang.String textValue)
Routine to Right-Click a selection according to its text value.
|
ComponentFunction |
rightClickTextItem(java.lang.String textValue)
Routine to Right-Click a selection according to its text value.
|
void |
selectAnotherTextItem(StepTestTable table,
java.lang.String textValue)
Routine to Control+Click and Verify a selection according to its text value.
|
ComponentFunction |
selectAnotherTextItem(java.lang.String textValue)
Routine to Control+Click and Verify a selection according to its text value.
|
void |
selectAnotherUnverifiedTextItem(StepTestTable table,
java.lang.String textValue)
Routine to Control+Click an item according to its text value.
|
ComponentFunction |
selectAnotherUnverifiedTextItem(java.lang.String textValue)
Routine to Control+Click an item according to its text value.
|
void |
selectIndex(StepTestTable table,
java.lang.String index)
Select an item based on it's index in the list, starting from 1
Select an item based on it's index in the list, starting from 1
|
ComponentFunction |
selectIndex(java.lang.String index)
Select an item based on it's index in the list, starting from 1
Select an item based on it's index in the list, starting from 1
|
void |
selectPartialMatch(StepTestTable table,
java.lang.String textValue)
Routine to Click and Verify an item according to a partial text match.
|
ComponentFunction |
selectPartialMatch(java.lang.String textValue)
Routine to Click and Verify an item according to a partial text match.
|
void |
selectTextItem(StepTestTable table,
java.lang.String textValue)
Routine to Click and Verify a selection according to its text value.
|
ComponentFunction |
selectTextItem(java.lang.String textValue)
Routine to Click and Verify a selection according to its text value.
|
void |
selectUnverifiedAnotherTextItem(StepTestTable table,
java.lang.String textValue)
Use the identical "SelectAnotherUnverifiedTextItem" instead.
|
ComponentFunction |
selectUnverifiedAnotherTextItem(java.lang.String textValue)
Use the identical "SelectAnotherUnverifiedTextItem" instead.
|
void |
selectUnverifiedPartialMatch(StepTestTable table,
java.lang.String textValue)
Routine to Click an item according to a partial text match.
|
ComponentFunction |
selectUnverifiedPartialMatch(java.lang.String textValue)
Routine to Click an item according to a partial text match.
|
void |
selectUnverifiedTextItem(StepTestTable table,
java.lang.String textValue)
Routine to Click a selection according to its text value.
|
ComponentFunction |
selectUnverifiedTextItem(java.lang.String textValue)
Routine to Click a selection according to its text value.
|
void |
setListContains(StepTestTable table,
java.lang.String[] parameters)
Set a variable with the result of checking that a listview contains the provided item.
|
void |
setListContains(StepTestTable table,
java.lang.String itemText,
java.lang.String resultVar)
Set a variable with the result of checking that a listview contains the provided item.
|
ComponentFunction |
setListContains(java.lang.String[] parameters)
Set a variable with the result of checking that a listview contains the provided item.
|
ComponentFunction |
setListContains(java.lang.String itemText,
java.lang.String resultVar)
Set a variable with the result of checking that a listview contains the provided item.
|
void |
verifyItem(StepTestTable table,
java.lang.String[] parameters)
Verifies a particular case-sensitive item based on index is equal
to a particular value.
|
void |
verifyItem(StepTestTable table,
java.lang.String index,
java.lang.String textValue)
Verifies a particular case-sensitive item based on index is equal
to a particular value.
|
ComponentFunction |
verifyItem(java.lang.String[] parameters)
Verifies a particular case-sensitive item based on index is equal
to a particular value.
|
ComponentFunction |
verifyItem(java.lang.String index,
java.lang.String textValue)
Verifies a particular case-sensitive item based on index is equal
to a particular value.
|
void |
verifyItemUnselected(StepTestTable table,
java.lang.String textValue)
Verifies a particular case-sensitive text item is NOT selected.
|
ComponentFunction |
verifyItemUnselected(java.lang.String textValue)
Verifies a particular case-sensitive text item is NOT selected.
|
void |
verifyListContains(StepTestTable table,
java.lang.String[] parameters)
Verifies a particular list-item exists in the list (somewhere)
Verifies a particular list-item exists in the list (somewhere).
|
void |
verifyListContains(StepTestTable table,
java.lang.String textValue,
java.lang.String caseSensitive)
Verifies a particular list-item exists in the list (somewhere)
Verifies a particular list-item exists in the list (somewhere).
|
ComponentFunction |
verifyListContains(java.lang.String[] parameters)
Verifies a particular list-item exists in the list (somewhere)
Verifies a particular list-item exists in the list (somewhere).
|
ComponentFunction |
verifyListContains(java.lang.String textValue,
java.lang.String caseSensitive)
Verifies a particular list-item exists in the list (somewhere)
Verifies a particular list-item exists in the list (somewhere).
|
void |
verifyListContainsPartialMatch(StepTestTable table,
java.lang.String[] parameters)
Verifies a particular list-item substring exists in the list (somewhere)
Verifies a particular list-item substring exists in the list (somewhere).
|
void |
verifyListContainsPartialMatch(StepTestTable table,
java.lang.String textValue,
java.lang.String caseSensitive)
Verifies a particular list-item substring exists in the list (somewhere)
Verifies a particular list-item substring exists in the list (somewhere).
|
ComponentFunction |
verifyListContainsPartialMatch(java.lang.String[] parameters)
Verifies a particular list-item substring exists in the list (somewhere)
Verifies a particular list-item substring exists in the list (somewhere).
|
ComponentFunction |
verifyListContainsPartialMatch(java.lang.String textValue,
java.lang.String caseSensitive)
Verifies a particular list-item substring exists in the list (somewhere)
Verifies a particular list-item substring exists in the list (somewhere).
|
void |
verifyListDoesNotContain(StepTestTable table,
java.lang.String[] parameters)
Verifies a particular list-item does NOT exists in the list (somewhere)
Verifies a particular list-item does NOT exists in the list (somewhere).
|
void |
verifyListDoesNotContain(StepTestTable table,
java.lang.String textValue,
java.lang.String caseSensitive)
Verifies a particular list-item does NOT exists in the list (somewhere)
Verifies a particular list-item does NOT exists in the list (somewhere).
|
ComponentFunction |
verifyListDoesNotContain(java.lang.String[] parameters)
Verifies a particular list-item does NOT exists in the list (somewhere)
Verifies a particular list-item does NOT exists in the list (somewhere).
|
ComponentFunction |
verifyListDoesNotContain(java.lang.String textValue,
java.lang.String caseSensitive)
Verifies a particular list-item does NOT exists in the list (somewhere)
Verifies a particular list-item does NOT exists in the list (somewhere).
|
void |
verifyListDoesNotContainPartialMatch(StepTestTable table,
java.lang.String[] parameters)
Verifies a particular list-item substring does NOT exists in the list (somewhere)
Verifies a particular list-item substring does NOT exists in the list (somewhere).
|
void |
verifyListDoesNotContainPartialMatch(StepTestTable table,
java.lang.String textValue,
java.lang.String caseSensitive)
Verifies a particular list-item substring does NOT exists in the list (somewhere)
Verifies a particular list-item substring does NOT exists in the list (somewhere).
|
ComponentFunction |
verifyListDoesNotContainPartialMatch(java.lang.String[] parameters)
Verifies a particular list-item substring does NOT exists in the list (somewhere)
Verifies a particular list-item substring does NOT exists in the list (somewhere).
|
ComponentFunction |
verifyListDoesNotContainPartialMatch(java.lang.String textValue,
java.lang.String caseSensitive)
Verifies a particular list-item substring does NOT exists in the list (somewhere)
Verifies a particular list-item substring does NOT exists in the list (somewhere).
|
void |
verifyMenuItem(StepTestTable table,
java.lang.String textValue)
Verifies a particular case-sensitive menu-item exists
in the list (somewhere)
Verifies a particular case-sensitive menu-item exists
in the list (somewhere)
|
ComponentFunction |
verifyMenuItem(java.lang.String textValue)
Verifies a particular case-sensitive menu-item exists
in the list (somewhere)
Verifies a particular case-sensitive menu-item exists
in the list (somewhere)
|
void |
verifyMenuPartialMatch(StepTestTable table,
java.lang.String textValue)
Verifies a particular case-insensitive menu-item
substring exists in the list (somewhere)
Verifies a particular case-insensitive menu-item
substring exists in the list (somewhere)
|
ComponentFunction |
verifyMenuPartialMatch(java.lang.String textValue)
Verifies a particular case-insensitive menu-item
substring exists in the list (somewhere)
Verifies a particular case-insensitive menu-item
substring exists in the list (somewhere)
|
void |
verifyPartialMatch(StepTestTable table,
java.lang.String[] parameters)
Verifies a particular case-insensitive item based on
index is has as substring a particular value.
|
void |
verifyPartialMatch(StepTestTable table,
java.lang.String index,
java.lang.String textValue)
Verifies a particular case-insensitive item based on
index is has as substring a particular value.
|
ComponentFunction |
verifyPartialMatch(java.lang.String[] parameters)
Verifies a particular case-insensitive item based on
index is has as substring a particular value.
|
ComponentFunction |
verifyPartialMatch(java.lang.String index,
java.lang.String textValue)
Verifies a particular case-insensitive item based on
index is has as substring a particular value.
|
void |
verifySelectedItem(StepTestTable table,
java.lang.String textValue)
Verifies a particular case-sensitive text item is selected
Verifies a particular case-sensitive text item is selected
|
ComponentFunction |
verifySelectedItem(java.lang.String textValue)
Verifies a particular case-sensitive text item is selected
Verifies a particular case-sensitive text item is selected
|
void |
verifySelectedPartialMatch(StepTestTable table,
java.lang.String textValue)
Verifies a particular case-sensitive item is selected
based on a substring match.
|
ComponentFunction |
verifySelectedPartialMatch(java.lang.String textValue)
Verifies a particular case-sensitive item is selected
based on a substring match.
|
altLeftDrag, altLeftDrag, click, click, click, click, clickScreenImage, clickScreenImage, clickScreenLocation, clickScreenLocation, clickScreenPoint, clickScreenPoint, compareStoredData, compareStoredData, compareStoredData, compareStoredData, compareStoredProperties, compareStoredProperties, compareStoredProperties, compareStoredProperties, ctrlAltLeftDrag, ctrlAltLeftDrag, ctrlClick, ctrlClick, ctrlClick, ctrlClick, ctrlClickScreenImage, ctrlClickScreenImage, ctrlLeftDrag, ctrlLeftDrag, ctrlRightClick, ctrlRightClick, ctrlRightClick, ctrlRightClick, ctrlRightClickScreenImage, ctrlRightClickScreenImage, ctrlShiftLeftDrag, ctrlShiftLeftDrag, doubleClick, doubleClick, doubleClick, doubleClick, doubleClickScreenImage, doubleClickScreenImage, doubleClickScreenLocation, doubleClickScreenLocation, doubleClickScreenPoint, doubleClickScreenPoint, doubleTap, doubleTap, dragTo, dragTo, dragTo, dragTo, flick, flick, flick, flick, flickDown, flickDown, flickLeft, flickLeft, flickRight, flickRight, flickUp, flickUp, hScrollTo, hScrollTo, javaMenuSelect, javaMenuSelect, leftDrag, leftDrag, mouseClick, mouseClick, multiClick, multiClick, multiClick, multiClick, multiClickScreenImage, multiClickScreenImage, multiClickScreenImage, multiClickScreenImage, press, press, rightClick, rightClick, rightClick, rightClick, rightClickScreenImage, rightClickScreenImage, rightClickScreenLocation, rightClickScreenLocation, rightClickScreenPoint, rightClickScreenPoint, rightDrag, rightDrag, shiftClick, shiftClick, shiftClick, shiftClick, shiftClickScreenImage, shiftClickScreenImage, shiftLeftDrag, shiftLeftDrag, tap, tap, twoFingerTap, twoFingerTap, verifyImage, verifyImage, vScrollTo, vScrollTo
assignPropertyVariable, assignPropertyVariable, assignPropertyVariable, assignPropertyVariable, captureObjectDataToFile, captureObjectDataToFile, captureObjectDataToFile, captureObjectDataToFile, capturePropertiesToFile, capturePropertiesToFile, capturePropertiesToFile, capturePropertiesToFile, capturePropertyToFile, capturePropertyToFile, capturePropertyToFile, capturePropertyToFile, clearAppMapCache, clearAppMapCache, clearCache, clearCache, executeScript, executeScript, executeScript, executeScript, getComputedStyle, getComputedStyle, getGUIImage, getGUIImage, getGUIImage, getGUIImage, getTextFromGUI, getTextFromGUI, getTextFromGUI, getTextFromGUI, gUIDoesExist, gUIDoesExist, gUIDoesNotExist, gUIDoesNotExist, hoverMouse, hoverMouse, hoverMouse, hoverMouse, hoverScreenLocation, hoverScreenLocation, hoverScreenLocation, hoverScreenLocation, inputCharacters, inputCharacters, inputKeys, inputKeys, isPropertyExist, isPropertyExist, isPropertyExist, isPropertyExist, locateScreenImage, locateScreenImage, locateScreenImage, locateScreenImage, saveTextFromGUI, saveTextFromGUI, saveTextFromGUI, saveTextFromGUI, sendEvent, sendEvent, sendEvent, sendEvent, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, showOnPage, showOnPage, typeChars, typeChars, typeEncryption, typeEncryption, typeEncryption, typeEncryption, typeKeys, typeKeys, verifyArrayPropertyToFile, verifyArrayPropertyToFile, verifyArrayPropertyToFile, verifyArrayPropertyToFile, verifyBinaryFileToFile, verifyBinaryFileToFile, verifyBinaryFileToFile, verifyBinaryFileToFile, verifyClipboardToFile, verifyClipboardToFile, verifyClipboardToFile, verifyClipboardToFile, verifyClipboardVP, verifyClipboardVP, verifyComputedStyle, verifyComputedStyle, verifyFileToFile, verifyFileToFile, verifyFileToFile, verifyFileToFile, verifyGUIImageToFile, verifyGUIImageToFile, verifyGUIImageToFile, verifyGUIImageToFile, verifyObjectDataToFile, verifyObjectDataToFile, verifyObjectDataToFile, verifyObjectDataToFile, verifyPropertiesSubsetToFile, verifyPropertiesSubsetToFile, verifyPropertiesSubsetToFile, verifyPropertiesSubsetToFile, verifyPropertiesToFile, verifyPropertiesToFile, verifyPropertiesToFile, verifyPropertiesToFile, verifyProperty, verifyProperty, verifyProperty, verifyProperty, verifyPropertyContains, verifyPropertyContains, verifyPropertyContains, verifyPropertyContains, verifyPropertyToFile, verifyPropertyToFile, verifyPropertyToFile, verifyPropertyToFile, verifyTabOrder, verifyTabOrder, verifyTextFileToFile, verifyTextFileToFile, verifyTextFileToFile, verifyTextFileToFile, verifyValueContains, verifyValueContains, verifyValueContains, verifyValueContains, verifyValueContainsIgnoreCase, verifyValueContainsIgnoreCase, verifyValueContainsIgnoreCase, verifyValueContainsIgnoreCase, verifyValueDoesNotContain, verifyValueDoesNotContain, verifyValueDoesNotContain, verifyValueDoesNotContain, verifyValues, verifyValues, verifyValues, verifyValues, verifyValuesIgnoreCase, verifyValuesIgnoreCase, verifyValuesIgnoreCase, verifyValuesIgnoreCase, verifyValuesNotEqual, verifyValuesNotEqual, verifyValuesNotEqual, verifyValuesNotEqual
getWindow, setWindow
getName, getParent, getParentName, quote
public ListBox(Window window, java.lang.String compname)
window
- Optional:NO
Specifies which Window this component is 'in'.compname
- Optional:NO
Specifies the AppMap name of the component in the Window.public ListBox(java.lang.String winname, java.lang.String compname)
winname
- Optional:NO
Specifies the AppMap name of the window.compname
- Optional:NO
Specifies the AppMap name of the component in the Window.protected ListBox(java.lang.String compname)
public ComponentFunction activatePartialMatch(java.lang.String textValue)
Routine to DblClick and Verify an item according to a partial text match. Routine to DblClick and Verify an item according to a partial text match.Supporting Engines:
textValue
- Optional:NO
Case-sensitive substring of node to DblClick and verify.public void activatePartialMatch(StepTestTable table, java.lang.String textValue)
Routine to DblClick and Verify an item according to a partial text match. Routine to DblClick and Verify an item according to a partial text match.Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-sensitive substring of node to DblClick and verify.public ComponentFunction activateTextItem(java.lang.String textValue)
Routine to DblClick and Verify an item according to its text value. Routine to DblClick and Verify an item according to its text value.Supporting Engines:
textValue
- Optional:NO
Case-sensitive text of node to DblClick and verify.public void activateTextItem(StepTestTable table, java.lang.String textValue)
Routine to DblClick and Verify an item according to its text value. Routine to DblClick and Verify an item according to its text value.Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-sensitive text of node to DblClick and verify.public ComponentFunction activateUnverifiedPartialMatch(java.lang.String textValue)
DblClicks an item according to a partial text match. DblClicks an item according to a partial text match. The item is activated but no check is performed after the selection to verify the selection was successful.Supporting Engines:
textValue
- Optional:NO
Case-sensitive substring of node to DblClick.public void activateUnverifiedPartialMatch(StepTestTable table, java.lang.String textValue)
DblClicks an item according to a partial text match. DblClicks an item according to a partial text match. The item is activated but no check is performed after the selection to verify the selection was successful.Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-sensitive substring of node to DblClick.public ComponentFunction activateUnverifiedTextItem(java.lang.String textValue)
Routine to DblClick an item according to its text value. Routine to DblClick an item according to its text value. No check is performed after the selection to verify success. This is typically done for cases when the listbox is only temporary in nature and disappears immediately upon a selection.Supporting Engines:
textValue
- Optional:NO
Case-sensitive text of node to DblClick.public void activateUnverifiedTextItem(StepTestTable table, java.lang.String textValue)
Routine to DblClick an item according to its text value. Routine to DblClick an item according to its text value. No check is performed after the selection to verify success. This is typically done for cases when the listbox is only temporary in nature and disappears immediately upon a selection.Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-sensitive text of node to DblClick.public ComponentFunction captureItemsToFile(java.lang.String fileName, java.lang.String fileEncoding)
Capture Items To a File specified (if not abs, then to test dir) Capture Items To a File specified (if not abs, then to test dir)Supporting Engines:
fileName
- Optional:NO
File name (if not absolute, then to test dir)fileEncoding
- Optional:YES DefaultVal:
Specify a character encoding to be used when saving data to a file.
If it is not specified, the system default file encoding will be used.
The encoding should be a valid string supported by Java; if it is not valid,
the system default file encoding will be used instead.public void captureItemsToFile(StepTestTable table, java.lang.String fileName, java.lang.String fileEncoding)
Capture Items To a File specified (if not abs, then to test dir) Capture Items To a File specified (if not abs, then to test dir)Supporting Engines:
table
- Optional:NO
The table to add the record to.fileName
- Optional:NO
File name (if not absolute, then to test dir)fileEncoding
- Optional:YES DefaultVal:
Specify a character encoding to be used when saving data to a file.
If it is not specified, the system default file encoding will be used.
The encoding should be a valid string supported by Java; if it is not valid,
the system default file encoding will be used instead.public ComponentFunction captureItemsToFile(java.lang.String[] parameters)
Capture Items To a File specified (if not abs, then to test dir) Capture Items To a File specified (if not abs, then to test dir)Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void captureItemsToFile(StepTestTable table, java.lang.String[] parameters)
Capture Items To a File specified (if not abs, then to test dir) Capture Items To a File specified (if not abs, then to test dir)Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction clickColumnIndex(java.lang.String index)
Click a column header based on it's index of list, starting from 1 Click a column header based on it's index of list, starting from 1Supporting Engines:
index
- Optional:NO
Index of the column header to click, starting from 1public void clickColumnIndex(StepTestTable table, java.lang.String index)
Click a column header based on it's index of list, starting from 1 Click a column header based on it's index of list, starting from 1Supporting Engines:
table
- Optional:NO
The table to add the record to.index
- Optional:NO
Index of the column header to click, starting from 1public ComponentFunction clickColumnLabel(java.lang.String label)
Click a column header based on it's label Click a column header based on it's labelSupporting Engines:
label
- Optional:NO
Label of the column header to clickpublic void clickColumnLabel(StepTestTable table, java.lang.String label)
Click a column header based on it's label Click a column header based on it's labelSupporting Engines:
table
- Optional:NO
The table to add the record to.label
- Optional:NO
Label of the column header to clickpublic ComponentFunction clickTextItem(java.lang.String textValue)
Routine to Click a selection according to its text value. Note: This keyword triggers the click event Routine to Click a selection according to its text value. NOTE: Only ClickTextItem keyword triggers the click event. SelectTextItem keyword fails to trigger click event on some instances.Supporting Engines:
textValue
- Optional:NO
Case-sensitive text of node to select.public void clickTextItem(StepTestTable table, java.lang.String textValue)
Routine to Click a selection according to its text value. Note: This keyword triggers the click event Routine to Click a selection according to its text value. NOTE: Only ClickTextItem keyword triggers the click event. SelectTextItem keyword fails to trigger click event on some instances.Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-sensitive text of node to select.public ComponentFunction extendSelectionToTextItem(java.lang.String textValue)
Routine to Shift+Click and Verify a selection according to its text value. This extends the current selection to include the specified selection and all other items inbetween. NOTE: This may not work in all environments (Java, Web, etc...) For example, in Java, we can usually verify that an item exists in the list; but we do not seem to be able to verify if a newly added selection to multiple selections is actually selected. So, for Java, we will verify existence in the list, but we cannot verify the selection was successful--we will skip that last check.Supporting Engines:
textValue
- Optional:NO
Case-sensitive text of node to select and verify.public void extendSelectionToTextItem(StepTestTable table, java.lang.String textValue)
Routine to Shift+Click and Verify a selection according to its text value. This extends the current selection to include the specified selection and all other items inbetween. NOTE: This may not work in all environments (Java, Web, etc...) For example, in Java, we can usually verify that an item exists in the list; but we do not seem to be able to verify if a newly added selection to multiple selections is actually selected. So, for Java, we will verify existence in the list, but we cannot verify the selection was successful--we will skip that last check.Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-sensitive text of node to select and verify.public ComponentFunction rightClickTextItem(java.lang.String textValue)
Routine to Right-Click a selection according to its text value. Note: This keyword triggers the right-click event. Routine to Right-Click a selection according to its text value.Supporting Engines:
textValue
- Optional:NO
Case-sensitive text of node to right-click on.public void rightClickTextItem(StepTestTable table, java.lang.String textValue)
Routine to Right-Click a selection according to its text value. Note: This keyword triggers the right-click event. Routine to Right-Click a selection according to its text value.Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-sensitive text of node to right-click on.public ComponentFunction selectAnotherTextItem(java.lang.String textValue)
Routine to Control+Click and Verify a selection according to its text value. This adds selected items to items already selected. NOTE: This may not work in all environments (Java, Web, etc...) For example, in Java, we can usually verify that an item exists in the list; but we do not seem to be able to verify if a newly added selection to multiple selections is actually selected. So, for Java, we will verify existence in the list, but we cannot verify the selection was successful--we will skip that last check.Supporting Engines:
textValue
- Optional:NO
Case-sensitive text of node to select and verify.public void selectAnotherTextItem(StepTestTable table, java.lang.String textValue)
Routine to Control+Click and Verify a selection according to its text value. This adds selected items to items already selected. NOTE: This may not work in all environments (Java, Web, etc...) For example, in Java, we can usually verify that an item exists in the list; but we do not seem to be able to verify if a newly added selection to multiple selections is actually selected. So, for Java, we will verify existence in the list, but we cannot verify the selection was successful--we will skip that last check.Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-sensitive text of node to select and verify.public ComponentFunction selectAnotherUnverifiedTextItem(java.lang.String textValue)
Routine to Control+Click an item according to its text value. No post-select verification of the selection is performed. Routine to Control+Click an item according to its text value. No post-select verification of the selection is performed. This selection is added to any items already selected. NOTE: This may not work in all environments (Java, Web, etc...)Supporting Engines:
textValue
- Optional:NO
Case-sensitive text of node to select.public void selectAnotherUnverifiedTextItem(StepTestTable table, java.lang.String textValue)
Routine to Control+Click an item according to its text value. No post-select verification of the selection is performed. Routine to Control+Click an item according to its text value. No post-select verification of the selection is performed. This selection is added to any items already selected. NOTE: This may not work in all environments (Java, Web, etc...)Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-sensitive text of node to select.public ComponentFunction selectIndex(java.lang.String index)
Select an item based on it's index in the list, starting from 1 Select an item based on it's index in the list, starting from 1Supporting Engines:
index
- Optional:NO
Index of the text item to select, starting from 1public void selectIndex(StepTestTable table, java.lang.String index)
Select an item based on it's index in the list, starting from 1 Select an item based on it's index in the list, starting from 1Supporting Engines:
table
- Optional:NO
The table to add the record to.index
- Optional:NO
Index of the text item to select, starting from 1public ComponentFunction selectPartialMatch(java.lang.String textValue)
Routine to Click and Verify an item according to a partial text match. Routine to Click and Verify an item according to a partial text match. Note: for RobotJ, same as SelectUnverifiedPartialMatchSupporting Engines:
textValue
- Optional:NO
Case-sensitive substring of node to select and verify.public void selectPartialMatch(StepTestTable table, java.lang.String textValue)
Routine to Click and Verify an item according to a partial text match. Routine to Click and Verify an item according to a partial text match. Note: for RobotJ, same as SelectUnverifiedPartialMatchSupporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-sensitive substring of node to select and verify.public ComponentFunction selectTextItem(java.lang.String textValue)
Routine to Click and Verify a selection according to its text value. Routine to Click and Verify a selection according to its text value. Note: RobotJ also uses the identical keyword 'Select' Note: For RobotJ, there is no additional verify step in the framework code, in other words, for RobotJ, the SelectTextItem and SelectUnverifiedTextItem keywords are identical because RobotJ does all of the verification internally and there is no control over that in it's api.Supporting Engines:
textValue
- Optional:NO
Case-sensitive text of node to select and verify.public void selectTextItem(StepTestTable table, java.lang.String textValue)
Routine to Click and Verify a selection according to its text value. Routine to Click and Verify a selection according to its text value. Note: RobotJ also uses the identical keyword 'Select' Note: For RobotJ, there is no additional verify step in the framework code, in other words, for RobotJ, the SelectTextItem and SelectUnverifiedTextItem keywords are identical because RobotJ does all of the verification internally and there is no control over that in it's api.Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-sensitive text of node to select and verify.public ComponentFunction selectUnverifiedAnotherTextItem(java.lang.String textValue)
Use the identical "SelectAnotherUnverifiedTextItem" instead. Routine to Control+Click an item according to its text value. No post-select verification of the selection is performed. This selection is added to any items already selected. NOTE: This may not work in all environments (Java, Web, etc...)Supporting Engines:
textValue
- Optional:NO
Case-sensitive text of node to select.public void selectUnverifiedAnotherTextItem(StepTestTable table, java.lang.String textValue)
Use the identical "SelectAnotherUnverifiedTextItem" instead. Routine to Control+Click an item according to its text value. No post-select verification of the selection is performed. This selection is added to any items already selected. NOTE: This may not work in all environments (Java, Web, etc...)Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-sensitive text of node to select.public ComponentFunction selectUnverifiedPartialMatch(java.lang.String textValue)
Routine to Click an item according to a partial text match. Routine to Click an item according to a partial text match. No check is performed after the selection to verify success. This is typically done for cases when the listbox is only temporary in nature and disappears immediately upon a selection. Note: for RobotJ, same as SelectPartialMatchSupporting Engines:
textValue
- Optional:NO
Case-sensitive substring of node to select.public void selectUnverifiedPartialMatch(StepTestTable table, java.lang.String textValue)
Routine to Click an item according to a partial text match. Routine to Click an item according to a partial text match. No check is performed after the selection to verify success. This is typically done for cases when the listbox is only temporary in nature and disappears immediately upon a selection. Note: for RobotJ, same as SelectPartialMatchSupporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-sensitive substring of node to select.public ComponentFunction selectUnverifiedTextItem(java.lang.String textValue)
Routine to Click a selection according to its text value. Routine to Click a selection according to its text value. No check is performed after the selection to verify success. This is typically done for cases when the listbox is only temporary in nature and disappears immediately upon a selection. Note: RobotJ also uses the identical keyword 'SelectUnverified' Note: This is the default for RobotJ, in other words, for RobotJ, the SelectTextItem and SelectUnverifiedTextItem keywords are identical because RobotJ does all of the verification internally and there is no control over that in it's api.Supporting Engines:
textValue
- Optional:NO
Case-sensitive text of node to select.public void selectUnverifiedTextItem(StepTestTable table, java.lang.String textValue)
Routine to Click a selection according to its text value. Routine to Click a selection according to its text value. No check is performed after the selection to verify success. This is typically done for cases when the listbox is only temporary in nature and disappears immediately upon a selection. Note: RobotJ also uses the identical keyword 'SelectUnverified' Note: This is the default for RobotJ, in other words, for RobotJ, the SelectTextItem and SelectUnverifiedTextItem keywords are identical because RobotJ does all of the verification internally and there is no control over that in it's api.Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-sensitive text of node to select.public ComponentFunction setListContains(java.lang.String itemText, java.lang.String resultVar)
Set a variable with the result of checking that a listview contains the provided item. The search of the item is expected to be a case-sensitive exact match of the item. The provided variable is set with 'TRUE' if the item is found or 'FALSE' if the item is not found.Supporting Engines:
itemText
- Optional:NO
The case-sensitive name of the sought item.resultVar
- Optional:NO
The name of the variable receiving the result.public void setListContains(StepTestTable table, java.lang.String itemText, java.lang.String resultVar)
Set a variable with the result of checking that a listview contains the provided item. The search of the item is expected to be a case-sensitive exact match of the item. The provided variable is set with 'TRUE' if the item is found or 'FALSE' if the item is not found.Supporting Engines:
table
- Optional:NO
The table to add the record to.itemText
- Optional:NO
The case-sensitive name of the sought item.resultVar
- Optional:NO
The name of the variable receiving the result.public ComponentFunction setListContains(java.lang.String[] parameters)
Set a variable with the result of checking that a listview contains the provided item. The search of the item is expected to be a case-sensitive exact match of the item. The provided variable is set with 'TRUE' if the item is found or 'FALSE' if the item is not found.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void setListContains(StepTestTable table, java.lang.String[] parameters)
Set a variable with the result of checking that a listview contains the provided item. The search of the item is expected to be a case-sensitive exact match of the item. The provided variable is set with 'TRUE' if the item is found or 'FALSE' if the item is not found.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction verifyItem(java.lang.String index, java.lang.String textValue)
Verifies a particular case-sensitive item based on index is equal to a particular value. Verifies a particular case-sensitive item based on index is equal to a particular value.Supporting Engines:
index
- Optional:NO
Index of the item in the list starting from 1textValue
- Optional:NO
Case-sensitive string to compare to the text of the node at the index.public void verifyItem(StepTestTable table, java.lang.String index, java.lang.String textValue)
Verifies a particular case-sensitive item based on index is equal to a particular value. Verifies a particular case-sensitive item based on index is equal to a particular value.Supporting Engines:
table
- Optional:NO
The table to add the record to.index
- Optional:NO
Index of the item in the list starting from 1textValue
- Optional:NO
Case-sensitive string to compare to the text of the node at the index.public ComponentFunction verifyItem(java.lang.String[] parameters)
Verifies a particular case-sensitive item based on index is equal to a particular value. Verifies a particular case-sensitive item based on index is equal to a particular value.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void verifyItem(StepTestTable table, java.lang.String[] parameters)
Verifies a particular case-sensitive item based on index is equal to a particular value. Verifies a particular case-sensitive item based on index is equal to a particular value.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction verifyItemUnselected(java.lang.String textValue)
Verifies a particular case-sensitive text item is NOT selected. Verifies a particular case-sensitive text item is NOT selected.Supporting Engines:
textValue
- Optional:NO
Case-sensitive text of node that will be verified as unselectedpublic void verifyItemUnselected(StepTestTable table, java.lang.String textValue)
Verifies a particular case-sensitive text item is NOT selected. Verifies a particular case-sensitive text item is NOT selected.Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-sensitive text of node that will be verified as unselectedpublic ComponentFunction verifyListContains(java.lang.String textValue, java.lang.String caseSensitive)
Verifies a particular list-item exists in the list (somewhere) Verifies a particular list-item exists in the list (somewhere). The comparison can be case-sensitive. By default, it is not.Supporting Engines:
textValue
- Optional:NO
String to look for in the list.caseSensitive
- Optional:YES
Optional "True" for case-sensitive searchpublic void verifyListContains(StepTestTable table, java.lang.String textValue, java.lang.String caseSensitive)
Verifies a particular list-item exists in the list (somewhere) Verifies a particular list-item exists in the list (somewhere). The comparison can be case-sensitive. By default, it is not.Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
String to look for in the list.caseSensitive
- Optional:YES
Optional "True" for case-sensitive searchpublic ComponentFunction verifyListContains(java.lang.String[] parameters)
Verifies a particular list-item exists in the list (somewhere) Verifies a particular list-item exists in the list (somewhere). The comparison can be case-sensitive. By default, it is not.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void verifyListContains(StepTestTable table, java.lang.String[] parameters)
Verifies a particular list-item exists in the list (somewhere) Verifies a particular list-item exists in the list (somewhere). The comparison can be case-sensitive. By default, it is not.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction verifyListContainsPartialMatch(java.lang.String textValue, java.lang.String caseSensitive)
Verifies a particular list-item substring exists in the list (somewhere) Verifies a particular list-item substring exists in the list (somewhere). The comparison can be case-sensitive. By default, it is not.Supporting Engines:
textValue
- Optional:NO
SubString to look for in the list.caseSensitive
- Optional:YES
Optional "True" for case-sensitive searchpublic void verifyListContainsPartialMatch(StepTestTable table, java.lang.String textValue, java.lang.String caseSensitive)
Verifies a particular list-item substring exists in the list (somewhere) Verifies a particular list-item substring exists in the list (somewhere). The comparison can be case-sensitive. By default, it is not.Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
SubString to look for in the list.caseSensitive
- Optional:YES
Optional "True" for case-sensitive searchpublic ComponentFunction verifyListContainsPartialMatch(java.lang.String[] parameters)
Verifies a particular list-item substring exists in the list (somewhere) Verifies a particular list-item substring exists in the list (somewhere). The comparison can be case-sensitive. By default, it is not.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void verifyListContainsPartialMatch(StepTestTable table, java.lang.String[] parameters)
Verifies a particular list-item substring exists in the list (somewhere) Verifies a particular list-item substring exists in the list (somewhere). The comparison can be case-sensitive. By default, it is not.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction verifyListDoesNotContain(java.lang.String textValue, java.lang.String caseSensitive)
Verifies a particular list-item does NOT exists in the list (somewhere) Verifies a particular list-item does NOT exists in the list (somewhere). The comparison can be case-sensitive. It is NOT case-sensitive by default.Supporting Engines:
textValue
- Optional:NO
String to look for in the list.caseSensitive
- Optional:YES
Optional "True" for case-sensitive searchpublic void verifyListDoesNotContain(StepTestTable table, java.lang.String textValue, java.lang.String caseSensitive)
Verifies a particular list-item does NOT exists in the list (somewhere) Verifies a particular list-item does NOT exists in the list (somewhere). The comparison can be case-sensitive. It is NOT case-sensitive by default.Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
String to look for in the list.caseSensitive
- Optional:YES
Optional "True" for case-sensitive searchpublic ComponentFunction verifyListDoesNotContain(java.lang.String[] parameters)
Verifies a particular list-item does NOT exists in the list (somewhere) Verifies a particular list-item does NOT exists in the list (somewhere). The comparison can be case-sensitive. It is NOT case-sensitive by default.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void verifyListDoesNotContain(StepTestTable table, java.lang.String[] parameters)
Verifies a particular list-item does NOT exists in the list (somewhere) Verifies a particular list-item does NOT exists in the list (somewhere). The comparison can be case-sensitive. It is NOT case-sensitive by default.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction verifyListDoesNotContainPartialMatch(java.lang.String textValue, java.lang.String caseSensitive)
Verifies a particular list-item substring does NOT exists in the list (somewhere) Verifies a particular list-item substring does NOT exists in the list (somewhere). The comparison can be case-sensitive. It is NOT case-sensitive by default.Supporting Engines:
textValue
- Optional:NO
SubString to look for in the list.caseSensitive
- Optional:YES
Optional "True" for case-sensitive searchpublic void verifyListDoesNotContainPartialMatch(StepTestTable table, java.lang.String textValue, java.lang.String caseSensitive)
Verifies a particular list-item substring does NOT exists in the list (somewhere) Verifies a particular list-item substring does NOT exists in the list (somewhere). The comparison can be case-sensitive. It is NOT case-sensitive by default.Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
SubString to look for in the list.caseSensitive
- Optional:YES
Optional "True" for case-sensitive searchpublic ComponentFunction verifyListDoesNotContainPartialMatch(java.lang.String[] parameters)
Verifies a particular list-item substring does NOT exists in the list (somewhere) Verifies a particular list-item substring does NOT exists in the list (somewhere). The comparison can be case-sensitive. It is NOT case-sensitive by default.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void verifyListDoesNotContainPartialMatch(StepTestTable table, java.lang.String[] parameters)
Verifies a particular list-item substring does NOT exists in the list (somewhere) Verifies a particular list-item substring does NOT exists in the list (somewhere). The comparison can be case-sensitive. It is NOT case-sensitive by default.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction verifyMenuItem(java.lang.String textValue)
Verifies a particular case-sensitive menu-item exists in the list (somewhere) Verifies a particular case-sensitive menu-item exists in the list (somewhere)Supporting Engines:
textValue
- Optional:NO
Case-sensitive string to compare to the text of any node in the list.public void verifyMenuItem(StepTestTable table, java.lang.String textValue)
Verifies a particular case-sensitive menu-item exists in the list (somewhere) Verifies a particular case-sensitive menu-item exists in the list (somewhere)Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-sensitive string to compare to the text of any node in the list.public ComponentFunction verifyMenuPartialMatch(java.lang.String textValue)
Verifies a particular case-insensitive menu-item substring exists in the list (somewhere) Verifies a particular case-insensitive menu-item substring exists in the list (somewhere)Supporting Engines:
textValue
- Optional:NO
Case-insensitive substring to compare to the text of any node in the list.public void verifyMenuPartialMatch(StepTestTable table, java.lang.String textValue)
Verifies a particular case-insensitive menu-item substring exists in the list (somewhere) Verifies a particular case-insensitive menu-item substring exists in the list (somewhere)Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-insensitive substring to compare to the text of any node in the list.public ComponentFunction verifyPartialMatch(java.lang.String index, java.lang.String textValue)
Verifies a particular case-insensitive item based on index is has as substring a particular value. Verifies a particular case-insensitive item based on index is has as substring a particular value.Supporting Engines:
index
- Optional:NO
Index of the item in the list starting from 1textValue
- Optional:NO
Case-insensitive substring to compare to the text of the node at the index.public void verifyPartialMatch(StepTestTable table, java.lang.String index, java.lang.String textValue)
Verifies a particular case-insensitive item based on index is has as substring a particular value. Verifies a particular case-insensitive item based on index is has as substring a particular value.Supporting Engines:
table
- Optional:NO
The table to add the record to.index
- Optional:NO
Index of the item in the list starting from 1textValue
- Optional:NO
Case-insensitive substring to compare to the text of the node at the index.public ComponentFunction verifyPartialMatch(java.lang.String[] parameters)
Verifies a particular case-insensitive item based on index is has as substring a particular value. Verifies a particular case-insensitive item based on index is has as substring a particular value.Supporting Engines:
parameters
- Optional:NO
An array containing the following parameters:
public void verifyPartialMatch(StepTestTable table, java.lang.String[] parameters)
Verifies a particular case-insensitive item based on index is has as substring a particular value. Verifies a particular case-insensitive item based on index is has as substring a particular value.Supporting Engines:
table
- Optional:NO
The table to add the record to.parameters
- Optional:NO
An array containing the following parameters:
public ComponentFunction verifySelectedItem(java.lang.String textValue)
Verifies a particular case-sensitive text item is selected Verifies a particular case-sensitive text item is selectedSupporting Engines:
textValue
- Optional:NO
Case-sensitive text of node that will be verified as selectedpublic void verifySelectedItem(StepTestTable table, java.lang.String textValue)
Verifies a particular case-sensitive text item is selected Verifies a particular case-sensitive text item is selectedSupporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-sensitive text of node that will be verified as selectedpublic ComponentFunction verifySelectedPartialMatch(java.lang.String textValue)
Verifies a particular case-sensitive item is selected based on a substring match. Verifies a particular case-sensitive item is selected based on a substring match.Supporting Engines:
textValue
- Optional:NO
Case-sensitive substring of node that will be verified selectedpublic void verifySelectedPartialMatch(StepTestTable table, java.lang.String textValue)
Verifies a particular case-sensitive item is selected based on a substring match. Verifies a particular case-sensitive item is selected based on a substring match.Supporting Engines:
table
- Optional:NO
The table to add the record to.textValue
- Optional:NO
Case-sensitive substring of node that will be verified selectedCopyright © SAS Institute. All Rights Reserved.