java.awt
Class MenuShortcut

java.lang.Object
  extended by java.awt.MenuShortcut
All Implemented Interfaces:
Serializable

public class MenuShortcut
extends Object
implements Serializable

This class implements a keyboard accelerator for a menu item.

See Also:
Serialized Form

Constructor Summary
MenuShortcut(int key)
          Initializes a new instance of MenuShortcut with the specified virtual key value.
MenuShortcut(int key, boolean usesShift)
          Initializes a new instance of MenuShortcut with the specified virtual key value and shift setting.
 
Method Summary
 boolean equals(MenuShortcut obj)
          Tests this object for equality against the specified object.
 boolean equals(Object obj)
          Determine whether this Object is semantically equal to another Object.
 int getKey()
          Returns the virtual keycode for this shortcut.
 int hashCode()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.
protected  String paramString()
          Returns a debugging string for this object.
 String toString()
          Returns a string representation of this shortcut.
 boolean usesShiftModifier()
          Returns the shift setting for this shortcut.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MenuShortcut

public MenuShortcut(int key)
Initializes a new instance of MenuShortcut with the specified virtual key value.

Parameters:
key - The virtual keycode for the shortcut.

MenuShortcut

public MenuShortcut(int key,
                    boolean usesShift)
Initializes a new instance of MenuShortcut with the specified virtual key value and shift setting.

Parameters:
key - The virtual keycode for the shortcut.
usesShift - true if the shift key was pressed, false otherwise.
Method Detail

getKey

public int getKey()
Returns the virtual keycode for this shortcut.

Returns:
The virtual keycode for this shortcut.

usesShiftModifier

public boolean usesShiftModifier()
Returns the shift setting for this shortcut.

Returns:
true if the shift key was pressed, false otherwise.

equals

public boolean equals(MenuShortcut obj)
Tests this object for equality against the specified object. The two objects will be considered equal if and only if the specified object is an instance of MenuShortcut and has the same key value and shift setting as this object.

Parameters:
obj - The object to test for equality against.
Returns:
true if the two objects are equal, false otherwise.

equals

public boolean equals(Object obj)
Description copied from class: Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

This is typically overridden to throw a ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

Overrides:
equals in class Object
Parameters:
obj - the Object to compare to
Returns:
whether this Object is semantically equal to another
See Also:
Object.hashCode()

toString

public String toString()
Returns a string representation of this shortcut.

Overrides:
toString in class Object
Returns:
A string representation of this shortcut.
See Also:
Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)

hashCode

public int hashCode()
Description copied from class: Object
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

Notice that since hashCode is used in Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

Overrides:
hashCode in class Object
Returns:
the hash code for this Object
See Also:
Object.equals(Object), System.identityHashCode(Object)

paramString

protected String paramString()
Returns a debugging string for this object.

Returns:
A debugging string for this object.