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, based on Robot

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.

Method Summary

Modifier and Type	Method	Description
void	autoDelay(int autoDelay)
static Controller	controller()
static Controller	controller(GraphicsDevice device)
void	key(String keyStroke)	Processes the given keystroke.
void	key(String keyStroke, int repeat)	Processes the given keystroke.
void	key(String keyStroke, int repeat, @Nullable String description)	Processes the given keystroke.
void	key(String keyStroke, @Nullable String description)	Processes the given keystroke.
void	pause(int milliseconds)
void	type(String text)	Types the given text.
void	type(String text, @Nullable String description)	Types the given text.

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)

Parameters:

autoDelay - the robot auto delay in ms

See Also:

• Robot.setAutoDelay(int)

type

public void type(String text)

Types the given text.

Parameters:

text - the text to type

type

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

Types the given text.

Parameters:

text - the text to type

description - the description

key

public void key(String keyStroke)

Processes the given keystroke.

Parameters:

keyStroke - the AWT formatted keystroke

Throws:

Controller.FocusLostException - in case application input focus is lost

See Also:

• AWTKeyStroke.getAWTKeyStroke(String)

key

public void key(String keyStroke,
 int repeat)

Processes the given keystroke.

Parameters:

keyStroke - the AWT formatted keystroke

repeat - the number of times to repeat the keystroke

Throws:

Controller.FocusLostException - in case application input focus is lost

See Also:

• AWTKeyStroke.getAWTKeyStroke(String)

key

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

Processes the given keystroke.

Parameters:

keyStroke - the AWT formatted keystroke

description - the description

Throws:

Controller.FocusLostException - in case application input focus is lost

See Also:

• AWTKeyStroke.getAWTKeyStroke(String)

key

public void 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

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