io.appium.java_client.pagefactory

Class AppiumFieldDecorator

java.lang.Object

io.appium.java_client.pagefactory.AppiumFieldDecorator

All Implemented Interfaces:

org.openqa.selenium.support.pagefactory.FieldDecorator

public class AppiumFieldDecorator
extends Object
implements org.openqa.selenium.support.pagefactory.FieldDecorator

Default decorator for use with PageFactory. Will decorate 1) all of the WebElement fields and 2) List of WebElement that have @AndroidFindBy, @AndroidFindBys, or @iOSFindBy/@iOSFindBys annotation with a proxy that locates the elements using the passed in ElementLocatorFactory. Please pay attention: fields of WebElement, RemoteWebElement, MobileElement, AndroidElement and IOSElement are allowed to use with this decorator

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_IMPLICITLY_WAIT_TIMEOUT
static TimeUnit	DEFAULT_TIMEUNIT

Constructor Summary

Constructors

Constructor and Description
AppiumFieldDecorator(org.openqa.selenium.SearchContext context)
AppiumFieldDecorator(org.openqa.selenium.SearchContext context, long implicitlyWaitTimeOut, TimeUnit timeUnit)
AppiumFieldDecorator(org.openqa.selenium.SearchContext context, TimeOutDuration timeOutDuration)

Method Summary

Methods

Modifier and Type	Method and Description
Object	decorate(ClassLoader ignored, Field field)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_IMPLICITLY_WAIT_TIMEOUT

public static long DEFAULT_IMPLICITLY_WAIT_TIMEOUT

DEFAULT_TIMEUNIT

public static TimeUnit DEFAULT_TIMEUNIT

Constructor Detail

AppiumFieldDecorator

public AppiumFieldDecorator(org.openqa.selenium.SearchContext context,
                    long implicitlyWaitTimeOut,
                    TimeUnit timeUnit)

AppiumFieldDecorator

public AppiumFieldDecorator(org.openqa.selenium.SearchContext context,
                    TimeOutDuration timeOutDuration)

Parameters:

context - is an instance of SearchContext It may be the instance of WebDriver or WebElement or Widget or some other user's extension/implementation.

timeOutDuration - is a desired duration of the waiting for an element presence.

AppiumFieldDecorator

public AppiumFieldDecorator(org.openqa.selenium.SearchContext context)

Method Detail

decorate

public Object decorate(ClassLoader ignored,
              Field field)

Specified by:

decorate in interface org.openqa.selenium.support.pagefactory.FieldDecorator

Parameters:

ignored - class loader is ignored by current implementation

field - is Field of page object which is supposed to be decorated.

Returns:

a field value or null.