ListView (SAFS API DOCUMENT)

java.lang.Object
- org.safs.model.Component
- - org.safs.model.components.UIComponent
  - - org.safs.model.components.GenericMaster
    - - org.safs.model.components.GenericObject
      - org.safs.model.components.ListView

public class ListView
extends GenericObject

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ListView(java.lang.String compname)`
	`ListView(java.lang.String winname, java.lang.String compname)` Constructor Create an instance of pseudo-component representing a specific component in a specific window.
	`ListView(Window window, java.lang.String compname)` Constructor Create an instance of pseudo-component representing a specific component in a specific window.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activateIndex(StepTestTable table, java.lang.String index)` Activate (double-click) an item based on it's index in the list It is important to note that some ListViews index their values differently.
`ComponentFunction`	`activateIndex(java.lang.String index)` Activate (double-click) an item based on it's index in the list It is important to note that some ListViews index their values differently.
`void`	`activateIndexItem(StepTestTable table, java.lang.String indexValue)` Routine to double click an item according to its index in the list.
`ComponentFunction`	`activateIndexItem(java.lang.String indexValue)` Routine to double click an item according to its index in the list.
`void`	`activatePartialMatch(StepTestTable table, java.lang.String[] parameters)` Routine to double click an item according to a partial text match.
`void`	`activatePartialMatch(StepTestTable table, java.lang.String partialTextValue, java.lang.String matchIndex)` Routine to double click an item according to a partial text match.
`ComponentFunction`	`activatePartialMatch(java.lang.String[] parameters)` Routine to double click an item according to a partial text match.
`ComponentFunction`	`activatePartialMatch(java.lang.String partialTextValue, java.lang.String matchIndex)` Routine to double click an item according to a partial text match.
`void`	`activateTextItem(StepTestTable table, java.lang.String[] parameters)` Routine to double click an item according to its text value.
`void`	`activateTextItem(StepTestTable table, java.lang.String selectTextValue, java.lang.String matchIndex)` Routine to double click an item according to its text value.
`ComponentFunction`	`activateTextItem(java.lang.String[] parameters)` Routine to double click an item according to its text value.
`ComponentFunction`	`activateTextItem(java.lang.String selectTextValue, java.lang.String matchIndex)` Routine to double click an item according to its text value.
`void`	`activateTextItemCoords(StepTestTable table, java.lang.String[] parameters)` Double click a text item at specific Coords.
`void`	`activateTextItemCoords(StepTestTable table, java.lang.String selectTextValue, java.lang.String coords, java.lang.String matchIndex)` Double click a text item at specific Coords.
`ComponentFunction`	`activateTextItemCoords(java.lang.String[] parameters)` Double click a text item at specific Coords.
`ComponentFunction`	`activateTextItemCoords(java.lang.String selectTextValue, java.lang.String coords, java.lang.String matchIndex)` Double click a text item at specific Coords.
`void`	`activateUnverifiedTextItem(StepTestTable table, java.lang.String[] parameters)` Routine to double click an unverifiable item according to its text value.
`void`	`activateUnverifiedTextItem(StepTestTable table, java.lang.String selectTextValue, java.lang.String matchIndex)` Routine to double click an unverifiable item according to its text value.
`ComponentFunction`	`activateUnverifiedTextItem(java.lang.String[] parameters)` Routine to double click an unverifiable item according to its text value.
`ComponentFunction`	`activateUnverifiedTextItem(java.lang.String selectTextValue, java.lang.String matchIndex)` Routine to double click an unverifiable item according to its text value.
`void`	`activateUnverifiedTextItemCoords(StepTestTable table, java.lang.String[] parameters)` Double click an unverifiable text item at specific Coords.
`void`	`activateUnverifiedTextItemCoords(StepTestTable table, java.lang.String selectTextValue, java.lang.String coords, java.lang.String matchIndex)` Double click an unverifiable text item at specific Coords.
`ComponentFunction`	`activateUnverifiedTextItemCoords(java.lang.String[] parameters)` Double click an unverifiable text item at specific Coords.
`ComponentFunction`	`activateUnverifiedTextItemCoords(java.lang.String selectTextValue, java.lang.String coords, java.lang.String matchIndex)` Double click an unverifiable text item at specific Coords.
`void`	`assignCellValue(StepTestTable table, java.lang.String[] parameters)` Assigns the value of a cell in a listview to a variable.
`void`	`assignCellValue(StepTestTable table, java.lang.String variable, java.lang.String rowCoord, java.lang.String colCoord)` Assigns the value of a cell in a listview to a variable.
`ComponentFunction`	`assignCellValue(java.lang.String[] parameters)` Assigns the value of a cell in a listview to a variable.
`ComponentFunction`	`assignCellValue(java.lang.String variable, java.lang.String rowCoord, java.lang.String colCoord)` Assigns the value of a cell in a listview to a variable.
`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`	`clickIndex(StepTestTable table, java.lang.String index)` Same as (Alias for) ListView ActivateIndexItem
`ComponentFunction`	`clickIndex(java.lang.String index)` Same as (Alias for) ListView ActivateIndexItem
`void`	`clickIndexItem(StepTestTable table, java.lang.String index)` Same as (Alias for) ListView ActivateIndexItem
`ComponentFunction`	`clickIndexItem(java.lang.String index)` Same as (Alias for) ListView ActivateIndexItem
`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[] parameters)` Routine to RightClick (single click) an item according to its text value.
`void`	`rightClickTextItem(StepTestTable table, java.lang.String selectTextValue, java.lang.String matchIndex)` Routine to RightClick (single click) an item according to its text value.
`ComponentFunction`	`rightClickTextItem(java.lang.String[] parameters)` Routine to RightClick (single click) an item according to its text value.
`ComponentFunction`	`rightClickTextItem(java.lang.String selectTextValue, java.lang.String matchIndex)` Routine to RightClick (single click) an item according to its text value.
`void`	`rightClickTextItemCoords(StepTestTable table, java.lang.String[] parameters)` Right click a text item at specific Coords.
`void`	`rightClickTextItemCoords(StepTestTable table, java.lang.String selectTextValue, java.lang.String coords, java.lang.String matchIndex)` Right click a text item at specific Coords.
`ComponentFunction`	`rightClickTextItemCoords(java.lang.String[] parameters)` Right click a text item at specific Coords.
`ComponentFunction`	`rightClickTextItemCoords(java.lang.String selectTextValue, java.lang.String coords, java.lang.String matchIndex)` Right click a text item at specific Coords.
`void`	`rightClickUnverifiedTextItem(StepTestTable table, java.lang.String[] parameters)` Routine to RightClick (single click) an unverifiable item according to its text value.
`void`	`rightClickUnverifiedTextItem(StepTestTable table, java.lang.String selectTextValue, java.lang.String matchIndex)` Routine to RightClick (single click) an unverifiable item according to its text value.
`ComponentFunction`	`rightClickUnverifiedTextItem(java.lang.String[] parameters)` Routine to RightClick (single click) an unverifiable item according to its text value.
`ComponentFunction`	`rightClickUnverifiedTextItem(java.lang.String selectTextValue, java.lang.String matchIndex)` Routine to RightClick (single click) an unverifiable item according to its text value.
`void`	`rightClickUnverifiedTextItemCoords(StepTestTable table, java.lang.String[] parameters)` Right Click an unverifiable text item at specific Coords.
`void`	`rightClickUnverifiedTextItemCoords(StepTestTable table, java.lang.String selectTextValue, java.lang.String coords, java.lang.String matchIndex)` Right Click an unverifiable text item at specific Coords.
`ComponentFunction`	`rightClickUnverifiedTextItemCoords(java.lang.String[] parameters)` Right Click an unverifiable text item at specific Coords.
`ComponentFunction`	`rightClickUnverifiedTextItemCoords(java.lang.String selectTextValue, java.lang.String coords, java.lang.String matchIndex)` Right Click an unverifiable text item at specific Coords.
`void`	`selectAnotherPartialMatch(StepTestTable table, java.lang.String[] parameters)` Routine for multiple selection to Control+Click on an item according to a partial text match.
`void`	`selectAnotherPartialMatch(StepTestTable table, java.lang.String partialTextValue, java.lang.String matchIndex)` Routine for multiple selection to Control+Click on an item according to a partial text match.
`ComponentFunction`	`selectAnotherPartialMatch(java.lang.String[] parameters)` Routine for multiple selection to Control+Click on an item according to a partial text match.
`ComponentFunction`	`selectAnotherPartialMatch(java.lang.String partialTextValue, java.lang.String matchIndex)` Routine for multiple selection to Control+Click on an item according to a partial text match.
`void`	`selectAnotherTextItem(StepTestTable table, java.lang.String[] parameters)` Routine for multiple selection to Control+Click on an item by its text value.
`void`	`selectAnotherTextItem(StepTestTable table, java.lang.String textValue, java.lang.String matchIndex)` Routine for multiple selection to Control+Click on an item by its text value.
`ComponentFunction`	`selectAnotherTextItem(java.lang.String[] parameters)` Routine for multiple selection to Control+Click on an item by its text value.
`ComponentFunction`	`selectAnotherTextItem(java.lang.String textValue, java.lang.String matchIndex)` Routine for multiple selection to Control+Click on an item by its text value.
`void`	`selectIndex(StepTestTable table, java.lang.String index)` Same as (Alias for) ListView SelectIndexItem
`ComponentFunction`	`selectIndex(java.lang.String index)` Same as (Alias for) ListView SelectIndexItem
`void`	`selectIndexItem(StepTestTable table, java.lang.String itemIndex)` Routine to single click an item according to its Index value.
`ComponentFunction`	`selectIndexItem(java.lang.String itemIndex)` Routine to single click an item according to its Index value.
`void`	`selectIndexItemCoords(StepTestTable table, java.lang.String[] parameters)` Routine to single click an item by Index at specific coordinates.
`void`	`selectIndexItemCoords(StepTestTable table, java.lang.String itemIndex, java.lang.String coords)` Routine to single click an item by Index at specific coordinates.
`ComponentFunction`	`selectIndexItemCoords(java.lang.String[] parameters)` Routine to single click an item by Index at specific coordinates.
`ComponentFunction`	`selectIndexItemCoords(java.lang.String itemIndex, java.lang.String coords)` Routine to single click an item by Index at specific coordinates.
`void`	`selectPartialMatch(StepTestTable table, java.lang.String[] parameters)` Routine to select (single click) an item according to a partial text match.
`void`	`selectPartialMatch(StepTestTable table, java.lang.String partialTextValue, java.lang.String matchIndex)` Routine to select (single click) an item according to a partial text match.
`ComponentFunction`	`selectPartialMatch(java.lang.String[] parameters)` Routine to select (single click) an item according to a partial text match.
`ComponentFunction`	`selectPartialMatch(java.lang.String partialTextValue, java.lang.String matchIndex)` Routine to select (single click) an item according to a partial text match.
`void`	`selectRandomItems(StepTestTable table, java.lang.String itemCount)` Routine to randomly select multiple items in the ListView object.
`ComponentFunction`	`selectRandomItems(java.lang.String itemCount)` Routine to randomly select multiple items in the ListView object.
`void`	`selectTextItem(StepTestTable table, java.lang.String[] parameters)` Routine to select (single click) an item according to its text value.
`void`	`selectTextItem(StepTestTable table, java.lang.String selectTextValue, java.lang.String matchIndex)` Routine to select (single click) an item according to its text value.
`ComponentFunction`	`selectTextItem(java.lang.String[] parameters)` Routine to select (single click) an item according to its text value.
`ComponentFunction`	`selectTextItem(java.lang.String selectTextValue, java.lang.String matchIndex)` Routine to select (single click) an item according to its text value.
`void`	`selectTextItemCoords(StepTestTable table, java.lang.String[] parameters)` Single click a text item at specific Coords.
`void`	`selectTextItemCoords(StepTestTable table, java.lang.String selectTextValue, java.lang.String coords, java.lang.String matchIndex)` Single click a text item at specific Coords.
`ComponentFunction`	`selectTextItemCoords(java.lang.String[] parameters)` Single click a text item at specific Coords.
`ComponentFunction`	`selectTextItemCoords(java.lang.String selectTextValue, java.lang.String coords, java.lang.String matchIndex)` Single click a text item at specific Coords.
`void`	`selectUnverifiedTextItem(StepTestTable table, java.lang.String[] parameters)` Routine to select (single click) an unverifiable item according to its text value.
`void`	`selectUnverifiedTextItem(StepTestTable table, java.lang.String selectTextValue, java.lang.String matchIndex)` Routine to select (single click) an unverifiable item according to its text value.
`ComponentFunction`	`selectUnverifiedTextItem(java.lang.String[] parameters)` Routine to select (single click) an unverifiable item according to its text value.
`ComponentFunction`	`selectUnverifiedTextItem(java.lang.String selectTextValue, java.lang.String matchIndex)` Routine to select (single click) an unverifiable item according to its text value.
`void`	`selectUnverifiedTextItemCoords(StepTestTable table, java.lang.String[] parameters)` Single click an unverifiable text item at specific Coords.
`void`	`selectUnverifiedTextItemCoords(StepTestTable table, java.lang.String selectTextValue, java.lang.String coords, java.lang.String matchIndex)` Single click an unverifiable text item at specific Coords.
`ComponentFunction`	`selectUnverifiedTextItemCoords(java.lang.String[] parameters)` Single click an unverifiable text item at specific Coords.
`ComponentFunction`	`selectUnverifiedTextItemCoords(java.lang.String selectTextValue, java.lang.String coords, java.lang.String matchIndex)` Single click an unverifiable text item at specific Coords.
`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`	`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 itemText)` Verify that a list view contains the provided item.
`ComponentFunction`	`verifyListContains(java.lang.String itemText)` Verify that a list view contains the provided item.
`void`	`verifySelectedItem(StepTestTable table, java.lang.String textValue)` Verifies a particular case-sensitive text item is selected
`ComponentFunction`	`verifySelectedItem(java.lang.String textValue)` Verifies a particular case-sensitive text item is selected

