io.selendroid.client

Class TouchActionBuilder

java.lang.Object

io.selendroid.client.TouchActionBuilder

public class TouchActionBuilder
extends Object

The TouchActionBuilder is used to construct TouchActions by sequencing low level touch screen interactions that are executed on a device

Constructor Summary

Constructors

Constructor and Description
TouchActionBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAction(String actionName)
TouchAction	build()
TouchActionBuilder	flick(org.openqa.selenium.Point origin, FlickDirection direction, int distance, int duration) Non-standard (high-level) command to flick the screen in a given tick.
TouchActionBuilder	pause() Pause can be used to synchronize actions in a MultiTouchAction chain, pause() is equivalent to a no-op for a tick.
TouchActionBuilder	pause(int ms) Pause for a given period of time (in milliseconds).
TouchActionBuilder	pointerCancel() Cancels the existing sequence of actions.
TouchActionBuilder	pointerDown(int x, int y) Places Pointer down at the specified (x, y) coordinates.
TouchActionBuilder	pointerDown(org.openqa.selenium.WebElement element) Places the pointer down at the top left corner of the specified WebElement.
TouchActionBuilder	pointerDown(org.openqa.selenium.WebElement element, int x, int y) Places pointer down at an offset from the top left corner of the specified WebElement
TouchActionBuilder	pointerMove(int x, int y) Places Moves the pointer to the specified (x, y) coordinates.
TouchActionBuilder	pointerMove(org.openqa.selenium.WebElement element) Moves the pointer to the top left corner of the specified WebElement.
TouchActionBuilder	pointerMove(org.openqa.selenium.WebElement element, int x, int y) Moves the pointer to a position offset from the top left corner of the specified WebElement This is only possible if the pointer is currently down.
TouchActionBuilder	pointerUp() Removes pointer from the touch screen at it's current position.

Methods inherited from class java.lang.Object

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

Constructor Detail

TouchActionBuilder

public TouchActionBuilder()

Method Detail

addAction

public void addAction(String actionName)

pointerDown

public TouchActionBuilder pointerDown(org.openqa.selenium.WebElement element)

Places the pointer down at the top left corner of the specified WebElement.

Parameters:

element - WebElement to place pointer down on

Returns:

this

pointerDown

public TouchActionBuilder pointerDown(int x,
                             int y)

Places Pointer down at the specified (x, y) coordinates.

Parameters:

x - x-coordinate

y - y-coordinate

Returns:

this

pointerDown

public TouchActionBuilder pointerDown(org.openqa.selenium.WebElement element,
                             int x,
                             int y)

Places pointer down at an offset from the top left corner of the specified WebElement

Parameters:

element - WebElement to place pointer relative to

x - x-offset from top left

y - y-offset from top left

Returns:

this

pointerUp

public TouchActionBuilder pointerUp()

Removes pointer from the touch screen at it's current position. This method should only be called after pointerDown() has been called.

Returns:

this

pointerMove

public TouchActionBuilder pointerMove(org.openqa.selenium.WebElement element)

Moves the pointer to the top left corner of the specified WebElement. This is only possible if the pointer is currently down.

Parameters:

element - WebElement to place pointer down on

Returns:

this

pointerMove

public TouchActionBuilder pointerMove(int x,
                             int y)

Places Moves the pointer to the specified (x, y) coordinates. This is only possible if the pointer is currently down.

Parameters:

x - x-coordinate

y - y-coordinate

Returns:

this

pointerMove

public TouchActionBuilder pointerMove(org.openqa.selenium.WebElement element,
                             int x,
                             int y)

Moves the pointer to a position offset from the top left corner of the specified WebElement This is only possible if the pointer is currently down.

Parameters:

element - WebElement to place pointer relative to

x - x-offset from top left

y - y-offset from top left

Returns:

this

pause

public TouchActionBuilder pause()

Pause can be used to synchronize actions in a MultiTouchAction chain, pause() is equivalent to a no-op for a tick.

Returns:

this

pause

public TouchActionBuilder pause(int ms)

Pause for a given period of time (in milliseconds). If used in a MultiTouchAction all actions will pause for the longest pause in a given tick.

Parameters:

ms - Pause Time (in ms)

Returns:

this

flick

public TouchActionBuilder flick(org.openqa.selenium.Point origin,
                       FlickDirection direction,
                       int distance,
                       int duration)

Non-standard (high-level) command to flick the screen in a given tick. This method should not be used in MultiTouchActions, or if the pointer is already down in a given position.

Parameters:

origin - Point at which the flick should start

direction - Direction in which to flick

distance - Distance in which the flick should occur

duration - Length of time the finger should be down on the screen

Returns:

this

pointerCancel

public TouchActionBuilder pointerCancel()

Cancels the existing sequence of actions. This will release the pointer if it is already down.

Returns:

this

build

public TouchAction build()