FileDocCategorySizeDatePackage
MenuShortcut.javaAPI DocJava SE 5 API5539Fri Aug 26 14:56:46 BST 2005java.awt

MenuShortcut

public class MenuShortcut extends Object implements Serializable
The MenuShortcutclass 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 {@link Toolkit#getMenuShortcutKeyMask}.

author
Thomas Ball
version
1.25, 12/19/03
since
JDK1.1

Fields 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. 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.
boolean
usesShift
Indicates whether the shft key was pressed. If true, the shift key was pressed. If false, the shift key was not pressed
private static final long
serialVersionUID
Constructors Summary
public MenuShortcut(int key)
Constructs a new MenuShortcut for the specified virtual keycode.

param
key the raw keycode for this MenuShortcut, as would be returned in the keyCode field of a {@link java.awt.event.KeyEvent KeyEvent} if this key were pressed.
see
java.awt.event.KeyEvent


                                               
       
        this(key, false);
    
public MenuShortcut(int key, boolean useShiftModifier)
Constructs a new MenuShortcut for the specified virtual keycode.

param
key the raw keycode for this MenuShortcut, as would be returned in the keyCode field of a {@link java.awt.event.KeyEvent KeyEvent} if this key were pressed.
param
useShiftModifier indicates whether this MenuShortcut is invoked with the SHIFT key down.
see
java.awt.event.KeyEvent

        this.key = key;
        this.usesShift = useShiftModifier;
    
Methods Summary
public booleanequals(java.awt.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.

param
s the MenuShortcut to compare with this.
return
true if this MenuShortcut is the same as another, false otherwise.
since
JDK1.1

	return (s != null && (s.getKey() == key) &&
                (s.usesShiftModifier() == usesShift));
    
public booleanequals(java.lang.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.

param
obj the Object to compare with this.
return
true if this MenuShortcut is the same as another, false otherwise.
since
1.2

        if (obj instanceof MenuShortcut) {
            return equals( (MenuShortcut) obj );
        }
        return false;
    
public intgetKey()
Returns the raw keycode of this MenuShortcut.

return
the raw keycode of this MenuShortcut.
see
java.awt.event.KeyEvent
since
JDK1.1

        return key;
    
public inthashCode()
Returns the hashcode for this MenuShortcut.

return
the hashcode for this MenuShortcut.
since
1.2

        return (usesShift) ? (~key) : key;
    
protected java.lang.StringparamString()
Returns the parameter string representing the state of this MenuShortcut. This string is useful for debugging.

return
the parameter string of this MenuShortcut.
since
JDK1.1

        String str = "key=" + key;
	if (usesShiftModifier()) {
	    str += ",usesShiftModifier";
	}
	return str;
    
public java.lang.StringtoString()
Returns an internationalized description of the MenuShortcut.

return
a string representation of this MenuShortcut.
since
JDK1.1

        int modifiers = 0;
        if (!GraphicsEnvironment.isHeadless()) {
            modifiers = Toolkit.getDefaultToolkit().getMenuShortcutKeyMask();
	}
        if (usesShiftModifier()) {
            modifiers |= Event.SHIFT_MASK;
        }
	return KeyEvent.getKeyModifiersText(modifiers) + "+" +
               KeyEvent.getKeyText(key);
    
public booleanusesShiftModifier()
Returns whether this MenuShortcut must be invoked using the SHIFT key.

return
true if this MenuShortcut must be invoked using the SHIFT key, false otherwise.
since
JDK1.1

        return usesShift;