Methods inherited from class org.safs.model.components.GenericObject
altClick, altClick, altClick, altClick, 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

Methods inherited from class org.safs.model.components.GenericMaster
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

Methods inherited from class org.safs.model.components.UIComponent
getWindow, setWindow

Methods inherited from class org.safs.model.Component
getName, getParent, getParentName, quote

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ListView
```
public ListView(Window window,
                java.lang.String compname)
```
  Constructor Create an instance of pseudo-component representing a specific component in a specific window.
  
  Parameters:
  
  window - Optional:NO Specifies which Window this component is 'in'.
  
  compname - Optional:NO Specifies the AppMap name of the component in the Window.
- ListView
```
public ListView(java.lang.String winname,
                java.lang.String compname)
```
  Constructor Create an instance of pseudo-component representing a specific component in a specific window. This convenience routine will create the requisite Window component.
  
  Parameters:
  
  winname - Optional:NO Specifies the AppMap name of the window.
  
  compname - Optional:NO Specifies the AppMap name of the component in the Window.
- ListView
```
protected ListView(java.lang.String compname)
```

Method Detail

activateIndex

public ComponentFunction activateIndex(java.lang.String index)

 
                Activate (double-click) an item based on it's index in the list
               
                It is important to note that some ListViews index their values
                differently.  For example, you may need to select an item by 
                text by using a property whose starting index is 1.  Yet, 
                if you request to seek an item strictly by index, the starting 
                index is 0.  So, the test developer may need to evaluate their 
                ListView object for these differences.

