io.appium.java_client

Class TouchAction

java.lang.Object

io.appium.java_client.TouchAction

All Implemented Interfaces:

PerformsActions<TouchAction>

Direct Known Subclasses:

IOSTouchAction

public class TouchAction
extends java.lang.Object
implements PerformsActions<TouchAction>

Used for Webdriver 3 touch actions See the Webriver 3 spec https://dvcs.w3.org/hg/webdriver/raw-file/default/webdriver-spec.html The flow is to chain individual touch actions into an entire gesture. e.g. TouchAction action = new TouchAction(performsTouchActions); action.press(element).waitAction(300).moveTo(element1).release().perform(); Calling perform() sends the action command to the Mobile Driver. Otherwise, more and more actions can be chained.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TouchAction.ActionParameter Just holds values to eventually return the parameters required for the mjsonwp.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.common.collect.ImmutableList.Builder<TouchAction.ActionParameter>	parameterBuilder

Constructor Summary

Constructors

Constructor and Description
TouchAction(PerformsTouchActions performsTouchActions)

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel this action, if it was partially completed by the performsTouchActions.
protected void	clearParameters()
protected com.google.common.collect.ImmutableMap<java.lang.String,com.google.common.collect.ImmutableList<java.lang.Object>>	getParameters() Get the mjsonwp parameters for this Action.
TouchAction	longPress(int x, int y) Press and hold the at an absolute position on the screen until the contextmenu event has fired.
TouchAction	longPress(int x, int y, java.time.Duration duration) Press and hold the at an absolute position on the screen until the contextmenu event has fired.
TouchAction	longPress(int x, int y, int duration) Deprecated.
TouchAction	longPress(WebElement el) Press and hold the at the center of an element until the contextmenu event has fired.
TouchAction	longPress(WebElement el, java.time.Duration duration) Press and hold the at the center of an element until the contextmenu event has fired.
TouchAction	longPress(WebElement el, int duration) Deprecated.
TouchAction	longPress(WebElement el, int x, int y) Press and hold the at an elements upper-left corner, offset by the given amount, until the contextmenu event has fired.
TouchAction	longPress(WebElement el, int x, int y, java.time.Duration duration) Press and hold the at an elements upper-left corner, offset by the given amount, until the contextmenu event has fired.
TouchAction	longPress(WebElement el, int x, int y, int duration) Deprecated.
TouchAction	moveTo(int x, int y) Move current touch to a new position relative to the current position on the screen.
TouchAction	moveTo(WebElement el) Move current touch to center of an element.
TouchAction	moveTo(WebElement el, int x, int y) Move current touch to an element, offset from upper left corner.
TouchAction	perform() Perform this chain of actions on the performsTouchActions.
TouchAction	press(int x, int y) Press on an absolute position on the screen.
TouchAction	press(WebElement el) Press on the center of an element.
TouchAction	press(WebElement el, int x, int y) Press on an element, offset from upper left corner by a number of pixels.
TouchAction	release() Remove the current touching implement from the screen (withdraw your touch).
TouchAction	tap(int x, int y) Tap an absolute position on the screen.
TouchAction	tap(WebElement el) Tap the center of an element.
TouchAction	tap(WebElement el, int x, int y) Tap an element, offset from upper left corner.
TouchAction	waitAction() A wait action, used as a NOP in multi-chaining.
TouchAction	waitAction(java.time.Duration duration) Waits for specified amount of time to pass before continue to next touch action.
TouchAction	waitAction(int ms) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

parameterBuilder

protected com.google.common.collect.ImmutableList.Builder<TouchAction.ActionParameter> parameterBuilder

Constructor Detail

TouchAction

public TouchAction(PerformsTouchActions performsTouchActions)

Method Detail

press

public TouchAction press(WebElement el)

Press on the center of an element.

Parameters:

el - element to press on.

Returns:

this TouchAction, for chaining.

press

public TouchAction press(int x,
                         int y)

Press on an absolute position on the screen.

Parameters:

x - x coordinate.

y - y coordinate.

Returns:

this TouchAction, for chaining.

press

public TouchAction press(WebElement el,
                         int x,
                         int y)

Press on an element, offset from upper left corner by a number of pixels.

Parameters:

el - element to press on.

x - x offset.

y - y offset.

Returns:

this TouchAction, for chaining.

release

public TouchAction release()

Remove the current touching implement from the screen (withdraw your touch).

Returns:

this TouchAction, for chaining.

moveTo

public TouchAction moveTo(WebElement el)

Move current touch to center of an element.

Parameters:

el - element to move to.

Returns:

this TouchAction, for chaining.

moveTo

public TouchAction moveTo(int x,
                          int y)

Move current touch to a new position relative to the current position on the screen. If the current position of this TouchAction is (xOld, yOld), then this method will move the TouchAction to (xOld + x, yOld + y).

Parameters:

x - change in x coordinate to move through.

y - change in y coordinate to move through.

Returns:

this TouchAction, for chaining.

moveTo

public TouchAction moveTo(WebElement el,
                          int x,
                          int y)

