org.safs.selenium.webdriver.lib.model

Class MenuItem

java.lang.Object

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

org.safs.selenium.webdriver.lib.model.Element

org.safs.selenium.webdriver.lib.model.HierarchicalElement

org.safs.selenium.webdriver.lib.model.MenuItem

All Implemented Interfaces:

IRefreshable

public class MenuItem
extends HierarchicalElement

History:

Jun 23, 2014 (Lei Wang) Initial release.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_SUBMENUID 'submenuid' used to find the submenu WebElement of this menuitem
static java.lang.String	STATUS_BARBREAK
static java.lang.String	STATUS_BITMAP
static java.lang.String	STATUS_BREAK
static java.lang.String	STATUS_CHECKED
static java.lang.String	STATUS_DEFAULT
static java.lang.String	STATUS_DISABLED
static java.lang.String	STATUS_ENABLED
static java.lang.String	STATUS_GRAYED
static java.lang.String	STATUS_HILITED
static java.lang.String	STATUS_NORMAL
static java.lang.String	STATUS_SEPARATOR
static java.lang.String	STATUS_SUBMENU_NUM
static java.lang.String	STATUS_UNCHECKED
static java.lang.String	STATUS_UNGRAYED
static java.lang.String	STATUS_UNHILITEED
protected java.lang.String	subMenuId

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

children, parent, PROPERTY_CHILDREN, PROPERTY_PARENT

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

clickableWebElement, disabled, iconURL, label, PROPERTY_CLASS, PROPERTY_DISABLED, PROPERTY_EXPANDED, PROPERTY_ICON, PROPERTY_ID, PROPERTY_INDEX, PROPERTY_LABEL, PROPERTY_SELECTABLE, PROPERTY_SELECTED, PROPERTY_TEXTCONTENT, PROPERTY_VALUE, PROPERTY_VISIBLE, selected, visible

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

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MenuItem()
	MenuItem(java.lang.Object object)

Method Summary

Modifier and Type	Method and Description
protected boolean	containsBitMap() Subclass may need to override this method to get a correct value.
MenuItem[]	getChildren()
MenuItem	getParent()
java.lang.String	getSubMenuId()
boolean	hasSubMenu()
protected boolean	isChecked() Subclass may need to override this method to get a correct value.
protected boolean	isSeparator() Subclass may need to override this method to get a correct value.
boolean	matchStatus(java.lang.String expectedStatus) Note: The separator must be a blank " "
protected MenuItem[]	newArray(int length) Create an array of HierarchicalElement. Sub class MUST OVERRIDE this method to provide its own array.
protected MenuItem	newInstance(java.lang.Object object) Create an instance of HierarchicalElement. Sub class MUST OVERRIDE this method to provide its own instance.
void	setChildren(HierarchicalElement[] children)
void	setSubMenuId(java.lang.String subMenuId)
protected boolean	subMenuCountOk(java.lang.String subMenuNumber)
void	updateFields() set/update the class's fields through the underlying WebElement or Map.

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

addChild, addChild, getClickableWebElement, getFullPath, getRootId, parseChildren, parseChildren, reverseChildren, setParent

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

_getLabel, contentValue, equals, getIconURL, getLabel, isDisabled, isSelected, isVisible, parseWebElementText, setSelected, toString

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

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

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_SUBMENUID

public static final java.lang.String PROPERTY_SUBMENUID

'submenuid' used to find the submenu WebElement of this menuitem

See Also:

Constant Field Values

STATUS_ENABLED

public static final java.lang.String STATUS_ENABLED

See Also:

Constant Field Values

STATUS_UNGRAYED

public static final java.lang.String STATUS_UNGRAYED

See Also:

Constant Field Values

STATUS_DISABLED

public static final java.lang.String STATUS_DISABLED

See Also:

Constant Field Values

STATUS_GRAYED

public static final java.lang.String STATUS_GRAYED

See Also:

Constant Field Values

STATUS_CHECKED

public static final java.lang.String STATUS_CHECKED

See Also:

Constant Field Values

STATUS_UNCHECKED

