org.safs.model.commands

Class JavaMenuFunctions

java.lang.Object

org.safs.model.commands.JavaMenuFunctions

public class JavaMenuFunctions
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESETMENUCACHE_KEYWORD "ResetMenuCache"
static java.lang.String	SELECTMENUITEM_KEYWORD "SelectMenuItem"
static java.lang.String	SELECTMENUITEMCONTAINS_KEYWORD "SelectMenuItemContains"
static java.lang.String	SELECTUNVERIFIEDMENUITEM_KEYWORD "SelectUnverifiedMenuItem"
static java.lang.String	VERIFYMENUITEM_KEYWORD "VerifyMenuItem"
static java.lang.String	VERIFYMENUITEMCONTAINS_KEYWORD "VerifyMenuItemContains"

Method Summary

Modifier and Type	Method and Description
static JavaMenuFunctions	getInstance() public Singleton to access class static methods via instance
static ComponentFunction	resetMenuCache(java.lang.String winname, java.lang.String compname) Reset the cache containing the content of whole menu.
static ComponentFunction	selectMenuItem(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Action to select a menuItem according to its text value.
static ComponentFunction	selectMenuItem(java.lang.String winname, java.lang.String compname, java.lang.String textValue, java.lang.String indexPath) Action to select a menuItem according to its text value.
static ComponentFunction	selectMenuItemContains(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Action to select a menuItem according to a partial match of its text value.
static ComponentFunction	selectMenuItemContains(java.lang.String winname, java.lang.String compname, java.lang.String textValue, java.lang.String indexPath) Action to select a menuItem according to a partial match of its text value.
static ComponentFunction	selectUnverifiedMenuItem(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Action to select a menuItem according to its text value without verification of it's existance.
static ComponentFunction	selectUnverifiedMenuItem(java.lang.String winname, java.lang.String compname, java.lang.String textValue, java.lang.String indexPath) Action to select a menuItem according to its text value without verification of it's existance.
static ComponentFunction	verifyMenuItem(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to verify the a particular menuitem exists in a menu.
static ComponentFunction	verifyMenuItem(java.lang.String winname, java.lang.String compname, java.lang.String menuItemText, java.lang.String expectedStatus, java.lang.String indexPath) Attempts to verify the a particular menuitem exists in a menu.
static ComponentFunction	verifyMenuItemContains(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Attempts to verify the existence of a menuitem found by partial text match.
static ComponentFunction	verifyMenuItemContains(java.lang.String winname, java.lang.String compname, java.lang.String menuItemText, java.lang.String expectedStatus, java.lang.String indexPath) Attempts to verify the existence of a menuitem found by partial text match.

Methods inherited from class java.lang.Object

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

Field Detail

RESETMENUCACHE_KEYWORD

public static final java.lang.String RESETMENUCACHE_KEYWORD

"ResetMenuCache"

See Also:

Constant Field Values

SELECTMENUITEM_KEYWORD

public static final java.lang.String SELECTMENUITEM_KEYWORD

"SelectMenuItem"

See Also:

Constant Field Values

SELECTMENUITEMCONTAINS_KEYWORD

public static final java.lang.String SELECTMENUITEMCONTAINS_KEYWORD

"SelectMenuItemContains"

See Also:

Constant Field Values

SELECTUNVERIFIEDMENUITEM_KEYWORD

public static final java.lang.String SELECTUNVERIFIEDMENUITEM_KEYWORD

"SelectUnverifiedMenuItem"

See Also:

Constant Field Values

VERIFYMENUITEM_KEYWORD

public static final java.lang.String VERIFYMENUITEM_KEYWORD

"VerifyMenuItem"

See Also:

Constant Field Values

VERIFYMENUITEMCONTAINS_KEYWORD

public static final java.lang.String VERIFYMENUITEMCONTAINS_KEYWORD

"VerifyMenuItemContains"

See Also:

Constant Field Values

Method Detail

getInstance

public static JavaMenuFunctions getInstance()

public Singleton to access class static methods via instance

resetMenuCache

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

 
                 Reset the cache containing the content of whole menu.
               
                Reset the cache containing the content of whole menu.
                
                When we begin to manipulate a new menu, we should call this keyword to reset the cache.
                This cache is used for verification.
                
                  

Supporting Engines:

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

selectMenuItem

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

 
                 Action to select a menuItem according to its text value.
              
                 In RRAFS, this command will work on both JavaMenu items and JavaPopupMenu items.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Automated QA TestComplete
• 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:YES Case-sensitive text of menuItem to select OR an App Map reference.

indexPath - Optional:YES The index for item of each level. It is 1-based.

selectMenuItem

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

 
                 Action to select a menuItem according to its text value.
              
                 In RRAFS, this command will work on both JavaMenu items and JavaPopupMenu items.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Automated QA TestComplete
• 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:YES Case-sensitive text of menuItem to select OR an App Map reference.
indexPath -- Optional:YES The index for item of each level. It is 1-based.

selectMenuItemContains

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

 
                 Action to select a menuItem according to a partial match of its text value.
              
                 In RRAFS, this command will work on both JavaMenu items and JavaPopupMenu items.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Automated QA TestComplete
• 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:YES Case-insensitive substring of menuItem to select OR an App Map reference.

indexPath - Optional:YES The index for item of each level. It is 1-based.

selectMenuItemContains

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

 
                 Action to select a menuItem according to a partial match of its text value.
              
                 In RRAFS, this command will work on both JavaMenu items and JavaPopupMenu items.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Automated QA TestComplete
• 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:YES Case-insensitive substring of menuItem to select OR an App Map reference.
indexPath -- Optional:YES The index for item of each level. It is 1-based.

selectUnverifiedMenuItem

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

 
                 Action to select a menuItem according to its text value without verification of it's existance.
              
                                  Action to select a menuItem according to its text value without verification of it's existance.
                  

Supporting Engines:

• Rational RobotJ
• Automated QA TestComplete
• 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 menuItem to select OR an App Map reference.

indexPath - Optional:YES The index for item of each level. It is 1-based.

selectUnverifiedMenuItem

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

 
                 Action to select a menuItem according to its text value without verification of it's existance.
              
                                  Action to select a menuItem according to its text value without verification of it's existance.
                  

Supporting Engines:

• Rational RobotJ
• Automated QA TestComplete
• 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 Case-sensitive text of menuItem to select OR an App Map reference.
indexPath -- Optional:YES The index for item of each level. It is 1-based.

verifyMenuItem

public static ComponentFunction verifyMenuItem(java.lang.String winname,
                                               java.lang.String compname,
                                               java.lang.String menuItemText,
                                               java.lang.String expectedStatus,
                                               java.lang.String indexPath)

 
               Attempts to verify the a particular menuitem exists in a menu.
               
                The menuitem should be specified in the form 
                "Menu->Menu->MenuItem   CTRL+V" with the full text (ampersands optional), 
                spaces(if any), and keyboard shortcut text (if any).  
                (The ampersands precede any character in the menuitem that is underlined.)
                
                This command differs from the WindowFunction.VerifyMenuItem command because 
                here we are actually seeking a JavaMenu component, not a Window that contains 
                a menu.  Also, we do not currently verify any state information like the 
                WindowFunctions.VerifyMenuItem command.
                
                  

Supporting Engines:

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

menuItemText - Optional:NO Menu->MenuItem hierarchy string to identify which menuitem to find.

expectedStatus - Optional:YES Expected status string (or part thereof) of the menuitem.

indexPath - Optional:YES The index for item of each level. It is 1-based.

verifyMenuItem

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

 
               Attempts to verify the a particular menuitem exists in a menu.
               
                The menuitem should be specified in the form 
                "Menu->Menu->MenuItem   CTRL+V" with the full text (ampersands optional), 
                spaces(if any), and keyboard shortcut text (if any).  
                (The ampersands precede any character in the menuitem that is underlined.)
                
                This command differs from the WindowFunction.VerifyMenuItem command because 
                here we are actually seeking a JavaMenu component, not a Window that contains 
                a menu.  Also, we do not currently verify any state information like the 
                WindowFunctions.VerifyMenuItem command.
                
                  

Supporting Engines:

• Rational RobotJ
• Automated QA TestComplete
• 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:

menuItemText -- Optional:NO Menu->MenuItem hierarchy string to identify which menuitem to find.
expectedStatus -- Optional:YES Expected status string (or part thereof) of the menuitem.
indexPath -- Optional:YES The index for item of each level. It is 1-based.

verifyMenuItemContains

public static ComponentFunction verifyMenuItemContains(java.lang.String winname,
                                                       java.lang.String compname,
                                                       java.lang.String menuItemText,
                                                       java.lang.String expectedStatus,
                                                       java.lang.String indexPath)

 
               Attempts to verify the existence of a menuitem found by partial text match.
               
                Attempts to verify the existence of a menuitem found by partial text match.
                The menuitem should be specified in the form "Menu->Menu->MenuItem".  
                (Optional ampersands precede any character in the menuitem that is underlined.)
                
                This command differs from the WindowFunction.VerifyMenuItemContains command because 
                here we are actually seeking a JavaMenu component, not a Window that contains 
                a menu.  Also, we do not currently verify any state information like the 
                WindowFunctions.VerifyMenuItemContains command.
                
                  

Supporting Engines:

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

menuItemText - Optional:NO Menu->MenuItem hierarchy string to identify which menuitem to find.

expectedStatus - Optional:YES Expected status string (or part thereof) of the menuitem.

indexPath - Optional:YES The index for item of each level. It is 1-based.

verifyMenuItemContains

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

 
               Attempts to verify the existence of a menuitem found by partial text match.
               
                Attempts to verify the existence of a menuitem found by partial text match.
                The menuitem should be specified in the form "Menu->Menu->MenuItem".  
                (Optional ampersands precede any character in the menuitem that is underlined.)
                
                This command differs from the WindowFunction.VerifyMenuItemContains command because 
                here we are actually seeking a JavaMenu component, not a Window that contains 
                a menu.  Also, we do not currently verify any state information like the 
                WindowFunctions.VerifyMenuItemContains command.
                
                  

Supporting Engines:

• Rational RobotJ
• Automated QA TestComplete
• 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:

menuItemText -- Optional:NO Menu->MenuItem hierarchy string to identify which menuitem to find.
expectedStatus -- Optional:YES Expected status string (or part thereof) of the menuitem.
indexPath -- Optional:YES The index for item of each level. It is 1-based.