java.awt
Class MenuShortcut

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

public class MenuShortcut

extends Object

implements Serializable

A class which represents a keyboard accelerator for a MenuItem.

See Also:

Serialized Form

Field Summary

(package private) int	key This is indicates the virtual keycode for the menu shortcut.
private static long	serialVersionUID
(package private) boolean	usesShift Indicates whether the shft key was pressed.

Constructor Summary

MenuShortcut(int key)
Constructs a new MenuShortcut for the specified key.

MenuShortcut(int key, boolean useShiftModifier)
Constructs a new MenuShortcut for the specified key.

Method Summary

boolean	equals(MenuShortcut s) 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.
boolean	equals(Object obj) 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.
int	getKey() Return the raw keycode of this MenuShortcut.
int	hashCode() Returns the hashcode for this MenuShortcut.
protected String	paramString()
String	toString() Returns an internationalized description of the MenuShortcut.
boolean	usesShiftModifier() Return whether this MenuShortcut must be invoked using the SHIFT key.

Methods inherited from class java.lang.Object

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

Field Detail

key

int key

This is indicates the virtual keycode for the menu shortcut. It is the key code with which the menu short cut will be created. In 1.1.2 you must use setActionCommand() on a menu item in order for its shortcut to work, otherwise it will fire a null action command. Must use KeyEvent virtual keys - eg : VK_A.

See Also:

getKey(), usesShiftModifier()

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

See Also:

usesShiftModifier()

serialVersionUID

private static final long serialVersionUID

Constructor Detail

MenuShortcut

public MenuShortcut(int key)

Constructs a new MenuShortcut for the specified key.

Parameters:

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

MenuShortcut

public MenuShortcut(int key,
                    boolean useShiftModifier)

Constructs a new MenuShortcut for the specified key.

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.

Method Detail

getKey

public int getKey()

Return the raw keycode of this MenuShortcut.

usesShiftModifier

public boolean usesShiftModifier()

Return whether this MenuShortcut must be invoked using the SHIFT key.

equals

public boolean equals(MenuShortcut s)

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.

equals

public boolean equals(Object obj)

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:

obj - the Object to compare with this.

Overrides:

equals in class Object

hashCode

public int hashCode()

Returns the hashcode for this MenuShortcut.

Overrides:

hashCode in class Object

toString

public String toString()

Returns an internationalized description of the MenuShortcut.

Overrides:

toString in class Object

paramString

protected String paramString()