Class Key

java.lang.Object
com.codename1.cli.Key
public final class Key extends Object
One key press read from a terminal in raw mode, decoded from the bytes and escape sequences terminals send. Prompt is built on these; code that wants keys of its own reads them with read().

  • Method Details

    • type

      public Key.Type type()
      What was pressed.

    • codePoint

      public int codePoint()
      The character of a Key.Type.CHAR, the lower-case letter of a Key.Type.CTRL, 0 otherwise.

    • number

      public int number()
      The number of a Key.Type.FUNCTION key, 1 for F1.

    • alt

      public boolean alt()
      Whether Alt (Meta, Option) was held.

    • is

      public boolean is(char c)
      Whether this is the printable character c.

    • read

      public static Key read()
      Reads one key from standard input, which must be in raw mode (see Prompt.rawMode()).

    • toString

      public String toString()
      Description copied from class: Object
      Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method. The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: getClass().getName() + '@' + Integer.toHexString(hashCode())
      Overrides:
      toString in class Object