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.getMenuShortcutKeyMask()
.
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.
|
Modifier and Type | Method | Description |
---|---|---|
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() |
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)
public MenuShortcut(int key, boolean useShiftModifier)
public int getKey()
KeyEvent
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)
equals
in class Object
obj
- the Object to compare with this.true
if this MenuShortcut is the same as another,
false
otherwise.Object.hashCode()
,
HashMap
public int hashCode()
hashCode
in class Object
Object.equals(java.lang.Object)
,
System.identityHashCode(java.lang.Object)
public String toString()
protected String paramString()
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-internal+0-adhoc.mlchung.jdk9-jdeps