org.eclipse.ui.keys
Class Key
java.lang.Object
org.eclipse.ui.keys.Key
-
All Implemented Interfaces:
-
Comparable
-
Direct Known Subclasses:
-
ModifierKey,
NaturalKey
Deprecated. Please use org.eclipse.jface.bindings.keys.KeyStroke and
org.eclipse.jface.bindings.keys.KeyLookupFactory
-
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.
-
Since:
- 3.0
-
Restriction:
- This class is not intended to be subclassed by clients.
Field Summary
|
protected int
|
key
Deprecated. The key from which this key was constructed. |
key
protected final int key
-
Deprecated.
- The key from which this key was constructed. This value is defined by
KeyLookupFactory.getDefault()
.
compareTo
public final int compareTo(
Object object)
-
Deprecated.
-
-
Specified by:
-
compareTo
in interface
Comparable
-
-
See Also:
-
Comparable.compareTo(java.lang.Object)
equals
public final boolean equals(
Object object)
-
Deprecated.
-
-
Overrides:
-
equals
in class
Object
-
-
See Also:
-
Object.equals(java.lang.Object)
hashCode
public final int hashCode()
-
Deprecated.
-
-
Overrides:
-
hashCode
in class
Object
-
-
See Also:
-
Object.hashCode()
toString
public final
String toString()
-
Deprecated.
- Returns the formal string representation for this key.
-
-
Overrides:
-
toString
in class
Object
-
-
Returns:
- The formal string representation for this key. Guaranteed not to
be
null
. -
See Also:
-
Object.toString()
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.