org.safs.selenium.webdriver.lib

Class Menu

java.lang.Object

org.safs.selenium.webdriver.lib.model.DefaultRefreshable

org.safs.selenium.webdriver.lib.Component

org.safs.selenium.webdriver.lib.Menu

All Implemented Interfaces:

IHierarchicalSelectable, IMenuSelectable, IOperable, IRefreshable, ISelectable, IWebAccessibleInternetRole

public class Menu
extends Component
implements IMenuSelectable

A library class to handle different specific Menu.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	Menu.DefaultSelectable_Menu
static class	Menu.SapSelectable_Menu
static class	Menu.SAS_HC_PushMenu

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HOME_KEY "SAS_PushMenu_GoHome_SAS" The path to trigger 'go home' event of SAS_HC_PushMenu
(package private) IMenuSelectable	menuSelectable

Fields inherited from class org.safs.selenium.webdriver.lib.Component

accessible, anOperableObject, ATTRIBUTE_CLASS, ATTRIBUTE_DIJITPOPUPPARENT, ATTRIBUTE_ID, ATTRIBUTE_INDEX, ATTRIBUTE_MULTIPLE, ATTRIBUTE_NAME, ATTRIBUTE_TEXT, ATTRIBUTE_TYPE, ATTRIBUTE_VALUE, ATTRIBUTE_VISIBILITY, ATTRIBUTE_WIDGETID, delayGetContent, dijitpopupparent, operableObjects, TAG_HTML_INPUT, TAG_HTML_SELECT, VALUE_CHECKBOX_ATTRIBUTE_TYPE, VALUE_PASSWORD_ATTRIBUTE_TYPE, VALUE_RADIO_ATTRIBUTE_TYPE, VALUE_SUBMIT_ATTRIBUTE_TYPE, VALUE_TEXT_ATTRIBUTE_TYPE, VALUE_VISIBILITY_HIDDEN, VALUE_VISIBILITY_VISIBLE, waiRole, widgetid

Fields inherited from class org.safs.selenium.webdriver.lib.model.DefaultRefreshable

cssClass, id, map, object, possibleRecognitionStrings, searchContext, tagName, webelement

Fields inherited from interface org.safs.selenium.webdriver.lib.model.IWebAccessibleInternetRole

