com.tplan.robot.remoteclient.capabilities

Interface GestureCapable

public interface GestureCapable

Interface of a client able to perform free style touch screen gestures.

Since:

6.2

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DURATION_MS
static String	GESTURE_MOVE
static String	GESTURE_PRESS
static String	GESTURE_RELEASE
static int	MAX_FINGERS
static int	MIN_DURATION_MS
static int	MOVE_LOOPS
static String	PARAM_EVENT
static String	PARAM_FINGER
static String	PARAM_TO
static int	STEP_DELAY_MS

Method Summary

Modifier and Type	Method and Description
void	checkSupported() Check if gestures are supported.
int	getMaxFingers() Get the maximum number of fingers supported by the device.
boolean	isAsynchronous() Indicate whether the gesture is performed synchronously (false) or asynchronously (true).
void	performGesture(List<Map> params, Dimension screenSize, int durationMs) Perform the gesture.

Field Detail

MAX_FINGERS

static final int MAX_FINGERS

See Also:

Constant Field Values

MOVE_LOOPS

static final int MOVE_LOOPS

See Also:

Constant Field Values

STEP_DELAY_MS

static final int STEP_DELAY_MS

See Also:

Constant Field Values

DEFAULT_DURATION_MS

static final int DEFAULT_DURATION_MS

See Also:

Constant Field Values

MIN_DURATION_MS

static final int MIN_DURATION_MS

See Also:

Constant Field Values

GESTURE_PRESS

static final String GESTURE_PRESS

See Also:

Constant Field Values

GESTURE_MOVE

static final String GESTURE_MOVE

See Also:

Constant Field Values

GESTURE_RELEASE

static final String GESTURE_RELEASE

See Also:

Constant Field Values

PARAM_EVENT

static final String PARAM_EVENT

See Also:

Constant Field Values

PARAM_FINGER

static final String PARAM_FINGER

See Also:

Constant Field Values

PARAM_TO

static final String PARAM_TO

See Also:

Constant Field Values

Method Detail

checkSupported

void checkSupported()
             throws UnsupportedOperationException

Check if gestures are supported.

Throws:

UnsupportedOperationException - if gestures are not supported by the implementing class.

getMaxFingers

int getMaxFingers()

Get the maximum number of fingers supported by the device.

Returns:

the maximum number of fingers supported by the device.

isAsynchronous

boolean isAsynchronous()

Indicate whether the gesture is performed synchronously (false) or asynchronously (true). For asynchronous implementations the calling process typically pauses for the gesture duration to avoid further interaction while the gesture is still executing.

Returns:

true/false if the gesture is asynchronous/synchronous.

performGesture

void performGesture(List<Map> params,
                    Dimension screenSize,
                    int durationMs)
             throws IOException

Perform the gesture.

Parameters:

params - gesture parameters. It is a list of steps. Each step is a map which specifies the finger ID (PARAM_EVENT having one of the PARAM_FINGER values), the action type (GESTURE_MOVE, GESTURE_PRESS, GESTURE_RELEASE)and the target location (PARAM_TO).

screenSize - the current client screen size. It is used to resolve relative coordinates given as percentages.

durationMs - gesture duration in milliseconds.

Throws:

IOException - on an I/O error.