com.tplan.robot.remoteclient.capabilities

Interface CharacterTransferCapable

public interface CharacterTransferCapable

Interface of a client which supports transfer of a limited set of characters. It's methods allow to test whether a certain character or piece of text can be typed and have it reported through the GUI to the user.

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

Method Summary

Modifier and Type	Method and Description
boolean	canPress(String key, StringBuilder err) Test if a character or a key can be pressed on the client desktop.
boolean	canType(String text, StringBuilder err) Test if a text can be typed on the client desktop.
void	sendKeyEvent(KeyEvent evt, boolean applyAsIs) Send the key event and indicate the key press mode.

Method Detail

canType

boolean canType(String text,
                StringBuilder err)

Test if a text can be typed on the client desktop.

Parameters:

text - some text.

err - optional container to save the eventual error message to.

Returns:

true if the text can be typed or false if not.

canPress

boolean canPress(String key,
                 StringBuilder err)

Test if a character or a key can be pressed on the client desktop.

Parameters:

key - a key.

err - optional container to save the eventual error message to.

Returns:

true if the key can be pressed or false if not.

sendKeyEvent

void sendKeyEvent(KeyEvent evt,
                  boolean applyAsIs)
           throws IOException

Send the key event and indicate the key press mode.

Parameters:

evt - a key event.

applyAsIs - true will make the client perform the key as is, typically when the call is part of a custom key operation such as long key press (hold).

Throws:

IOException - on an I/O error.