org.safs.selenium.webdriver.lib

Class Menu.DefaultSelectable_Menu

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

org.safs.selenium.webdriver.lib.Menu.DefaultSelectable_Menu

All Implemented Interfaces:

IHierarchicalSelectable, IMenuSelectable, IOperable, ISelectable, Supportable

Enclosing class:

Menu

class Menu.DefaultSelectable_Menu
extends AbstractMenuSelectable

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
DefaultSelectable_Menu(Component parent)

Method Summary

Modifier and Type	Method and Description
protected void	expandItem(MenuItem node, boolean expandChildren) Expand the nodes (by double-click) from the root level by level. Note:The second parameter expandChildren is not used yet here.
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) This method override that of superclass.
java.lang.String[]	getSupportedClassNames()
protected boolean	isShowOnPage(Element element) For menu, the menuitem is usually NOT shown on page. The method EmbeddedObject.isShowOnPage(Element) in super-class will try to search the related web-element (which doesn't exist yet) and will waste a lot of time. So override it, and just return false, so that we will always call showOnPage(Element) to make it visible on page and can be selected correctly.
boolean	isSupported(org.openqa.selenium.WebElement element) Test if the element is supported.
protected void	showOnPage(Element element) Make the element is inside the container, and visible on the page. For example, some element may not be visible if there are too many elements in its container; User can scroll to make the element visible on the page. User may need to wait for a while so that the element related object can be updated (like position-onscreen, visibility etc.) This method gives a default implementation: it will scroll and align the top of element to the top of container. Before this method is called, it is suggested to call EmbeddedObject.isShowOnPage(Element) firstly. This method will be override by sub-class.

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

convertTo, verifyItemSelected, verifyMenuItem, waitAndVerifyItemSelected

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

activateItem, selectItem, verifyItemSelection

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

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

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

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

Constructor Detail

DefaultSelectable_Menu

public DefaultSelectable_Menu(Component parent)
                       throws SeleniumPlusException

Parameters:

parent -

Throws:

SeleniumPlusException

Method Detail

isSupported

public boolean isSupported(org.openqa.selenium.WebElement element)

Description copied from class: EmbeddedObject

Test if the element is supported. Handle different domains such as SAP, DOJO, HTML etc.

Specified by:

isSupported in interface Supportable

Overrides:

isSupported in class EmbeddedObject

Parameters:

element - WebElement, the element to check.

getSupportedClassNames

public java.lang.String[] getSupportedClassNames()

Returns:

String[], an array of class-name supported by this class

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 AbstractMenuSelectable

Returns:

Element[] an array of the element

Throws:

SeleniumPlusException

See Also:

AbstractSelectable.getCacheableContent()

getMatchedElement

public MenuItem getMatchedElement(TextMatchingCriterion criterion)
                           throws SeleniumPlusException

This method override that of superclass. It will only try to find each node according to
the path provided as parameter, and then return a simple-chain of MenuItem which contains only
the nodes specified in the path. Not like the result return in superclass, which is a double-direction
chain and the whole MenuBar can be accessed thought it.
Note:The parameter matchIndex is not used yet here. Need to be considered. TODO

Specified by:

getMatchedElement in interface IMenuSelectable

Specified by:

getMatchedElement in interface ISelectable

Overrides:

getMatchedElement in class AbstractMenuSelectable

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()

showOnPage

protected void showOnPage(Element element)
                   throws SeleniumPlusException

Description copied from class: AbstractSelectable

Make the element is inside the container, and visible on the page.
For example, some element may not be visible if there are too many elements in its container;
User can scroll to make the element visible on the page.
User may need to wait for a while so that the element related object can be updated (like position-onscreen, visibility etc.)

This method gives a default implementation:
it will scroll and align the top of element to the top of container.
Before this method is called, it is suggested to call EmbeddedObject.isShowOnPage(Element) firstly.
This method will be override by sub-class.

Overrides:

showOnPage in class AbstractSelectable

Parameters:

element - Element, the element needs to be visible on page

Throws:

SeleniumPlusException

See Also:

#isShowOnPage(Element)}

expandItem

protected void expandItem(MenuItem node,
                          boolean expandChildren)
                   throws SeleniumPlusException

Expand the nodes (by double-click) from the root level by level.
Note:The second parameter expandChildren is not used yet here.

Throws:

SeleniumPlusException

isShowOnPage

protected boolean isShowOnPage(Element element)
                        throws SeleniumPlusException

For menu, the menuitem is usually NOT shown on page.
The method EmbeddedObject.isShowOnPage(Element) in super-class will
try to search the related web-element (which doesn't exist yet) and will waste
a lot of time.
So override it, and just return false, so that we will always call showOnPage(Element)
to make it visible on page and can be selected correctly.

Overrides:

isShowOnPage in class EmbeddedObject

Parameters:

element - Element, the element to check

Returns:

boolean, true if the element is visible on page.

Throws:

SeleniumPlusException

See Also:

EmbeddedObject.isShowOnPage(Element)