org.safs.model.commands

Class PopupMenuFunctions

java.lang.Object

org.safs.model.commands.PopupMenuFunctions

public class PopupMenuFunctions
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SELECTPOPUPMENUID_KEYWORD "SelectPopupMenuID"
static java.lang.String	SELECTPOPUPMENUITEM_KEYWORD "SelectPopupMenuItem"
static java.lang.String	SELECTUNVERIFIEDPOPUPMENUITEM_KEYWORD "SelectUnverifiedPopupMenuItem"
static java.lang.String	VERIFYPOPUPMENU_KEYWORD "VerifyPopupMenu"
static java.lang.String	VERIFYPOPUPMENUID_KEYWORD "VerifyPopupMenuID"
static java.lang.String	VERIFYPOPUPMENUITEM_KEYWORD "VerifyPopupMenuItem"
static java.lang.String	VERIFYPOPUPMENUPARTIALMATCH_KEYWORD "VerifyPopupMenuPartialMatch"

Method Summary

Modifier and Type	Method and Description
static PopupMenuFunctions	getInstance() public Singleton to access class static methods via instance
static ComponentFunction	selectPopupMenuID(java.lang.String winname, java.lang.String compname, java.lang.String menuItemID) Select a menuItem via its menuID in the currently active popup menu.
static ComponentFunction	selectPopupMenuItem(java.lang.String winname, java.lang.String compname, java.lang.String menuItemText) Select a menuItem via its text in the currently active popup menu.
static ComponentFunction	selectUnverifiedPopupMenuItem(java.lang.String winname, java.lang.String compname, java.lang.String menuItemText) Select a menuItem via its text in the currently active popup menu without verification.
static ComponentFunction	verifyPopupMenu(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Verify the complete status of the current popup menu with a benchmark file.
static ComponentFunction	verifyPopupMenu(java.lang.String winname, java.lang.String compname, java.lang.String benchmarkFile, java.lang.String headerText, java.lang.String actualFile, java.lang.String diffFile) Verify the complete status of the current popup menu with a benchmark file.
static ComponentFunction	verifyPopupMenuID(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Verify the state of a menuItem via its menuID in the currently active popup menu.
static ComponentFunction	verifyPopupMenuID(java.lang.String winname, java.lang.String compname, java.lang.String menuItemID, java.lang.String stateInfo) Verify the state of a menuItem via its menuID in the currently active popup menu.
static ComponentFunction	verifyPopupMenuItem(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters) Verify the state of a menuItem found via its text in the currently active popup menu.
static ComponentFunction	verifyPopupMenuItem(java.lang.String winname, java.lang.String compname, java.lang.String menuItemText, java.lang.String stateInfo) Verify the state of a menuItem found via its text in the currently active popup menu.
static ComponentFunction	verifyPopupMenuPartialMatch(java.lang.String winname, java.lang.String compname, java.lang.String menuItemText) Verify if a menuItem contains a substring Verify if a menuItem contains a substring For Java popups: Valid recognition information for the Java window and "child" popup menu must be provided.

Methods inherited from class java.lang.Object

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

Field Detail

SELECTPOPUPMENUID_KEYWORD

public static final java.lang.String SELECTPOPUPMENUID_KEYWORD

"SelectPopupMenuID"

See Also:

Constant Field Values

SELECTPOPUPMENUITEM_KEYWORD

public static final java.lang.String SELECTPOPUPMENUITEM_KEYWORD

"SelectPopupMenuItem"

See Also:

Constant Field Values

SELECTUNVERIFIEDPOPUPMENUITEM_KEYWORD

public static final java.lang.String SELECTUNVERIFIEDPOPUPMENUITEM_KEYWORD

"SelectUnverifiedPopupMenuItem"

See Also:

Constant Field Values

VERIFYPOPUPMENU_KEYWORD

public static final java.lang.String VERIFYPOPUPMENU_KEYWORD

"VerifyPopupMenu"

See Also:

Constant Field Values

VERIFYPOPUPMENUID_KEYWORD

public static final java.lang.String VERIFYPOPUPMENUID_KEYWORD

"VerifyPopupMenuID"

See Also:

Constant Field Values

VERIFYPOPUPMENUITEM_KEYWORD

public static final java.lang.String VERIFYPOPUPMENUITEM_KEYWORD

"VerifyPopupMenuItem"

See Also:

Constant Field Values

VERIFYPOPUPMENUPARTIALMATCH_KEYWORD

public static final java.lang.String VERIFYPOPUPMENUPARTIALMATCH_KEYWORD

"VerifyPopupMenuPartialMatch"

See Also:

Constant Field Values

Method Detail

getInstance

public static PopupMenuFunctions getInstance()

public Singleton to access class static methods via instance

selectPopupMenuID

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

 
                Select a menuItem via its menuID in the currently active popup menu.
               
                Attempts to select a particular menuID in the currently 
                active popup menu.  This is generally used when the menuitem is a bitmap 
                or other item that does not have text.  This value can be retrieved from 
                the the menu by index or by manual lookup from a menu structure output 
                from MenuUtilities.
                
                The routine first verifies that the specified menuitem exists
                and exits with error if it does not.
                If it does exist then the selection proceeds.
                
                For RC and Win32 popups: The Window and Component references are not 
                used and can be anything.  They just cannot be blank.
                  

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.

menuItemID - Optional:NO The Windows menuID of the menuItem to select.

selectPopupMenuItem

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

 
                Select a menuItem via its text in the currently active popup menu.
               
                Attempts to select a particular text string menuitem in the currently 
                active popup menu.  The menuitem should be specified in the form 
                "Menu->Menu->MenuItem   CTRL+V" with the full text, spaces(if any), and 
                keyboard shortcut text (if any).  
                
                Ampersands preceding underlined characters are optional.
                The routine first verifies that the specified menuitem exists
                and exits with error if it does not.
                If it does exist then the selection proceeds using the MenuID retrieved
                from the found menuitem.
                
                For RC and Win32 popups: The Window and Component references are not 
                used and can be anything.  They just cannot be blank.
                
                For Java popups: Valid recognition information for the Java window and 
                "child" popup menu must be provided.
                
                Also refer to JavaMenuFunctions for support specific to Java menus and 
                popup menus.
                
                TC Note:Component can be the object who contains 'popup menu', or it
                can be the 'context menu' object.                 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• 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.

menuItemText - Optional:NO Menu->MenuItem hierarchy to the menuItem to select.

selectUnverifiedPopupMenuItem

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

 
                Select a menuItem via its text in the currently active popup menu without verification.
               
                Attempts to select a particular text string menuitem in the currently 
                active popup menu. This routine performs no verification prior to or
                following the selection.  This may cause a Rational error if the Popup
                Menu or selected menu item is not available. 
                The menuitem should be specified in the form 
                "Menu->Menu->MenuItem   CTRL+V" with the full text, spaces(if any), and 
                keyboard shortcut text (if any).
                
                Ampersands preceding underlined characters are optional.
                
                
                For RC and Win32 popups: The Window and Component references are not 
                used and can be anything.  They just cannot be blank.
                
                TC Note:Component can be the object who contains 'popup menu', or it
                can be the 'context menu' object. 
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• 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.

menuItemText - Optional:NO Menu->MenuItem hierarchy to the menuItem to select.

verifyPopupMenu

public static ComponentFunction verifyPopupMenu(java.lang.String winname,
                                                java.lang.String compname,
                                                java.lang.String benchmarkFile,
                                                java.lang.String headerText,
                                                java.lang.String actualFile,
                                                java.lang.String diffFile)

 
                Verify the complete status of the current popup menu with a benchmark file.
              
                Verify the complete status of the current popup menu with a benchmark file.
                Typically, benchmarks are stored in the Datapool\Bench directory.  
                In that event, only the filename.ext is needed.  There is currently 
                a limit of 32K allowed for this type of comparison.  
                The Window and Component objects are not validated and have no role.
                The Window and Component strings can be any text, but they cannot be blank.
                
                Due to the nature of the verification using a DOS file comparison, the popup 
                menu will no longer be present after the verification and must be reactivated 
                if additional popup menu activity is to occur.
                  

Supporting Engines:

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

benchmarkFile - Optional:NO The name.ext of the file used as the comparison benchmark.

headerText - Optional:YES DefaultVal: Optional descriptive header line of text to match with the benchmark.

actualFile - Optional:YES DefaultVal: The optional name.ext of the file used for the captured menu status.

diffFile - Optional:YES DefaultVal: The optional name.ext of the file used to contain the differences found.

verifyPopupMenu

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

 
                Verify the complete status of the current popup menu with a benchmark file.
              
                Verify the complete status of the current popup menu with a benchmark file.
                Typically, benchmarks are stored in the Datapool\Bench directory.  
                In that event, only the filename.ext is needed.  There is currently 
                a limit of 32K allowed for this type of comparison.  
                The Window and Component objects are not validated and have no role.
                The Window and Component strings can be any text, but they cannot be blank.
                
                Due to the nature of the verification using a DOS file comparison, the popup 
                menu will no longer be present after the verification and must be reactivated 
                if additional popup menu activity is to occur.
                  

Supporting Engines:

• Rational Robot
• 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:

benchmarkFile -- Optional:NO The name.ext of the file used as the comparison benchmark.
headerText -- Optional:YES DefaultVal: Optional descriptive header line of text to match with the benchmark.
actualFile -- Optional:YES DefaultVal: The optional name.ext of the file used for the captured menu status.
diffFile -- Optional:YES DefaultVal: The optional name.ext of the file used to contain the differences found.

verifyPopupMenuID

public static ComponentFunction verifyPopupMenuID(java.lang.String winname,
                                                  java.lang.String compname,
                                                  java.lang.String menuItemID,
                                                  java.lang.String stateInfo)

 
                Verify the state of a menuItem via its menuID in the currently active popup menu.
               
                Verify the state of a particular menuID in the currently 
                active popup menu.  This is generally used when the menuitem is a bitmap 
                or other item that does not have text.  This menuID can be retrieved from 
                the the menu by index or by manual lookup from a menu structure output 
                from MenuUtilities.
                
                The routine first verifies that the specified menuitem exists
                and exits with error if it does not.
                
                For RC and Win32 popups: The Window and Component references are not 
                used and can be anything.  They just cannot be blank.
                  

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.

menuItemID - Optional:NO The Windows menuID of the menuItem to verify.

stateInfo - Optional:NO Expected status string (or part thereof) to verify.

verifyPopupMenuID

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

 
                Verify the state of a menuItem via its menuID in the currently active popup menu.
               
                Verify the state of a particular menuID in the currently 
                active popup menu.  This is generally used when the menuitem is a bitmap 
                or other item that does not have text.  This menuID can be retrieved from 
                the the menu by index or by manual lookup from a menu structure output 
                from MenuUtilities.
                
                The routine first verifies that the specified menuitem exists
                and exits with error if it does not.
                
                For RC and Win32 popups: The Window and Component references are not 
                used and can be anything.  They just cannot be blank.
                  

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:

menuItemID -- Optional:NO The Windows menuID of the menuItem to verify.
stateInfo -- Optional:NO Expected status string (or part thereof) to verify.

verifyPopupMenuItem

public static ComponentFunction verifyPopupMenuItem(java.lang.String winname,
                                                    java.lang.String compname,
                                                    java.lang.String menuItemText,
                                                    java.lang.String stateInfo)

 
                Verify the state of a menuItem found via its text in the currently active popup menu.
               
                The menuitem should be specified in the form 
                "Menu->Menu->MenuItem   CTRL+V" with the full text, spaces(if any), and 
                keyboard shortcut text (if any).  
                
                Ampersands preceding underlined characters are optional.
                The routine first verifies that the specified menuitem exists
                and exits with error if it does not.
                
                For RC and Win32 popups: The Window and Component references are not 
                used and can be anything.  They just cannot be blank.
                
                For Java popups: Valid recognition information for the Java window and 
                "child" popup menu must be provided.
                
                Also refer to JavaMenuFunctions for support specific to Java menus and 
                popup menus.                
                  

Supporting Engines:

• Rational Robot
• 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 to the menuItem to verify.

stateInfo - Optional:NO Expected status string (or part thereof) to verify.

verifyPopupMenuItem

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

 
                Verify the state of a menuItem found via its text in the currently active popup menu.
               
                The menuitem should be specified in the form 
                "Menu->Menu->MenuItem   CTRL+V" with the full text, spaces(if any), and 
                keyboard shortcut text (if any).  
                
                Ampersands preceding underlined characters are optional.
                The routine first verifies that the specified menuitem exists
                and exits with error if it does not.
                
                For RC and Win32 popups: The Window and Component references are not 
                used and can be anything.  They just cannot be blank.
                
                For Java popups: Valid recognition information for the Java window and 
                "child" popup menu must be provided.
                
                Also refer to JavaMenuFunctions for support specific to Java menus and 
                popup menus.                
                  

Supporting Engines:

• Rational Robot
• 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 to the menuItem to verify.
stateInfo -- Optional:NO Expected status string (or part thereof) to verify.

verifyPopupMenuPartialMatch

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

 
                Verify if a menuItem contains a substring
               
                Verify if a menuItem contains a substring
                
                For Java popups: Valid recognition information for the Java window and 
                "child" popup menu must be provided.
                
                Also refer to JavaMenuFunctions for support specific to Java menus and 
                popup menus.                
                  

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 substring to the menuItem to search for.