org.safs.selenium.webdriver.lib

Class Tree.DefaultSelectable_Tree

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

org.safs.selenium.webdriver.lib.Tree.DefaultSelectable_Tree

All Implemented Interfaces:

IHierarchicalSelectable, IOperable, ISelectable, ITreeSelectable, Supportable

Enclosing class:

Tree

class Tree.DefaultSelectable_Tree
extends AbstractTreeSelectable

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

Method Summary

Modifier and Type	Method and Description
protected void	collapseItem(TreeNode node, boolean collpaseChildren) Collapse the nodes (by double-click). Note:The second parameter collpaseChildren is not used here.
protected void	expandItem(TreeNode 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.
TreeNode[]	getCacheableContent() Get the real-time content from WebElement. For some components like Tree, Menu etc.
TreeNode	getMatchedElement(TextMatchingCriterion criterion) This method override that of superclass.
java.lang.String[]	getSupportedClassNames()
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.
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	verifyItemSelected(Element element) Note:In subclass, we need to update the 'selected' property of Element. Please call AbstractSelectable.waitAndVerifyItemSelected(Element) instead to verify selection, as the first method will also try the wait for element to be ready and call EmbeddedObject.refresh(boolean).

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

collapseItem, convertTo, expandItem, getContent, verifyItemExpension

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, selectItem, verifyContains, verifyItemSelection, verifyItemSelection, waitAndVerifyItemSelected, waitElementReady, waitElementReady

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

isShowOnPage, 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_Tree

public DefaultSelectable_Tree(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

getCacheableContent

public TreeNode[] getCacheableContent()
                               throws SeleniumPlusException

Description copied from class: AbstractSelectable

Get the real-time content from WebElement.
For some components like Tree, Menu etc. it is time-consuming to retrieve content,
user may implement this method instead of AbstractSelectable.getContent() so that the retrived content
will be kept in cache, and AbstractSelectable.getContent() will use the content in the cache.

Overrides:

getCacheableContent in class AbstractSelectable

Throws:

SeleniumPlusException

See Also:

AbstractSelectable.getContent()

getMatchedElement

public TreeNode getMatchedElement(TextMatchingCriterion criterion)
                           throws SeleniumPlusException

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

Specified by:

getMatchedElement in interface ISelectable

Specified by:

getMatchedElement in interface ITreeSelectable

Overrides:

getMatchedElement in class AbstractTreeSelectable

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

Specified by:

expandItem in class AbstractTreeSelectable

Parameters:

node - TreeNode, the node to expand.

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

Throws:

SeleniumPlusException

collapseItem

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

Collapse the nodes (by double-click).
Note:The second parameter collpaseChildren is not used here.

Specified by:

collapseItem in class AbstractTreeSelectable

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

Description copied from class: AbstractTreeSelectable

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

Overrides:

verifyItemExpanded in class AbstractTreeSelectable

Parameters:

node - TreeNode

Returns:

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

Throws:

SeleniumPlusException

verifyItemSelected

protected void verifyItemSelected(Element element)
                           throws SeleniumPlusException

Description copied from class: AbstractSelectable

Note:In subclass, we need to update the 'selected' property of Element.
Please call AbstractSelectable.waitAndVerifyItemSelected(Element) instead to verify selection,
as the first method will also try the wait for element to be ready and call EmbeddedObject.refresh(boolean).

Overrides:

verifyItemSelected in class AbstractSelectable

Parameters:

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

Throws:

SeleniumPlusException