org.eclipse.ui.keys
Class Key

java.lang.Object
  org.eclipse.ui.keys.Key

All Implemented Interfaces:

Comparable

Direct Known Subclasses:

ModifierKey, NaturalKey

public abstract class Key

extends Object

implements Comparable

Key is the abstract base class for all objects representing keys on the keyboard.

All Key objects have a formal string representation, called the 'name' of the key, available via the toString() method.

All Key objects, via the format() method, provide a version of their formal string representation translated by platform and locale, suitable for display to a user.

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

EXPERIMENTAL

Since:

3.0

Field Summary

protected String

name The formal string representation for this object.

Method Summary

int	compareTo(Object object)
boolean	equals(Object object)
int	hashCode()
String	toString() Returns the formal string representation for this key.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

name

protected String name

The formal string representation for this object. Equality of Key objects is determined solely by this field.

Method Detail

compareTo

public int compareTo(Object object)

Specified by:

compareTo in interface Comparable

equals

public boolean equals(Object object)

hashCode

public int hashCode()

toString

public String toString()

Returns the formal string representation for this key.

Returns:

The formal string representation for this key. Guaranteed not to be null.

See Also:

Object.toString()