org.safs.model.commands

Class TabControlFunctions

java.lang.Object

org.safs.model.commands.TabControlFunctions

public class TabControlFunctions
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLICK_KEYWORD "Click"
static java.lang.String	CLICKTAB_KEYWORD "ClickTab"
static java.lang.String	CLICKTABCONTAINS_KEYWORD "ClickTabContains"
static java.lang.String	MAKESELECTION_KEYWORD "MakeSelection"
static java.lang.String	SELECTTAB_KEYWORD "SelectTab"
static java.lang.String	SELECTTABINDEX_KEYWORD "SelectTabIndex"
static java.lang.String	UNVERIFIEDCLICK_KEYWORD "UnverifiedClick"
static java.lang.String	UNVERIFIEDCLICKTAB_KEYWORD "UnverifiedClickTab"

Method Summary

Modifier and Type	Method and Description
static ComponentFunction	click(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Use ClickTab instead (where available).
static ComponentFunction	click(java.lang.String winname, java.lang.String compname, java.lang.String textValue, java.lang.String process) Use ClickTab instead (where available).
static ComponentFunction	clickTab(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Attempts to perform a standard Click on a particular Tab on the TabControl Attempts to perform a standard Click on a particular Tab on the TabControl.
static ComponentFunction	clickTabContains(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Attempts to perform a Click on a Tab according to a partial match of its text value.
static TabControlFunctions	getInstance() public Singleton to access class static methods via instance
static ComponentFunction	makeSelection(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Attempts to perform a standard Click on a particular Tab on the TabControl Attempts to perform a standard Click on a particular Tab on the TabControl.
static ComponentFunction	selectTab(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Attempts to perform a standard SelectTab on a particular Tab on the TabControl Attempts to perform a standard Selection on a particular Tab on the TabControl.
static ComponentFunction	selectTabIndex(java.lang.String winname, java.lang.String compname, java.lang.String tabIndex) Attempts to select a particular Tab by Index.
static ComponentFunction	unverifiedClick(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Use UnverifiedClickTab instead (where available).
static ComponentFunction	unverifiedClickTab(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Attempts to perform an unverified Click on a particular Tab on the TabControl Attempts to perform an unverified Click on a particular Tab on the TabControl.

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

CLICKTAB_KEYWORD

public static final java.lang.String CLICKTAB_KEYWORD

"ClickTab"

See Also:

Constant Field Values

CLICKTABCONTAINS_KEYWORD

public static final java.lang.String CLICKTABCONTAINS_KEYWORD

"ClickTabContains"

See Also:

Constant Field Values

MAKESELECTION_KEYWORD

public static final java.lang.String MAKESELECTION_KEYWORD

"MakeSelection"

See Also:

Constant Field Values

SELECTTAB_KEYWORD

public static final java.lang.String SELECTTAB_KEYWORD

"SelectTab"

See Also:

Constant Field Values

SELECTTABINDEX_KEYWORD

public static final java.lang.String SELECTTABINDEX_KEYWORD

"SelectTabIndex"

See Also:

Constant Field Values

UNVERIFIEDCLICK_KEYWORD

public static final java.lang.String UNVERIFIEDCLICK_KEYWORD

"UnverifiedClick"

See Also:

Constant Field Values

UNVERIFIEDCLICKTAB_KEYWORD

public static final java.lang.String UNVERIFIEDCLICKTAB_KEYWORD

"UnverifiedClickTab"

See Also:

Constant Field Values

Method Detail

getInstance

public static TabControlFunctions getInstance()

public Singleton to access class static methods via instance

click

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

 
                 Use ClickTab instead (where available).
               
                Attempts to perform a standard Click on a particular Tab on the TabControl.
                The routine will set the StepDriverTestInfo.statuscode and
                log any pass/warning/fail info using the StepDriverTestInfo.fac LogFacility.
                  

Supporting Engines:

• Mercury Interactive WinRunner

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* on the tab to identify which tab to click.

process - Optional:YES Indicator for unverified click.

click

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

 
                 Use ClickTab instead (where available).
               
                Attempts to perform a standard Click on a particular Tab on the TabControl.
                The routine will set the StepDriverTestInfo.statuscode and
                log any pass/warning/fail info using the StepDriverTestInfo.fac LogFacility.
                  

Supporting Engines:

• Mercury Interactive WinRunner

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 Case-sensitive text* on the tab to identify which tab to click.
process -- Optional:YES Indicator for unverified click.

clickTab

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

 
                 Attempts to perform a standard Click on a particular Tab on the TabControl
               
                Attempts to perform a standard Click on a particular Tab on the TabControl.
                The routine will set the StepDriverTestInfo.statuscode and
                log any pass/warning/fail info using the StepDriverTestInfo.fac LogFacility.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• Automated QA TestComplete
• Google Android
• 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 on the tab to identify which tab to click.

clickTabContains

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

 
                Attempts to perform a Click on a Tab according to a partial match of its text value.
               
                Attempts to perform a Click on a Tab according to a partial match of its text value.
                The routine will set the StepDriverTestInfo.statuscode and
                log any pass/warning/fail info using the StepDriverTestInfo.fac LogFacility.
                Note: this keyword used to be UnverifiedClickTabContains, and it was renamed on 01/26/2011 due to conflict.
                  

Supporting Engines:

• Rational RobotJ
• Automated QA TestComplete
• Google Android
• 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 Partial case-sensitive text on the tab to identify which tab to click.

makeSelection

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

 
                 Attempts to perform a standard Click on a particular Tab on the TabControl
               
                Attempts to perform a standard Click on a particular Tab on the TabControl.
                The routine will set the StepDriverTestInfo.statuscode and
                log any pass/warning/fail info using the StepDriverTestInfo.fac LogFacility.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• Automated QA TestComplete
• Google Android
• 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 on the tab to identify which tab to click.

selectTab

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

 
                 Attempts to perform a standard SelectTab on a particular Tab on the TabControl
               
                Attempts to perform a standard Selection on a particular Tab on the TabControl.
                The routine will set the StepDriverTestInfo.statuscode and
                log any pass/warning/fail info using the StepDriverTestInfo.fac LogFacility.
                Note, this routine will call the CLICK function to try 
                default CLICK processing if it is not able to locate all 
                the component properties it needs for success.
                This command has been provided for times when it might 
                work and the other TabControl CLICK alternatives do not.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• Automated QA TestComplete
• Google Android
• 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 on the tab to identify which tab to click.

selectTabIndex

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

 
                 Attempts to select a particular Tab by Index.
              
                Attempts to select a particular Tab by Index.
                The routine will set the StepDriverTestInfo.statuscode and
                log any pass/warning/fail info using the StepDriverTestInfo.fac LogFacility.
                
                For some engines, like Rational Robot, the user must know whether the indices of 
                the TabControl are 0-based or 1-based and use the raw index number.  
                
                
                For Rational Functional Tester we attempt to enforce that all indices are 
                1-based whenever possible.  Thus, the first tab would be specified as TabIndex=1 
                even if the control itself uses 0-based tab indices.
                
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Automated QA TestComplete
• Google Android
• 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.

tabIndex - Optional:NO Index of the tab to click.

unverifiedClick

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

 
                 Use UnverifiedClickTab instead (where available).
               
                Attempts to perform an unverified Click on a particular Tab on the TabControl.
                The routine will set the StepDriverTestInfo.statuscode and
                log any pass/warning/fail info using the StepDriverTestInfo.fac LogFacility.
                  

Supporting Engines:

• Mercury Interactive WinRunner

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* on the tab to identify which tab to click.

unverifiedClickTab

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

 
                 Attempts to perform an unverified Click on a particular Tab on the TabControl
               
                Attempts to perform an unverified Click on a particular Tab on the TabControl.
                The routine will set the StepDriverTestInfo.statuscode and
                log any pass/warning/fail info using the StepDriverTestInfo.fac LogFacility.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Automated QA TestComplete
• Google Android
• 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* on the tab to identify which tab to click.