public static final java.lang.String STATUS_UNCHECKED

See Also:

Constant Field Values

STATUS_SUBMENU_NUM

public static final java.lang.String STATUS_SUBMENU_NUM

See Also:

Constant Field Values

STATUS_BITMAP

public static final java.lang.String STATUS_BITMAP

See Also:

Constant Field Values

STATUS_SEPARATOR

public static final java.lang.String STATUS_SEPARATOR

See Also:

Constant Field Values

STATUS_BARBREAK

public static final java.lang.String STATUS_BARBREAK

See Also:

Constant Field Values

STATUS_BREAK

public static final java.lang.String STATUS_BREAK

See Also:

Constant Field Values

STATUS_HILITED

public static final java.lang.String STATUS_HILITED

See Also:

Constant Field Values

STATUS_UNHILITEED

public static final java.lang.String STATUS_UNHILITEED

See Also:

Constant Field Values

STATUS_DEFAULT

public static final java.lang.String STATUS_DEFAULT

See Also:

Constant Field Values

STATUS_NORMAL

public static final java.lang.String STATUS_NORMAL

See Also:

Constant Field Values

subMenuId

protected java.lang.String subMenuId

Constructor Detail

MenuItem

protected MenuItem()

MenuItem

public MenuItem(java.lang.Object object)

Method Detail

updateFields

public void updateFields()

set/update the class's fields through the underlying WebElement or Map.

Overrides:

updateFields in class HierarchicalElement

See Also:

DefaultRefreshable.refresh(boolean)

newInstance

protected MenuItem newInstance(java.lang.Object object)

Description copied from class: HierarchicalElement

Create an instance of HierarchicalElement.
Sub class MUST OVERRIDE this method to provide its own instance.

Overrides:

newInstance in class HierarchicalElement

Parameters:

object - Object, to create an instance of this class.

Returns:

HierarchicalElement, an instance of HierarchicalElement

newArray

protected MenuItem[] newArray(int length)

Description copied from class: HierarchicalElement

Create an array of HierarchicalElement.
Sub class MUST OVERRIDE this method to provide its own array.

Overrides:

newArray in class HierarchicalElement

Parameters:

length - int, the length of the array

Returns:

an array of HierarchicalElement(or subclass).

getParent

public MenuItem getParent()

Overrides:

getParent in class HierarchicalElement

getChildren

public MenuItem[] getChildren()

Overrides:

getChildren in class HierarchicalElement

setChildren

public void setChildren(HierarchicalElement[] children)
                 throws SeleniumPlusException

Overrides:

setChildren in class HierarchicalElement

Parameters:

children - TreeNode[], an array of TreeNode

Throws:

SeleniumPlusException

setSubMenuId

public void setSubMenuId(java.lang.String subMenuId)

getSubMenuId

public java.lang.String getSubMenuId()

hasSubMenu

public boolean hasSubMenu()

matchStatus

public boolean matchStatus(java.lang.String expectedStatus)

Note: The separator must be a blank " "

Parameters:

expectedStatus - A String contains status of the node item, can be an combination of followings:
Supported: "Enabled" "Ungrayed" "Grayed" "Disabled" "Checked" "Unchecked" "Menu With N MenuItems" "BitMap" "Separator"
Future: "BarBreak" "Break" "Hilited" "Default" "Unhilited" "Normal"
Example:"Enabled Unchecked"

Returns:

If matched, return true

isChecked

protected boolean isChecked()

Subclass may need to override this method to get a correct value.

Returns:

boolean, Whether this menuItem is selected

containsBitMap

protected boolean containsBitMap()

Subclass may need to override this method to get a correct value.

Returns:

boolean, Whether this menuItem contains an icon

isSeparator

protected boolean isSeparator()

Subclass may need to override this method to get a correct value.

Returns:

boolean, Whether this menuItem is a separator

subMenuCountOk

protected boolean subMenuCountOk(java.lang.String subMenuNumber)

Parameters:

subMenuNumber, - String, Represent the number of submenus under this menu

Returns:

boolean