org.safs.selenium.webdriver.lib.model

Class EmbeddedObject

java.lang.Object

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

All Implemented Interfaces:

Supportable

Direct Known Subclasses:

AbstractSelectable, CheckBox.AbstractCheckable, ComboBox.HtmlSelect, ScrollBar.AbstractScrollable

public abstract class EmbeddedObject
extends java.lang.Object
implements Supportable

This class represents an object to be included in the org.safs.selenium.webdriver.lib.Component
or its subclass. This class provides an ability to detect whether the webelement is supported for
a certain Component (Tree, ListView) whatever the domain (DOJO, SAP, HTML) this webelement belongs to.
Subclass needs to provide the method Supportable.getSupportedClassNames().

History:

Apr 25, 2014 (Lei Wang) Initial release.
Oct 15, 2014 (Lei Wang) Add method isShowOnPage().

Field Summary

Fields

Modifier and Type	Field and Description
protected Component	parent The Component object who is the parent of this embedded object.

Constructor Summary

Constructors

Constructor and Description
EmbeddedObject(Component parent)

Method Summary

Modifier and Type	Method and Description
protected boolean	isShowOnPage(Element element) To check if an Element is visible on page. If the center of the element is in the container and is shown in the browser's client area, the element will be considered as visible on page.
boolean	isSupported(org.openqa.selenium.WebElement element) Test if the element is supported.
boolean	refresh(boolean checkStale) If some native javascript APIs are called, the parent's under-lying web element may become stale.
org.openqa.selenium.WebElement	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

Field Detail

parent

protected Component parent

The Component object who is the parent of this embedded object.

Constructor Detail

EmbeddedObject

public EmbeddedObject(Component parent)
               throws SeleniumPlusException

Throws:

SeleniumPlusException

Method Detail

isSupported

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

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

Specified by:

isSupported in interface Supportable

Parameters:

element - WebElement, the element to check.

refresh

public boolean refresh(boolean checkStale)

If some native javascript APIs are called, the parent's under-lying web element may become stale.
In this case, this refresh() method needs to be called.
Normally before calling webelement() to get a webelement, you may call this refresh(boolean).

Parameters:

checkStale - boolean, if true then check if the element is stale or not before refresh; ohterwise, then refresh the element directly. The check will spend some time, if you don't want to waste time, use false.

Returns:

boolean, true if the refresh succeed

See Also:

webelement()

isShowOnPage

protected boolean isShowOnPage(Element element)
                        throws SeleniumPlusException

To check if an Element is visible on page.
If the center of the element is in the container and is shown in the browser's client area, the
element will be considered as visible on page.

Parameters:

element - Element, the element to check

Returns:

boolean, true if the element is visible on page.

Throws:

SeleniumPlusException

webelement

public org.openqa.selenium.WebElement webelement()