Module is.codion.tools.swing.robot

Package is.codion.tools.swing.robot

Class Controller

java.lang.Object

is.codion.tools.swing.robot.Controller

public final class Controller
extends Object

Keyboard controller with high-level operations. Delivers input either through a Robot (Controller.Transport.ROBOT, realistic OS-level input, for demo recording) or by dispatching events directly on the event dispatch thread (Controller.Transport.EDT, deterministic and synchronously confirmed, for reliable programmatic control).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Controller.FocusLostException	Thrown when an input action is attempted when no application window is focused.
static enum	Controller.Transport	The available input transports.

Method Summary

Modifier and Type	Method	Description
void	autoDelay(int autoDelay)	The auto delay of the underlying Robot, no effect when using Controller.Transport.EDT.
static Controller	controller()
static Controller	controller(Controller.Transport transport)
static Controller	controller(GraphicsDevice device)
Interaction	key(String keyStroke)	Processes the given keystroke.
Interaction	key(String keyStroke, int repeat)	Processes the given keystroke.
Interaction	key(String keyStroke, int repeat, @Nullable String description)	Processes the given keystroke.
Interaction	key(String keyStroke, @Nullable String description)	Processes the given keystroke.
void	pause(int milliseconds)
Interaction	type(String text)	Types the given text.
Interaction	type(String text, @Nullable String description)	Types the given text.
void	verifyTimeout(int verifyTimeout)

Methods inherited from class java.lang.Object

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

Method Details

autoDelay

public void autoDelay(int autoDelay)

The auto delay of the underlying Robot, no effect when using Controller.Transport.EDT.

Parameters:

autoDelay - the robot auto delay in ms

See Also:

• Robot.setAutoDelay(int)

verifyTimeout

public void verifyTimeout(int verifyTimeout)

Parameters:

verifyTimeout - the number of milliseconds to wait for the key event confirming an interaction

type

public Interaction type(String text)

Types the given text.

Parameters:

text - the text to type

Returns:

the Interaction verdict for the typed text

type

public Interaction type(String text,
 @Nullable String description)

Types the given text.

Parameters:

text - the text to type

description - the description

Returns:

the Interaction verdict for the typed text

key

public Interaction key(String keyStroke)

Processes the given keystroke.

Parameters:

keyStroke - the AWT formatted keystroke

Returns:

the Interaction verdict for the typed key

Throws:

Controller.FocusLostException - in case application input focus is lost

See Also:

• AWTKeyStroke.getAWTKeyStroke(String)

key

public Interaction key(String keyStroke,
 int repeat)

Processes the given keystroke.

Parameters:

keyStroke - the AWT formatted keystroke

repeat - the number of times to repeat the keystroke

Returns:

the Interaction verdict for the typed key

Throws:

Controller.FocusLostException - in case application input focus is lost

See Also:

• AWTKeyStroke.getAWTKeyStroke(String)

key

public Interaction key(String keyStroke,
 @Nullable String description)

Processes the given keystroke.

Parameters:

keyStroke - the AWT formatted keystroke

description - the description

Returns:

the Interaction verdict for the keystroke

Throws:

Controller.FocusLostException - in case application input focus is lost

See Also:

• AWTKeyStroke.getAWTKeyStroke(String)

key

public Interaction key(String keyStroke,
 int repeat,
 @Nullable String description)

Processes the given keystroke.

Parameters:

keyStroke - the AWT formatted keystroke

repeat - the number of times to repeat the keystroke

description - the description

Returns:

the Interaction verdict for the keystroke

Throws:

Controller.FocusLostException - in case application input focus is lost

See Also:

• AWTKeyStroke.getAWTKeyStroke(String)

pause

public void pause(int milliseconds)

controller

public static Controller controller()

Returns:

a Controller for the default screen device

controller

public static Controller controller(GraphicsDevice device)

Parameters:

device - the screen device

Returns:

a Controller for the given screen device, using the Controller.Transport.ROBOT transport

controller

public static Controller controller(Controller.Transport transport)

Parameters:

transport - the input transport

Returns:

a Controller using the given transport, Controller.Transport.ROBOT uses the default screen device