| |
|
| java.lang.Object java.awt.MenuShortcut
MenuShortcut | public class MenuShortcut implements java.io.Serializable(Code) | | 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 .
author: Thomas Ball version: 1.32, 05/05/07 since: JDK1.1 |
Field Summary | |
int | key The virtual keycode for the menu shortcut.
This is the keycode with which the menu shortcut will be created.
Note that it is a virtual keycode, not a character,
e.g. | boolean | usesShift Indicates whether the shft key was pressed. |
Constructor Summary | |
public | MenuShortcut(int key) Constructs a new MenuShortcut for the specified virtual keycode. | public | MenuShortcut(int key, boolean useShiftModifier) Constructs a new MenuShortcut for the specified virtual keycode. |
Method Summary | |
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. | 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.
Parameters: obj - the Object to compare with this. | public int | getKey() Returns the raw keycode of this MenuShortcut. | public int | hashCode() Returns the hashcode for this MenuShortcut. | protected String | paramString() Returns the parameter string representing the state of this
MenuShortcut. | public String | toString() Returns an internationalized description of the MenuShortcut. | public boolean | usesShiftModifier() Returns whether this MenuShortcut must be invoked using the SHIFT key. |
key | int key(Code) | | The virtual keycode for the menu shortcut.
This is the keycode with which the menu shortcut will be created.
Note that it is a virtual keycode, not a character,
e.g. KeyEvent.VK_A, not 'a'.
Note: in 1.1.x you must use setActionCommand() on a menu item
in order for its shortcut to work, otherwise it will fire a null
action command.
See Also: MenuShortcut.getKey() See Also: MenuShortcut.usesShiftModifier() See Also: java.awt.event.KeyEvent since: JDK1.1 |
usesShift | boolean usesShift(Code) | | Indicates whether the shft key was pressed.
If true, the shift key was pressed.
If false, the shift key was not pressed
See Also: MenuShortcut.usesShiftModifier() since: JDK1.1 |
MenuShortcut | public MenuShortcut(int key)(Code) | | Constructs a new MenuShortcut for the specified virtual keycode.
Parameters: key - the raw keycode for this MenuShortcut, as would be returnedin the keyCode field of a java.awt.event.KeyEvent KeyEvent if this key were pressed. See Also: java.awt.event.KeyEvent |
MenuShortcut | public MenuShortcut(int key, boolean useShiftModifier)(Code) | | Constructs a new MenuShortcut for the specified virtual keycode.
Parameters: key - the raw keycode for this MenuShortcut, as would be returnedin the keyCode field of a java.awt.event.KeyEvent KeyEvent if this key were pressed. Parameters: useShiftModifier - indicates whether this MenuShortcut is invokedwith the SHIFT key down. See Also: java.awt.event.KeyEvent |
equals | public boolean equals(MenuShortcut s)(Code) | | 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. true if this MenuShortcut is the same as another, false otherwise. since: JDK1.1 |
equals | public boolean equals(Object obj)(Code) | | 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: obj - the Object to compare with this. true if this MenuShortcut is the same as another, false otherwise. since: 1.2 |
getKey | public int getKey()(Code) | | Returns the raw keycode of this MenuShortcut.
the raw keycode of this MenuShortcut. See Also: java.awt.event.KeyEvent since: JDK1.1 |
hashCode | public int hashCode()(Code) | | Returns the hashcode for this MenuShortcut.
the hashcode for this MenuShortcut. since: 1.2 |
paramString | protected String paramString()(Code) | | Returns the parameter string representing the state of this
MenuShortcut. This string is useful for debugging.
the parameter string of this MenuShortcut. since: JDK1.1 |
toString | public String toString()(Code) | | Returns an internationalized description of the MenuShortcut.
a string representation of this MenuShortcut. since: JDK1.1 |
usesShiftModifier | public boolean usesShiftModifier()(Code) | | Returns whether this MenuShortcut must be invoked using the SHIFT key.
true if this MenuShortcut must be invoked using the SHIFT key, false otherwise. since: JDK1.1 |
|
|
|