org.safs.model.commands

Class DotNetMenuFunctions

java.lang.Object

org.safs.model.commands.DotNetMenuFunctions

public class DotNetMenuFunctions
extends java.lang.Object

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
static DotNetMenuFunctions	getInstance() public Singleton to access class static methods via instance
static ComponentFunction	selectMenuItem(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to select a menuItem according to its text value.
static ComponentFunction	selectMenuItemContains(java.lang.String winname, java.lang.String compname, java.lang.String textValue) Action to select a menuItem according to a partial match of its text value.
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) 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) 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

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

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 DotNetMenuFunctions getInstance()

public Singleton to access class static methods via instance

selectMenuItem

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

 
                 Action to select a menuItem according to its text value.
              
                 In RRAFS, this command will work on both JavaMenu items and 
                 JavaPopupMenu items.
                                 For RJ implementation: When Field5 is provided,
                                                                        the routine first verifies that the specified menuitem exists and exits with error if it does not. 
                                                                        If it does exist then the select found menuitem. 
                  

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:YES Case-insensitive text of menuItem to select OR an App Map reference.

selectMenuItemContains

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

 
                 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.
                                 For RJ implementation: When Field5 is provided,
                                                                        the routine first verifies that the specified menuitem exists and exits with error if it does not. 
                                                                        If it does exist then the select found menuitem. 
                  

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:YES Case-insensitive substring of menuItem to select OR an App Map reference.

verifyMenuItem

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

 
               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

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.

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

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.

verifyMenuItemContains

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

 
               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

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.

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

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.