This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

java.awt
class MenuShortcut

java.lang.Object extended by java.awt.MenuShortcut
All Implemented Interfaces:
Serializable
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}.

Constructor Summary
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
 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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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 {@link java.awt.event.KeyEvent KeyEvent} if this key were pressed.

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 {@link java.awt.event.KeyEvent KeyEvent} if this key were pressed.
useShiftModifier - indicates whether this MenuShortcut is invoked with the SHIFT key down.
Method Detail

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.

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 class Object
Parameters:
obj - the Object to compare with this.
Returns:
true if this MenuShortcut is the same as another, false otherwise.

getKey

public int getKey()
Returns the raw keycode of this MenuShortcut.

Returns:
the raw keycode of this MenuShortcut.

hashCode

public int hashCode()
Returns the hashcode for this MenuShortcut.

Overrides:
hashCode in class Object
Returns:
the hashcode for this 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.

toString

public String toString()
Returns an internationalized description of the MenuShortcut.

Overrides:
toString in class Object
Returns:
a string representation of this MenuShortcut.

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.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.