Package jexer

Class TKeypress

  • public class TKeypress
extends java.lang.Object
    This class represents keystrokes.

    • Field Detail

      • BACKSPACE

        public static final int BACKSPACE
        Backspace, used for control-backspace.
        See Also:
        Constant Field Values

      • kbNoKey

        public static final TKeypress kbNoKey
        Special "no-key" keypress, used to ignore undefined keystrokes.

      • kbF1

        public static final TKeypress kbF1
        F1

      • kbF2

        public static final TKeypress kbF2
        F2

      • kbF3

        public static final TKeypress kbF3
        F3

      • kbF4

        public static final TKeypress kbF4
        F4

      • kbF5

        public static final TKeypress kbF5
        F5

      • kbF6

        public static final TKeypress kbF6
        F6

      • kbF7

        public static final TKeypress kbF7
        F7

      • kbF8

        public static final TKeypress kbF8
        F8

      • kbF9

        public static final TKeypress kbF9
        F9

      • kbF10

        public static final TKeypress kbF10
        F10

      • kbF11

        public static final TKeypress kbF11
        F11

      • kbF12

        public static final TKeypress kbF12
        F12

      • kbAltF1

        public static final TKeypress kbAltF1
        Alt-F1

      • kbAltF2

        public static final TKeypress kbAltF2
        Alt-F2

      • kbAltF3

        public static final TKeypress kbAltF3
        Alt-F3

      • kbAltF4

        public static final TKeypress kbAltF4
        Alt-F4

      • kbAltF5

        public static final TKeypress kbAltF5
        Alt-F5

      • kbAltF6

        public static final TKeypress kbAltF6
        Alt-F6

      • kbAltF7

        public static final TKeypress kbAltF7
        Alt-F7

      • kbAltF8

        public static final TKeypress kbAltF8
        Alt-F8

      • kbAltF9

        public static final TKeypress kbAltF9
        Alt-F9

      • kbAltF10

        public static final TKeypress kbAltF10
        Alt-F10

      • kbAltF11

        public static final TKeypress kbAltF11
        Alt-F11

      • kbAltF12

        public static final TKeypress kbAltF12
        Alt-F12

      • kbCtrlF1

        public static final TKeypress kbCtrlF1
        Ctrl-F1

      • kbCtrlF2

        public static final TKeypress kbCtrlF2
        Ctrl-F2

      • kbCtrlF3

        public static final TKeypress kbCtrlF3
        Ctrl-F3

      • kbCtrlF4

        public static final TKeypress kbCtrlF4
        Ctrl-F4

      • kbCtrlF5

        public static final TKeypress kbCtrlF5
        Ctrl-F5

      • kbCtrlF6

        public static final TKeypress kbCtrlF6
        Ctrl-F6

      • kbCtrlF7

        public static final TKeypress kbCtrlF7
        Ctrl-F7

      • kbCtrlF8

        public static final TKeypress kbCtrlF8
        Ctrl-F8

      • kbCtrlF9

        public static final TKeypress kbCtrlF9
        Ctrl-F9

      • kbCtrlF10

        public static final TKeypress kbCtrlF10
        Ctrl-F10

      • kbCtrlF11

        public static final TKeypress kbCtrlF11
        Ctrl-F11

      • kbCtrlF12

        public static final TKeypress kbCtrlF12
        Ctrl-F12

      • kbShiftF1

        public static final TKeypress kbShiftF1
        Shift-F1

      • kbShiftF2

        public static final TKeypress kbShiftF2
        Shift-F2

      • kbShiftF3

        public static final TKeypress kbShiftF3
        Shift-F3

      • kbShiftF4

        public static final TKeypress kbShiftF4
        Shift-F4

      • kbShiftF5

        public static final TKeypress kbShiftF5
        Shift-F5

      • kbShiftF6

        public static final TKeypress kbShiftF6
        Shift-F6

      • kbShiftF7

        public static final TKeypress kbShiftF7
        Shift-F7

      • kbShiftF8

        public static final TKeypress kbShiftF8
        Shift-F8

      • kbShiftF9

        public static final TKeypress kbShiftF9
        Shift-F9

      • kbShiftF10

        public static final TKeypress kbShiftF10
        Shift-F10

      • kbShiftF11

        public static final TKeypress kbShiftF11
        Shift-F11

      • kbShiftF12

        public static final TKeypress kbShiftF12
        Shift-F12

      • kbEnter

        public static final TKeypress kbEnter
        Enter

      • kbTab

        public static final TKeypress kbTab
        Tab

      • kbEsc

        public static final TKeypress kbEsc
        Esc

      • kbHome

        public static final TKeypress kbHome
        Home

      • kbEnd

        public static final TKeypress kbEnd
        End

      • kbPgUp

        public static final TKeypress kbPgUp
        PgUp

      • kbPgDn

        public static final TKeypress kbPgDn
        PgDn

      • kbIns

        public static final TKeypress kbIns
        Ins

      • kbDel

        public static final TKeypress kbDel
        Del

      • kbUp

        public static final TKeypress kbUp
        Up

      • kbDown

        public static final TKeypress kbDown
        Down

      • kbLeft

        public static final TKeypress kbLeft
        Left

      • kbRight

        public static final TKeypress kbRight
        Right

      • kbAltEnter

        public static final TKeypress kbAltEnter
        Alt-Enter

      • kbAltTab

        public static final TKeypress kbAltTab
        Alt-Tab

      • kbAltEsc

        public static final TKeypress kbAltEsc
        Alt-Esc

      • kbAltHome

        public static final TKeypress kbAltHome
        Alt-Home

      • kbAltEnd

        public static final TKeypress kbAltEnd
        Alt-End

      • kbAltPgUp

        public static final TKeypress kbAltPgUp
        Alt-PgUp

      • kbAltPgDn

        public static final TKeypress kbAltPgDn
        Alt-PgDn

      • kbAltIns

        public static final TKeypress kbAltIns
        Alt-Ins

      • kbAltDel

        public static final TKeypress kbAltDel
        Alt-Del

      • kbAltUp

        public static final TKeypress kbAltUp
        Alt-Up

      • kbAltDown

        public static final TKeypress kbAltDown
        Alt-Down

      • kbAltLeft

        public static final TKeypress kbAltLeft
        Alt-Left

      • kbAltRight

        public static final TKeypress kbAltRight
        Alt-Right

      • kbCtrlEnter

        public static final TKeypress kbCtrlEnter
        Ctrl-Enter

      • kbCtrlTab

        public static final TKeypress kbCtrlTab
        Ctrl-Tab

      • kbCtrlEsc

        public static final TKeypress kbCtrlEsc
        Ctrl-Esc

      • kbCtrlHome

        public static final TKeypress kbCtrlHome
        Ctrl-Home

      • kbCtrlEnd

        public static final TKeypress kbCtrlEnd
        Ctrl-End

      • kbCtrlPgUp

        public static final TKeypress kbCtrlPgUp
        Ctrl-PgUp

      • kbCtrlPgDn

        public static final TKeypress kbCtrlPgDn
        Ctrl-PgDn

      • kbCtrlIns

        public static final TKeypress kbCtrlIns
        Ctrl-Ins

      • kbCtrlDel

        public static final TKeypress kbCtrlDel
        Ctrl-Del

      • kbCtrlUp

        public static final TKeypress kbCtrlUp
        Ctrl-Up

      • kbCtrlDown

        public static final TKeypress kbCtrlDown
        Ctrl-Down

      • kbCtrlLeft

        public static final TKeypress kbCtrlLeft
        Ctrl-Left

      • kbCtrlRight

        public static final TKeypress kbCtrlRight
        Ctrl-Right

      • kbShiftEnter

        public static final TKeypress kbShiftEnter
        Shift-Enter

      • kbShiftTab

        public static final TKeypress kbShiftTab
        Shift-Tab

      • kbBackTab

        public static final TKeypress kbBackTab
        Shift-BackTab

      • kbShiftEsc

        public static final TKeypress kbShiftEsc
        Shift-Esc

      • kbShiftHome

        public static final TKeypress kbShiftHome
        Shift-Home

      • kbShiftEnd

        public static final TKeypress kbShiftEnd
        Shift-End

      • kbShiftPgUp

        public static final TKeypress kbShiftPgUp
        Shift-PgUp

      • kbShiftPgDn

        public static final TKeypress kbShiftPgDn
        Shift-PgDn

      • kbShiftIns

        public static final TKeypress kbShiftIns
        Shift-Ins

      • kbShiftDel

        public static final TKeypress kbShiftDel
        Shift-Del

      • kbShiftUp

        public static final TKeypress kbShiftUp
        Shift-Up

      • kbShiftDown

        public static final TKeypress kbShiftDown
        Shift-Down

      • kbShiftLeft

        public static final TKeypress kbShiftLeft
        Shift-Left

      • kbShiftRight

        public static final TKeypress kbShiftRight
        Shift-Right

      • kbSpace

        public static final TKeypress kbSpace
        Space (' ')

      • kbAltA

        public static final TKeypress kbAltA
        Alt-A

      • kbAltB

        public static final TKeypress kbAltB
        Alt-B

      • kbAltC

        public static final TKeypress kbAltC
        Alt-C

      • kbAltD

        public static final TKeypress kbAltD
        Alt-D

      • kbAltE

        public static final TKeypress kbAltE
        Alt-E

      • kbAltF

        public static final TKeypress kbAltF
        Alt-F

      • kbAltG

        public static final TKeypress kbAltG
        Alt-G

      • kbAltH

        public static final TKeypress kbAltH
        Alt-H

      • kbAltI

        public static final TKeypress kbAltI
        Alt-I

      • kbAltJ

        public static final TKeypress kbAltJ
        Alt-J

      • kbAltK

        public static final TKeypress kbAltK
        Alt-K

      • kbAltL

        public static final TKeypress kbAltL
        Alt-L

      • kbAltM

        public static final TKeypress kbAltM
        Alt-M

      • kbAltN

        public static final TKeypress kbAltN
        Alt-N

      • kbAltO

        public static final TKeypress kbAltO
        Alt-O

      • kbAltP

        public static final TKeypress kbAltP
        Alt-P

      • kbAltQ

        public static final TKeypress kbAltQ
        Alt-Q

      • kbAltR

        public static final TKeypress kbAltR
        Alt-R

      • kbAltS

        public static final TKeypress kbAltS
        Alt-S

      • kbAltT

        public static final TKeypress kbAltT
        Alt-T

      • kbAltU

        public static final TKeypress kbAltU
        Alt-U

      • kbAltV

        public static final TKeypress kbAltV
        Alt-V

      • kbAltW

        public static final TKeypress kbAltW
        Alt-W

      • kbAltX

        public static final TKeypress kbAltX
        Alt-X

      • kbAltY

        public static final TKeypress kbAltY
        Alt-Y

      • kbAltZ

        public static final TKeypress kbAltZ
        Alt-Z

      • kbAlt0

        public static final TKeypress kbAlt0
        Alt-0

      • kbAlt1

        public static final TKeypress kbAlt1
        Alt-1

      • kbAlt2

        public static final TKeypress kbAlt2
        Alt-2

      • kbAlt3

        public static final TKeypress kbAlt3
        Alt-3

      • kbAlt4

        public static final TKeypress kbAlt4
        Alt-4

      • kbAlt5

        public static final TKeypress kbAlt5
        Alt-5

      • kbAlt6

        public static final TKeypress kbAlt6
        Alt-6

      • kbAlt7

        public static final TKeypress kbAlt7
        Alt-7

      • kbAlt8

        public static final TKeypress kbAlt8
        Alt-8

      • kbAlt9

        public static final TKeypress kbAlt9
        Alt-9

      • kbCtrlA

        public static final TKeypress kbCtrlA
        Ctrl-A

      • kbCtrlB

        public static final TKeypress kbCtrlB
        Ctrl-B

      • kbCtrlC

        public static final TKeypress kbCtrlC
        Ctrl-C

      • kbCtrlD

        public static final TKeypress kbCtrlD
        Ctrl-D

      • kbCtrlE

        public static final TKeypress kbCtrlE
        Ctrl-E

      • kbCtrlF

        public static final TKeypress kbCtrlF
        Ctrl-F

      • kbCtrlG

        public static final TKeypress kbCtrlG
        Ctrl-G

      • kbCtrlH

        public static final TKeypress kbCtrlH
        Ctrl-H

      • kbCtrlI

        public static final TKeypress kbCtrlI
        Ctrl-I

      • kbCtrlJ

        public static final TKeypress kbCtrlJ
        Ctrl-J

      • kbCtrlK

        public static final TKeypress kbCtrlK
        Ctrl-K

      • kbCtrlL

        public static final TKeypress kbCtrlL
        Ctrl-L

      • kbCtrlM

        public static final TKeypress kbCtrlM
        Ctrl-M

      • kbCtrlN

        public static final TKeypress kbCtrlN
        Ctrl-N

      • kbCtrlO

        public static final TKeypress kbCtrlO
        Ctrl-O

      • kbCtrlP

        public static final TKeypress kbCtrlP
        Ctrl-P

      • kbCtrlQ

        public static final TKeypress kbCtrlQ
        Ctrl-Q

      • kbCtrlR

        public static final TKeypress kbCtrlR
        Ctrl-R

      • kbCtrlS

        public static final TKeypress kbCtrlS
        Ctrl-S

      • kbCtrlT

        public static final TKeypress kbCtrlT
        Ctrl-T

      • kbCtrlU

        public static final TKeypress kbCtrlU
        Ctrl-U

      • kbCtrlV

        public static final TKeypress kbCtrlV
        Ctrl-V

      • kbCtrlW

        public static final TKeypress kbCtrlW
        Ctrl-W

      • kbCtrlX

        public static final TKeypress kbCtrlX
        Ctrl-X

      • kbCtrlY

        public static final TKeypress kbCtrlY
        Ctrl-Y

      • kbCtrlZ

        public static final TKeypress kbCtrlZ
        Ctrl-Z

      • kbAltShiftA

        public static final TKeypress kbAltShiftA
        Alt-Shift-A

      • kbAltShiftB

        public static final TKeypress kbAltShiftB
        Alt-Shift-B

      • kbAltShiftC

        public static final TKeypress kbAltShiftC
        Alt-Shift-C

      • kbAltShiftD

        public static final TKeypress kbAltShiftD
        Alt-Shift-D

      • kbAltShiftE

        public static final TKeypress kbAltShiftE
        Alt-Shift-E

      • kbAltShiftF

        public static final TKeypress kbAltShiftF
        Alt-Shift-F

      • kbAltShiftG

        public static final TKeypress kbAltShiftG
        Alt-Shift-G

      • kbAltShiftH

        public static final TKeypress kbAltShiftH
        Alt-Shift-H

      • kbAltShiftI

        public static final TKeypress kbAltShiftI
        Alt-Shift-I

      • kbAltShiftJ

        public static final TKeypress kbAltShiftJ
        Alt-Shift-J

      • kbAltShiftK

        public static final TKeypress kbAltShiftK
        Alt-Shift-K

      • kbAltShiftL

        public static final TKeypress kbAltShiftL
        Alt-Shift-L

      • kbAltShiftM

        public static final TKeypress kbAltShiftM
        Alt-Shift-M

      • kbAltShiftN

        public static final TKeypress kbAltShiftN
        Alt-Shift-N

      • kbAltShiftO

        public static final TKeypress kbAltShiftO
        Alt-Shift-O

      • kbAltShiftP

        public static final TKeypress kbAltShiftP
        Alt-Shift-P

      • kbAltShiftQ

        public static final TKeypress kbAltShiftQ
        Alt-Shift-Q

      • kbAltShiftR

        public static final TKeypress kbAltShiftR
        Alt-Shift-R

      • kbAltShiftS

        public static final TKeypress kbAltShiftS
        Alt-Shift-S

      • kbAltShiftT

        public static final TKeypress kbAltShiftT
        Alt-Shift-T

      • kbAltShiftU

        public static final TKeypress kbAltShiftU
        Alt-Shift-U

      • kbAltShiftV

        public static final TKeypress kbAltShiftV
        Alt-Shift-V

      • kbAltShiftW

        public static final TKeypress kbAltShiftW
        Alt-Shift-W

      • kbAltShiftX

        public static final TKeypress kbAltShiftX
        Alt-Shift-X

      • kbAltShiftY

        public static final TKeypress kbAltShiftY
        Alt-Shift-Y

      • kbAltShiftZ

        public static final TKeypress kbAltShiftZ
        Alt-Shift-Z

      • kbAltShiftHome

        public static final TKeypress kbAltShiftHome
        Alt-Shift-Home

      • kbAltShiftEnd

        public static final TKeypress kbAltShiftEnd
        Alt-Shift-End

      • kbAltShiftPgUp

        public static final TKeypress kbAltShiftPgUp
        Alt-Shift-PgUp

      • kbAltShiftPgDn

        public static final TKeypress kbAltShiftPgDn
        Alt-Shift-PgDn

      • kbAltShiftUp

        public static final TKeypress kbAltShiftUp
        Alt-Shift-Up

      • kbAltShiftDown

        public static final TKeypress kbAltShiftDown
        Alt-Shift-Down

      • kbAltShiftLeft

        public static final TKeypress kbAltShiftLeft
        Alt-Shift-Left

      • kbAltShiftRight

        public static final TKeypress kbAltShiftRight
        Alt-Shift-Right

      • kbCtrlShiftHome

        public static final TKeypress kbCtrlShiftHome
        Ctrl-Shift-Home

      • kbCtrlShiftEnd

        public static final TKeypress kbCtrlShiftEnd
        Ctrl-Shift-End

      • kbCtrlShiftPgUp

        public static final TKeypress kbCtrlShiftPgUp
        Ctrl-Shift-PgUp

      • kbCtrlShiftPgDn

        public static final TKeypress kbCtrlShiftPgDn
        Ctrl-Shift-PgDn

      • kbCtrlShiftUp

        public static final TKeypress kbCtrlShiftUp
        Ctrl-Shift-Up

      • kbCtrlShiftDown

        public static final TKeypress kbCtrlShiftDown
        Ctrl-Shift-Down

      • kbCtrlShiftLeft

        public static final TKeypress kbCtrlShiftLeft
        Ctrl-Shift-Left

      • kbCtrlShiftRight

        public static final TKeypress kbCtrlShiftRight
        Ctrl-Shift-Right

      • kbBackspace

        public static final TKeypress kbBackspace
        Backspace as ^H.

      • kbCtrlBackspace

        public static final TKeypress kbCtrlBackspace
        Control-Backspace as function key.

      • kbAltBackspace

        public static final TKeypress kbAltBackspace
        Alt-Backspace as function key.

      • kbBackspaceDel

        public static final TKeypress kbBackspaceDel
        Backspace as ^?.

    • Constructor Detail

      • TKeypress

        public TKeypress​(boolean isKey,
                 int fnKey,
                 int ch,
                 boolean alt,
                 boolean ctrl,
                 boolean shift)
        Public constructor makes an immutable instance.
        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

    • Method Detail

      • isFnKey

        public boolean isFnKey()
        Getter for isFunctionKey.
        Returns:
        if true, ch is meaningless, use keyCode instead

      • getKeyCode

        public int getKeyCode()
        Getter for function key code.
        Returns:
        function key code int value (only valid is isKey is true)

      • isAlt

        public boolean isAlt()
        Getter for ALT.
        Returns:
        alt value

      • isCtrl

        public boolean isCtrl()
        Getter for CTRL.
        Returns:
        ctrl value

      • isShift

        public boolean isShift()
        Getter for SHIFT.
        Returns:
        shift value

      • getChar

        public int getChar()
        Getter for character.
        Returns:
        the character (only valid if isKey is false)

      • dup

        public TKeypress dup()
        Create a duplicate instance.
        Returns:
        duplicate intance

      • 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 TKeypress instance
        Returns:
        true if all fields are equal

      • equalsWithoutModifiers

        public boolean equalsWithoutModifiers​(java.lang.Object rhs)
        Comparison check, omitting the ctrl/alt/shift flags.
        Parameters:
        rhs - another TKeypress instance
        Returns:
        true if all fields (except for ctrl/alt/shift) 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 TKeypress.
        Overrides:
        toString in class java.lang.Object
        Returns:
        displayable String

      • toLowerCase

        public TKeypress toLowerCase()
        Convert a keypress to lowercase. Function keys and alt/ctrl keys are not converted.
        Returns:
        a new instance with the key converted

      • toUpperCase

        public TKeypress toUpperCase()
        Convert a keypress to uppercase. Function keys and alt/ctrl keys are not converted.
        Returns:
        a new instance with the key converted