ATTRIBUTE_ARIA_ACTIVEDDESCENDANT, ATTRIBUTE_ARIA_ATOMIC, ATTRIBUTE_ARIA_AUTOCOMPLETE, ATTRIBUTE_ARIA_BUSY, ATTRIBUTE_ARIA_CHECKED, ATTRIBUTE_ARIA_CONTROLS, ATTRIBUTE_ARIA_DESCRIBEDBY, ATTRIBUTE_ARIA_DISABLED, ATTRIBUTE_ARIA_DRIPEFFECT, ATTRIBUTE_ARIA_EXPANDED, ATTRIBUTE_ARIA_FLOWTO, ATTRIBUTE_ARIA_GRABBED, ATTRIBUTE_ARIA_HASPOPUP, ATTRIBUTE_ARIA_HIDDEN, ATTRIBUTE_ARIA_INVALID, ATTRIBUTE_ARIA_LABEL, ATTRIBUTE_ARIA_LABELDEBY, ATTRIBUTE_ARIA_LEVEL, ATTRIBUTE_ARIA_LIVE, ATTRIBUTE_ARIA_MULTISELECTABLE, ATTRIBUTE_ARIA_ORIENTATION, ATTRIBUTE_ARIA_OWNS, ATTRIBUTE_ARIA_POSINSET, ATTRIBUTE_ARIA_PRESSED, ATTRIBUTE_ARIA_READONLY, ATTRIBUTE_ARIA_RELEVANT, ATTRIBUTE_ARIA_REQUIRED, ATTRIBUTE_ARIA_SELECTED, ATTRIBUTE_ARIA_SETSIZE, ATTRIBUTE_ARIA_SORT, ATTRIBUTE_ARIA_VALUEMAX, ATTRIBUTE_ARIA_VALUEMIN, ATTRIBUTE_ARIA_VALUENOW, ATTRIBUTE_ARIA_VALUETEXT, ATTRIBUTE_WAI_ROLE, WAI_ROLE_ALERT, WAI_ROLE_ALERTDIALOG, WAI_ROLE_APPLICATION, WAI_ROLE_ARTICLE, WAI_ROLE_BANNER, WAI_ROLE_BUTTON, WAI_ROLE_CHECKBOX, WAI_ROLE_COLUMNHEADER, WAI_ROLE_COMBOBOX, WAI_ROLE_COMPLEMENTARY, WAI_ROLE_CONTENTINFO, WAI_ROLE_DEFINITION, WAI_ROLE_DIALOG, WAI_ROLE_DIRECTORY, WAI_ROLE_DOCUMENT, WAI_ROLE_FORM, WAI_ROLE_GRID, WAI_ROLE_GRIDCELL, WAI_ROLE_GROUP, WAI_ROLE_HEADING, WAI_ROLE_IMG, WAI_ROLE_LINK, WAI_ROLE_LIST, WAI_ROLE_LISTBOX, WAI_ROLE_LISTITEM, WAI_ROLE_LOG, WAI_ROLE_MAIN, WAI_ROLE_MARQUEE, WAI_ROLE_MATH, WAI_ROLE_MENU, WAI_ROLE_MENUBAR, WAI_ROLE_MENUITEM, WAI_ROLE_MENUITEMCHECKBOX, WAI_ROLE_MENUITEMRADIO, WAI_ROLE_NAVIGATION, WAI_ROLE_NOTE, WAI_ROLE_OPTION, WAI_ROLE_PRESENTATION, WAI_ROLE_PROGRESSBAR, WAI_ROLE_RADIO, WAI_ROLE_RADIOGROUP, WAI_ROLE_REGION, WAI_ROLE_ROW, WAI_ROLE_ROWGROUP, WAI_ROLE_ROWHEADER, WAI_ROLE_SCROLLBAR, WAI_ROLE_SEARCH, WAI_ROLE_SEPARATOR, WAI_ROLE_SLIDER, WAI_ROLE_SPINBUTTON, WAI_ROLE_STATUS, WAI_ROLE_TAB, WAI_ROLE_TABLIST, WAI_ROLE_TABPANEL, WAI_ROLE_TEXTBOX, WAI_ROLE_TIMER, WAI_ROLE_TOOLBAR, WAI_ROLE_TOOLTIP, WAI_ROLE_TREE, WAI_ROLE_TREEGRID, WAI_ROLE_TREEITEM

Constructor Summary

Constructors

Constructor and Description
Menu(org.openqa.selenium.WebElement menubar)

Method Summary