Supporting Engines:

Google Android
OpenQA Selenium

Parameters:: index - Optional:NO Index of the text item to select

activateIndex

public void activateIndex(StepTestTable table,
                          java.lang.String index)

 
                Activate (double-click) an item based on it's index in the list
               
                It is important to note that some ListViews index their values
                differently.  For example, you may need to select an item by 
                text by using a property whose starting index is 1.  Yet, 
                if you request to seek an item strictly by index, the starting 
                index is 0.  So, the test developer may need to evaluate their 
                ListView object for these differences.

Supporting Engines:

Google Android
OpenQA Selenium

Parameters:: table - Optional:NO The table to add the record to.; index - Optional:NO Index of the text item to select

activateIndexItem

public ComponentFunction activateIndexItem(java.lang.String indexValue)

 
                Routine to double click an item according to its index in the list.
               
                It is important to note that some ListViews index their values
                differently.  For example, you may need to select an item by 
                text by using a property whose starting index is 1.  Yet, 
                if you request to seek an item strictly by index, the starting 
                index is 0.  So, the test developer may need to evaluate their 
                ListView object for these differences.

Supporting Engines:

Google Android
OpenQA Selenium

Parameters:: indexValue - Optional:NO Index of item to activate.

activateIndexItem

public void activateIndexItem(StepTestTable table,
                              java.lang.String indexValue)

 
                Routine to double click an item according to its index in the list.
               
                It is important to note that some ListViews index their values
                differently.  For example, you may need to select an item by 
                text by using a property whose starting index is 1.  Yet, 
                if you request to seek an item strictly by index, the starting 
                index is 0.  So, the test developer may need to evaluate their 
                ListView object for these differences.

Supporting Engines:

Google Android
OpenQA Selenium

Parameters:: table - Optional:NO The table to add the record to.; indexValue - Optional:NO Index of item to activate.

activatePartialMatch

public ComponentFunction activatePartialMatch(java.lang.String partialTextValue,
                                              java.lang.String matchIndex)

 
                Routine to double click an item according to a partial text match.

Supporting Engines:

AutomatedQA TestComplete
Google Android
OpenQA Selenium

Parameters:: partialTextValue - Optional:NO Case-sensitive substring of text item to select; matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

activatePartialMatch
```
public void activatePartialMatch(StepTestTable table,
                                 java.lang.String partialTextValue,
                                 java.lang.String matchIndex)
```
```
 
                Routine to double click an item according to a partial text match.
                  
```
Supporting Engines:
- AutomatedQA TestComplete
- Google Android
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.

partialTextValue - Optional:NO Case-sensitive substring of text item to select

matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

activatePartialMatch
```
public ComponentFunction activatePartialMatch(java.lang.String[] parameters)
```
```
 
                Routine to double click an item according to a partial text match.
                  
```
Supporting Engines:
- AutomatedQA TestComplete
- Google Android
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

activatePartialMatch
```
public void activatePartialMatch(StepTestTable table,
                                 java.lang.String[] parameters)
```
```
 
                Routine to double click an item according to a partial text match.
                  
```
Supporting Engines:
- AutomatedQA TestComplete
- Google Android
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.
parameters - Optional:NO An array containing the following parameters:

activateTextItem
```
public ComponentFunction activateTextItem(java.lang.String selectTextValue,
                                          java.lang.String matchIndex)
```
```
 
                Routine to double click an item according to its text value.
                  
```
Supporting Engines:
- Rational Robot
- Mercury Interactive WinRunner
- AutomatedQA TestComplete
- Google Android
- OpenQA Selenium
Parameters:

selectTextValue - Optional:NO Case-sensitive text of node to select

matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

activateTextItem
```
public void activateTextItem(StepTestTable table,
                             java.lang.String selectTextValue,
                             java.lang.String matchIndex)
```
```
 
                Routine to double click an item according to its text value.
                  
```
Supporting Engines:
- Rational Robot
- Mercury Interactive WinRunner
- AutomatedQA TestComplete
- Google Android
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.

selectTextValue - Optional:NO Case-sensitive text of node to select

matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

activateTextItem
```
public ComponentFunction activateTextItem(java.lang.String[] parameters)
```
```
 
                Routine to double click an item according to its text value.
                  
```
Supporting Engines:
- Rational Robot
- Mercury Interactive WinRunner
- AutomatedQA TestComplete
- Google Android
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

activateTextItem
```
public void activateTextItem(StepTestTable table,
                             java.lang.String[] parameters)
```
```
 
                Routine to double click an item according to its text value.
                  
```
Supporting Engines:
- Rational Robot
- Mercury Interactive WinRunner
- AutomatedQA TestComplete
- Google Android
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.
parameters - Optional:NO An array containing the following parameters:

activateTextItemCoords
```
public ComponentFunction activateTextItemCoords(java.lang.String selectTextValue,
                                                java.lang.String coords,
                                                java.lang.String matchIndex)
```
```
 
                Double click a text item at specific Coords.
                  
```
Supporting Engines:
- Rational Robot
- OpenQA Selenium
Parameters:

selectTextValue - Optional:NO Case-sensitive text of node to select

coords - Optional:NO The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.

matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

activateTextItemCoords
```
public void activateTextItemCoords(StepTestTable table,
                                   java.lang.String selectTextValue,
                                   java.lang.String coords,
                                   java.lang.String matchIndex)
```
```
 
                Double click a text item at specific Coords.
                  
```
Supporting Engines:
- Rational Robot
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.

selectTextValue - Optional:NO Case-sensitive text of node to select

coords - Optional:NO The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.

matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

activateTextItemCoords
```
public ComponentFunction activateTextItemCoords(java.lang.String[] parameters)
```
```
 
                Double click a text item at specific Coords.
                  
```
Supporting Engines:
- Rational Robot
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

activateTextItemCoords
```
public void activateTextItemCoords(StepTestTable table,
                                   java.lang.String[] parameters)
```
```
 
                Double click a text item at specific Coords.
                  
```
Supporting Engines:
- Rational Robot
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.
parameters - Optional:NO An array containing the following parameters:

