org.safs.selenium.webdriver.lib.model

Class AbstractMenuSelectable

java.lang.Object

org.safs.selenium.webdriver.lib.model.EmbeddedObject

org.safs.selenium.webdriver.lib.model.AbstractSelectable

org.safs.selenium.webdriver.lib.model.AbstractHierarchicalSelectable

org.safs.selenium.webdriver.lib.model.AbstractMenuSelectable

All Implemented Interfaces:

IHierarchicalSelectable, IMenuSelectable, IOperable, ISelectable, Supportable

Direct Known Subclasses:

Menu.DefaultSelectable_Menu, Menu.SapSelectable_Menu, Menu.SAS_HC_PushMenu

public abstract class AbstractMenuSelectable
extends AbstractHierarchicalSelectable
implements IMenuSelectable

Field Summary

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

contentObjects, DEFAULT_WAIT_TIME

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

parent

Constructor Summary

Constructors

Constructor and Description
AbstractMenuSelectable(Component parent)

Method Summary

Modifier and Type	Method and Description
protected MenuItem	convertTo(Element element) Cast the Element to MenuItem.
MenuItem[]	getContent() Try to get the cached content according to the WebElement. If no cached content can be found, then get the real-time content by calling AbstractSelectable.getCacheableContent(), and put the content in the cache and return it. If subclass doesn't need this functionality, then just override this method. If subclass needs this functionality, then override method AbstractSelectable.getCacheableContent()
MenuItem	getMatchedElement(TextMatchingCriterion criterion) According to the "hierarchical path" to get a MenuItem object.
protected void	verifyItemSelected(Element element) As it is hard to know if a MenuItem has been selected, it is so transient.
void	verifyMenuItem(TextMatchingCriterion criterion, java.lang.String expectedStatus)
protected void	waitAndVerifyItemSelected(Element element) Override the method in super-class to turn off the post-verification, we just log a debug message.

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

activateItem, getMatchedNode, getMatchedNode, selectItem, verifyItemSelection

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

activateItem, clearCache, clickElement, getCacheableContent, selectItem, showOnPage, verifyContains, verifyItemSelection, verifyItemSelection, waitElementReady, waitElementReady

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

isShowOnPage, isSupported, refresh, webelement

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.ISelectable

activateItem, activateItem, selectItem, selectItem, verifyContains, verifyItemSelection, verifyItemSelection

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

clearCache

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

getSupportedClassNames

Constructor Detail

AbstractMenuSelectable

public AbstractMenuSelectable(Component parent)
                       throws SeleniumPlusException

Parameters:

parent -

Throws:

SeleniumPlusException

Method Detail

getContent

public MenuItem[] getContent()
                      throws SeleniumPlusException

Description copied from class: AbstractSelectable

Try to get the cached content according to the WebElement.
If no cached content can be found, then get the real-time content by calling AbstractSelectable.getCacheableContent(),
and put the content in the cache and return it.
If subclass doesn't need this functionality, then just override this method.
If subclass needs this functionality, then override method AbstractSelectable.getCacheableContent()

Specified by:

getContent in interface IHierarchicalSelectable

Specified by:

getContent in interface IMenuSelectable

Specified by:

getContent in interface ISelectable

Overrides:

getContent in class AbstractSelectable

Returns:

Element[] an array of the element

Throws:

SeleniumPlusException

See Also:

AbstractSelectable.getCacheableContent()

getMatchedElement

public MenuItem getMatchedElement(TextMatchingCriterion criterion)
                           throws SeleniumPlusException

According to the "hierarchical path" to get a MenuItem object.

Specified by:

getMatchedElement in interface IMenuSelectable

Specified by:

getMatchedElement in interface ISelectable

Overrides:

getMatchedElement in class AbstractHierarchicalSelectable

Parameters:

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

Returns:

Element, the matched Element object.

Throws:

SeleniumPlusException - if Element cannot be found

See Also:

AbstractSelectable.getContent()

convertTo

protected MenuItem convertTo(Element element)
                      throws SeleniumPlusException

Cast the Element to MenuItem.

Overrides:

convertTo in class AbstractHierarchicalSelectable

Parameters:

element - Element, the Element object to cast

Returns:

HierarchicalElement, the HierarchicalElement object cast from Element object.

Throws:

SeleniumPlusException - if the Element object cannot be cast to HierarchicalElement.

waitAndVerifyItemSelected

protected void waitAndVerifyItemSelected(Element element)
                                  throws SeleniumPlusException

Override the method in super-class to turn off the post-verification, we just log a debug message.

AbstractSelectable.waitAndVerifyItemSelected(Element) will try to refresh the WebElment and then call verifyItemSelected(Element) to verify item's selection. But currently verifyItemSelected(Element) will do nothing, so it is a time-wasting to refresh the WebElement. We just override waitAndVerifyItemSelected(Element) to do nothing but log a debug message.

Overrides:

waitAndVerifyItemSelected in class AbstractSelectable

Parameters:

element - Element, the element has been selected or clicked or double-clicked.

Throws:

SeleniumPlusException

See Also:

#verifyItemSelected(Element)}

verifyItemSelected

protected void verifyItemSelected(Element element)
                           throws SeleniumPlusException

As it is hard to know if a MenuItem has been selected, it is so transient. For example, MenuItemBase API does NOT provide a way to get menu item selection status. So we will do nothing in verifyItemSelected(Element), which could be overrode if we know a way to verify menu item selection.

Overrides:

verifyItemSelected in class AbstractSelectable

Parameters:

element - Element, the element to verify that it is selected.

Throws:

SeleniumPlusException

verifyMenuItem

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

Specified by:

verifyMenuItem in interface IMenuSelectable

Throws:

SeleniumPlusException