jexer.event

Class TKeypressEvent

java.lang.Object

jexer.event.TInputEvent

jexer.event.TKeypressEvent

public class TKeypressEvent
extends TInputEvent

This class encapsulates a keyboard input event.

Constructor Summary

Constructors

Constructor and Description
TKeypressEvent(boolean isKey, int fnKey, int ch, boolean alt, boolean ctrl, boolean shift) Public constructor.
TKeypressEvent(TKeypress key) Public contructor.
TKeypressEvent(TKeypress key, boolean alt, boolean ctrl, boolean shift) Public constructor.

Method Summary

Modifier and Type	Method and Description
TKeypressEvent	dup() Create a duplicate instance.
boolean	equals(java.lang.Object rhs) Comparison check.
TKeypress	getKey() Get keystroke.
int	hashCode() Hashcode uses all fields in equals().
java.lang.String	toString() Make human-readable description of this TKeypressEvent.

Methods inherited from class jexer.event.TInputEvent

getTime

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TKeypressEvent

public TKeypressEvent(TKeypress key)

Public contructor.

Parameters:

key - the TKeypress received

TKeypressEvent

public TKeypressEvent(boolean isKey,
                      int fnKey,
                      int ch,
                      boolean alt,
                      boolean ctrl,
                      boolean shift)

Public constructor.

Parameters:

isKey - is true, this is a function key

fnKey - the function key code (only valid if isKey is true)

ch - the character (only valid if fnKey is false)

alt - if true, ALT was pressed with this keystroke

ctrl - if true, CTRL was pressed with this keystroke

shift - if true, SHIFT was pressed with this keystroke

TKeypressEvent

public TKeypressEvent(TKeypress key,
                      boolean alt,
                      boolean ctrl,
                      boolean shift)

Public constructor.

Parameters:

key - the TKeypress received

alt - if true, ALT was pressed with this keystroke

ctrl - if true, CTRL was pressed with this keystroke

shift - if true, SHIFT was pressed with this keystroke

Method Detail

equals

public boolean equals(java.lang.Object rhs)

Comparison check. All fields must match to return true.

Overrides:

equals in class java.lang.Object

Parameters:

rhs - another TKeypressEvent or TKeypress instance

Returns:

true if all fields are equal

hashCode

public int hashCode()

Hashcode uses all fields in equals().

Overrides:

hashCode in class java.lang.Object

Returns:

the hash

toString

public java.lang.String toString()

Make human-readable description of this TKeypressEvent.

Overrides:

toString in class java.lang.Object

Returns:

displayable String

getKey

public TKeypress getKey()

Get keystroke.

Returns:

keystroke

dup

public TKeypressEvent dup()

Create a duplicate instance.

Returns:

duplicate intance