activateUnverifiedTextItem

public ComponentFunction activateUnverifiedTextItem(java.lang.String selectTextValue,
                                                    java.lang.String matchIndex)

 
                Routine to double click an unverifiable item according to its text value.
              
                An unverifiable item is one whose READ value is not the same as its SET value.

Supporting Engines:

Rational Robot
AutomatedQA TestComplete
Google Android
OpenQA Selenium

Parameters:: selectTextValue - Optional:NO Case-sensitive text of node to select; matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

activateUnverifiedTextItem

public void activateUnverifiedTextItem(StepTestTable table,
                                       java.lang.String selectTextValue,
                                       java.lang.String matchIndex)

 
                Routine to double click an unverifiable item according to its text value.
              
                An unverifiable item is one whose READ value is not the same as its SET value.

Supporting Engines:

Rational Robot
AutomatedQA TestComplete
Google Android
OpenQA Selenium

Parameters:: table - Optional:NO The table to add the record to.; selectTextValue - Optional:NO Case-sensitive text of node to select; matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

activateUnverifiedTextItem
```
public ComponentFunction activateUnverifiedTextItem(java.lang.String[] parameters)
```
```
 
                Routine to double click an unverifiable item according to its text value.
              
                An unverifiable item is one whose READ value is not the same as its SET value.
                  
```
Supporting Engines:
- Rational Robot
- AutomatedQA TestComplete
- Google Android
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

activateUnverifiedTextItem
```
public void activateUnverifiedTextItem(StepTestTable table,
                                       java.lang.String[] parameters)
```
```
 
                Routine to double click an unverifiable item according to its text value.
              
                An unverifiable item is one whose READ value is not the same as its SET value.
                  
```
Supporting Engines:
- Rational Robot
- AutomatedQA TestComplete
- Google Android
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.
parameters - Optional:NO An array containing the following parameters:

activateUnverifiedTextItemCoords

public ComponentFunction activateUnverifiedTextItemCoords(java.lang.String selectTextValue,
                                                          java.lang.String coords,
                                                          java.lang.String matchIndex)

 
                Double click an unverifiable text item at specific Coords.
              
                An unverifiable item is one whose READ value is not the same as its SET value.

Supporting Engines:

Rational Robot
OpenQA Selenium

Parameters:: selectTextValue - Optional:NO Case-sensitive text of node to select; coords - Optional:NO The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.; matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

activateUnverifiedTextItemCoords

public void activateUnverifiedTextItemCoords(StepTestTable table,
                                             java.lang.String selectTextValue,
                                             java.lang.String coords,
                                             java.lang.String matchIndex)

 
                Double click an unverifiable text item at specific Coords.
              
                An unverifiable item is one whose READ value is not the same as its SET value.

Supporting Engines:

Rational Robot
OpenQA Selenium

Parameters:: table - Optional:NO The table to add the record to.; selectTextValue - Optional:NO Case-sensitive text of node to select; coords - Optional:NO The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.; matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

activateUnverifiedTextItemCoords
```
public ComponentFunction activateUnverifiedTextItemCoords(java.lang.String[] parameters)
```
```
 
                Double click an unverifiable text item at specific Coords.
              
                An unverifiable item is one whose READ value is not the same as its SET value.
                  
```
Supporting Engines:
- Rational Robot
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

activateUnverifiedTextItemCoords
```
public void activateUnverifiedTextItemCoords(StepTestTable table,
                                             java.lang.String[] parameters)
```
```
 
                Double click an unverifiable text item at specific Coords.
              
                An unverifiable item is one whose READ value is not the same as its SET value.
                  
```
Supporting Engines:
- Rational Robot
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.
parameters - Optional:NO An array containing the following parameters:

assignCellValue
```
public ComponentFunction assignCellValue(java.lang.String variable,
                                         java.lang.String rowCoord,
                                         java.lang.String colCoord)
```
```
 
                Assigns the value of a cell in a listview to a variable.
                  
```
Supporting Engines:
- Rational Robot
Parameters:

variable - Optional:NO Name of variable to assign value

rowCoord - Optional:NO The coordinate of the row in the listview that you want to capture the value.

colCoord - Optional:NO The coordinate of the column in the listview that you want to capture the value.

assignCellValue
```
public void assignCellValue(StepTestTable table,
                            java.lang.String variable,
                            java.lang.String rowCoord,
                            java.lang.String colCoord)
```
```
 
                Assigns the value of a cell in a listview to a variable.
                  
```
Supporting Engines:
- Rational Robot
Parameters:

table - Optional:NO The table to add the record to.

variable - Optional:NO Name of variable to assign value

rowCoord - Optional:NO The coordinate of the row in the listview that you want to capture the value.

colCoord - Optional:NO The coordinate of the column in the listview that you want to capture the value.

assignCellValue
```
public ComponentFunction assignCellValue(java.lang.String[] parameters)
```
```
 
                Assigns the value of a cell in a listview to a variable.
                  
```
Supporting Engines:
- Rational Robot
Parameters:
parameters - Optional:NO An array containing the following parameters:

assignCellValue
```
public void assignCellValue(StepTestTable table,
                            java.lang.String[] parameters)
```
```
 
                Assigns the value of a cell in a listview to a variable.
                  
```
Supporting Engines:
- Rational Robot
Parameters:

table - Optional:NO The table to add the record to.
parameters - Optional:NO An array containing the following parameters:

captureItemsToFile
```
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:
- Google Android
- AutomatedQA TestComplete
- OpenQA Selenium
Parameters:

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.

captureItemsToFile
```
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:
- Google Android
- AutomatedQA TestComplete
- OpenQA Selenium
Parameters:

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.

captureItemsToFile
```
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:
- Google Android
- AutomatedQA TestComplete
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

captureItemsToFile
```
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:
- Google Android
- AutomatedQA TestComplete
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.
parameters - Optional:NO An array containing the following parameters:

clickIndex

public ComponentFunction clickIndex(java.lang.String index)

 
                Same as (Alias for) ListView ActivateIndexItem

Supporting Engines:

Google Android
OpenQA Selenium

Parameters:: index - Optional:NO See ListView ActivateIndexItem

clickIndex

public void clickIndex(StepTestTable table,
                       java.lang.String index)

 
                Same as (Alias for) ListView ActivateIndexItem

Supporting Engines:

Google Android
OpenQA Selenium

Parameters:: table - Optional:NO The table to add the record to.; index - Optional:NO See ListView ActivateIndexItem

clickIndexItem

public ComponentFunction clickIndexItem(java.lang.String index)

 
                Same as (Alias for) ListView ActivateIndexItem

Supporting Engines:

Google Android
OpenQA Selenium

Parameters:: index - Optional:NO See ListView ActivateIndexItem

clickIndexItem

public void clickIndexItem(StepTestTable table,
                           java.lang.String index)

 
                Same as (Alias for) ListView ActivateIndexItem

Supporting Engines:

Google Android
OpenQA Selenium

Parameters:: table - Optional:NO The table to add the record to.; index - Optional:NO See ListView ActivateIndexItem

extendSelectionToTextItem

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...)

Supporting Engines:

AutomatedQA TestComplete
OpenQA Selenium

