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()
        .keyCode(VK_DOWN)
        .onKeyRelease(false)
        .modifiers(MENU_SHORTCUT_MASK)
        .condition(WHEN_FOCUSED)
        .action(findNext)
        .enable(textField);

See Also:

• builder()

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.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MENU_SHORTCUT_MASK	The platform-appropriate modifier mask for menu shortcuts.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

MENU_SHORTCUT_MASK

public static final int MENU_SHORTCUT_MASK

The platform-appropriate modifier mask for menu shortcuts.

• Windows/Linux: InputEvent.CTRL_DOWN_MASK (Control key)
• macOS: InputEvent.META_DOWN_MASK (Command key)
• Headless: InputEvent.CTRL_DOWN_MASK

Use this constant instead of hardcoding InputEvent.CTRL_DOWN_MASK to provide native keyboard shortcuts on each platform. For example, shortcuts using this mask will appear as Ctrl+F on Windows/Linux and ⌘+F on macOS.

See Also:

• Toolkit.getMenuShortcutKeyMaskEx()

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.

keyStroke

public static KeyStroke keyStroke(int keyCode)

Returns a KeyStroke with the given keyCode and no modifiers.

Parameters:

keyCode - the key code

Returns:

a keystroke

See Also:

• KeyStroke.getKeyStroke(int, int)

keyStroke

public static KeyStroke keyStroke(int keyCode,
 int modifiers)

Returns a KeyStroke with the given keyCode and modifiers.

Parameters:

keyCode - the key code

modifiers - the modifiers

Returns:

a keystroke

See Also:

• KeyStroke.getKeyStroke(int, int)

keyStroke

public static KeyStroke keyStroke(String keyStroke)

Returns a KeyStroke parsed from the given string.

Parameters:

keyStroke - the keystroke to parse

Returns:

a keystroke

See Also:

• KeyStroke.getKeyStroke(String)