Modifier and Type	Method and Description
void	activateItem(int index, boolean verify, org.openqa.selenium.Keys key, java.awt.Point offset) Try to activate (double-click) the item according to the index, and then verify if the item has been really selected according to the parameter 'verify'.
void	activateItem(TextMatchingCriterion criterion, boolean verify, org.openqa.selenium.Keys key, java.awt.Point offset) Try to activate (double-click) the item according to the item's text (fully or partially given), and then verify if the item has been really selected according to the parameter 'verify'.
protected void	castOperable() Cast the IOperable object to the specific one. The subclasses will override this method as they know what specific Operable to use. Here a void implementation is given, as not all subclass need the specific Operable, such as EditBox. Cast may throw Exception, we should catch it if calling this method. This method should be called after Component.anOperableObject has been initialized.
protected IOperable	createDefaultOperable() Create the default IOperable object for a certain specific component. It is different from the Component.createGenericOperable(), which will provide an IOperable to support the minimal generic functionalities, like GetGUIImage, Click, HoverMouse etc. Subclass COULD override this method to provide a default backup IOperable when other ways fail to create IOperable.
protected IOperable	createSAPOperable() Create the IOperable object for SAP domain. Subclass SHOULD override this method if SAP will be supported.
MenuItem[]	getContent() Get all items withing a Menu.
MenuItem	getMatchedElement(TextMatchingCriterion criterion) According to a certain 'search condition', get the matched subitem within this Component. This method just return a null.
static boolean	isNodeSelected(org.openqa.selenium.WebElement menuitem)
static java.lang.String	parseNodeText(org.openqa.selenium.WebElement menuitem) TODO adjust for MenuItem For menuitem, WebElement.getText() may return also the text of its children. These text are separated by '\n', this method tries to get the text before the first '\n', which should be text of this tree node.
void	selectItem(int index, boolean verify, org.openqa.selenium.Keys key, java.awt.Point offset, int mouseButtonNumber) Try to select (single-click) the item according to the index, and then verify if the item has been really selected according to the parameter 'verify'.
void	selectItem(TextMatchingCriterion criterion, boolean verify, org.openqa.selenium.Keys key, java.awt.Point offset, int mouseButtonNumber) Try to select (single-click) the item according to the item's text (fully or partially given), and then verify if the item has been really selected according to the parameter 'verify'.
void	verifyContains(TextMatchingCriterion criterion) Verify the item (specified by text, partialMatch and matchIndex) is contained.
void	verifyItemSelection(int index, boolean expectSelected) Verify the item (specified by index) is selected or un-selected.
void	verifyItemSelection(TextMatchingCriterion criterion, boolean expectSelected) Verify the item (specified by text, partialMatch and matchIndex) is selected or un-selected.
void	verifyMenuItem(TextMatchingCriterion criterion, java.lang.String expectedStatus)

Methods inherited from class org.safs.selenium.webdriver.lib.Component

clearCache, clearComponentBox, createDOJOOperable, createGenericOperable, createHTMLOperable, createOperable, doubleCheckVerification, getDijitpopupparent, getValue, getWaiRole, getWidgetid, initialize, inputChars, inputComponentBoxChars, inputComponentBoxKeys, inputKeys, isAccessible, permitInvisible, setDijitpopupparent, setFocus, setWidgetid, updateFields, verifyComponentBox

Methods inherited from class org.safs.selenium.webdriver.lib.model.DefaultRefreshable

getAttribute, getCssClass, getEmbeddedObject, getId, getMap, getPossibleRecognitionStrings, getSearchContext, getTagName, getWebElement, initialize, refresh, setCssClass, setId, setPossibleRecognitionStrings, setSearchContext, setTagName, setWebElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.safs.selenium.webdriver.lib.model.IOperable

clearCache

Field Detail

menuSelectable

IMenuSelectable menuSelectable

HOME_KEY

public static final java.lang.String HOME_KEY

"SAS_PushMenu_GoHome_SAS" The path to trigger 'go home' event of SAS_HC_PushMenu

See Also:

Constant Field Values

Constructor Detail

Menu

public Menu(org.openqa.selenium.WebElement menubar)
     throws SeleniumPlusException

Throws:

SeleniumPlusException

Method Detail

castOperable

protected void castOperable()

Description copied from class: Component

Cast the IOperable object to the specific one.
The subclasses will override this method as they know what specific Operable to use.
Here a void implementation is given, as not all subclass need the specific Operable, such as EditBox.
Cast may throw Exception, we should catch it if calling this method.
This method should be called after Component.anOperableObject has been initialized.

Overrides:

castOperable in class Component

See Also:

Component.anOperableObject, Component.updateFields()

createSAPOperable

protected IOperable createSAPOperable()

Description copied from class: Component

Create the IOperable object for SAP domain.
Subclass SHOULD override this method if SAP will be supported.

Overrides:

createSAPOperable in class Component

See Also:

Component.createOperable(WebElement)

createDefaultOperable

protected IOperable createDefaultOperable()

Description copied from class: Component

Create the default IOperable object for a certain specific component.
It is different from the Component.createGenericOperable(), which will provide an IOperable
to support the minimal generic functionalities, like GetGUIImage, Click, HoverMouse etc.
Subclass COULD override this method to provide a default backup IOperable when other ways fail to create IOperable.

Overrides:

createDefaultOperable in class Component

See Also:

Component.createOperable(WebElement), Component.createDOJOOperable(), Component.createHTMLOperable(), Component.createSAPOperable()