Parameters:: textValue - Optional:NO Case-sensitive text of node to select and verify.

extendSelectionToTextItem

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...)

Supporting Engines:

AutomatedQA TestComplete
OpenQA Selenium

Parameters:: table - Optional:NO The table to add the record to.; textValue - Optional:NO Case-sensitive text of node to select and verify.

rightClickTextItem

public ComponentFunction rightClickTextItem(java.lang.String selectTextValue,
                                            java.lang.String matchIndex)

 
                     Routine to RightClick (single click) an item according to its text value.

Supporting Engines:

Rational Robot
AutomatedQA TestComplete
OpenQA Selenium

Parameters:: selectTextValue - Optional:NO Case-sensitive text of node to RightClick; matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

rightClickTextItem
```
public void rightClickTextItem(StepTestTable table,
                               java.lang.String selectTextValue,
                               java.lang.String matchIndex)
```
```
 
                     Routine to RightClick (single click) an item according to its text value.
                       
```
Supporting Engines:
- Rational Robot
- AutomatedQA TestComplete
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.

selectTextValue - Optional:NO Case-sensitive text of node to RightClick

matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

rightClickTextItem
```
public ComponentFunction rightClickTextItem(java.lang.String[] parameters)
```
```
 
                     Routine to RightClick (single click) an item according to its text value.
                       
```
Supporting Engines:
- Rational Robot
- AutomatedQA TestComplete
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

rightClickTextItem
```
public void rightClickTextItem(StepTestTable table,
                               java.lang.String[] parameters)
```
```
 
                     Routine to RightClick (single click) an item according to its text value.
                       
```
Supporting Engines:
- Rational Robot
- AutomatedQA TestComplete
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.
parameters - Optional:NO An array containing the following parameters:

rightClickTextItemCoords
```
public ComponentFunction rightClickTextItemCoords(java.lang.String selectTextValue,
                                                  java.lang.String coords,
                                                  java.lang.String matchIndex)
```
```
 
                     Right click a text item at specific Coords.
                       
```
Supporting Engines:
- Rational Robot
- OpenQA Selenium
Parameters:

selectTextValue - Optional:NO Case-sensitive text of node to RightClick

coords - Optional:NO The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.

matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

rightClickTextItemCoords
```
public void rightClickTextItemCoords(StepTestTable table,
                                     java.lang.String selectTextValue,
                                     java.lang.String coords,
                                     java.lang.String matchIndex)
```
```
 
                     Right click a text item at specific Coords.
                       
```
Supporting Engines:
- Rational Robot
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.

selectTextValue - Optional:NO Case-sensitive text of node to RightClick

coords - Optional:NO The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.

matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

rightClickTextItemCoords
```
public ComponentFunction rightClickTextItemCoords(java.lang.String[] parameters)
```
```
 
                     Right click a text item at specific Coords.
                       
```
Supporting Engines:
- Rational Robot
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

rightClickTextItemCoords
```
public void rightClickTextItemCoords(StepTestTable table,
                                     java.lang.String[] parameters)
```
```
 
                     Right click a text item at specific Coords.
                       
```
Supporting Engines:
- Rational Robot
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.
parameters - Optional:NO An array containing the following parameters:

rightClickUnverifiedTextItem

public ComponentFunction rightClickUnverifiedTextItem(java.lang.String selectTextValue,
                                                      java.lang.String matchIndex)

 
                     Routine to RightClick (single click) an unverifiable item according to its text value.
                   
                     An unverifiable item is one whose READ value is not the same as its SET value.

Supporting Engines:

Rational Robot

Parameters:: selectTextValue - Optional:NO Case-sensitive text of node to RightClick; matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

rightClickUnverifiedTextItem

public void rightClickUnverifiedTextItem(StepTestTable table,
                                         java.lang.String selectTextValue,
                                         java.lang.String matchIndex)

 
                     Routine to RightClick (single click) an unverifiable item according to its text value.
                   
                     An unverifiable item is one whose READ value is not the same as its SET value.

Supporting Engines:

Rational Robot

Parameters:: table - Optional:NO The table to add the record to.; selectTextValue - Optional:NO Case-sensitive text of node to RightClick; matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

rightClickUnverifiedTextItem

public ComponentFunction rightClickUnverifiedTextItem(java.lang.String[] parameters)

 
                     Routine to RightClick (single click) an unverifiable item according to its text value.
                   
                     An unverifiable item is one whose READ value is not the same as its SET value.

Supporting Engines:

Rational Robot

Parameters:

parameters - Optional:NO An array containing the following parameters:

rightClickUnverifiedTextItem

public void rightClickUnverifiedTextItem(StepTestTable table,
                                         java.lang.String[] parameters)

 
                     Routine to RightClick (single click) an unverifiable item according to its text value.
                   
                     An unverifiable item is one whose READ value is not the same as its SET value.

Supporting Engines:

Rational Robot

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

rightClickUnverifiedTextItemCoords

public ComponentFunction rightClickUnverifiedTextItemCoords(java.lang.String selectTextValue,
                                                            java.lang.String coords,
                                                            java.lang.String matchIndex)

 
                     Right Click an unverifiable text item at specific Coords.
                   
                     An unverifiable item is one whose READ value is not the same as its SET value.

Supporting Engines:

Rational Robot

Parameters:: selectTextValue - Optional:NO Case-sensitive text of node to select; coords - Optional:NO The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.; matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

rightClickUnverifiedTextItemCoords

public void rightClickUnverifiedTextItemCoords(StepTestTable table,
                                               java.lang.String selectTextValue,
                                               java.lang.String coords,
                                               java.lang.String matchIndex)

 
                     Right Click an unverifiable text item at specific Coords.
                   
                     An unverifiable item is one whose READ value is not the same as its SET value.

Supporting Engines:

Rational Robot

Parameters:: table - Optional:NO The table to add the record to.; selectTextValue - Optional:NO Case-sensitive text of node to select; coords - Optional:NO The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.; matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

rightClickUnverifiedTextItemCoords
```
public ComponentFunction rightClickUnverifiedTextItemCoords(java.lang.String[] parameters)
```
```
 
                     Right Click an unverifiable text item at specific Coords.
                   
                     An unverifiable item is one whose READ value is not the same as its SET value.
                       
```
Supporting Engines:
- Rational Robot
Parameters:
parameters - Optional:NO An array containing the following parameters:

rightClickUnverifiedTextItemCoords
```
public void rightClickUnverifiedTextItemCoords(StepTestTable table,
                                               java.lang.String[] parameters)
```
```
 
                     Right Click an unverifiable text item at specific Coords.
                   
                     An unverifiable item is one whose READ value is not the same as its SET value.
                       
```
Supporting Engines:
- Rational Robot
Parameters:

table - Optional:NO The table to add the record to.
parameters - Optional:NO An array containing the following parameters:

selectAnotherPartialMatch

public ComponentFunction selectAnotherPartialMatch(java.lang.String partialTextValue,
                                                   java.lang.String matchIndex)

 
                Routine for multiple selection to Control+Click on an item according to a partial text match.
               
                This adds selected items to items already selected.

Supporting Engines:

AutomatedQA TestComplete
OpenQA Selenium

