Encapsulates the keys accepted by KeyHandler. This class never attempts to represent all key states that a generic input method framework desires to handle. Instead, this class only reflects the keys KeyHandler will handle.

This is not always a perfect representation (for example, shift muddles the picture), but is sufficient for KeyHandler's needs.

Constructors

  • Parameters

    • c: string = ""
    • n: KeyName = KeyName.UNKNOWN
    • shiftPressed: boolean = false
    • ctrlPressed: boolean = false
    • isNumpadKey: boolean = false

    Returns Key

Accessors

  • get ctrlPressed(): boolean
  • If the Control modifier is pressed.

    Returns boolean

  • get isCursorKey(): boolean
  • If the key is for moving the input cursor.

    Returns boolean

  • get isDeleteKey(): boolean
  • If the key is for deleting the previous character.

    Returns boolean

  • get isNumpadKey(): boolean
  • If the key is on the Numpad.

    Returns boolean

  • get shiftPressed(): boolean
  • If the Shift modifier is pressed.

    Returns boolean

Methods

  • Parameters

    • c: string
    • shiftPressed: boolean = false
    • ctrlPressed: boolean = false

    Returns Key

  • Parameters

    • name: KeyName
    • shiftPressed: boolean = false
    • ctrlPressed: boolean = false

    Returns Key