isNodeSelected

public static boolean isNodeSelected(org.openqa.selenium.WebElement menuitem)

parseNodeText

public static java.lang.String parseNodeText(org.openqa.selenium.WebElement menuitem)

TODO adjust for MenuItem For menuitem, WebElement.getText() may return also the text of its children.
These text are separated by '\n', this method tries to get the text before the first '\n', which
should be text of this tree node.

Parameters:

menuitem - WebElement, represents the tree node.

Returns:

String, the label of the MenuItem.

selectItem

public void selectItem(TextMatchingCriterion criterion,
                       boolean verify,
                       org.openqa.selenium.Keys key,
                       java.awt.Point offset,
                       int mouseButtonNumber)
                throws SeleniumPlusException

Description copied from interface: ISelectable

Try to select (single-click) the item according to the item's text (fully or partially given), and then verify if the item has been really selected according to the parameter 'verify'. If the parameter key is provided, the selection will happen with that key pressed at the same time. If the parameter offset is provided, then click at offset relative to the top-left corner of view; otherwise at the center. The parameter mouseButtonNumber decides right-click or left-click.
Note: There are maybe some callback methods associated with the item-container, but setting select text MAY NOT invoke them, in the implementation of this method we should make sure those callbacks are invoked (we can fire some events.)

Specified by:

selectItem in interface ISelectable

Parameters:

criterion - TextMatchingCriterion, containing text, partialMatch, matchedIndex as search-criterion.

verify - boolean, if true then verify the selection;

key - org.openqa.selenium.Keys, it is the key to press during selection.
for example Keys.SHIFT, or Keys.CONTROL.
If user doesn't want any key pressed, please provide null

offset - Point, the position relative to the up-left corner to click at
If user provides null, then the center of the item will be used

mouseButtonNumber - int, the mouse-button-number representing right, middle, or left button.
it can be WDLibrary.MOUSE_BUTTON_LEFT or WDLibrary.MOUSE_BUTTON_RIGHT
or WDLibrary.MOUSE_BUTTON_MIDDLE.

Throws:

SeleniumPlusException

selectItem

public void selectItem(int index,
                       boolean verify,
                       org.openqa.selenium.Keys key,
                       java.awt.Point offset,
                       int mouseButtonNumber)
                throws SeleniumPlusException

Description copied from interface: ISelectable

Try to select (single-click) the item according to the index, and then verify if the item has been really selected according to the parameter 'verify'. If the parameter key is provided, the selection will happen with that key pressed at the same time. If the parameter offset is provided, then click at offset relative to the top-left corner of view; otherwise at the center. The parameter mouseButtonNumber decides right-click or left-click.
Note: There are maybe some callback methods associated with the item-container, but setting select index MAY NOT invoke them, in the implementation of this method we should make sure those callbacks are invoked (we can fire some events.)

Specified by:

selectItem in interface ISelectable

Parameters:

index - int, the index of the item to select, it is 0-based index.

verify - boolean, if true then verify the selection;

key - org.openqa.selenium.Keys, it is the key to press during selection.
for example Keys.SHIFT, or Keys.CONTROL.
If user doesn't want any key pressed, please provide null

offset - Point, the position relative to the up-left corner to click at
If user provides null, then the center of the item will be used

mouseButtonNumber - int, the mouse-button-number representing right, middle, or left button.
it can be WDLibrary.MOUSE_BUTTON_LEFT or WDLibrary.MOUSE_BUTTON_RIGHT
or WDLibrary.MOUSE_BUTTON_MIDDLE.

Throws:

SeleniumPlusException

activateItem

public void activateItem(TextMatchingCriterion criterion,
                         boolean verify,
                         org.openqa.selenium.Keys key,
                         java.awt.Point offset)
                  throws SeleniumPlusException

Description copied from interface: ISelectable

Try to activate (double-click) the item according to the item's text (fully or partially given), and then verify if the item has been really selected according to the parameter 'verify'. If the parameter key is provided, the selection will happen with that key pressed at the same time.

Specified by:

activateItem in interface ISelectable

Parameters:

criterion - TextMatchingCriterion, containing text, partialMatch, matchedIndex as search-criterion.

verify - boolean, if true then verify the selection;

key - org.openqa.selenium.Keys, it is the key to press during selection.
for example Keys.SHIFT, or Keys.CONTROL.
If user doesn't want any key pressed, please provide null

offset - Point, the position relative to the up-left corner to click at
If user provides null, then the center of the item will be used

Throws:

SeleniumPlusException

activateItem

public void activateItem(int index,
                         boolean verify,
                         org.openqa.selenium.Keys key,
                         java.awt.Point offset)
                  throws SeleniumPlusException

Description copied from interface: ISelectable

Try to activate (double-click) the item according to the index, and then verify if the item has been really selected according to the parameter 'verify'. If the parameter key is provided, the selection will happen with that key pressed at the same time.

Specified by:

activateItem in interface ISelectable

Parameters:

index - int, the index of the item to select, it is 0-based index.

verify - boolean, if true then verify the selection;

key - org.openqa.selenium.Keys, it is the key to press during selection.
for example Keys.SHIFT, or Keys.CONTROL.
If user doesn't want any key pressed, please provide null

offset - Point, the position relative to the up-left corner to click at
If user provides null, then the center of the item will be used

Throws:

SeleniumPlusException

verifyItemSelection

public void verifyItemSelection(TextMatchingCriterion criterion,
                                boolean expectSelected)
                         throws SeleniumPlusException

Description copied from interface: ISelectable

Verify the item (specified by text, partialMatch and matchIndex) is selected or un-selected.

Specified by:

verifyItemSelection in interface ISelectable

Parameters:

criterion - TextMatchingCriterion, containing text, partialMatch, matchedIndex as search-criterion.

expectSelected - boolean, true if the item is expected 'selected'; false if expected 'unselected'.

Throws:

SeleniumPlusException - if the verification fails.

verifyItemSelection

public void verifyItemSelection(int index,
                                boolean expectSelected)
                         throws SeleniumPlusException

Description copied from interface: ISelectable

Verify the item (specified by index) is selected or un-selected.

Specified by:

verifyItemSelection in interface ISelectable

Parameters:

index - int, the index of the item to select, it is 0-based index.

expectSelected - boolean, true if the item is expected 'selected'; false if expected 'unselected'.

Throws:

SeleniumPlusException - if the verification fails.

verifyContains

public void verifyContains(TextMatchingCriterion criterion)
                    throws SeleniumPlusException

Description copied from interface: ISelectable

Verify the item (specified by text, partialMatch and matchIndex) is contained.

Specified by:

verifyContains in interface ISelectable

Parameters:

criterion - TextMatchingCriterion, containing text, partialMatch, matchedIndex as search-criterion.

Throws:

SeleniumPlusException - if the verification fails.

getContent

public MenuItem[] getContent()
                      throws SeleniumPlusException

Description copied from interface: IMenuSelectable

Get all items withing a Menu.

Specified by:

getContent in interface IHierarchicalSelectable

Specified by:

getContent in interface IMenuSelectable

Specified by:

getContent in interface ISelectable

Returns:

MenuItem[] an array of the MenuItem

Throws:

SeleniumPlusException

getMatchedElement

public MenuItem getMatchedElement(TextMatchingCriterion criterion)
                           throws SeleniumPlusException

Description copied from class: Component

According to a certain 'search condition', get the matched subitem within this Component.
This method just return a null. Its sublcass SHOULD give a detail implementation.

Specified by:

getMatchedElement in interface IMenuSelectable

Specified by:

getMatchedElement in interface ISelectable

Overrides:

getMatchedElement in class Component

Parameters:

criterion - TextMatchingCriterion, the search condition

Returns:

Element, the matched element

Throws:

SeleniumPlusException - if Element cannot be found

verifyMenuItem

public void verifyMenuItem(TextMatchingCriterion criterion,
                           java.lang.String expectedStatus)
                    throws SeleniumPlusException

Specified by:

verifyMenuItem in interface IMenuSelectable

Throws:

SeleniumPlusException