Package org.jline.terminal

Class KeyEvent

java.lang.Object

org.jline.terminal.KeyEvent

public class KeyEvent
extends Object

Represents a keyboard event in a terminal.

The KeyEvent class encapsulates information about keyboard actions in a terminal, including the type of key pressed, any modifier keys that were held, and the raw sequence that was received from the terminal.

Key events include:

• Character - A printable character was typed
• Arrow - An arrow key was pressed (Up, Down, Left, Right)
• Function - A function key was pressed (F1-F35)
• Special - A special key was pressed (Enter, Tab, Escape, etc.)
• Keypad - A keypad key was pressed
• Media - A media key was pressed
• ModifierKey - A modifier key was pressed/released as its own event
• Unknown - An unrecognized key sequence

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	KeyEvent.Arrow	Defines arrow key directions.
static enum	KeyEvent.EventType	Defines the type of key action for protocols that distinguish press, repeat, and release events (e.g., Kitty Keyboard Protocol).
static enum	KeyEvent.Keypad	Defines keypad keys reported by the Kitty Keyboard Protocol.
static enum	KeyEvent.MediaKey	Defines media keys reported by the Kitty Keyboard Protocol.
static enum	KeyEvent.Modifier	Defines modifier keys that can be held during a key event.
static enum	KeyEvent.ModKey	Identifies individual modifier keys for standalone key events.
static enum	KeyEvent.Special	Defines special keys.
static enum	KeyEvent.Type	Defines the types of key events that can occur.

Constructor Summary

Constructors

Constructor	Description
KeyEvent(char character, EnumSet<KeyEvent.Modifier> modifiers, String rawSequence)	Creates a character key event.
KeyEvent(int functionKey, EnumSet<KeyEvent.Modifier> modifiers, String rawSequence)	Creates a function key event.
KeyEvent(String rawSequence)	Creates an unknown key event.
KeyEvent(KeyEvent.Arrow arrow, EnumSet<KeyEvent.Modifier> modifiers, String rawSequence)	Creates an arrow key event.
KeyEvent(KeyEvent.Special special, EnumSet<KeyEvent.Modifier> modifiers, String rawSequence)	Creates a special key event.
KeyEvent(KeyEvent.Type type, char character, KeyEvent.Arrow arrow, KeyEvent.Special special, int functionKey, EnumSet<KeyEvent.Modifier> modifiers, String rawSequence, KeyEvent.EventType eventType, int keyCode, int shiftedKeyCode, int baseLayoutKeyCode, String associatedText)	Backward-compatible constructor without keypad/media/modifier key fields.
KeyEvent(KeyEvent.Type type, char character, KeyEvent.Arrow arrow, KeyEvent.Special special, KeyEvent.Keypad keypad, KeyEvent.MediaKey mediaKey, KeyEvent.ModKey modKey, int functionKey, EnumSet<KeyEvent.Modifier> modifiers, String rawSequence, KeyEvent.EventType eventType, int keyCode, int shiftedKeyCode, int baseLayoutKeyCode, String associatedText)	Full constructor with all Kitty Keyboard Protocol fields.

Method Summary

Modifier and Type	Method	Description
KeyEvent.Arrow	getArrow()
String	getAssociatedText()	Returns the associated text reported by the terminal.
int	getBaseLayoutKeyCode()	Returns the base layout key code (the key on a US keyboard layout).
char	getCharacter()
KeyEvent.EventType	getEventType()	Returns the event type (press, repeat, or release).
int	getFunctionKey()
int	getKeyCode()	Returns the Unicode key code as reported by the Kitty Keyboard Protocol.
KeyEvent.Keypad	getKeypad()	Returns the keypad key, or null if this is not a keypad event.
KeyEvent.MediaKey	getMediaKey()	Returns the media key, or null if this is not a media event.
EnumSet<KeyEvent.Modifier>	getModifiers()
KeyEvent.ModKey	getModKey()	Returns the modifier key, or null if this is not a modifier key event.
String	getRawSequence()
int	getShiftedKeyCode()	Returns the shifted variant key code.
KeyEvent.Special	getSpecial()
KeyEvent.Type	getType()
boolean	hasModifier(KeyEvent.Modifier modifier)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

