Package org.eclipse.ui.keys

Class CharacterKey

java.lang.Object
org.eclipse.ui.keys.Key
org.eclipse.ui.keys.NaturalKey
org.eclipse.ui.keys.CharacterKey
All Implemented Interfaces:
Comparable
@Deprecated(forRemoval=true, since="2024-03") public final class CharacterKey extends NaturalKey
Deprecated, for removal: This API element is subject to removal in a future version.
Please use org.eclipse.jface.bindings.keys.KeyStroke and org.eclipse.jface.bindings.keys.KeyLookupFactory

Instances of CharacterKey represent keys on the keyboard which represent unicode characters.

CharacterKey objects are immutable. Clients are not permitted to extend this class.

Since:
3.0

  • Field Details

    • BS

      @Deprecated public static final CharacterKey BS
      Deprecated.
      The single static instance of CharacterKey which represents the backspace key (U+0008).

    • CR

      @Deprecated public static final CharacterKey CR
      Deprecated.
      The single static instance of CharacterKey which represents the carriage return (U+000D) key

    • DEL

      @Deprecated public static final CharacterKey DEL
      Deprecated.
      The single static instance of CharacterKey which represents the delete (U+007F) key.

    • ESC

      @Deprecated public static final CharacterKey ESC
      Deprecated.
      The single static instance of CharacterKey which represents the escape (U+001B) key.

    • FF

      @Deprecated public static final CharacterKey FF
      Deprecated.
      The single static instance of CharacterKey which represents the form feed (U+000C) key.

    • LF

      @Deprecated public static final CharacterKey LF
      Deprecated.
      The single static instance of CharacterKey which represents the line feed (U+000A) key.

    • NUL

      @Deprecated public static final CharacterKey NUL
      Deprecated.
      The single static instance of CharacterKey which represents the null (U+0000) key.

    • SPACE

      @Deprecated public static final CharacterKey SPACE
      Deprecated.
      The single static instance of CharacterKey which represents the space (U+0020) key.

    • TAB

      @Deprecated public static final CharacterKey TAB
      Deprecated.
      The single static instance of CharacterKey which represents the tab (U+0009) key.

    • VT

      @Deprecated public static final CharacterKey VT
      Deprecated.
      The single static instance of CharacterKey which represents the vertical tab (U+000B) key.

  • Method Details

    • getInstance

      @Deprecated public static CharacterKey getInstance(char character)
      Deprecated.
      Creates an instance of CharacterKey given a unicode character. This method determines the correct name for the key based on character. Typically, this name is a string of one-character in length equal to the character that this instance represents.
      Parameters:
      character - the character that the resultant CharacterKey instance is to represent.
      Returns:
      an instance of CharacterKey representing the character.

    • getCharacter

      @Deprecated public char getCharacter()
      Deprecated.
      Gets the character that this object represents.
      Returns:
      the character that this object represents.