org.safs.selenium.webdriver.lib.model

Class HierarchicalElement

java.lang.Object

org.safs.selenium.webdriver.lib.model.DefaultRefreshable

org.safs.selenium.webdriver.lib.model.Element

org.safs.selenium.webdriver.lib.model.HierarchicalElement

All Implemented Interfaces:

IRefreshable

Direct Known Subclasses:

MenuItem, TreeNode

public class HierarchicalElement
extends Element

This class represents a hierarchical structure like Tree or Menu etc.

History:

Jun 23, 2014 (Lei Wang) Initial release.

Field Summary

Fields

Modifier and Type	Field and Description
protected HierarchicalElement[]	children
protected HierarchicalElement	parent
static java.lang.String	PROPERTY_CHILDREN 'children'
static java.lang.String	PROPERTY_PARENT 'parent'

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

clickableWebElement, disabled, iconURL, label, PROPERTY_CLASS, PROPERTY_DISABLED, PROPERTY_EXPANDED, PROPERTY_ICON, PROPERTY_ID, PROPERTY_INDEX, PROPERTY_LABEL, PROPERTY_SELECTABLE, PROPERTY_SELECTED, PROPERTY_TEXTCONTENT, PROPERTY_VALUE, PROPERTY_VISIBLE, selected, visible

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

cssClass, id, map, object, possibleRecognitionStrings, searchContext, tagName, webelement

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HierarchicalElement()
	HierarchicalElement(java.lang.Object object)

Method Summary

Modifier and Type	Method and Description
void	addChild(HierarchicalElement child)
void	addChild(HierarchicalElement[] childs)
HierarchicalElement[]	getChildren()
org.openqa.selenium.WebElement	getClickableWebElement() In this method, we are trying to get a WebElement occupying the precise area of the node. The node's text is often represented by a tag <span>, which is what we want, we will try to get it by the node's text.
java.lang.String	getFullPath() Return the full path of this node in the hierarchical structure.
HierarchicalElement	getParent()
java.lang.String	getRootId() Return the root's id (the root of this hierarchical structure like Tree or Menu)
protected HierarchicalElement[]	newArray(int length) Create an array of HierarchicalElement. Sub class MUST OVERRIDE this method to provide its own array.
protected HierarchicalElement	newInstance(java.lang.Object ojbect) Create an instance of HierarchicalElement. Sub class MUST OVERRIDE this method to provide its own instance.
protected void	parseChildren(java.util.Map<?,?> map) parse the children of this element.
protected void	parseChildren(org.openqa.selenium.WebElement element)
void	reverseChildren()
void	setChildren(HierarchicalElement[] children)
void	setParent(HierarchicalElement parent)
void	updateFields() set/update the class's fields through the underlying WebElement or AbstractMap.

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

_getLabel, contentValue, equals, getIconURL, getLabel, isDisabled, isSelected, isVisible, parseWebElementText, setSelected, toString

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

getAttribute, getCssClass, getEmbeddedObject, getId, getMap, getPossibleRecognitionStrings, getSearchContext, getTagName, getWebElement, initialize, isStale, refresh, setCssClass, setId, setPossibleRecognitionStrings, setSearchContext, setTagName, setWebElement

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROPERTY_CHILDREN

public static final java.lang.String PROPERTY_CHILDREN

'children'

See Also:

Constant Field Values

PROPERTY_PARENT

public static final java.lang.String PROPERTY_PARENT

'parent'

See Also:

Constant Field Values

parent

protected HierarchicalElement parent

children

protected HierarchicalElement[] children

Constructor Detail

HierarchicalElement

protected HierarchicalElement()

HierarchicalElement

public HierarchicalElement(java.lang.Object object)

Method Detail

updateFields

public void updateFields()

set/update the class's fields through the underlying WebElement or AbstractMap.

Overrides:

updateFields in class Element

See Also:

DefaultRefreshable.refresh(boolean)

parseChildren

protected void parseChildren(org.openqa.selenium.WebElement element)

parseChildren

protected void parseChildren(java.util.Map<?,?> map)

parse the children of this element. To create the CORRECT child element, subclass
MUST OVERRIDE newArray(int)/newInstance(Object) to provide their own instance/array.

Parameters:

map - Map, contains 'children' field.

See Also:

newArray(int), newInstance(Object)

newInstance

protected HierarchicalElement newInstance(java.lang.Object ojbect)

Create an instance of HierarchicalElement.
Sub class MUST OVERRIDE this method to provide its own instance.

Parameters:

ojbect - Object, to create an instance of this class.

Returns:

HierarchicalElement, an instance of HierarchicalElement

newArray

protected HierarchicalElement[] newArray(int length)

Create an array of HierarchicalElement.
Sub class MUST OVERRIDE this method to provide its own array.

Parameters:

length - int, the length of the array

Returns:

an array of HierarchicalElement(or subclass).

getChildren

public HierarchicalElement[] getChildren()

setChildren

public void setChildren(HierarchicalElement[] children)
                 throws SeleniumPlusException

Throws:

SeleniumPlusException

addChild

public void addChild(HierarchicalElement[] childs)

addChild

public void addChild(HierarchicalElement child)

reverseChildren

public void reverseChildren()

getParent

public HierarchicalElement getParent()

setParent

public void setParent(HierarchicalElement parent)

getRootId

public java.lang.String getRootId()

Return the root's id (the root of this hierarchical structure like Tree or Menu)

Returns:

String, the root's id.

getFullPath

public java.lang.String getFullPath()

Return the full path of this node in the hierarchical structure.

Returns:

String, the full path.

getClickableWebElement

public org.openqa.selenium.WebElement getClickableWebElement()

In this method, we are trying to get a WebElement occupying the precise area of the node.
The node's text is often represented by a tag <span>, which is what we want, we will
try to get it by the node's text.

Overrides:

getClickableWebElement in class Element

Returns:

WebElement

See Also:

getClickableWebElement()