Class MenuShortcut
- java.lang.Object
-
- java.awt.MenuShortcut
-
- All Implemented Interfaces:
- Serializable
public class MenuShortcut extends Object implements Serializable
TheMenuShortcut
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 byMenuShortcut 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 inKeyEvent
only work if the current keyboard layout produces a corresponding letter.The accelerator key is platform-dependent and may be obtained via
Toolkit.getMenuShortcutKeyMask()
.- Since:
- JDK1.1
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and 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 and 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.
-
-
-
Constructor Detail
MenuShortcut
public MenuShortcut(int key)
Constructs a new MenuShortcut for the specified virtual keycode.
MenuShortcut
public MenuShortcut(int key, boolean useShiftModifier)
Constructs a new MenuShortcut for the specified virtual keycode.
-
Method Detail
getKey
public int getKey()
Returns the raw keycode of this MenuShortcut.- Returns:
- the raw keycode of this MenuShortcut.
- Since:
- JDK1.1
- See Also:
-
KeyEvent
usesShiftModifier
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. - Since:
- JDK1.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:
-
true
if this MenuShortcut is the same as another,false
otherwise. - Since:
- JDK1.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:
-
equals
in classObject
- Parameters:
-
obj
- the Object to compare with this. - Returns:
-
true
if this MenuShortcut is the same as another,false
otherwise. - Since:
- 1.2
- See Also:
-
Object.hashCode()
,HashMap
hashCode
public int hashCode()
Returns the hashcode for this MenuShortcut.- Overrides:
-
hashCode
in 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:
- JDK1.1
-
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, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.