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-F12)
• Special - A special key was pressed (Enter, Tab, Escape, etc.)
• 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.Modifier	Defines modifier keys that can be held during a key event.
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.

Method Summary

Modifier and Type	Method	Description
KeyEvent.Arrow	getArrow()
char	getCharacter()
int	getFunctionKey()
EnumSet<KeyEvent.Modifier>	getModifiers()
String	getRawSequence()
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.

Method Details

getType

public KeyEvent.Type getType()

getCharacter

public char getCharacter()

getArrow

public KeyEvent.Arrow getArrow()

getSpecial

public KeyEvent.Special getSpecial()

getFunctionKey

public int getFunctionKey()

getModifiers

public EnumSet<KeyEvent.Modifier> getModifiers()

getRawSequence

public String getRawSequence()

hasModifier

public boolean hasModifier(KeyEvent.Modifier modifier)

toString

public String toString()

Overrides:

toString in class Object