io.appium.java_client.pagefactory

Class Widget

java.lang.Object

io.appium.java_client.pagefactory.Widget

All Implemented Interfaces:

org.openqa.selenium.internal.WrapsDriver, org.openqa.selenium.internal.WrapsElement, SearchContext

public abstract class Widget
extends java.lang.Object
implements SearchContext, org.openqa.selenium.internal.WrapsDriver, org.openqa.selenium.internal.WrapsElement

It is the Appium-specific extension of the Page Object design pattern. It allows user to create objects which typify some element with nested sub-elements. Also it allows to describe and encapsulate logic of interaction/behavior within. About the Page Object design pattern please read these documents: - https://code.google.com/p/selenium/wiki/PageObjects - https://code.google.com/p/selenium/wiki/PageFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Widget(WebElement element)

Method Summary

Modifier and Type	Method and Description
WebElement	findElement(org.openqa.selenium.By by) Find the first WebElement using the given method.
java.util.List<WebElement>	findElements(org.openqa.selenium.By by) Find all elements within the current context using the given mechanism.
Widget	getSelfReference()
WebDriver	getWrappedDriver()
WebElement	getWrappedElement()

Methods inherited from class java.lang.Object

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

Constructor Detail

Widget

protected Widget(WebElement element)

Method Detail

findElements

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

Description copied from interface: SearchContext

Find all elements within the current context using the given mechanism.

Specified by:

findElements in interface SearchContext

Parameters:

by - The locating mechanism to use

Returns:

A list of all WebElements, or an empty list if nothing matches

See Also:

By

findElement

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

Description copied from interface: SearchContext

Find the first WebElement using the given method.

Specified by:

findElement in interface SearchContext

Parameters:

by - The locating mechanism

Returns:

The first matching element on the current context

getWrappedDriver

public WebDriver getWrappedDriver()

Specified by:

getWrappedDriver in interface org.openqa.selenium.internal.WrapsDriver

getWrappedElement

public WebElement getWrappedElement()

Specified by:

getWrappedElement in interface org.openqa.selenium.internal.WrapsElement

getSelfReference

public Widget getSelfReference()