- java.lang.Object
-
- java.awt.MenuShortcut
-
- All Implemented Interfaces:
Serializable
public class MenuShortcut extends Object implements Serializable
TheMenuShortcutclass 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);or alternatively
MenuShortcut ms = new MenuShortcut(KeyEvent.getExtendedKeyCodeForChar('A'), false);Menu shortcuts may also be constructed for a wider set of keycodes using the
java.awt.event.KeyEvent.getExtendedKeyCodeForCharcall. For example, a menu shortcut for "Ctrl+cyrillic ef" is created byMenuShortcut ms = new MenuShortcut(KeyEvent.getExtendedKeyCodeForChar('ф'), false);Note that shortcuts created with a keycode or an extended keycode defined as a constant in
KeyEventwork regardless of the current keyboard layout. However, a shortcut made of an extended keycode not listed inKeyEventonly work if the current keyboard layout produces a corresponding letter.The accelerator key is platform-dependent and may be obtained via
Toolkit.getMenuShortcutKeyMaskEx().- Since:
- 1.1
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description 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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(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.booleanequals(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.intgetKey()Returns the raw keycode of this MenuShortcut.inthashCode()Returns the hashcode for this MenuShortcut.protected StringparamString()Returns the parameter string representing the state of this MenuShortcut.StringtoString()Returns an internationalized description of the MenuShortcut.booleanusesShiftModifier()Returns whether this MenuShortcut must be invoked using the SHIFT key.
-
-
-
Method Detail
-
getKey
public int getKey()
Returns the raw keycode of this MenuShortcut.- Returns:
- the raw keycode of this MenuShortcut.
- Since:
- 1.1
- See Also:
KeyEvent
-
usesShiftModifier
public boolean usesShiftModifier()
Returns whether this MenuShortcut must be invoked using the SHIFT key.- Returns:
trueif this MenuShortcut must be invoked using the SHIFT key,falseotherwise.- Since:
- 1.1
-
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.- Returns:
trueif this MenuShortcut is the same as another,falseotherwise.- Since:
- 1.1
-
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.- Overrides:
equalsin classObject- Parameters:
obj- the Object to compare with this.- Returns:
trueif this MenuShortcut is the same as another,falseotherwise.- Since:
- 1.2
- See Also:
Object.hashCode(),HashMap
-
hashCode
public int hashCode()
Returns the hashcode for this MenuShortcut.- Overrides:
hashCodein classObject- Returns:
- the hashcode for this MenuShortcut.
- Since:
- 1.2
- See Also:
Object.equals(java.lang.Object),System.identityHashCode(java.lang.Object)
-
toString
public String toString()
Returns an internationalized description of the MenuShortcut.
-
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:
- 1.1
-
-