Parameters:: partialTextValue - Optional:NO Case-sensitive substring of text item to select.; matchIndex - Optional:YES DefaultVal:1 Optional index of the Nth duplicate item to match.

selectAnotherPartialMatch

public void selectAnotherPartialMatch(StepTestTable table,
                                      java.lang.String partialTextValue,
                                      java.lang.String matchIndex)

 
                Routine for multiple selection to Control+Click on an item according to a partial text match.
               
                This adds selected items to items already selected.

Supporting Engines:

AutomatedQA TestComplete
OpenQA Selenium

Parameters:: table - Optional:NO The table to add the record to.; partialTextValue - Optional:NO Case-sensitive substring of text item to select.; matchIndex - Optional:YES DefaultVal:1 Optional index of the Nth duplicate item to match.

selectAnotherPartialMatch
```
public ComponentFunction selectAnotherPartialMatch(java.lang.String[] parameters)
```
```
 
                Routine for multiple selection to Control+Click on an item according to a partial text match.
               
                This adds selected items to items already selected.

                  
```
Supporting Engines:
- AutomatedQA TestComplete
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

selectAnotherPartialMatch
```
public void selectAnotherPartialMatch(StepTestTable table,
                                      java.lang.String[] parameters)
```
```
 
                Routine for multiple selection to Control+Click on an item according to a partial text match.
               
                This adds selected items to items already selected.

                  
```
Supporting Engines:
- AutomatedQA TestComplete
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.
parameters - Optional:NO An array containing the following parameters:

selectAnotherTextItem

public ComponentFunction selectAnotherTextItem(java.lang.String textValue,
                                               java.lang.String matchIndex)

 
                Routine for multiple selection to Control+Click on an item by its text value.
               
                This adds selected items to items already selected.

Supporting Engines:

AutomatedQA TestComplete
OpenQA Selenium

Parameters:: textValue - Optional:NO Case-sensitive text of node to select.; matchIndex - Optional:YES DefaultVal:1 Optional index of the Nth duplicate item to match.

selectAnotherTextItem

public void selectAnotherTextItem(StepTestTable table,
                                  java.lang.String textValue,
                                  java.lang.String matchIndex)

 
                Routine for multiple selection to Control+Click on an item by its text value.
               
                This adds selected items to items already selected.

Supporting Engines:

AutomatedQA TestComplete
OpenQA Selenium

Parameters:: table - Optional:NO The table to add the record to.; textValue - Optional:NO Case-sensitive text of node to select.; matchIndex - Optional:YES DefaultVal:1 Optional index of the Nth duplicate item to match.

selectAnotherTextItem
```
public ComponentFunction selectAnotherTextItem(java.lang.String[] parameters)
```
```
 
                Routine for multiple selection to Control+Click on an item by its text value.
               
                This adds selected items to items already selected.

                  
```
Supporting Engines:
- AutomatedQA TestComplete
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

selectAnotherTextItem
```
public void selectAnotherTextItem(StepTestTable table,
                                  java.lang.String[] parameters)
```
```
 
                Routine for multiple selection to Control+Click on an item by its text value.
               
                This adds selected items to items already selected.

                  
```
Supporting Engines:
- AutomatedQA TestComplete
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.
parameters - Optional:NO An array containing the following parameters:

selectIndex

public ComponentFunction selectIndex(java.lang.String index)

 
                Same as (Alias for) ListView SelectIndexItem

Supporting Engines:

Google Android
OpenQA Selenium

Parameters:: index - Optional:NO See ListView SelectIndexItem

selectIndex

public void selectIndex(StepTestTable table,
                        java.lang.String index)

 
                Same as (Alias for) ListView SelectIndexItem

Supporting Engines:

Google Android
OpenQA Selenium

Parameters:: table - Optional:NO The table to add the record to.; index - Optional:NO See ListView SelectIndexItem

selectIndexItem

public ComponentFunction selectIndexItem(java.lang.String itemIndex)

 
                Routine to single click an item according to its Index value.
               
                It is important to note that some ListViews index their values
                differently.  For example, you may need to select an item by 
                text by using a property whose starting index is 1.  Yet, 
                if you request to seek an item strictly by index, the starting 
                index is 0.  So, the test developer may need to evaluate their 
                ListView object for these differences.

Supporting Engines:

Rational Robot
Mercury Interactive WinRunner
AutomatedQA TestComplete
Google Android
OpenQA Selenium

Parameters:: itemIndex - Optional:NO Index of node to select.

selectIndexItem

public void selectIndexItem(StepTestTable table,
                            java.lang.String itemIndex)

 
                Routine to single click an item according to its Index value.
               
                It is important to note that some ListViews index their values
                differently.  For example, you may need to select an item by 
                text by using a property whose starting index is 1.  Yet, 
                if you request to seek an item strictly by index, the starting 
                index is 0.  So, the test developer may need to evaluate their 
                ListView object for these differences.

Supporting Engines:

Rational Robot
Mercury Interactive WinRunner
AutomatedQA TestComplete
Google Android
OpenQA Selenium

Parameters:: table - Optional:NO The table to add the record to.; itemIndex - Optional:NO Index of node to select.

selectIndexItemCoords

public ComponentFunction selectIndexItemCoords(java.lang.String itemIndex,
                                               java.lang.String coords)

 
                Routine to single click an item by Index at specific coordinates.
               
                It is important to note that some ListViews index their values
                differently.  For example, you may need to select an item by 
                text by using a property whose starting index is 1.  Yet, 
                if you request to seek an item strictly by index, the starting 
                index is 0.  So, the test developer may need to evaluate their 
                ListView object for these differences.

Supporting Engines:

Rational Robot
OpenQA Selenium

Parameters:: itemIndex - Optional:NO Index of node to select.; coords - Optional:NO The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.

selectIndexItemCoords

public void selectIndexItemCoords(StepTestTable table,
                                  java.lang.String itemIndex,
                                  java.lang.String coords)

 
                Routine to single click an item by Index at specific coordinates.
               
                It is important to note that some ListViews index their values
                differently.  For example, you may need to select an item by 
                text by using a property whose starting index is 1.  Yet, 
                if you request to seek an item strictly by index, the starting 
                index is 0.  So, the test developer may need to evaluate their 
                ListView object for these differences.

Supporting Engines:

Rational Robot
OpenQA Selenium

Parameters:: table - Optional:NO The table to add the record to.; itemIndex - Optional:NO Index of node to select.; coords - Optional:NO The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.

selectIndexItemCoords

public ComponentFunction selectIndexItemCoords(java.lang.String[] parameters)

 
                Routine to single click an item by Index at specific coordinates.
               
                It is important to note that some ListViews index their values
                differently.  For example, you may need to select an item by 
                text by using a property whose starting index is 1.  Yet, 
                if you request to seek an item strictly by index, the starting 
                index is 0.  So, the test developer may need to evaluate their 
                ListView object for these differences.

Supporting Engines:

Rational Robot
OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

selectIndexItemCoords

public void selectIndexItemCoords(StepTestTable table,
                                  java.lang.String[] parameters)

 
                Routine to single click an item by Index at specific coordinates.
               
                It is important to note that some ListViews index their values
                differently.  For example, you may need to select an item by 
                text by using a property whose starting index is 1.  Yet, 
                if you request to seek an item strictly by index, the starting 
                index is 0.  So, the test developer may need to evaluate their 
                ListView object for these differences.

