org.safs.model.commands

Class ListBoxFunctions

java.lang.Object

org.safs.model.commands.ListBoxFunctions

public class ListBoxFunctions
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTIVATEPARTIALMATCH_KEYWORD "ActivatePartialMatch"
static java.lang.String	ACTIVATETEXTITEM_KEYWORD "ActivateTextItem"
static java.lang.String	ACTIVATEUNVERIFIEDPARTIALMATCH_KEYWORD "ActivateUnverifiedPartialMatch"
static java.lang.String	ACTIVATEUNVERIFIEDTEXTITEM_KEYWORD "ActivateUnverifiedTextItem"
static java.lang.String	CAPTUREITEMSTOFILE_KEYWORD "CaptureItemsToFile"
static java.lang.String	CLICKCOLUMNINDEX_KEYWORD "ClickColumnIndex"
static java.lang.String	CLICKCOLUMNLABEL_KEYWORD "ClickColumnLabel"
static java.lang.String	CLICKTEXTITEM_KEYWORD "ClickTextItem"
static java.lang.String	EXTENDSELECTIONTOTEXTITEM_KEYWORD "ExtendSelectionToTextItem"
static java.lang.String	RIGHTCLICKTEXTITEM_KEYWORD "RightClickTextItem"
static java.lang.String	SELECTANOTHERTEXTITEM_KEYWORD "SelectAnotherTextItem"
static java.lang.String	SELECTANOTHERUNVERIFIEDTEXTITEM_KEYWORD "SelectAnotherUnverifiedTextItem"
static java.lang.String	SELECTINDEX_KEYWORD "SelectIndex"
static java.lang.String	SELECTPARTIALMATCH_KEYWORD "SelectPartialMatch"
static java.lang.String	SELECTTEXTITEM_KEYWORD "SelectTextItem"
static java.lang.String	SELECTUNVERIFIEDANOTHERTEXTITEM_KEYWORD "SelectUnverifiedAnotherTextItem"
static java.lang.String	SELECTUNVERIFIEDPARTIALMATCH_KEYWORD "SelectUnverifiedPartialMatch"
static java.lang.String	SELECTUNVERIFIEDTEXTITEM_KEYWORD "SelectUnverifiedTextItem"
static java.lang.String	SETLISTCONTAINS_KEYWORD "SetListContains"
static java.lang.String	VERIFYITEM_KEYWORD "VerifyItem"
static java.lang.String	VERIFYITEMUNSELECTED_KEYWORD "VerifyItemUnselected"
static java.lang.String	VERIFYLISTCONTAINS_KEYWORD "VerifyListContains"
static java.lang.String	VERIFYLISTCONTAINSPARTIALMATCH_KEYWORD "VerifyListContainsPartialMatch"
static java.lang.String	VERIFYLISTDOESNOTCONTAIN_KEYWORD "VerifyListDoesNotContain"
static java.lang.String	VERIFYLISTDOESNOTCONTAINPARTIALMATCH_KEYWORD "VerifyListDoesNotContainPartialMatch"
static java.lang.String	VERIFYMENUITEM_KEYWORD "VerifyMenuItem"
static java.lang.String	VERIFYMENUPARTIALMATCH_KEYWORD "VerifyMenuPartialMatch"
static java.lang.String	VERIFYPARTIALMATCH_KEYWORD "VerifyPartialMatch"
static java.lang.String	VERIFYSELECTEDITEM_KEYWORD "VerifySelectedItem"
static java.lang.String	VERIFYSELECTEDPARTIALMATCH_KEYWORD "VerifySelectedPartialMatch"

Method Summary

