com.tplan.robot.remoteclient.capabilities

Interface IOConfigurationCapable

All Superinterfaces:

Capability

public interface IOConfigurationCapable
extends Capability

Methods of a client wishing to override the I/O configuration settings such as the keyboard and mouse delays.

Since:

3.5

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

Method Summary

Modifier and Type	Method and Description
Integer	getClickPressReleaseDelayMs() Get the preferred delay between the mouse button press and release events in milliseconds.
Integer	getDragDelayMs()
Integer	getKeyPressReleaseDelayMs() Get the preferred delay between the key press and release events in milliseconds.
Integer	getMaximumDragDistance()
Integer	getMaximumMoveDistance()
Integer	getMoveDelayMs()
Integer	getMultiClickDelayMs() Get the preferred delay between two subsequent mouse clicks generated by a single command.
Integer	getMultiKeyDelayMs() Get the preferred delay between two subsequent key presses generated by a single command.
Boolean	isGenerateMoveBeforePressEnabled() Indicate whether the Mouse command should internally generate mouse move events in the direction of the target location before it performs a mouse press.
Boolean	isMouseMoveRecordingEnabled()
Boolean	isSmoothMouseMoveEnabled()
void	setTextBeingTyped(boolean b) Indicate that typing of a longer text has either started or finished.

Method Detail

getKeyPressReleaseDelayMs

Integer getKeyPressReleaseDelayMs()

Get the preferred delay between the key press and release events in milliseconds.

Returns:

the delay or null if the client wishes to fall back to the generic configuration value stored in the UserConfiguration under the PressCommand.pressReleaseDelay parameter key.

getMultiKeyDelayMs

Integer getMultiKeyDelayMs()

Get the preferred delay between two subsequent key presses generated by a single command. This delay is applied when the Press command is executed with the count parameter set to 2 or more.

Returns:

the delay or null if the client wishes to fall back to the generic configuration value stored in the UserConfiguration under the PressCommand.multiKeyDelay parameter key.

getClickPressReleaseDelayMs

Integer getClickPressReleaseDelayMs()

Get the preferred delay between the mouse button press and release events in milliseconds.

Returns:

the delay or null if the client wishes to fall back to the generic configuration value stored in the UserConfiguration under the MouseCommand.pressReleaseDelay parameter key.

getMultiClickDelayMs

Integer getMultiClickDelayMs()

Get the preferred delay between two subsequent mouse clicks generated by a single command. This delay is applied when the "Mouse click" command is executed with the count parameter set to 2 or more.

Returns:

the delay or null if the client wishes to fall back to the generic configuration value stored in the UserConfiguration under the MouseCommand.multiClickDelay parameter key.

isGenerateMoveBeforePressEnabled

Boolean isGenerateMoveBeforePressEnabled()

Indicate whether the Mouse command should internally generate mouse move events in the direction of the target location before it performs a mouse press. This is required by some desktop systems which may fail to recognize the press when there is no mouse pointer move. Systems using a touch screen typically return false because there's no continuous mouse pointer movement to the target press location.

Returns:

true sets on generating of the mouse move events. The method may return null if the client wishes to fall back to the generic configuration value stored in the UserConfiguration under the MouseCommand.generateMouseMove parameter key.

getMaximumDragDistance

Integer getMaximumDragDistance()

getDragDelayMs

Integer getDragDelayMs()

isSmoothMouseMoveEnabled

Boolean isSmoothMouseMoveEnabled()

getMaximumMoveDistance

Integer getMaximumMoveDistance()

getMoveDelayMs

Integer getMoveDelayMs()

isMouseMoveRecordingEnabled

Boolean isMouseMoveRecordingEnabled()

setTextBeingTyped

void setTextBeingTyped(boolean b)

Indicate that typing of a longer text has either started or finished. This may be used for optimization because no control keys will be pressed in this mode.

Parameters:

b - true means that a text is about to type while false indicates that typing has finished.

Since:

4.1.1