java.awt
Class MenuShortcut

java.lang.Object
 |
 +--java.awt.MenuShortcut

All Implemented Interfaces:

Serializable

public class MenuShortcut

extends Object

implements Serializable

Safe:

See Also:

Serialized Form

key

int key

The virtual keycode for the menu shortcut. This is the keycode with which the menu shortcut will be created. Note that it is a virtual keycode, not a character, e.g. KeyEvent.VK_A, not 'a'. Note: in 1.1.x you must use setActionCommand() on a menu item in order for its shortcut to work, otherwise it will fire a null action command.

Since:

JDK1.1

See Also:

getKey(), usesShiftModifier(), java.awt.event.KeyEvent

usesShift

boolean usesShift

Indicates whether the shft key was pressed. If true, the shift key was pressed. If false, the shift key was not pressed

Since:

JDK1.1

See Also:

usesShiftModifier()

serialVersionUID

private static final long serialVersionUID

MenuShortcut

public MenuShortcut(int key)

Enabled: Constructs a new MenuShortcut for the specified virtual keycode.

Parameters:

key - the raw keycode for this MenuShortcut, as would be returned in the keyCode field of a KeyEvent if this key were pressed.

See Also:

java.awt.event.KeyEvent

MenuShortcut

public MenuShortcut(int key,
 boolean useShiftModifier)

Enabled: Constructs a new MenuShortcut for the specified virtual keycode.

Parameters:

key - the raw keycode for this MenuShortcut, as would be returned in the keyCode field of a KeyEvent if this key were pressed.

useShiftModifier - indicates whether this MenuShortcut is invoked with the SHIFT key down.

See Also:

java.awt.event.KeyEvent

getKey

public int getKey()

Enabled: Returns the raw keycode of this MenuShortcut.

Returns:

the raw keycode of this MenuShortcut.

Since:

JDK1.1

See Also:

java.awt.event.KeyEvent

usesShiftModifier

public boolean usesShiftModifier()

Enabled: Returns whether this MenuShortcut must be invoked using the SHIFT key.

Returns:

true if this MenuShortcut must be invoked using the SHIFT key, false otherwise.

Since:

JDK1.1

equals

public boolean equals(MenuShortcut s)

Suppressed: Returns whether this MenuShortcut is the same as another: equality is defined to mean that both MenuShortcuts use the same key and both either use or don't use the SHIFT key.

Parameters:

s - the MenuShortcut to compare with this.

Returns:

true if this MenuShortcut is the same as another, false otherwise.

Since:

JDK1.1

equals

public boolean equals(Object obj)

Suppressed: Returns whether this MenuShortcut is the same as another: equality is defined to mean that both MenuShortcuts use the same key and both either use or don't use the SHIFT key.

Overrides:

equals in class Object

Parameters:

obj - the Object to compare with this.

Returns:

true if this MenuShortcut is the same as another, false otherwise.

Since:

1.2

See Also:

Object.hashCode(), java.util.Hashtable

hashCode

public int hashCode()

Suppressed: Returns the hashcode for this MenuShortcut.

Overrides:

hashCode in class Object

Returns:

the hashcode for this MenuShortcut.

Since:

1.2

See Also:

java.lang.Object#equals(java.lang.Object), java.util.Hashtable

toString

public String toString()

Suppressed: Returns an internationalized description of the MenuShortcut.

Overrides:

toString in class Object

Returns:

a string representation of this MenuShortcut.

Since:

JDK1.1

paramString

protected String paramString()

Returns the parameter string representing the state of this MenuShortcut. This string is useful for debugging.

Returns:

the parameter string of this MenuShortcut.

Since:

JDK1.1