Modifier and Type	Method and Description
static ComponentFunction	activatePartialMatch(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Routine to DblClick and Verify an item according to a partial text match.
static ComponentFunction	activateTextItem(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Routine to DblClick and Verify an item according to its text value.
static ComponentFunction	activateUnverifiedPartialMatch(java.lang.String winname, java.lang.String compname, java.lang.String textValue) DblClicks an item according to a partial text match.
static ComponentFunction	activateUnverifiedTextItem(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Routine to DblClick an item according to its text value.
static ComponentFunction	captureItemsToFile(java.lang.String winname, java.lang.String compname, 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)
static ComponentFunction	captureItemsToFile(java.lang.String winname, java.lang.String compname, 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)
static ComponentFunction	clickColumnIndex(java.lang.String winname, java.lang.String compname, 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
static ComponentFunction	clickColumnLabel(java.lang.String winname, java.lang.String compname, java.lang.String label) Click a column header based on it's label Click a column header based on it's label
static ComponentFunction	clickTextItem(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Routine to Click a selection according to its text value.
static ComponentFunction	extendSelectionToTextItem(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Routine to Shift+Click and Verify a selection according to its text value.
static ListBoxFunctions	getInstance() public Singleton to access class static methods via instance
static ComponentFunction	rightClickTextItem(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Routine to Right-Click a selection according to its text value.
static ComponentFunction	selectAnotherTextItem(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Routine to Control+Click and Verify a selection according to its text value.
static ComponentFunction	selectAnotherUnverifiedTextItem(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Routine to Control+Click an item according to its text value.
static ComponentFunction	selectIndex(java.lang.String winname, java.lang.String compname, 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
static ComponentFunction	selectPartialMatch(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Routine to Click and Verify an item according to a partial text match.
static ComponentFunction	selectTextItem(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Routine to Click and Verify a selection according to its text value.
static ComponentFunction	selectUnverifiedAnotherTextItem(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Use the identical "SelectAnotherUnverifiedTextItem" instead.
static ComponentFunction	selectUnverifiedPartialMatch(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Routine to Click an item according to a partial text match.
static ComponentFunction	selectUnverifiedTextItem(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Routine to Click a selection according to its text value.
static ComponentFunction	setListContains(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Set a variable with the result of checking that a listview contains the provided item.
static ComponentFunction	setListContains(java.lang.String winname, java.lang.String compname, java.lang.String itemText, java.lang.String resultVar) Set a variable with the result of checking that a listview contains the provided item.
static ComponentFunction	verifyItem(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Verifies a particular case-sensitive item based on index is equal to a particular value.
static ComponentFunction	verifyItem(java.lang.String winname, java.lang.String compname, java.lang.String index, java.lang.String textValue) Verifies a particular case-sensitive item based on index is equal to a particular value.
static ComponentFunction	verifyItemUnselected(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Verifies a particular case-sensitive text item is NOT selected.
static ComponentFunction	verifyListContains(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Verifies a particular list-item exists in the list (somewhere) Verifies a particular list-item exists in the list (somewhere).
static ComponentFunction	verifyListContains(java.lang.String winname, java.lang.String compname, 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).
static ComponentFunction	verifyListContainsPartialMatch(java.lang.String winname, java.lang.String compname, 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).
static ComponentFunction	verifyListContainsPartialMatch(java.lang.String winname, java.lang.String compname, 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).
static ComponentFunction	verifyListDoesNotContain(java.lang.String winname, java.lang.String compname, 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).
static ComponentFunction	verifyListDoesNotContain(java.lang.String winname, java.lang.String compname, 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).
static ComponentFunction	verifyListDoesNotContainPartialMatch(java.lang.String winname, java.lang.String compname, 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).
static ComponentFunction	verifyListDoesNotContainPartialMatch(java.lang.String winname, java.lang.String compname, 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).
static ComponentFunction	verifyMenuItem(java.lang.String winname, java.lang.String compname, 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)
static ComponentFunction	verifyMenuPartialMatch(java.lang.String winname, java.lang.String compname, 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)
static ComponentFunction	verifyPartialMatch(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Verifies a particular case-insensitive item based on index is has as substring a particular value.
static ComponentFunction	verifyPartialMatch(java.lang.String winname, java.lang.String compname, java.lang.String index, java.lang.String textValue) Verifies a particular case-insensitive item based on index is has as substring a particular value.
static ComponentFunction	verifySelectedItem(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Verifies a particular case-sensitive text item is selected Verifies a particular case-sensitive text item is selected
static ComponentFunction	verifySelectedPartialMatch(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Verifies a particular case-sensitive item is selected based on a substring match.

Methods inherited from class java.lang.Object

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

Field Detail

ACTIVATEPARTIALMATCH_KEYWORD

public static final java.lang.String ACTIVATEPARTIALMATCH_KEYWORD

"ActivatePartialMatch"

See Also:

Constant Field Values

ACTIVATETEXTITEM_KEYWORD

public static final java.lang.String ACTIVATETEXTITEM_KEYWORD

"ActivateTextItem"

See Also:

Constant Field Values

ACTIVATEUNVERIFIEDPARTIALMATCH_KEYWORD

public static final java.lang.String ACTIVATEUNVERIFIEDPARTIALMATCH_KEYWORD

"ActivateUnverifiedPartialMatch"

See Also:

Constant Field Values

ACTIVATEUNVERIFIEDTEXTITEM_KEYWORD

public static final java.lang.String ACTIVATEUNVERIFIEDTEXTITEM_KEYWORD

"ActivateUnverifiedTextItem"

See Also:

Constant Field Values

CAPTUREITEMSTOFILE_KEYWORD

public static final java.lang.String CAPTUREITEMSTOFILE_KEYWORD

"CaptureItemsToFile"

See Also:

Constant Field Values

CLICKCOLUMNINDEX_KEYWORD

public static final java.lang.String CLICKCOLUMNINDEX_KEYWORD

"ClickColumnIndex"

See Also:

Constant Field Values

CLICKCOLUMNLABEL_KEYWORD

public static final java.lang.String CLICKCOLUMNLABEL_KEYWORD

"ClickColumnLabel"

See Also:

Constant Field Values

CLICKTEXTITEM_KEYWORD

public static final java.lang.String CLICKTEXTITEM_KEYWORD

"ClickTextItem"

See Also:

Constant Field Values

EXTENDSELECTIONTOTEXTITEM_KEYWORD

public static final java.lang.String EXTENDSELECTIONTOTEXTITEM_KEYWORD

"ExtendSelectionToTextItem"

See Also:

Constant Field Values

RIGHTCLICKTEXTITEM_KEYWORD

public static final java.lang.String RIGHTCLICKTEXTITEM_KEYWORD

"RightClickTextItem"

See Also:

Constant Field Values

SELECTANOTHERTEXTITEM_KEYWORD

public static final java.lang.String SELECTANOTHERTEXTITEM_KEYWORD

"SelectAnotherTextItem"

See Also:

Constant Field Values

SELECTANOTHERUNVERIFIEDTEXTITEM_KEYWORD

public static final java.lang.String SELECTANOTHERUNVERIFIEDTEXTITEM_KEYWORD

"SelectAnotherUnverifiedTextItem"

See Also:

Constant Field Values

SELECTINDEX_KEYWORD

public static final java.lang.String SELECTINDEX_KEYWORD

"SelectIndex"

See Also:

Constant Field Values

SELECTPARTIALMATCH_KEYWORD

public static final java.lang.String SELECTPARTIALMATCH_KEYWORD

"SelectPartialMatch"

See Also:

Constant Field Values

SELECTTEXTITEM_KEYWORD

public static final java.lang.String SELECTTEXTITEM_KEYWORD

"SelectTextItem"

See Also:

Constant Field Values

SELECTUNVERIFIEDANOTHERTEXTITEM_KEYWORD

public static final java.lang.String SELECTUNVERIFIEDANOTHERTEXTITEM_KEYWORD

"SelectUnverifiedAnotherTextItem"

See Also:

Constant Field Values

SELECTUNVERIFIEDPARTIALMATCH_KEYWORD

public static final java.lang.String SELECTUNVERIFIEDPARTIALMATCH_KEYWORD

"SelectUnverifiedPartialMatch"

See Also:

Constant Field Values

SELECTUNVERIFIEDTEXTITEM_KEYWORD

public static final java.lang.String SELECTUNVERIFIEDTEXTITEM_KEYWORD

"SelectUnverifiedTextItem"

See Also:

Constant Field Values

SETLISTCONTAINS_KEYWORD

public static final java.lang.String SETLISTCONTAINS_KEYWORD

"SetListContains"

See Also:

Constant Field Values

VERIFYITEM_KEYWORD

public static final java.lang.String VERIFYITEM_KEYWORD

"VerifyItem"

See Also:

Constant Field Values

VERIFYITEMUNSELECTED_KEYWORD

public static final java.lang.String VERIFYITEMUNSELECTED_KEYWORD

"VerifyItemUnselected"

See Also:

Constant Field Values

VERIFYLISTCONTAINS_KEYWORD

public static final java.lang.String VERIFYLISTCONTAINS_KEYWORD

"VerifyListContains"

See Also:

Constant Field Values

VERIFYLISTCONTAINSPARTIALMATCH_KEYWORD

public static final java.lang.String VERIFYLISTCONTAINSPARTIALMATCH_KEYWORD

"VerifyListContainsPartialMatch"

See Also:

Constant Field Values

VERIFYLISTDOESNOTCONTAIN_KEYWORD

public static final java.lang.String VERIFYLISTDOESNOTCONTAIN_KEYWORD

"VerifyListDoesNotContain"

See Also:

Constant Field Values

VERIFYLISTDOESNOTCONTAINPARTIALMATCH_KEYWORD

public static final java.lang.String VERIFYLISTDOESNOTCONTAINPARTIALMATCH_KEYWORD

"VerifyListDoesNotContainPartialMatch"

See Also:

Constant Field Values

VERIFYMENUITEM_KEYWORD

public static final java.lang.String VERIFYMENUITEM_KEYWORD

"VerifyMenuItem"

See Also:

Constant Field Values

VERIFYMENUPARTIALMATCH_KEYWORD

public static final java.lang.String VERIFYMENUPARTIALMATCH_KEYWORD

"VerifyMenuPartialMatch"

See Also:

Constant Field Values

VERIFYPARTIALMATCH_KEYWORD

public static final java.lang.String VERIFYPARTIALMATCH_KEYWORD

"VerifyPartialMatch"

See Also:

Constant Field Values

VERIFYSELECTEDITEM_KEYWORD

public static final java.lang.String VERIFYSELECTEDITEM_KEYWORD

"VerifySelectedItem"

See Also:

Constant Field Values

VERIFYSELECTEDPARTIALMATCH_KEYWORD

public static final java.lang.String VERIFYSELECTEDPARTIALMATCH_KEYWORD

"VerifySelectedPartialMatch"

See Also:

Constant Field Values

Method Detail

getInstance

public static ListBoxFunctions getInstance()

public Singleton to access class static methods via instance

activatePartialMatch

public static ComponentFunction activatePartialMatch(java.lang.String winname,
                                                     java.lang.String compname,
                                                     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:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive substring of node to DblClick and verify.

activateTextItem

public static ComponentFunction activateTextItem(java.lang.String winname,
                                                 java.lang.String compname,
                                                 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:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

activateUnverifiedPartialMatch

public static ComponentFunction activateUnverifiedPartialMatch(java.lang.String winname,
                                                               java.lang.String compname,
                                                               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:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive substring of node to DblClick.

activateUnverifiedTextItem

public static ComponentFunction activateUnverifiedTextItem(java.lang.String winname,
                                                           java.lang.String compname,
                                                           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:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive text of node to DblClick.

captureItemsToFile

public static ComponentFunction captureItemsToFile(java.lang.String winname,
                                                   java.lang.String compname,
                                                   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:

• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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 static ComponentFunction captureItemsToFile(java.lang.String winname,
                                                   java.lang.String compname,
                                                   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:

• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

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.

clickColumnIndex

public static ComponentFunction clickColumnIndex(java.lang.String winname,
                                                 java.lang.String compname,
                                                 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
                  

Supporting Engines:

• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

index - Optional:NO Index of the column header to click, starting from 1

clickColumnLabel

public static ComponentFunction clickColumnLabel(java.lang.String winname,
                                                 java.lang.String compname,
                                                 java.lang.String label)

 
                Click a column header based on it's label
               
                Click a column header based on it's label
                  

Supporting Engines:

• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

label - Optional:NO Label of the column header to click

clickTextItem

public static ComponentFunction clickTextItem(java.lang.String winname,
                                              java.lang.String compname,
                                              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:

• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

extendSelectionToTextItem

public static ComponentFunction extendSelectionToTextItem(java.lang.String winname,
                                                          java.lang.String compname,
                                                          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:

• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

rightClickTextItem

public static ComponentFunction rightClickTextItem(java.lang.String winname,
                                                   java.lang.String compname,
                                                   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:

• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive text of node to right-click on.

selectAnotherTextItem

public static ComponentFunction selectAnotherTextItem(java.lang.String winname,
                                                      java.lang.String compname,
                                                      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:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

selectAnotherUnverifiedTextItem

public static ComponentFunction selectAnotherUnverifiedTextItem(java.lang.String winname,
                                                                java.lang.String compname,
                                                                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:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

selectIndex

public static ComponentFunction selectIndex(java.lang.String winname,
                                            java.lang.String compname,
                                            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
                  

Supporting Engines:

• Rational RobotJ
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

index - Optional:NO Index of the text item to select, starting from 1

selectPartialMatch

public static ComponentFunction selectPartialMatch(java.lang.String winname,
                                                   java.lang.String compname,
                                                   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 SelectUnverifiedPartialMatch
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

selectTextItem

public static ComponentFunction selectTextItem(java.lang.String winname,
                                               java.lang.String compname,
                                               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:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

selectUnverifiedAnotherTextItem

public static ComponentFunction selectUnverifiedAnotherTextItem(java.lang.String winname,
                                                                java.lang.String compname,
                                                                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:

• Rational Robot

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

selectUnverifiedPartialMatch

public static ComponentFunction selectUnverifiedPartialMatch(java.lang.String winname,
                                                             java.lang.String compname,
                                                             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 SelectPartialMatch
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive substring of node to select.

selectUnverifiedTextItem

public static ComponentFunction selectUnverifiedTextItem(java.lang.String winname,
                                                         java.lang.String compname,
                                                         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:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

setListContains

public static ComponentFunction setListContains(java.lang.String winname,
                                                java.lang.String compname,
                                                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 RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

itemText - Optional:NO The case-sensitive name of the sought item.

resultVar - Optional:NO The name of the variable receiving the result.

setListContains

public static ComponentFunction setListContains(java.lang.String winname,
                                                java.lang.String compname,
                                                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 RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

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

verifyItem

public static ComponentFunction verifyItem(java.lang.String winname,
                                           java.lang.String compname,
                                           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:

• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

index - Optional:NO Index of the item in the list starting from 1

textValue - Optional:NO Case-sensitive string to compare to the text of the node at the index.

verifyItem

public static ComponentFunction verifyItem(java.lang.String winname,
                                           java.lang.String compname,
                                           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:

• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

index -- Optional:NO Index of the item in the list starting from 1
textValue -- Optional:NO Case-sensitive string to compare to the text of the node at the index.

verifyItemUnselected

public static ComponentFunction verifyItemUnselected(java.lang.String winname,
                                                     java.lang.String compname,
                                                     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:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

verifyListContains

public static ComponentFunction verifyListContains(java.lang.String winname,
                                                   java.lang.String compname,
                                                   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:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO String to look for in the list.

caseSensitive - Optional:YES Optional "True" for case-sensitive search

verifyListContains

public static ComponentFunction verifyListContains(java.lang.String winname,
                                                   java.lang.String compname,
                                                   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:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

textValue -- Optional:NO String to look for in the list.
caseSensitive -- Optional:YES Optional "True" for case-sensitive search

verifyListContainsPartialMatch

public static ComponentFunction verifyListContainsPartialMatch(java.lang.String winname,
                                                               java.lang.String compname,
                                                               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:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO SubString to look for in the list.

caseSensitive - Optional:YES Optional "True" for case-sensitive search

verifyListContainsPartialMatch

public static ComponentFunction verifyListContainsPartialMatch(java.lang.String winname,
                                                               java.lang.String compname,
                                                               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:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

textValue -- Optional:NO SubString to look for in the list.
caseSensitive -- Optional:YES Optional "True" for case-sensitive search

verifyListDoesNotContain

public static ComponentFunction verifyListDoesNotContain(java.lang.String winname,
                                                         java.lang.String compname,
                                                         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:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO String to look for in the list.

caseSensitive - Optional:YES Optional "True" for case-sensitive search

verifyListDoesNotContain

public static ComponentFunction verifyListDoesNotContain(java.lang.String winname,
                                                         java.lang.String compname,
                                                         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:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

textValue -- Optional:NO String to look for in the list.
caseSensitive -- Optional:YES Optional "True" for case-sensitive search

verifyListDoesNotContainPartialMatch

public static ComponentFunction verifyListDoesNotContainPartialMatch(java.lang.String winname,
                                                                     java.lang.String compname,
                                                                     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:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO SubString to look for in the list.

caseSensitive - Optional:YES Optional "True" for case-sensitive search

verifyListDoesNotContainPartialMatch

public static ComponentFunction verifyListDoesNotContainPartialMatch(java.lang.String winname,
                                                                     java.lang.String compname,
                                                                     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:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

textValue -- Optional:NO SubString to look for in the list.
caseSensitive -- Optional:YES Optional "True" for case-sensitive search

verifyMenuItem

public static ComponentFunction verifyMenuItem(java.lang.String winname,
                                               java.lang.String compname,
                                               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:

• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-sensitive string to compare to the text of any node in the list.

verifyMenuPartialMatch

public static ComponentFunction verifyMenuPartialMatch(java.lang.String winname,
                                                       java.lang.String compname,
                                                       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:

• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

textValue - Optional:NO Case-insensitive substring to compare to the text of any node in the list.

verifyPartialMatch

public static ComponentFunction verifyPartialMatch(java.lang.String winname,
                                                   java.lang.String compname,
                                                   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:

• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

index - Optional:NO Index of the item in the list starting from 1

textValue - Optional:NO Case-insensitive substring to compare to the text of the node at the index.

verifyPartialMatch

public static ComponentFunction verifyPartialMatch(java.lang.String winname,
                                                   java.lang.String compname,
                                                   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:

• Rational RobotJ

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

index -- Optional:NO Index of the item in the list starting from 1
textValue -- Optional:NO Case-insensitive substring to compare to the text of the node at the index.

verifySelectedItem

public static ComponentFunction verifySelectedItem(java.lang.String winname,
                                                   java.lang.String compname,
                                                   java.lang.String textValue)

 
                Verifies a particular case-sensitive text item is selected
               
                Verifies a particular case-sensitive text item is selected
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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

verifySelectedPartialMatch

public static ComponentFunction verifySelectedPartialMatch(java.lang.String winname,
                                                           java.lang.String compname,
                                                           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:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

winname - Optional:NO The name of the window to act upon.

compname - Optional:NO The name of the component to act upon.

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