io.appium.java_client.touch.offset

Class ElementOption

java.lang.Object

io.appium.java_client.touch.ActionOptions<T>

io.appium.java_client.touch.offset.PointOption<ElementOption>

io.appium.java_client.touch.offset.ElementOption

public class ElementOption
extends PointOption<ElementOption>

Field Summary

Fields inherited from class io.appium.java_client.touch.offset.PointOption

coordinates

Constructor Summary

Constructors

Constructor and Description
ElementOption()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	build() Creates a map based on the provided options.
static ElementOption	element(WebElement element) This method creates a build instance of the ElementOption.
static ElementOption	element(WebElement element, int x, int y) This method creates a build instance of the ElementOption.
protected void	verify() This method is automatically called before building options map to verify the consistency of the instance.
ElementOption	withCoordinates(int xOffset, int yOffset) It defines x and y offset from the upper left corner of an element.
ElementOption	withElement(WebElement element) This method sets the element as an option.

Methods inherited from class io.appium.java_client.touch.offset.PointOption

point

Methods inherited from class java.lang.Object

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

Constructor Detail

ElementOption

public ElementOption()

Method Detail

element

public static ElementOption element(WebElement element,
                                    int x,
                                    int y)

This method creates a build instance of the ElementOption.

Parameters:

element - is the element to calculate offset from.

x - is the x-offset from the upper left corner of the given element.

y - is the y-offset from the upper left corner of the given element.

Returns:

the built option

element

public static ElementOption element(WebElement element)

This method creates a build instance of the ElementOption.

Parameters:

element - is the element to calculate offset from.

Returns:

the built option

withCoordinates

public ElementOption withCoordinates(int xOffset,
                                     int yOffset)

It defines x and y offset from the upper left corner of an element.

Overrides:

withCoordinates in class PointOption<ElementOption>

Parameters:

xOffset - is x value.

yOffset - is y value.

Returns:

self-reference

withElement

public ElementOption withElement(WebElement element)

This method sets the element as an option. It means that x/y offset is the offset from the upper left corner of the given element.

Parameters:

element - is the element to calculate offset from.

Returns:

self-reference

verify

protected void verify()

Description copied from class: ActionOptions

This method is automatically called before building options map to verify the consistency of the instance.

Overrides:

verify in class PointOption<ElementOption>

build

public java.util.Map<java.lang.String,java.lang.Object> build()

Description copied from class: ActionOptions

Creates a map based on the provided options.

Overrides:

build in class PointOption<ElementOption>

Returns:

options mapping.