Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.key

Class KeyEvents

java.lang.Object

is.codion.swing.common.ui.key.KeyEvents

public final class KeyEvents
extends Object

A factory for key event builders.

JTextField textField = new JTextField();

KeyEvents.builder(VK_DOWN)
         .onKeyRelease(false)
         .modifiers(CTRL_DOWN_MASK)
         .condition(WHEN_FOCUSED)
         .action(new FindNextAction())
         .enable(textField);

See Also:

• builder()
• builder(int)
• builder(KeyStroke)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KeyEvents.Builder	A Builder for adding a key event to a component, with a default onKeyRelease trigger and condition JComponent.WHEN_FOCUSED.

Method Summary

Modifier and Type	Method	Description
static KeyEvents.Builder	builder()	Instantiates a new KeyEvents.Builder instance.
static KeyEvents.Builder	builder(int keyCode)	Instantiates a new KeyEvents.Builder instance.
static KeyEvents.Builder	builder(KeyStroke keyStroke)	Instantiates a new KeyEvents.Builder instance.
static KeyStroke	keyStroke(int keyCode)	Creates a KeyStroke with the given keyCode and no modifiers.
static KeyStroke	keyStroke(int keyCode, int modifiers)	Creates a KeyStroke with the given keyCode and modifiers.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static KeyEvents.Builder builder()

Instantiates a new KeyEvents.Builder instance. Note that an Action must be set via KeyEvents.Builder.action(Action) before enabling/disabling.

Returns:

a KeyEvents.Builder instance.

builder

public static KeyEvents.Builder builder(int keyCode)

Instantiates a new KeyEvents.Builder instance. Note that an Action must be set via KeyEvents.Builder.action(Action) before enabling/disabling.

Parameters:

keyCode - the key code

Returns:

a KeyEvents.Builder instance.

builder

public static KeyEvents.Builder builder(KeyStroke keyStroke)

Instantiates a new KeyEvents.Builder instance. Note that an Action must be set via KeyEvents.Builder.action(Action) before enabling/disabling.

Parameters:

keyStroke - the key stroke

Returns:

a KeyEvents.Builder instance.

keyStroke

public static KeyStroke keyStroke(int keyCode)

Creates a KeyStroke with the given keyCode and no modifiers.

Parameters:

keyCode - the key code

Returns:

a keystroke value

See Also:

• KeyStroke.getKeyStroke(int, int)

keyStroke

public static KeyStroke keyStroke(int keyCode,
 int modifiers)

Creates a KeyStroke with the given keyCode and modifiers.

Parameters:

keyCode - the key code

modifiers - the modifiers

Returns:

a keystroke value

See Also:

• KeyStroke.getKeyStroke(int, int)