Move current touch to an element, offset from upper left corner.

Parameters:

el - element to move current touch to.

x - x offset.

y - y offset.

Returns:

this TouchAction, for chaining.

tap

public TouchAction tap(WebElement el)

Tap the center of an element.

Parameters:

el - element to tap.

Returns:

this TouchAction, for chaining.

tap

public TouchAction tap(int x,
                       int y)

Tap an absolute position on the screen.

Parameters:

x - x coordinate.

y - y coordinate.

Returns:

this TouchAction, for chaining.

tap

public TouchAction tap(WebElement el,
                       int x,
                       int y)

Tap an element, offset from upper left corner.

Parameters:

el - element to tap.

x - x offset.

y - y offset.

Returns:

this TouchAction, for chaining.

waitAction

public TouchAction waitAction()

A wait action, used as a NOP in multi-chaining.

Returns:

this TouchAction, for chaining.

waitAction

@Deprecated
public TouchAction waitAction(int ms)

Deprecated.

Waits for specified amount of time to pass before continue to next touch action. The method is deprecated. Please use waitAction(Duration) instead.

Parameters:

ms - time in milliseconds to wait.

Returns:

this TouchAction, for chaining.

waitAction

public TouchAction waitAction(java.time.Duration duration)

Waits for specified amount of time to pass before continue to next touch action.

Parameters:

duration - of the wait action. Minimum time reolution unit is one millisecond.

Returns:

this TouchAction, for chaining.

longPress

public TouchAction longPress(WebElement el)

Press and hold the at the center of an element until the contextmenu event has fired.

Parameters:

el - element to long-press.

Returns:

this TouchAction, for chaining.

longPress

@Deprecated
public TouchAction longPress(WebElement el,
                                          int duration)

Deprecated.

Press and hold the at the center of an element until the contextmenu event has fired. This method is deprecated. Please use longPress(WebElement, Duration) instead.

Parameters:

el - element to long-press.

duration - of the long-press, in milliseconds.

Returns:

this TouchAction, for chaining.

longPress

public TouchAction longPress(WebElement el,
                             java.time.Duration duration)

Press and hold the at the center of an element until the contextmenu event has fired.

Parameters:

el - element to long-press.

duration - of the long-press. Minimum time resolution unit is one millisecond.

Returns:

this TouchAction, for chaining.

longPress

public TouchAction longPress(int x,
                             int y)

Press and hold the at an absolute position on the screen until the contextmenu event has fired.

Parameters:

x - x coordinate.

y - y coordinate.

Returns:

this TouchAction, for chaining.

longPress

@Deprecated
public TouchAction longPress(int x,
                                          int y,
                                          int duration)

Deprecated.

Press and hold the at an absolute position on the screen until the contextmenu event has fired. The method is deprecated. Please use longPress(int, int, Duration) instead.

Parameters:

x - x coordinate.

y - y coordinate.

duration - of the long-press, in milliseconds.

Returns:

this TouchAction, for chaining.

longPress

public TouchAction longPress(int x,
                             int y,
                             java.time.Duration duration)

Press and hold the at an absolute position on the screen until the contextmenu event has fired.

Parameters:

x - x coordinate.

y - y coordinate.

duration - of the long-press. Minimum time resolution unit is one millisecond.

Returns:

this TouchAction, for chaining.

longPress

public TouchAction longPress(WebElement el,
                             int x,
                             int y)

Press and hold the at an elements upper-left corner, offset by the given amount, until the contextmenu event has fired.

Parameters:

el - element to long-press.

x - x offset.

y - y offset.

Returns:

this TouchAction, for chaining.

longPress

@Deprecated
public TouchAction longPress(WebElement el,
                                          int x,
                                          int y,
                                          int duration)

Deprecated.

Press and hold the at an elements upper-left corner, offset by the given amount, until the contextmenu event has fired. The method is deprecated. Please use longPress(WebElement, int, int, Duration) instead.

Parameters:

el - element to long-press.

x - x offset.

y - y offset.

duration - of the long-press, in milliseconds.

Returns:

this TouchAction, for chaining.

longPress

public TouchAction longPress(WebElement el,
                             int x,
                             int y,
                             java.time.Duration duration)

Press and hold the at an elements upper-left corner, offset by the given amount, until the contextmenu event has fired.

Parameters:

el - element to long-press.

x - x offset.

y - y offset.

duration - of the long-press. Minimum time resolution unit is one millisecond.

Returns:

this TouchAction, for chaining.

cancel

public void cancel()

Cancel this action, if it was partially completed by the performsTouchActions.

perform

public TouchAction perform()

Perform this chain of actions on the performsTouchActions.

Specified by:

perform in interface PerformsActions<TouchAction>

Returns:

this TouchAction, for possible segmented-touches.

getParameters

protected com.google.common.collect.ImmutableMap<java.lang.String,com.google.common.collect.ImmutableList<java.lang.Object>> getParameters()

Get the mjsonwp parameters for this Action.

Returns:

A map of parameters for this touch action to pass as part of mjsonwp.

clearParameters

protected void clearParameters()