com.tplan.robot.remoteclient.capabilities

Interface LocalRecordingCapable

public interface LocalRecordingCapable

Interface of a local desktop client that can retrieve low level OS mouse and keyboard events for the script recording purposes.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFG_KEY_SHOW_INFO_MSG Name of the configuration key holding the flag controlling whether to show the info message on recording mode start.
static String	PROPERTY_EVT_EXITING_RECORDING Name of the property event to fire to the main window when the local recording finished.
static String	PROPERTY_EVT_STARTED_RECORDING Name of the property event to fire to the main window right after the local recording was started.
static String	PROPERTY_EVT_STARTING_RECORDING Name of the property event to fire to the main window when the local recording is about to start.

Method Summary

Modifier and Type	Method and Description
void	addObserver(Object recorder) Add (register) a recording observer.
boolean	canRecord() Define whether the recording can be currently started.
boolean	isRecording() Find out if the recording is in progress.
void	removeAllObservers() Remove (deregister) all observers registered through the addObserver(java.lang.Object) method.
void	removeObserver(Object recorder) Remove a recording observer.
void	setRecording(boolean enable) Start (enable) or finish (disable) recording.

Field Detail

PROPERTY_EVT_STARTING_RECORDING

static final String PROPERTY_EVT_STARTING_RECORDING

Name of the property event to fire to the main window when the local recording is about to start.

See Also:

Constant Field Values

PROPERTY_EVT_STARTED_RECORDING

static final String PROPERTY_EVT_STARTED_RECORDING

Name of the property event to fire to the main window right after the local recording was started. The expected reaction is that the GUI gets hidden.

Since:

4.1

See Also:

Constant Field Values

PROPERTY_EVT_EXITING_RECORDING

static final String PROPERTY_EVT_EXITING_RECORDING

Name of the property event to fire to the main window when the local recording finished. The expected reaction is that the GUI gets restored.

See Also:

Constant Field Values

CFG_KEY_SHOW_INFO_MSG

static final String CFG_KEY_SHOW_INFO_MSG

Name of the configuration key holding the flag controlling whether to show the info message on recording mode start.

See Also:

Constant Field Values

Method Detail

canRecord

boolean canRecord()

Define whether the recording can be currently started.

Returns:

true if recording can be started at the moment or false otherwise.

isRecording

boolean isRecording()

Find out if the recording is in progress.

Returns:

true if recording is in progress or false if not.

setRecording

void setRecording(boolean enable)

Start (enable) or finish (disable) recording.

Parameters:

enable - true will start recording, false will finish it.

addObserver

void addObserver(Object recorder)

Add (register) a recording observer. If the object implements the MouseListener and/or MouseMotionListener interfaces it will be notified of the appropriate mouse events. If the object implements the KeyListener it will be notified of the keys pressed on the keyboard.

Parameters:

recorder - an object interested in the recorded mouse and/or keyboard input events. If the object is already registered the method does nothing.

removeObserver

void removeObserver(Object recorder)

Remove a recording observer.

Parameters:

recorder - an object that has previously registered through the addObserver(java.lang.Object) method. If the object is not registered the method will do nothing.

removeAllObservers

void removeAllObservers()

Remove (deregister) all observers registered through the addObserver(java.lang.Object) method.