Serializable
public class MenuShortcut extends Object implements Serializable
MenuShortcut
class 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.getExtendedKeyCodeForChar
call. For example, a menu shortcut for "Ctrl+cyrillic ef" is created by
MenuShortcut ms = new MenuShortcut(KeyEvent.getExtendedKeyCodeForChar('Ñ'), false);
Note that shortcuts created with a keycode or an extended keycode defined as a constant in KeyEvent
work regardless of the current keyboard layout. However, a shortcut made of an extended keycode not listed in KeyEvent
only work if the current keyboard layout produces a corresponding letter.
The accelerator key is platform-dependent and may be obtained via Toolkit.getMenuShortcutKeyMaskEx()
.
Constructor | Description |
---|---|
MenuShortcut |
Constructs a new MenuShortcut for the specified virtual keycode. |
MenuShortcut |
Constructs a new MenuShortcut for the specified virtual keycode. |
Modifier and Type | Method | Description |
---|---|---|
boolean |
equals |
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 |
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. |
protected String |
paramString() |
Returns the parameter string representing the state of this MenuShortcut. |
String |
toString() |
Returns an internationalized description of the MenuShortcut. |
boolean |
usesShiftModifier() |
Returns whether this MenuShortcut must be invoked using the SHIFT key. |
public MenuShortcut(int key)
key
- the raw keycode for this MenuShortcut, as would be returned in the keyCode field of a KeyEvent
if this key were pressed.public MenuShortcut(int key, boolean useShiftModifier)
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.public int getKey()
public boolean usesShiftModifier()
true
if this MenuShortcut must be invoked using the SHIFT key, false
otherwise.public boolean equals(MenuShortcut s)
s
- the MenuShortcut to compare with this.true
if this MenuShortcut is the same as another, false
otherwise.public boolean equals(Object obj)
public int hashCode()
public String toString()
protected String paramString()
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/java/awt/MenuShortcut.html