org.safs

Class SAFSPlus.Menu

java.lang.Object

org.safs.SAFSPlus.Component

org.safs.SAFSPlus.Menu

Direct Known Subclasses:

SeleniumPlus.Menu

Enclosing class:

SAFSPlus

public static class SAFSPlus.Menu
extends SAFSPlus.Component

Wrapper class providing APIs to handle MenuBar/Menu keywords, like SelectMenuItem, VerifyMenuItemContains etc.

Constructor Summary

Constructors

Constructor and Description
Menu()

Method Summary

Modifier and Type	Method and Description
static boolean	SelectMenuItem(Component menu, java.lang.String path) Select a menuItem according to its text value.
static boolean	SelectMenuItem(Component menu, java.lang.String path, java.lang.String indexPath) Select a menuItem according to its text value, it will select the Nth matched item.
static boolean	SelectMenuItemContains(Component menu, java.lang.String path) Select a menuItem according to a partial match of its text value.
static boolean	SelectMenuItemContains(Component menu, java.lang.String path, java.lang.String indexPath) Select a menuItem according to a partial match of its text value, it will select the Nth matched item.
static boolean	SelectUnverifiedMenuItem(Component menu, java.lang.String path) Select a menuItem according to its text value, without verification of menuItem's existance.
static boolean	VerifyMenuItem(Component menu, java.lang.String path) Verify the existence of a menuItem according to its text value.
static boolean	VerifyMenuItem(Component menu, java.lang.String path, java.lang.String expectedStatus, java.lang.String indexPath) Verify the existence of a menuItem according to its text value, it will verify the Nth matched item.
static boolean	VerifyMenuItemContains(Component menu, java.lang.String path) Verify the existence of a menuItem found by partial text match.
static boolean	VerifyMenuItemContains(Component menu, java.lang.String path, java.lang.String expectedStatus, java.lang.String indexPath) Verify the existence of a menuItem found by partial text match, it will verify the Nth matched item.

Methods inherited from class org.safs.SAFSPlus.Component

AltClick, AltLeftDrag, AssignPropertyVariable, CaptureObjectDataToFile, CapturePropertiesToFile, CapturePropertyToFile, ClearCache, Click, CtrlAltLeftDrag, CtrlClick, CtrlLeftDrag, CtrlRightClick, CtrlShiftLeftDrag, DoubleClick, DragTo, ExecuteScript, GetComputedStyle, GetGUIImage, GetTextFromGUI, GUIDoesExist, GUIDoesNotExist, HoverMouse, HoverScreenLocation, InputCharacters, InputKeys, IsPropertyExist, IsPropertyExist, LeftDrag, LocateScreenImage, RightClick, RightDrag, SaveTextFromGUI, ShiftClick, ShiftLeftDrag, ShowOnPage, TypeChars, TypeEncryption, TypeKeys, VerifyBinaryFileToFile, VerifyComputedStyle, VerifyFileToFile, VerifyGUIImageToFile, VerifyObjectDataToFile, VerifyPropertiesSubsetToFile, VerifyPropertiesToFile, VerifyProperty, VerifyPropertyContains, VerifyPropertyContains, VerifyPropertyToFile, VerifyTextFileToFile, VerifyValueContains, VerifyValueContainsIgnoreCase, VerifyValueDoesNotContain, VerifyValues, VerifyValuesIgnoreCase, VerifyValuesNotEqual

Methods inherited from class java.lang.Object

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

Constructor Detail

Menu

public Menu()

Method Detail

SelectMenuItem

public static boolean SelectMenuItem(Component menu,
                                     java.lang.String path)

Select a menuItem according to its text value.

See Detailed Reference

Parameters:

menu - Component (from App Map) to select an item from.

path - String, the path of the item to select

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = Menu.SelectMenuItem(Map.SAPDemo.MenuBar,"Root->child");
 
 

SelectUnverifiedMenuItem

public static boolean SelectUnverifiedMenuItem(Component menu,
                                               java.lang.String path)

Select a menuItem according to its text value, without verification of menuItem's existance.

See Detailed Reference

Parameters:

menu - Component (from App Map) to select an item from.

path - String, the path of the item to select

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = Menu.SelectUnverifiedMenuItem(Map.SAPDemo.MenuBar,"Root->child");
 
 

SelectMenuItem

public static boolean SelectMenuItem(Component menu,
                                     java.lang.String path,
                                     java.lang.String indexPath)

Select a menuItem according to its text value, it will select the Nth matched item.

See Detailed Reference

Parameters:

