org.safs.model.commands

Class ComboEditBoxFunctions

java.lang.Object

org.safs.model.commands.ComboEditBoxFunctions

public class ComboEditBoxFunctions
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLICK_KEYWORD "Click"
static java.lang.String	SELECT_KEYWORD "Select"
static java.lang.String	SELECTINDEX_KEYWORD "SelectIndex"
static java.lang.String	SELECTPARTIALMATCH_KEYWORD "SelectPartialMatch"
static java.lang.String	SETTEXTVALUE_KEYWORD "SetTextValue"
static java.lang.String	SETUNVERIFIEDTEXTVALUE_KEYWORD "SetUnverifiedTextValue"

Method Summary

Modifier and Type	Method and Description
static ComponentFunction	click(java.lang.String winname, java.lang.String compname) Defaults to Generic CLICK where applicable.
static ComboEditBoxFunctions	getInstance() public Singleton to access class static methods via instance
static ComponentFunction	select(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Select an item by its text value from a ComboEditBox.
static ComponentFunction	selectIndex(java.lang.String winname, java.lang.String compname, java.lang.String indexValue) Select an item by its index from a ComboEditBox (ComboBox).
static ComponentFunction	selectPartialMatch(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Select an item via a partial text match.
static ComponentFunction	setTextValue(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Set the text of the ComboEditBox This action sets the text of the ComboEditBox.
static ComponentFunction	setUnverifiedTextValue(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Set the text of the ComboEditBox without verification This action sets the text of the ComboEditBox.

Methods inherited from class java.lang.Object

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

Field Detail

CLICK_KEYWORD

public static final java.lang.String CLICK_KEYWORD

"Click"

See Also:

Constant Field Values

SELECT_KEYWORD

public static final java.lang.String SELECT_KEYWORD

"Select"

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

SETTEXTVALUE_KEYWORD

public static final java.lang.String SETTEXTVALUE_KEYWORD

"SetTextValue"

See Also:

Constant Field Values

SETUNVERIFIEDTEXTVALUE_KEYWORD

public static final java.lang.String SETUNVERIFIEDTEXTVALUE_KEYWORD

"SetUnverifiedTextValue"

See Also:

Constant Field Values

Method Detail

getInstance

public static ComboEditBoxFunctions getInstance()

public Singleton to access class static methods via instance

click

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

 
                 Defaults to Generic CLICK where applicable.
               
                Attempts to perform a standard Click on the ComboEditBox.  If the ComboEditBox 
                list is not exposed then this may expose the list of items.  If the
                list is already exposed, then this may close the list.  It may also just provide 
                focus to the ComboEditBox.
                  
                It must be noted that when you expose the list in a ComboEditBox, it is no 
                longer a ComboEditBox.  It typically converts to a ComboListBox.  This may 
                not be an issue on controls that Robot can recognize with a NAME= method. 
                
                However, if the control is recognized by ObjectIndex or some other means 
                then the original ComboEditBox may no longer be found on the screen. 
                With this scenario, you need to reference the ComboEditBox and the ComboListBox
                in the application map (and associated data files) as two separate items.
                
                To avoid these potential problems, use the ComboEditBox 'SELECT' command 
                to actually open the list and select the item all with a single command.
                  

Supporting Engines:

• Mercury Interactive WinRunner
• AutomatedQA TestComplete

Parameters:

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

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

select

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

 
                 Select an item by its text value from a ComboEditBox.
               
                Select an item by its text value from a ComboEditBox.  
                This method combines the initial Click required to expose the list 
                of items and then the subsequent selection of a text item from the list.
                
                The routine will first attempt to see if the item exists in the list 
                and should provide a warning if it cannot find the item or cannot 
                read the list of items.  The routine will then attempt the selection.
                
                After the selection is attempted, the routine tries to verify that the 
                list has the specified item as the selected item.  A warning will be 
                issued if the routine cannot read the list.  A failure will be issued 
                if the routine CAN read the list and determines that the specified 
                item is NOT the currently selected item.
                  

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• AutomatedQA TestComplete

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 The case-sensitive item in the drop down list to select.

selectIndex

public static ComponentFunction selectIndex(java.lang.String winname,
                                            java.lang.String compname,
                                            java.lang.String indexValue)

 
                 Select an item by its index from a ComboEditBox (ComboBox).
               
                Select an item by its index from a ComboEditBox (ComboBox).  
                This method combines the initial Click required to expose the list 
                of items and then the subsequent selection of the item from the list.
                
                The routine will first attempt to see if the index exists in the list 
                and should provide a warning if it cannot find the item or cannot 
                read the list of items.  The routine will then attempt the selection.
                  

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• AutomatedQA TestComplete

Parameters:

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

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

indexValue - Optional:NO The item index in the drop down list to select.

selectPartialMatch

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

 
                 Select an item via a partial text match.
               
                Select an item via a partial text match.
                This method combines the initial Click required to expose the list 
                of items and then the subsequent selection of a text item from the list.
                
                The routine will first attempt to see if the item exists in the list 
                and should provide a warning if it cannot find the item or cannot 
                read the list of items.  The routine will then attempt the selection.
                
                After the selection is attempted, the routine tries to verify that the 
                list has the specified item as the selected item.  A warning will be 
                issued if the routine cannot read the list.  A failure will be issued 
                if the routine CAN read the list and determines that the specified 
                item is NOT the currently selected item.
                  

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• AutomatedQA TestComplete

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 The case-sensitive substring of an item in the drop down list to select.

setTextValue

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

 
            Set the text of the ComboEditBox
               
                This action sets the text of the ComboEditBox.  This version allows the use 
                of special character combinations and substrings to identify specific 
                keyboard keys.  These are the same special characters and interpretation 
                used for Robot's InputKeys command and the Windows Scripting Host.
                
                ~^+%{( are primarily the characters that induce special processing.
                
                The routine verifies we can read the text property, sets the text value 
                and will verify that the property has been set to that value *IF* none 
                of the special characters exist in the provided text value.  If those 
                special characters exist, then no post-set verification will occur.
                  

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• AutomatedQA TestComplete

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:YES DefaultVal: The text that will be typed into the ComboEditBox.

setUnverifiedTextValue

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

 
            Set the text of the ComboEditBox without verification
               
                This action sets the text of the ComboEditBox.  This version allows the use 
                of special character combinations and substrings to identify specific 
                keyboard keys.  These are the same special characters and interpretation 
                used for Robot's InputKeys command and the Windows Scripting Host.
                
                ~^+%{( are primarily the characters that induce special processing.
                
                The routine verifies we can read the text property, sets the text value 
                but does not verify that the property has been set to that value and does not verify whether
                or not any of the special characters exist in the provided text value.
                

                  

Supporting Engines:

• Rational Robot
• AutomatedQA TestComplete

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:YES DefaultVal: The text that will be typed into the ComboEditBox.