KeyEvent

public KeyEvent(char character,
 EnumSet<KeyEvent.Modifier> modifiers,
 String rawSequence)

Creates a character key event.

KeyEvent

public KeyEvent(KeyEvent.Arrow arrow,
 EnumSet<KeyEvent.Modifier> modifiers,
 String rawSequence)

Creates an arrow key event.

KeyEvent

public KeyEvent(KeyEvent.Special special,
 EnumSet<KeyEvent.Modifier> modifiers,
 String rawSequence)

Creates a special key event.

KeyEvent

public KeyEvent(int functionKey,
 EnumSet<KeyEvent.Modifier> modifiers,
 String rawSequence)

Creates a function key event.

KeyEvent

public KeyEvent(String rawSequence)

Creates an unknown key event.

KeyEvent

public KeyEvent(KeyEvent.Type type,
 char character,
 KeyEvent.Arrow arrow,
 KeyEvent.Special special,
 int functionKey,
 EnumSet<KeyEvent.Modifier> modifiers,
 String rawSequence,
 KeyEvent.EventType eventType,
 int keyCode,
 int shiftedKeyCode,
 int baseLayoutKeyCode,
 String associatedText)

Backward-compatible constructor without keypad/media/modifier key fields.

KeyEvent

public KeyEvent(KeyEvent.Type type,
 char character,
 KeyEvent.Arrow arrow,
 KeyEvent.Special special,
 KeyEvent.Keypad keypad,
 KeyEvent.MediaKey mediaKey,
 KeyEvent.ModKey modKey,
 int functionKey,
 EnumSet<KeyEvent.Modifier> modifiers,
 String rawSequence,
 KeyEvent.EventType eventType,
 int keyCode,
 int shiftedKeyCode,
 int baseLayoutKeyCode,
 String associatedText)

Full constructor with all Kitty Keyboard Protocol fields.

Method Details

getType

public KeyEvent.Type getType()

getCharacter

public char getCharacter()

getArrow

public KeyEvent.Arrow getArrow()

getSpecial

public KeyEvent.Special getSpecial()

getKeypad

public KeyEvent.Keypad getKeypad()

Returns the keypad key, or null if this is not a keypad event.

getMediaKey

public KeyEvent.MediaKey getMediaKey()

Returns the media key, or null if this is not a media event.

getModKey

public KeyEvent.ModKey getModKey()

Returns the modifier key, or null if this is not a modifier key event.

getFunctionKey

public int getFunctionKey()

getModifiers

public EnumSet<KeyEvent.Modifier> getModifiers()

getRawSequence

public String getRawSequence()

hasModifier

public boolean hasModifier(KeyEvent.Modifier modifier)

getEventType

public KeyEvent.EventType getEventType()

Returns the event type (press, repeat, or release). Only meaningful when the Kitty Keyboard Protocol is active with the FLAG_REPORT_EVENTS flag enabled.

Returns:

the event type, defaults to KeyEvent.EventType.Press

getKeyCode

public int getKeyCode()

Returns the Unicode key code as reported by the Kitty Keyboard Protocol. This is the primary key identifier — always the lowercase/unshifted codepoint for letter keys.

Returns:

the key code, or 0 if not from a kitty protocol sequence

getShiftedKeyCode

public int getShiftedKeyCode()

Returns the shifted variant key code. Only present when the Kitty Keyboard Protocol is active with the FLAG_REPORT_ALTERNATES flag and Shift is held.

Returns:

the shifted key code, or 0 if absent

getBaseLayoutKeyCode

public int getBaseLayoutKeyCode()

Returns the base layout key code (the key on a US keyboard layout). Only present when the Kitty Keyboard Protocol is active with the FLAG_REPORT_ALTERNATES flag.

Returns:

the base layout key code, or 0 if absent

getAssociatedText

public String getAssociatedText()

Returns the associated text reported by the terminal. Only present when the Kitty Keyboard Protocol is active with the FLAG_REPORT_TEXT flag.

Returns:

the associated text, or null if absent

toString

public String toString()

Overrides:

toString in class Object