Open topic with navigation

com.hp.lft.sdk.java

# Class KeyboardEventInfo

- java.lang.Object
- - com.hp.lft.sdk.java.KeyboardEventInfo

- All Implemented Interfaces:
    com.hp.lft.sdk.internal.java.LeanFtPreDefinedEventInfo, EventInfo

      public class KeyboardEventInfo
      extends java.lang.Object
      implements com.hp.lft.sdk.internal.java.LeanFtPreDefinedEventInfo

  A Java technology Keyboard event info to be used by fireEvent methods.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.Object[]` | `getEventArgs()` Returns an array of the event arguments.
    `KeyboardEvent` | `getKeyboardEvent()` Returns the `KeyboardEvent` of this event info.
    `java.lang.Character` | `getKeyChar()` Returns the Unicode character generated by this event.
    `int` | `getKeyCode()` Returns the key code for the physical key pressed, independent of the character generated.
    `java.lang.Integer` | `getKeyLocation()` Returns the location on the keyboard of the key that originated this event.
    `int` | `getLeanFtEventID()` Returns the Lean FT event id.
    `int` | `getModifiers()` Returns the mask of modifier keys down during event.
    `long` | `getWhen()` Returns the time the event occurred.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Method Detail

    - #### getLeanFtEventID

          public int getLeanFtEventID()

      Description copied from interface: `com.hp.lft.sdk.internal.java.LeanFtPreDefinedEventInfo`
      Returns the Lean FT event id.
      Specified by:
        `getLeanFtEventID` in interface `com.hp.lft.sdk.internal.java.LeanFtPreDefinedEventInfo`
      Returns:
        the Lean FT event id.

    - #### getEventArgs

          public java.lang.Object[] getEventArgs()

      Description copied from interface: `com.hp.lft.sdk.internal.java.LeanFtPreDefinedEventInfo`
      Returns an array of the event arguments.
      Specified by:
        `getEventArgs` in interface `com.hp.lft.sdk.internal.java.LeanFtPreDefinedEventInfo`
      Returns:
        an array of the event arguments.

    - #### getKeyboardEvent

          public KeyboardEvent getKeyboardEvent()

      Returns the `KeyboardEvent` of this event info.
      Returns:
        the `KeyboardEvent` of this event info.

    - #### getWhen

          public long getWhen()

      Returns the time the event occurred.
      Returns:
        the time the event occurred.

    - #### getModifiers

          public int getModifiers()

      Returns the mask of modifier keys down during event. See the documentation for java.awt.event.InputEvent.
      Returns:
        the modifier keys down during event.

    - #### getKeyCode

          public int getKeyCode()

      Returns the key code for the physical key pressed, independent of the character generated. For example, pressing the "a" key sends VK_A whether the character generated is "a" or "A". See the documentation for java.awt.event.KeyEvent.
      Returns:
        the code for the key pressed or VK_UNDEFINED.

    - #### getKeyChar

          public java.lang.Character getKeyChar()

      Returns the Unicode character generated by this event.
      Returns:
        the Unicode character generated by this event.

    - #### getKeyLocation

          public java.lang.Integer getKeyLocation()

      Returns the location on the keyboard of the key that originated this event.
      Returns:
        One of the KEY_LOCATION_* values from java.awt.event.KeyEvent.