menu - Component (from App Map) to select an item from.

path - String, the path of the item to select.

indexPath - String, the index path for Nth matched item of each level.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 //select the 3th item matching "child" under the 2th item matching "Root"
 boolean success = Menu.SelectMenuItem(Map.SAPDemo.MenuBar,"Root->child", "2->3");
 
 

SelectMenuItemContains

public static boolean SelectMenuItemContains(Component menu,
                                             java.lang.String path)

Select a menuItem according to a partial match of its text value.

See Detailed Reference

Parameters:

menu - Component (from App Map) to select an item from.

path - String, the path of the item to select

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = Menu.SelectMenuItemContains(Map.SAPDemo.MenuBar,"Root->child");
 
 

SelectMenuItemContains

public static boolean SelectMenuItemContains(Component menu,
                                             java.lang.String path,
                                             java.lang.String indexPath)

Select a menuItem according to a partial match of its text value, it will select the Nth matched item.

See Detailed Reference

Parameters:

menu - Component (from App Map) to select an item from.

path - String, the path of the item to select.

indexPath - String, the index path for Nth matched item of each level.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 //select the 3th item matching "child" under the 2th item matching "Root"
 boolean success = Menu.SelectMenuItemContains(Map.SAPDemo.MenuBar,"Root->child", "2->3");
 
 

VerifyMenuItem

public static boolean VerifyMenuItem(Component menu,
                                     java.lang.String path)

Verify the existence of a menuItem according to its text value.

See Detailed Reference

Parameters:

menu - Component (from App Map) to verify an item from.

path - String, the path of the item to verify

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = Menu.VerifyMenuItem(Map.SAPDemo.MenuBar,"Root->child");
 
 

VerifyMenuItem

public static boolean VerifyMenuItem(Component menu,
                                     java.lang.String path,
                                     java.lang.String expectedStatus,
                                     java.lang.String indexPath)

Verify the existence of a menuItem according to its text value, it will verify the Nth matched item.

See Detailed Reference

Parameters:

menu - Component (from App Map) to verify an item from.

path - String, the path of the item to verify.

expectedStatus - String, the status of the item to verify.

indexPath - String, the index path for Nth matched item of each level.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 //verify the first matched "Root->child" is enabled
 boolean success = Menu.VerifyMenuItem(Map.SAPDemo.MenuBar,"Root->child", "Enabled", "");
 //verify the 3th matched "child" under 2th matched "Root" exists
 boolean success = Menu.VerifyMenuItem(Map.SAPDemo.MenuBar,"Root->child", "", "2->3");
 //verify the 3th matched "child" under 2th matched "Root" is enabled and it has 4 children.
 boolean success = Menu.VerifyMenuItem(Map.SAPDemo.MenuBar,"Root->child", "Enabled Menu With 4 MenuItems", "2->3");
 
 

VerifyMenuItemContains

public static boolean VerifyMenuItemContains(Component menu,
                                             java.lang.String path)

Verify the existence of a menuItem found by partial text match.

See Detailed Reference

Parameters:

menu - Component (from App Map) to verify an item from.

path - String, the path of the item to verify

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 boolean success = Menu.VerifyMenuItemContains(Map.SAPDemo.MenuBar,"Roo->ild");
 
 

VerifyMenuItemContains

public static boolean VerifyMenuItemContains(Component menu,
                                             java.lang.String path,
                                             java.lang.String expectedStatus,
                                             java.lang.String indexPath)

Verify the existence of a menuItem found by partial text match, it will verify the Nth matched item.

See Detailed Reference

Parameters:

menu - Component (from App Map) to verify an item from.

path - String, the path of the item to verify.

expectedStatus - String, the status of the item to verify.

indexPath - String, the index path for Nth matched item of each level.

Returns:

true if successful, false otherwise.

See Also:

SAFSPlus.prevResults, TestRecordData.getStatusCode(), TestRecordData.getStatusInfo()

Example:

 
 //verify the first matched "Root->child" is enabled
 boolean success = Menu.VerifyMenuItemContains(Map.SAPDemo.MenuBar,"Root->child", "Enabled", "");
 //verify the 3th matched "child" under 2th matched "Root" exists
 boolean success = Menu.VerifyMenuItemContains(Map.SAPDemo.MenuBar,"Root->child", "", "2->3");
 //verify the 3th matched "child" under 2th matched "Root" is enabled and it has 4 children.
 boolean success = Menu.VerifyMenuItemContains(Map.SAPDemo.MenuBar,"Root->child", "Enabled Menu With 4 MenuItems", "2->3");