org.safs.selenium.webdriver.lib.model

Class AbstractTreeSelectable

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

All Implemented Interfaces:

IHierarchicalSelectable, IOperable, ISelectable, ITreeSelectable, Supportable

Direct Known Subclasses:

Tree.DefaultSelectable_Tree, Tree.SapSelectable_Tree

public abstract class AbstractTreeSelectable
extends AbstractHierarchicalSelectable
implements ITreeSelectable

May 30, 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
AbstractTreeSelectable(Component parent)

Method Summary

Modifier and Type	Method and Description
void	collapseItem(TextMatchingCriterion criterion, boolean collpaseChildren, boolean verify) Collapse the item according to the path.
protected abstract void	collapseItem(TreeNode node, boolean collpaseChildren)
protected TreeNode	convertTo(Element element) Cast the Element to TreeNode.
void	expandItem(TextMatchingCriterion criterion, boolean expandChildren, boolean verify) Expand the item according to the path.
protected abstract void	expandItem(TreeNode node, boolean expandChildren)
TreeNode[]	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()
TreeNode	getMatchedElement(TextMatchingCriterion criterion) According to the "hierarchical path" to get a TreeNode object.
protected boolean	verifyItemExpanded(TreeNode node) Note:In subclass, we need to update the 'expanded' property of TreeNode. Verify if a tree node is expanded or collapsed.
protected void	verifyItemExpension(TreeNode node, boolean expectExpended)

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

AbstractTreeSelectable

public AbstractTreeSelectable(Component parent)
                       throws SeleniumPlusException

Parameters:

parent -

Throws:

SeleniumPlusException

Method Detail

getContent

public TreeNode[] 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 ISelectable

Specified by:

getContent in interface ITreeSelectable

Overrides:

getContent in class AbstractSelectable

Returns:

Element[] an array of the element

Throws:

SeleniumPlusException

See Also:

AbstractSelectable.getCacheableContent()

expandItem

public void expandItem(TextMatchingCriterion criterion,
                       boolean expandChildren,
                       boolean verify)
                throws SeleniumPlusException

Description copied from interface: ITreeSelectable

Expand the item according to the path.

Specified by:

expandItem in interface ITreeSelectable

Parameters:

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

expandChildren - boolean, if true then expand all the children of this node.

verify - boolean, if true then verify the treepath has been expended.

Throws:

SeleniumPlusException

collapseItem

public void collapseItem(TextMatchingCriterion criterion,
                         boolean collpaseChildren,
                         boolean verify)
                  throws SeleniumPlusException

Description copied from interface: ITreeSelectable

Collapse the item according to the path.

Specified by:

collapseItem in interface ITreeSelectable

Parameters:

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

collpaseChildren - boolean, if true then collapse all the children of this node.

verify - boolean, if true then verify the treepath has been collapse.

Throws:

SeleniumPlusException

verifyItemExpension

protected void verifyItemExpension(TreeNode node,
                                   boolean expectExpended)
                            throws SeleniumPlusException

Parameters:

node - TreeNode

expectExpended - boolean, true then the node is expected as expended; false then the node is expected as collapsed.

Throws:

SeleniumPlusException

expandItem

protected abstract void expandItem(TreeNode node,
                                   boolean expandChildren)
                            throws SeleniumPlusException

Parameters:

node - TreeNode, the node to expand.

expandChildren - boolean, if true then expand all the children of this node.

Throws:

SeleniumPlusException

collapseItem

protected abstract void collapseItem(TreeNode node,
                                     boolean collpaseChildren)
                              throws SeleniumPlusException

Parameters:

node - TreeNode, the node to collapse.

collpaseChildren - boolean, if true then collapse all the children of this node.

Throws:

SeleniumPlusException

verifyItemExpanded

protected boolean verifyItemExpanded(TreeNode node)
                              throws SeleniumPlusException

Note:In subclass, we need to update the 'expanded' property of TreeNode.
Verify if a tree node is expanded or collapsed.

Parameters:

node - TreeNode

Returns:

boolean, true if the node is expended; false if it is collapsed.

Throws:

SeleniumPlusException

getMatchedElement

public TreeNode getMatchedElement(TextMatchingCriterion criterion)
                           throws SeleniumPlusException

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

Specified by:

getMatchedElement in interface ISelectable

Specified by:

getMatchedElement in interface ITreeSelectable

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 TreeNode convertTo(Element element)
                      throws SeleniumPlusException

Cast the Element to TreeNode.

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.