Supporting Engines:

Rational Robot
OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

selectPartialMatch

public ComponentFunction selectPartialMatch(java.lang.String partialTextValue,
                                            java.lang.String matchIndex)

 
                Routine to select (single click) an item according to a partial text match.

Supporting Engines:

AutomatedQA TestComplete
Google Android
OpenQA Selenium

Parameters:: partialTextValue - Optional:NO Case-sensitive substring of node to select; matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

selectPartialMatch
```
public void selectPartialMatch(StepTestTable table,
                               java.lang.String partialTextValue,
                               java.lang.String matchIndex)
```
```
 
                Routine to select (single click) an item according to a partial text match.
                  
```
Supporting Engines:
- AutomatedQA TestComplete
- Google Android
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.

partialTextValue - Optional:NO Case-sensitive substring of node to select

matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

selectPartialMatch
```
public ComponentFunction selectPartialMatch(java.lang.String[] parameters)
```
```
 
                Routine to select (single click) an item according to a partial text match.
                  
```
Supporting Engines:
- AutomatedQA TestComplete
- Google Android
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

selectPartialMatch
```
public void selectPartialMatch(StepTestTable table,
                               java.lang.String[] parameters)
```
```
 
                Routine to select (single click) an item according to a partial text match.
                  
```
Supporting Engines:
- AutomatedQA TestComplete
- Google Android
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.
parameters - Optional:NO An array containing the following parameters:

selectRandomItems

public ComponentFunction selectRandomItems(java.lang.String itemCount)

 
                Routine to randomly select multiple items in the ListView object.
              
                Routine to randomly select multiple items in the ListView object.  
                Each selection is done with a CTRL + Single Left Click.  
                Items are selected by index, not by their text values. Items 
                already selected are NOT unselected.  We add to existing 
                selections.

Supporting Engines:

Rational Robot
Mercury Interactive WinRunner

Parameters:: itemCount - Optional:NO The quantity of items to randomly select in the object.

selectRandomItems

public void selectRandomItems(StepTestTable table,
                              java.lang.String itemCount)

 
                Routine to randomly select multiple items in the ListView object.
              
                Routine to randomly select multiple items in the ListView object.  
                Each selection is done with a CTRL + Single Left Click.  
                Items are selected by index, not by their text values. Items 
                already selected are NOT unselected.  We add to existing 
                selections.

Supporting Engines:

Rational Robot
Mercury Interactive WinRunner

Parameters:: table - Optional:NO The table to add the record to.; itemCount - Optional:NO The quantity of items to randomly select in the object.

selectTextItem
```
public ComponentFunction selectTextItem(java.lang.String selectTextValue,
                                        java.lang.String matchIndex)
```
```
 
                Routine to select (single click) an item according to its text value.
                  
```
Supporting Engines:
- Rational Robot
- Mercury Interactive WinRunner
- AutomatedQA TestComplete
- Google Android
- OpenQA Selenium
Parameters:

selectTextValue - Optional:NO Case-sensitive text of node to select

matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

selectTextItem
```
public void selectTextItem(StepTestTable table,
                           java.lang.String selectTextValue,
                           java.lang.String matchIndex)
```
```
 
                Routine to select (single click) an item according to its text value.
                  
```
Supporting Engines:
- Rational Robot
- Mercury Interactive WinRunner
- AutomatedQA TestComplete
- Google Android
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.

selectTextValue - Optional:NO Case-sensitive text of node to select

matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

selectTextItem
```
public ComponentFunction selectTextItem(java.lang.String[] parameters)
```
```
 
                Routine to select (single click) an item according to its text value.
                  
```
Supporting Engines:
- Rational Robot
- Mercury Interactive WinRunner
- AutomatedQA TestComplete
- Google Android
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

selectTextItem
```
public void selectTextItem(StepTestTable table,
                           java.lang.String[] parameters)
```
```
 
                Routine to select (single click) an item according to its text value.
                  
```
Supporting Engines:
- Rational Robot
- Mercury Interactive WinRunner
- AutomatedQA TestComplete
- Google Android
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.
parameters - Optional:NO An array containing the following parameters:

selectTextItemCoords
```
public ComponentFunction selectTextItemCoords(java.lang.String selectTextValue,
                                              java.lang.String coords,
                                              java.lang.String matchIndex)
```
```
 
                Single click a text item at specific Coords.
                  
```
Supporting Engines:
- Rational Robot
- OpenQA Selenium
Parameters:

selectTextValue - Optional:NO Case-sensitive text of node to select

coords - Optional:NO The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.

matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

selectTextItemCoords
```
public void selectTextItemCoords(StepTestTable table,
                                 java.lang.String selectTextValue,
                                 java.lang.String coords,
                                 java.lang.String matchIndex)
```
```
 
                Single click a text item at specific Coords.
                  
```
Supporting Engines:
- Rational Robot
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.

selectTextValue - Optional:NO Case-sensitive text of node to select

coords - Optional:NO The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.

matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

selectTextItemCoords
```
public ComponentFunction selectTextItemCoords(java.lang.String[] parameters)
```
```
 
                Single click a text item at specific Coords.
                  
```
Supporting Engines:
- Rational Robot
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

selectTextItemCoords
```
public void selectTextItemCoords(StepTestTable table,
                                 java.lang.String[] parameters)
```
```
 
                Single click a text item at specific Coords.
                  
```
Supporting Engines:
- Rational Robot
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.
parameters - Optional:NO An array containing the following parameters:

selectUnverifiedTextItem

public ComponentFunction selectUnverifiedTextItem(java.lang.String selectTextValue,
                                                  java.lang.String matchIndex)

 
                Routine to select (single click) an unverifiable item according to its text value.
              
                An unverifiable item is one whose READ value is not the same as its SET value.

Supporting Engines:

Rational Robot
AutomatedQA TestComplete
Google Android
OpenQA Selenium

Parameters:: selectTextValue - Optional:NO Case-sensitive text of node to select; matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

selectUnverifiedTextItem

public void selectUnverifiedTextItem(StepTestTable table,
                                     java.lang.String selectTextValue,
                                     java.lang.String matchIndex)

 
                Routine to select (single click) an unverifiable item according to its text value.
              
                An unverifiable item is one whose READ value is not the same as its SET value.

Supporting Engines:

Rational Robot
AutomatedQA TestComplete
Google Android
OpenQA Selenium

Parameters:: table - Optional:NO The table to add the record to.; selectTextValue - Optional:NO Case-sensitive text of node to select; matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

selectUnverifiedTextItem
```
public ComponentFunction selectUnverifiedTextItem(java.lang.String[] parameters)
```
```
 
                Routine to select (single click) an unverifiable item according to its text value.
              
                An unverifiable item is one whose READ value is not the same as its SET value.
                  
```
Supporting Engines:
- Rational Robot
- AutomatedQA TestComplete
- Google Android
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

selectUnverifiedTextItem
```
public void selectUnverifiedTextItem(StepTestTable table,
                                     java.lang.String[] parameters)
```
```
 
                Routine to select (single click) an unverifiable item according to its text value.
              
                An unverifiable item is one whose READ value is not the same as its SET value.
                  
```
Supporting Engines:
- Rational Robot
- AutomatedQA TestComplete
- Google Android
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.
parameters - Optional:NO An array containing the following parameters:

