Eclipse Platform
Release 3.0

org.eclipse.ui.keys
Class CharacterKey

java.lang.Object
  extended byorg.eclipse.ui.keys.Key
      extended byorg.eclipse.ui.keys.NaturalKey
          extended byorg.eclipse.ui.keys.CharacterKey
All Implemented Interfaces:
Comparable

public final class CharacterKey
extends NaturalKey

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 Summary
static CharacterKey BS
          The single static instance of CharacterKey which represents the backspace key (U+0008).
static CharacterKey CR
          The single static instance of CharacterKey which represents the carriage return (U+000D) key
static CharacterKey DEL
          The single static instance of CharacterKey which represents the delete (U+007F) key.
static CharacterKey ESC
          The single static instance of CharacterKey which represents the escape (U+001B) key.
static CharacterKey FF
          The single static instance of CharacterKey which represents the form feed (U+000C) key.
static CharacterKey LF
          The single static instance of CharacterKey which represents the line feed (U+000A) key.
static CharacterKey NUL
          The single static instance of CharacterKey which represents the null (U+0000) key.
static CharacterKey SPACE
          The single static instance of CharacterKey which represents the space (U+0020) key.
static CharacterKey TAB
          The single static instance of CharacterKey which represents the tab (U+0009) key.
static CharacterKey VT
          The single static instance of CharacterKey which represents the vertical tab (U+000B) key.
 
Fields inherited from class org.eclipse.ui.keys.Key
name
 
Method Summary
 char getCharacter()
          Gets the character that this object represents.
static CharacterKey getInstance(char character)
          Creates an instance of CharacterKey given a unicode character.
 
Methods inherited from class org.eclipse.ui.keys.Key
compareTo, equals, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

BS

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


CR

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


DEL

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


ESC

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


FF

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


LF

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


NUL

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


SPACE

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


TAB

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


VT

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

Method Detail

getInstance

public static CharacterKey getInstance(char character)
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

public char getCharacter()
Gets the character that this object represents.

Returns:
the character that this object represents.

Eclipse Platform
Release 3.0

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.