Package org.eclipse.ui.keys

Class Key

java.lang.Object

org.eclipse.ui.keys.Key

All Implemented Interfaces:

Comparable

Direct Known Subclasses:

ModifierKey, NaturalKey

@Deprecated(forRemoval=true,
            since="2024-03")
public abstract class Key
extends Object
implements Comparable

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

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

Fields

Modifier and Type	Field	Description
protected final int	key	Deprecated.

Method Summary

Modifier and Type	Method	Description
final int	compareTo(Object object)	Deprecated.
final boolean	equals(Object object)	Deprecated.
final int	hashCode()	Deprecated.
final String	toString()	Deprecated.

Methods inherited from class java.lang.Object

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

Field Details

key

@Deprecated
protected final int key

Deprecated.

The key from which this key was constructed. This value is defined by KeyLookupFactory.getDefault().

Method Details

compareTo

@Deprecated
public final int compareTo(Object object)

Deprecated.

Specified by:

compareTo in interface Comparable

See Also:

• Comparable.compareTo(java.lang.Object)

equals

@Deprecated
public final boolean equals(Object object)

Deprecated.

Overrides:

equals in class Object

hashCode

@Deprecated
public final int hashCode()

Deprecated.

Overrides:

hashCode in class Object

toString

@Deprecated
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.