org.safs.model.commands

Class ToolBarFunctions

java.lang.Object

org.safs.model.commands.ToolBarFunctions

public class ToolBarFunctions
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLICKBUTTON_KEYWORD "ClickButton"
static java.lang.String	CLICKBUTTONINDEX_KEYWORD "ClickButtonIndex"
static java.lang.String	CLICKBUTTONTEXT_KEYWORD "ClickButtonText"
static java.lang.String	CLICKBUTTONTOOLTIP_KEYWORD "ClickButtonTooltip"
static java.lang.String	CLICKUNVERIFIEDBUTTONID_KEYWORD "ClickUnverifiedButtonID"
static java.lang.String	CLICKUNVERIFIEDBUTTONTEXT_KEYWORD "ClickUnverifiedButtonText"
static java.lang.String	VERIFYBUTTONCLICKED_KEYWORD "VerifyButtonClicked"
static java.lang.String	VERIFYBUTTONCOUNT_KEYWORD "VerifyButtonCount"
static java.lang.String	VERIFYBUTTONTEXT_KEYWORD "VerifyButtonText"
static java.lang.String	VERIFYBUTTONUNCLICKED_KEYWORD "VerifyButtonUnClicked"

Method Summary

Modifier and Type	Method and Description
static ComponentFunction	clickButton(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Deprecated.
static ComponentFunction	clickButton(java.lang.String winname, java.lang.String compname, java.lang.String buttonTextValue, java.lang.String caseInsensitive) Deprecated.
static ComponentFunction	clickButtonIndex(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Click on the icon at a certain position on the ToolBar object, it is 1-based.
static ComponentFunction	clickButtonIndex(java.lang.String winname, java.lang.String compname, java.lang.String index, java.lang.String coordination) Click on the icon at a certain position on the ToolBar object, it is 1-based.
static ComponentFunction	clickButtonText(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Routine to Click on the specified Button.Key (Text) value.
static ComponentFunction	clickButtonText(java.lang.String winname, java.lang.String compname, java.lang.String buttonTextValue, java.lang.String caseInsensitive, java.lang.String coordination) Routine to Click on the specified Button.Key (Text) value.
static ComponentFunction	clickButtonTooltip(java.lang.String winname, java.lang.String compname, java.lang.String tooltip) Click on the icon whose tooltip equals to the provided parameter Click on the icon whose tooltip equals to the provided parameter
static ComponentFunction	clickUnverifiedButtonID(java.lang.String winname, java.lang.String compname, java.lang.String buttonID) Routine to select a toolbar button using it's ID.
static ComponentFunction	clickUnverifiedButtonText(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Routine to Click on the specified Button.Key (Text) value.
static ComponentFunction	clickUnverifiedButtonText(java.lang.String winname, java.lang.String compname, java.lang.String buttonTextValue, java.lang.String caseInsensitive, java.lang.String coordination) Routine to Click on the specified Button.Key (Text) value.
static ToolBarFunctions	getInstance() public Singleton to access class static methods via instance
static ComponentFunction	verifyButtonClicked(java.lang.String winname, java.lang.String compname, java.lang.String buttonTextValue) Verifies a particular case-sensitive button text item is selected Verifies a particular case-sensitive button text item is selected
static ComponentFunction	verifyButtonCount(java.lang.String winname, java.lang.String compname, java.lang.String buttonCount) Verifies a total button presents in the Toolbar.
static ComponentFunction	verifyButtonText(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Verifies a particular case-sensitive text (button.key) item exists Verifies a particular case-sensitive text (button.key) item exists
static ComponentFunction	verifyButtonText(java.lang.String winname, java.lang.String compname, java.lang.String buttonTextValue, java.lang.String caseInsensitive) Verifies a particular case-sensitive text (button.key) item exists Verifies a particular case-sensitive text (button.key) item exists
static ComponentFunction	verifyButtonUnClicked(java.lang.String winname, java.lang.String compname, java.lang.String buttonTextValue) Verifies a particular case-sensitive button text item is unselected Verifies a particular case-sensitive button text item is unselected

Methods inherited from class java.lang.Object

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

Field Detail

CLICKBUTTON_KEYWORD

public static final java.lang.String CLICKBUTTON_KEYWORD

"ClickButton"

See Also:

Constant Field Values

CLICKBUTTONINDEX_KEYWORD

public static final java.lang.String CLICKBUTTONINDEX_KEYWORD

"ClickButtonIndex"

See Also:

Constant Field Values

CLICKBUTTONTEXT_KEYWORD

public static final java.lang.String CLICKBUTTONTEXT_KEYWORD

"ClickButtonText"

See Also:

Constant Field Values

CLICKBUTTONTOOLTIP_KEYWORD

public static final java.lang.String CLICKBUTTONTOOLTIP_KEYWORD

"ClickButtonTooltip"

See Also:

Constant Field Values

CLICKUNVERIFIEDBUTTONID_KEYWORD

public static final java.lang.String CLICKUNVERIFIEDBUTTONID_KEYWORD

"ClickUnverifiedButtonID"

See Also:

Constant Field Values

CLICKUNVERIFIEDBUTTONTEXT_KEYWORD

public static final java.lang.String CLICKUNVERIFIEDBUTTONTEXT_KEYWORD

"ClickUnverifiedButtonText"

See Also:

Constant Field Values

VERIFYBUTTONCLICKED_KEYWORD

public static final java.lang.String VERIFYBUTTONCLICKED_KEYWORD

"VerifyButtonClicked"

See Also:

Constant Field Values

VERIFYBUTTONCOUNT_KEYWORD

public static final java.lang.String VERIFYBUTTONCOUNT_KEYWORD

"VerifyButtonCount"

See Also:

Constant Field Values

VERIFYBUTTONTEXT_KEYWORD

public static final java.lang.String VERIFYBUTTONTEXT_KEYWORD

"VerifyButtonText"

See Also:

Constant Field Values

VERIFYBUTTONUNCLICKED_KEYWORD

public static final java.lang.String VERIFYBUTTONUNCLICKED_KEYWORD

"VerifyButtonUnClicked"

See Also:

Constant Field Values

Method Detail

getInstance

public static ToolBarFunctions getInstance()

public Singleton to access class static methods via instance

clickButton

public static ComponentFunction clickButton(java.lang.String winname,
                                            java.lang.String compname,
                                            java.lang.String buttonTextValue,
                                            java.lang.String caseInsensitive)

 
                Deprecated.  Use ClickButtonText instead.
               
                Deprecated.  Use ClickButtonText instead.
                  

Supporting Engines:

• Rational Robot
• Automated QA TestComplete

Parameters:

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

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

buttonTextValue - Optional:NO Case-sensitive text of the toolbar button to select.

caseInsensitive - Optional:YES "1", "CaseInsensitive", or "Case-Insensitive" to match button text in a case-insensitive manner.

clickButton

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

 
                Deprecated.  Use ClickButtonText instead.
               
                Deprecated.  Use ClickButtonText instead.
                  

Supporting Engines:

• Rational Robot
• Automated QA TestComplete

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:

buttonTextValue -- Optional:NO Case-sensitive text of the toolbar button to select.
caseInsensitive -- Optional:YES "1", "CaseInsensitive", or "Case-Insensitive" to match button text in a case-insensitive manner.

clickButtonIndex

public static ComponentFunction clickButtonIndex(java.lang.String winname,
                                                 java.lang.String compname,
                                                 java.lang.String index,
                                                 java.lang.String coordination)

 
                Click on the icon at a certain position on the ToolBar object, it is 1-based.
               
                Click on the icon at a certain position on the ToolBar object, it is 1-based.
                  

Supporting Engines:

• Rational RobotJ
• Automated QA TestComplete

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 described which icon to be clicked in the toolbar.

coordination - Optional:YES A position within the toolbar button, the mouse will be click there. RJ Note: This parameter is special for RJ implementation.

clickButtonIndex

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

 
                Click on the icon at a certain position on the ToolBar object, it is 1-based.
               
                Click on the icon at a certain position on the ToolBar object, it is 1-based.
                  

Supporting Engines:

• Rational RobotJ
• Automated QA TestComplete

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 described which icon to be clicked in the toolbar.
coordination -- Optional:YES A position within the toolbar button, the mouse will be click there. RJ Note: This parameter is special for RJ implementation.

clickButtonText

public static ComponentFunction clickButtonText(java.lang.String winname,
                                                java.lang.String compname,
                                                java.lang.String buttonTextValue,
                                                java.lang.String caseInsensitive,
                                                java.lang.String coordination)

 
                Routine to Click on the specified Button.Key (Text) value.
               
                Routine to Click on the specified Button.Key (Text) value.  
                The user has an optional parameter to specify that the provided 
                text is case-insensitive.  The routine will also verify that the 
                button is in the clicked or selected state upon completion.
                Use ClickUnverifiedButtonText if this post-click verification should 
                be skipped.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Automated QA TestComplete

Parameters:

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

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

buttonTextValue - Optional:NO Case-sensitive text of the toolbar button to select.

caseInsensitive - Optional:YES "1", "CaseInsensitive", or "Case-Insensitive" to match button text in a case-insensitive manner.

coordination - Optional:YES A position within the toolbar button, the mouse will be click there. RJ Note: This parameter is special for RJ implementation.

clickButtonText

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

 
                Routine to Click on the specified Button.Key (Text) value.
               
                Routine to Click on the specified Button.Key (Text) value.  
                The user has an optional parameter to specify that the provided 
                text is case-insensitive.  The routine will also verify that the 
                button is in the clicked or selected state upon completion.
                Use ClickUnverifiedButtonText if this post-click verification should 
                be skipped.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Automated QA TestComplete

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:

buttonTextValue -- Optional:NO Case-sensitive text of the toolbar button to select.
caseInsensitive -- Optional:YES "1", "CaseInsensitive", or "Case-Insensitive" to match button text in a case-insensitive manner.
coordination -- Optional:YES A position within the toolbar button, the mouse will be click there. RJ Note: This parameter is special for RJ implementation.

clickButtonTooltip

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

 
                Click on the icon whose tooltip equals to the provided parameter
               
                Click on the icon whose tooltip equals to the provided parameter
                  

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.

tooltip - Optional:NO Tooltip is description of the icon on ToolBar.

clickUnverifiedButtonID

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

 
                Routine to select a toolbar button using it's ID.
               
                Routine to select a toolbar button using it's ID.
                  

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.

buttonID - Optional:NO ID for a particular button in the toolbar to select.

clickUnverifiedButtonText

public static ComponentFunction clickUnverifiedButtonText(java.lang.String winname,
                                                          java.lang.String compname,
                                                          java.lang.String buttonTextValue,
                                                          java.lang.String caseInsensitive,
                                                          java.lang.String coordination)

 
                Routine to Click on the specified Button.Key (Text) value.
               
                Routine to Click on the specified Button.Key (Text) value.
                The user has an optional parameter to specify that the provided 
                text is case-insensitive.  However, not all Toolbars and Buttons will be 
                able to support this case-insensitive capability.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Automated QA TestComplete

Parameters:

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

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

buttonTextValue - Optional:NO Case-sensitive text of the toolbar button to select.

caseInsensitive - Optional:YES "1", "CaseInsensitive", or "Case-Insensitive" to match button text in a case-insensitive manner.

coordination - Optional:YES A position within the toolbar button, the mouse will be click there. RJ Note: This parameter is special for RJ implementation.

clickUnverifiedButtonText

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

 
                Routine to Click on the specified Button.Key (Text) value.
               
                Routine to Click on the specified Button.Key (Text) value.
                The user has an optional parameter to specify that the provided 
                text is case-insensitive.  However, not all Toolbars and Buttons will be 
                able to support this case-insensitive capability.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Automated QA TestComplete

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:

buttonTextValue -- Optional:NO Case-sensitive text of the toolbar button to select.
caseInsensitive -- Optional:YES "1", "CaseInsensitive", or "Case-Insensitive" to match button text in a case-insensitive manner.
coordination -- Optional:YES A position within the toolbar button, the mouse will be click there. RJ Note: This parameter is special for RJ implementation.

verifyButtonClicked

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

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

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.

buttonTextValue - Optional:NO Case-sensitive text(Button.Key) of button that will be verified as clicked

verifyButtonCount

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

 
                Verifies a total button presents in the Toolbar.
               
                Verifies a total button presents in the Toolbar.  Count includes buttons which are not visible as well.
                  

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.

buttonCount - Optional:NO Numeric count value represents the total button counts in the Toolbar.

verifyButtonText

public static ComponentFunction verifyButtonText(java.lang.String winname,
                                                 java.lang.String compname,
                                                 java.lang.String buttonTextValue,
                                                 java.lang.String caseInsensitive)

 
                Verifies a particular case-sensitive text (button.key) item exists
               
                Verifies a particular case-sensitive text (button.key) item exists
                  

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.

buttonTextValue - Optional:NO Case-sensitive text (button.key) item that will be verified as exists

caseInsensitive - Optional:YES "1", "CaseInsensitive", or "Case-Insensitive" to match button text in a case-insensitive manner.

verifyButtonText

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

 
                Verifies a particular case-sensitive text (button.key) item exists
               
                Verifies a particular case-sensitive text (button.key) item exists
                  

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.

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

buttonTextValue -- Optional:NO Case-sensitive text (button.key) item that will be verified as exists
caseInsensitive -- Optional:YES "1", "CaseInsensitive", or "Case-Insensitive" to match button text in a case-insensitive manner.

verifyButtonUnClicked

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

 
                Verifies a particular case-sensitive button text item is unselected
               
                Verifies a particular case-sensitive button text item is unselected
                  

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.

buttonTextValue - Optional:NO Case-sensitive text(Button.Key) of button that will be verified as unselected