jline
Enum WindowsTerminal.WindowsKey

java.lang.Object
  java.lang.Enum<WindowsTerminal.WindowsKey>
      jline.WindowsTerminal.WindowsKey

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WindowsTerminal.WindowsKey>

Enclosing class:

WindowsTerminal

public static enum WindowsTerminal.WindowsKey
extends java.lang.Enum<WindowsTerminal.WindowsKey>

Windows keys.

Constants copied wincon.h.

Enum Constant Summary

DELETE_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the delete key was pressed.

DOWN_ARROW_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates an down arrow key press.

END_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the end key was pressed.

ESCAPE_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR, this character indicates that the escape key was pressed.

HOME_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the home key was pressed.

INSERT_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the insert key was pressed.

LEFT_ARROW_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR, this character indicates an left arrow key press.

NUMPAD_KEY_INDICATOR
On windows terminals, this character indicates that a special key on the number pad has been pressed.

PAGE_DOWN_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the page down key was pressed.

PAGE_UP_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the page up key was pressed.

RIGHT_ARROW_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates an right arrow key press.

SPECIAL_KEY_INDICATOR
On windows terminals, this character indicates that a 'special' key has been pressed.

UP_ARROW_KEY
When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates an up arrow key press.

Field Summary

int

code

Method Summary

static WindowsTerminal.WindowsKey	valueOf(int code)
static WindowsTerminal.WindowsKey	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WindowsTerminal.WindowsKey[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SPECIAL_KEY_INDICATOR

public static final WindowsTerminal.WindowsKey SPECIAL_KEY_INDICATOR

On windows terminals, this character indicates that a 'special' key has been pressed. This means that a key such as an arrow key, or delete, or home, etc. will be indicated by the next character.

NUMPAD_KEY_INDICATOR

public static final WindowsTerminal.WindowsKey NUMPAD_KEY_INDICATOR

On windows terminals, this character indicates that a special key on the number pad has been pressed.

LEFT_ARROW_KEY

public static final WindowsTerminal.WindowsKey LEFT_ARROW_KEY

When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR, this character indicates an left arrow key press.

RIGHT_ARROW_KEY

public static final WindowsTerminal.WindowsKey RIGHT_ARROW_KEY

When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates an right arrow key press.

UP_ARROW_KEY

public static final WindowsTerminal.WindowsKey UP_ARROW_KEY

When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates an up arrow key press.

DOWN_ARROW_KEY

public static final WindowsTerminal.WindowsKey DOWN_ARROW_KEY

When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates an down arrow key press.

DELETE_KEY

public static final WindowsTerminal.WindowsKey DELETE_KEY

When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the delete key was pressed.

HOME_KEY

public static final WindowsTerminal.WindowsKey HOME_KEY

When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the home key was pressed.

END_KEY

public static final WindowsTerminal.WindowsKey END_KEY

When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the end key was pressed.

PAGE_UP_KEY

public static final WindowsTerminal.WindowsKey PAGE_UP_KEY

When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the page up key was pressed.

PAGE_DOWN_KEY

public static final WindowsTerminal.WindowsKey PAGE_DOWN_KEY

When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the page down key was pressed.

INSERT_KEY

public static final WindowsTerminal.WindowsKey INSERT_KEY

When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR this character indicates that the insert key was pressed.

ESCAPE_KEY

public static final WindowsTerminal.WindowsKey ESCAPE_KEY

When following the SPECIAL_KEY_INDICATOR or NUMPAD_KEY_INDICATOR, this character indicates that the escape key was pressed.

Field Detail

code

public final int code

Method Detail

values

public static WindowsTerminal.WindowsKey[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WindowsTerminal.WindowsKey c : WindowsTerminal.WindowsKey.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WindowsTerminal.WindowsKey valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

valueOf

public static WindowsTerminal.WindowsKey valueOf(int code)