com.github.bordertech.wcomponents.test.selenium.element

Class SeleniumWComponentWebElement

java.lang.Object

com.github.bordertech.wcomponents.test.selenium.element.SeleniumWComponentWebElement

All Implemented Interfaces:

org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebElement

Direct Known Subclasses:

SeleniumGroupInputWebElement, SeleniumSimpleSelectWebElement, SeleniumWButtonWebElement, SeleniumWComponentInputWebElement, SeleniumWDialogWebElement, SeleniumWLabelWebElement, SeleniumWMessageBoxWebElement, SeleniumWMessagesWebElement, SeleniumWTableWebElement

public class SeleniumWComponentWebElement
extends Object
implements org.openqa.selenium.WebElement

A wrapper for WebElement to provide specific WComponents behavior.

Since:

1.2.0

Author:

Joshua Barclay, Mark Reeves

Constructor Summary

Constructors

Constructor and Description
SeleniumWComponentWebElement(org.openqa.selenium.WebElement element, org.openqa.selenium.WebDriver driver) Creates a WebElementWrapper.

Method Summary

Modifier and Type	Method and Description
void	clear()
void	click()
protected void	clickElementNoWait(org.openqa.selenium.WebElement element)
void	clickNoWait() Perform a click action without waiting for the WComponent ready status Used when the click will result in a non-WComponents page.
SeleniumWComponentWebElement	findElement(org.openqa.selenium.By by)
SeleniumWComponentWebElement	findElementImmediate(org.openqa.selenium.By by) Find immediate with no polling.
List<org.openqa.selenium.WebElement>	findElements(org.openqa.selenium.By by)
List<org.openqa.selenium.WebElement>	findElementsImmediate(org.openqa.selenium.By by) Find immediate with no polling.
String	getActiveId() Get the id of the default "active" part of the component.
String	getAttribute(String name)
String	getCssValue(String propertyName)
protected org.openqa.selenium.WebDriver	getDriver()
org.openqa.selenium.WebElement	getElement()
org.openqa.selenium.Point	getLocation()
org.openqa.selenium.Rectangle	getRect()
<X> X	getScreenshotAs(org.openqa.selenium.OutputType<X> ot)
org.openqa.selenium.Dimension	getSize()
String	getTagName()
String	getText()
UIContext	getUserContextForSession()
boolean	isDisplayed()
boolean	isEnabled()
boolean	isHidden()
boolean	isSelected()
void	sendKeys(boolean wait, CharSequence... keys) Send a key sequence and optionally wait for page ready afterwards.
void	sendKeys(CharSequence... keys)
void	submit()
void	waitForPageReady() Wait for the page to have loaded, including all AJAX and JavaScript.
protected SeleniumWComponentWebElement	wrapElement(org.openqa.selenium.WebElement element)

Methods inherited from class java.lang.Object

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

Constructor Detail

SeleniumWComponentWebElement

public SeleniumWComponentWebElement(org.openqa.selenium.WebElement element,
                                    org.openqa.selenium.WebDriver driver)

Creates a WebElementWrapper.

Parameters:

element - the backing element.

driver - the SeleniumWComponentsWebDriver.

Method Detail

getDriver

protected org.openqa.selenium.WebDriver getDriver()

Returns:

the driver.

clear

public void clear()

Specified by:

clear in interface org.openqa.selenium.WebElement

click

public void click()

Specified by:

click in interface org.openqa.selenium.WebElement

clickNoWait

public void clickNoWait()

Perform a click action without waiting for the WComponent ready status

Used when the click will result in a non-WComponents page.

findElementImmediate

public SeleniumWComponentWebElement findElementImmediate(org.openqa.selenium.By by)

Find immediate with no polling.

Parameters:

by - the by condition

Returns:

the matching element

findElementsImmediate

public List<org.openqa.selenium.WebElement> findElementsImmediate(org.openqa.selenium.By by)

Find immediate with no polling.

Parameters:

by - the by condition

Returns:

the matching element

findElement

public SeleniumWComponentWebElement findElement(org.openqa.selenium.By by)

Specified by:

findElement in interface org.openqa.selenium.SearchContext

Specified by:

findElement in interface org.openqa.selenium.WebElement

findElements

public List<org.openqa.selenium.WebElement> findElements(org.openqa.selenium.By by)

Specified by:

findElements in interface org.openqa.selenium.SearchContext

Specified by:

findElements in interface org.openqa.selenium.WebElement

getAttribute

public String getAttribute(String name)

Specified by:

getAttribute in interface org.openqa.selenium.WebElement

getTagName

public String getTagName()

Specified by:

getTagName in interface org.openqa.selenium.WebElement

getText

public String getText()

Specified by:

getText in interface org.openqa.selenium.WebElement

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface org.openqa.selenium.WebElement

isSelected

public boolean isSelected()

Specified by:

isSelected in interface org.openqa.selenium.WebElement

isHidden

public boolean isHidden()

Returns:

true if the element is hidden in the current UI. This is not exactly the same as the reverse of isDisplayed as it tests only for the element being hidden using the meachanism internal to WComponents and not any other (CSS-based) mechanism which may result in isDisplayed() returning false.

sendKeys

public void sendKeys(CharSequence... keys)

Specified by:

sendKeys in interface org.openqa.selenium.WebElement

sendKeys

public void sendKeys(boolean wait,
                     CharSequence... keys)

Send a key sequence and optionally wait for page ready afterwards.

Parameters:

wait - if true then wait for page ready after sending the keys

keys - The keys to send

submit

public void submit()

Specified by:

submit in interface org.openqa.selenium.WebElement

isDisplayed

public boolean isDisplayed()

Specified by:

isDisplayed in interface org.openqa.selenium.WebElement

getLocation

public org.openqa.selenium.Point getLocation()

Specified by:

getLocation in interface org.openqa.selenium.WebElement

getSize

public org.openqa.selenium.Dimension getSize()

Specified by:

getSize in interface org.openqa.selenium.WebElement

getCssValue

public String getCssValue(String propertyName)

Specified by:

getCssValue in interface org.openqa.selenium.WebElement

getRect

public org.openqa.selenium.Rectangle getRect()

Specified by:

getRect in interface org.openqa.selenium.WebElement

getScreenshotAs

public <X> X getScreenshotAs(org.openqa.selenium.OutputType<X> ot)
                      throws org.openqa.selenium.WebDriverException

Specified by:

getScreenshotAs in interface org.openqa.selenium.TakesScreenshot

Throws:

org.openqa.selenium.WebDriverException

getActiveId

public String getActiveId()

Get the id of the default "active" part of the component. This may not be the WComponent id.

Returns:

the active component's id, by default this is the WComponent id.

getElement

public org.openqa.selenium.WebElement getElement()

Returns:

the backing web element

getUserContextForSession

public UIContext getUserContextForSession()

Returns:

the user context for this session

waitForPageReady

public void waitForPageReady()

Wait for the page to have loaded, including all AJAX and JavaScript. Uses default values for timeout and polling interval.

clickElementNoWait

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

Parameters:

element - the element to click with no wait

wrapElement

protected SeleniumWComponentWebElement wrapElement(org.openqa.selenium.WebElement element)

Parameters:

element - the element to wrap

Returns:

the element wrapped as SeleniumWComponentWebElement