MenuShortcut (Java Platform SE 6) (original) (raw)
java.awt
Class MenuShortcut
java.lang.Object
java.awt.MenuShortcut
All Implemented Interfaces:
public class MenuShortcut
extends Object
implements Serializable
The 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);
The accelerator key is platform-dependent and may be obtained via Toolkit.getMenuShortcutKeyMask().
Since:
JDK1.1
See Also:
Constructor Summary |
---|
MenuShortcut(int key) Constructs a new MenuShortcut for the specified virtual keycode. |
[MenuShortcut](../../java/awt/MenuShortcut.html#MenuShortcut%28int, boolean%29)(int key, boolean useShiftModifier) Constructs a new MenuShortcut for the specified virtual keycode. |
Method Summary | |
---|---|
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. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29) |
Constructor Detail |
---|
MenuShortcut
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:
MenuShortcut
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:
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:
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](../../java/lang/Object.html#equals%28java.lang.Object%29)
in class [Object](../../java/lang/Object.html "class in java.lang")
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:
hashCode
public int hashCode()
Returns the hashcode for this MenuShortcut.
Overrides:
[hashCode](../../java/lang/Object.html#hashCode%28%29)
in class [Object](../../java/lang/Object.html "class in java.lang")
Returns:
the hashcode for this MenuShortcut.
Since:
1.2
See Also:
Object.equals(java.lang.Object), Hashtable
toString
public String toString()
Returns an internationalized description of the MenuShortcut.
Overrides:
[toString](../../java/lang/Object.html#toString%28%29)
in class [Object](../../java/lang/Object.html "class in java.lang")
Returns:
a string representation of this MenuShortcut.
Since:
JDK1.1
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 Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.