public class

MenuShortcut

extends Object
implements Serializable
java.lang.Object
   ↳ java.awt.MenuShortcut

Class Overview

The MenuShortcutclass represents a keyboard accelerator for a MenuItem.

Menu shortcuts are created using virtual keycodes, not characters. For example, a menu shortcut for Ctrl-a (assuming that Control is the accelerator key) would be created with code like the following:

MenuShortcut ms = new MenuShortcut(KeyEvent.VK_A, false);

The accelerator key is platform-dependent and may be obtained via getMenuShortcutKeyMask().

Summary

Public Constructors
MenuShortcut(int key)
Constructs a new MenuShortcut for the specified virtual keycode.
MenuShortcut(int key, boolean useShiftModifier)
Constructs a new MenuShortcut for the specified virtual keycode.
Public Methods
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.
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.
int getKey()
Returns the raw keycode of this MenuShortcut.
int hashCode()
Returns the hashcode for this MenuShortcut.
String toString()
Returns an internationalized description of the MenuShortcut.
boolean usesShiftModifier()
Returns whether this MenuShortcut must be invoked using the SHIFT key.
Protected Methods
String paramString()
Returns the parameter string representing the state of this MenuShortcut.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public MenuShortcut (int key)

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

public MenuShortcut (int key, boolean useShiftModifier)

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

Public Methods

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.
Returns
  • true if this MenuShortcut is the same as another, false otherwise.

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.
Returns
  • true if this MenuShortcut is the same as another, false otherwise.

public int getKey ()

Returns the raw keycode of this MenuShortcut.

Returns
  • the raw keycode of this MenuShortcut.
See Also

public int hashCode ()

Returns the hashcode for this MenuShortcut.

Returns
  • the hashcode for this MenuShortcut.

public String toString ()

Returns an internationalized description of the MenuShortcut.

Returns
  • a string representation of this MenuShortcut.

public boolean usesShiftModifier ()

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.

Protected Methods

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.