selectUnverifiedTextItemCoords

public ComponentFunction selectUnverifiedTextItemCoords(java.lang.String selectTextValue,
                                                        java.lang.String coords,
                                                        java.lang.String matchIndex)

 
                Single click an unverifiable text item at specific Coords.
              
                An unverifiable item is one whose READ value is not the same as its SET value.

Supporting Engines:

Rational Robot
OpenQA Selenium

Parameters:: selectTextValue - Optional:NO Case-sensitive text of node to select; coords - Optional:NO The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.; matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

selectUnverifiedTextItemCoords

public void selectUnverifiedTextItemCoords(StepTestTable table,
                                           java.lang.String selectTextValue,
                                           java.lang.String coords,
                                           java.lang.String matchIndex)

 
                Single click an unverifiable text item at specific Coords.
              
                An unverifiable item is one whose READ value is not the same as its SET value.

Supporting Engines:

Rational Robot
OpenQA Selenium

Parameters:: table - Optional:NO The table to add the record to.; selectTextValue - Optional:NO Case-sensitive text of node to select; coords - Optional:NO The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.; matchIndex - Optional:YES Optional index of the Nth duplicate item to match.

selectUnverifiedTextItemCoords
```
public ComponentFunction selectUnverifiedTextItemCoords(java.lang.String[] parameters)
```
```
 
                Single click an unverifiable text item at specific Coords.
              
                An unverifiable item is one whose READ value is not the same as its SET value.
                  
```
Supporting Engines:
- Rational Robot
- OpenQA Selenium
Parameters:
parameters - Optional:NO An array containing the following parameters:

selectUnverifiedTextItemCoords
```
public void selectUnverifiedTextItemCoords(StepTestTable table,
                                           java.lang.String[] parameters)
```
```
 
                Single click an unverifiable text item at specific Coords.
              
                An unverifiable item is one whose READ value is not the same as its SET value.
                  
```
Supporting Engines:
- Rational Robot
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.
parameters - Optional:NO An array containing the following parameters:

setListContains

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:

Rational Robot
AutomatedQA TestComplete
OpenQA Selenium

Parameters:: itemText - Optional:NO The case-sensitive name of the sought item.; resultVar - Optional:NO The name of the variable receiving the result.

setListContains

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:

Rational Robot
AutomatedQA TestComplete
OpenQA Selenium

Parameters:: 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.

setListContains

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:

Rational Robot
AutomatedQA TestComplete
OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

setListContains

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:

Rational Robot
AutomatedQA TestComplete
OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

verifyItemUnselected
```
public ComponentFunction verifyItemUnselected(java.lang.String textValue)
```
```
 
                Verifies a particular case-sensitive text item is NOT selected.
                  
```
Supporting Engines:
- Rational Robot
- Mercury Interactive WinRunner
- AutomatedQA TestComplete
- OpenQA Selenium
Parameters:

textValue - Optional:NO Case-sensitive text of node that will be verified unselected

verifyItemUnselected
```
public void verifyItemUnselected(StepTestTable table,
                                 java.lang.String textValue)
```
```
 
                Verifies a particular case-sensitive text item is NOT selected.
                  
```
Supporting Engines:
- Rational Robot
- Mercury Interactive WinRunner
- AutomatedQA TestComplete
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.

textValue - Optional:NO Case-sensitive text of node that will be verified unselected

verifyListContains

public ComponentFunction verifyListContains(java.lang.String itemText)

                Verify that a list view contains the provided item.
                        
                The search of the item is expected to be a case-sensitive exact match of the item.

Supporting Engines:

Rational Robot
AutomatedQA TestComplete
OpenQA Selenium

Parameters:: itemText - Optional:NO The case-sensitive name of the item to verify.

verifyListContains

public void verifyListContains(StepTestTable table,
                               java.lang.String itemText)

                Verify that a list view contains the provided item.
                        
                The search of the item is expected to be a case-sensitive exact match of the item.

Supporting Engines:

Rational Robot
AutomatedQA TestComplete
OpenQA Selenium

Parameters:: table - Optional:NO The table to add the record to.; itemText - Optional:NO The case-sensitive name of the item to verify.

verifySelectedItem
```
public ComponentFunction verifySelectedItem(java.lang.String textValue)
```
```
 
                Verifies a particular case-sensitive text item is selected
                  
```
Supporting Engines:
- Rational Robot
- Mercury Interactive WinRunner
- AutomatedQA TestComplete
- OpenQA Selenium
Parameters:

textValue - Optional:NO Case-sensitive text of node that will be verified selected

verifySelectedItem
```
public void verifySelectedItem(StepTestTable table,
                               java.lang.String textValue)
```
```
 
                Verifies a particular case-sensitive text item is selected
                  
```
Supporting Engines:
- Rational Robot
- Mercury Interactive WinRunner
- AutomatedQA TestComplete
- OpenQA Selenium
Parameters:

table - Optional:NO The table to add the record to.

textValue - Optional:NO Case-sensitive text of node that will be verified selected

Class ListView

Constructor Summary

Method Summary

Methods inherited from class org.safs.model.components.GenericObject

Methods inherited from class org.safs.model.components.GenericMaster

Methods inherited from class org.safs.model.components.UIComponent

Methods inherited from class org.safs.model.Component

Methods inherited from class java.lang.Object

Constructor Detail

ListView

ListView

ListView

Method Detail

activateIndex

activateIndex

activateIndexItem

activateIndexItem

activatePartialMatch

activatePartialMatch

activatePartialMatch

activatePartialMatch

activateTextItem

activateTextItem

activateTextItem

activateTextItem

activateTextItemCoords

activateTextItemCoords

activateTextItemCoords

activateTextItemCoords

activateUnverifiedTextItem

activateUnverifiedTextItem

activateUnverifiedTextItem

activateUnverifiedTextItem

activateUnverifiedTextItemCoords

activateUnverifiedTextItemCoords

activateUnverifiedTextItemCoords

activateUnverifiedTextItemCoords

assignCellValue

assignCellValue

assignCellValue

assignCellValue

captureItemsToFile

captureItemsToFile

captureItemsToFile

captureItemsToFile

clickIndex

clickIndex

clickIndexItem

clickIndexItem

extendSelectionToTextItem

extendSelectionToTextItem

rightClickTextItem

rightClickTextItem

rightClickTextItem

rightClickTextItem

rightClickTextItemCoords

rightClickTextItemCoords

rightClickTextItemCoords

rightClickTextItemCoords

rightClickUnverifiedTextItem

rightClickUnverifiedTextItem

rightClickUnverifiedTextItem

rightClickUnverifiedTextItem

rightClickUnverifiedTextItemCoords

rightClickUnverifiedTextItemCoords

rightClickUnverifiedTextItemCoords

rightClickUnverifiedTextItemCoords

selectAnotherPartialMatch

selectAnotherPartialMatch

selectAnotherPartialMatch

selectAnotherPartialMatch

selectAnotherTextItem

selectAnotherTextItem

selectAnotherTextItem

selectAnotherTextItem

selectIndex

selectIndex

selectIndexItem

selectIndexItem

selectIndexItemCoords