org.safs.selenium.webdriver.lib.model

Class AbstractHierarchicalSelectable

java.lang.Object

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

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

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

All Implemented Interfaces:

IOperable, ISelectable, Supportable

Direct Known Subclasses:

AbstractMenuSelectable, AbstractTreeSelectable

public abstract class AbstractHierarchicalSelectable
extends AbstractSelectable

This class represents a hierarchical selectable structure like Tree or Menu etc.
It provides a defult implementation of #getMatchedElement(String, boolean, int)

History:

Jun 23, 2014 (Lei Wang) Initial release.

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

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'.
protected HierarchicalElement	convertTo(Element element) Cast the an Element object to HierarchicalElement. Subclass needs to override this method to cast it to its own type.
HierarchicalElement	getMatchedElement(TextMatchingCriterion criteria) According to the "hierarchical path" to get a Element object. The sub-class needs to provide an appropriate implementation of method AbstractSelectable.getContent(), on which this method depends.
(package private) HierarchicalElement	getMatchedNode(HierarchicalElement[] hierarchicalStructure, java.lang.String[] pathNodes, boolean partialMatch, int[] expectedMatchTimes) According to a pathNodes (an array of path) and expectedMatchTimes (an array of int), find the matched node in a hierarchical structure. If at certain level, the expectedMatchedTime is not satisfied, then the search will fail and just return a null.
(package private) HierarchicalElement	getMatchedNode(HierarchicalElement[] hierarchicalStructure, java.lang.String[] pathNodes, boolean partialMatch, MutableInteger matchedTimes, int expectedMatchTimes) According to a pathNodes (an array of path) and expectedMatchTimes, find the Nth-matched node in a hierarchical structure.
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	verifyItemSelection(int index, boolean expectSelected) Verify the item (specified by index) is selected or un-selected.

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

activateItem, clearCache, clickElement, getCacheableContent, getContent, selectItem, showOnPage, verifyContains, verifyItemSelected, verifyItemSelection, verifyItemSelection, waitAndVerifyItemSelected, 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.Supportable

getSupportedClassNames

Constructor Detail

AbstractHierarchicalSelectable

public AbstractHierarchicalSelectable(Component parent)
                               throws SeleniumPlusException

Parameters:

parent -

Throws:

SeleniumPlusException

Method Detail

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

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

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(int index,
                                boolean expectSelected)
                         throws SeleniumPlusException

Description copied from interface: ISelectable

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

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.

getMatchedElement

public HierarchicalElement getMatchedElement(TextMatchingCriterion criteria)
                                      throws SeleniumPlusException

According to the "hierarchical path" to get a Element object.
The sub-class needs to provide an appropriate implementation of method AbstractSelectable.getContent(), on which
this method depends. Subclass can override this method to cast the result HierarchicalElement to ist own type.

Parameters:

path - String, the hierarchical path, "root->node1" for example. The path should be separated by GuiObjectRecognition.DEFAULT_PATH_SEPARATOR

Returns:

Element, the matched Element object.

Throws:

SeleniumPlusException - if Element cannot be found

See Also:

AbstractSelectable.getContent()

getMatchedNode

HierarchicalElement getMatchedNode(HierarchicalElement[] hierarchicalStructure,
                                   java.lang.String[] pathNodes,
                                   boolean partialMatch,
                                   MutableInteger matchedTimes,
                                   int expectedMatchTimes)
                            throws SeleniumPlusException

According to a pathNodes (an array of path) and expectedMatchTimes, find the Nth-matched node in a hierarchical structure.

Parameters:

hierarchicalStructure - HierarchicalElement[], the hierarchical structure where to find the matched node.

pathNodes - String[], an array of node path to match

partialMatch - boolean, if the pathNodes contains partial string or full string to match

matchedTimes - MutableInteger, how many times that the node-path has been found.

expectedMatchTimes - int, the expected times that the node-path should be found.

Returns:

HierarchicalElement, the matched node. Sub-class may need to convert it to its own type.

Throws:

SeleniumPlusException

getMatchedNode

HierarchicalElement getMatchedNode(HierarchicalElement[] hierarchicalStructure,
                                   java.lang.String[] pathNodes,
                                   boolean partialMatch,
                                   int[] expectedMatchTimes)
                            throws SeleniumPlusException

According to a pathNodes (an array of path) and expectedMatchTimes (an array of int), find the matched node in a hierarchical structure.
If at certain level, the expectedMatchedTime is not satisfied, then the search will fail and just return a null.

Parameters:

hierarchicalStructure - HierarchicalElement[], the hierarchical structure where to find the matched node.

pathNodes - String[], an array of node path to match

partialMatch - boolean, if the pathNodes contains partial string or full string to match

expectedMatchTimes - int[], an array of int, each int value represents the expected times that the node-path should be found at its level.

Returns:

HierarchicalElement, the matched node. Sub-class may need to convert it to its own type.

Throws:

SeleniumPlusException

convertTo

protected HierarchicalElement convertTo(Element element)
                                 throws SeleniumPlusException

Cast the an Element object to HierarchicalElement.
Subclass needs to override this method to cast it to its own type.

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.