Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Class java.awt.swing.JMenuItem

java.lang.Object
    |
    +----java.awt.Component
            |
            +----java.awt.Container
                    |
                    +----java.awt.swing.JComponent
                            |
                            +----java.awt.swing.AbstractButton
                                    |
                                    +----java.awt.swing.JMenuItem
Subclasses:
JCheckBoxMenuItem, JMenu, JRadioButtonMenuItem

public class JMenuItem
extends AbstractButton
implements Accessible, MenuElement
An implementation of a MenuItem. A menu item is essentially a button sitting in a list. When the user selects the "button", the action associated with the menu item is performed. A JMenuItem contained in a JPopupMenu performs exactly that function.

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

See Also:
JPopupMenu, JMenu, JCheckBoxMenuItem, JRadioButtonMenuItem

Inner Class Summary
 JMenuItem.AccessibleJMenuItem
The class used to obtain the accessible role for this object.
 
Inner classes inherited from class java.awt.swing.AbstractButton
 AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener
 
Inner classes inherited from class java.awt.swing.JComponent
 JComponent.AccessibleJComponent
 

Fields inherited from class java.awt.swing.AbstractButton
 actionListener, changeEvent, changeListener, itemListener, model
 
Fields inherited from class java.awt.swing.JComponent
 accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
 BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 

Constructor Summary
 JMenuItem()
Creates a menuItem with no set text or icon.
 JMenuItem(Icon icon)
Creates a menuItem with an icon.
 JMenuItem(String text)
Creates a menuItem with text.
 JMenuItem(String text, Icon icon)
Creates a menuItem with the supplied text and icon.
 JMenuItem(String text, int mnemonic)
Creates a menuItem with the specified text and keyboard mnemonic.
 

Method Summary
KeyStroke  getAccelerator()
 
AccessibleContext  getAccessibleContext()
Get the AccessibleContext associated with this JComponent
Component  getComponent()
This method returns the java.awt.Component used to paint this object.
MenuElement[]  getSubElements()
This method returns an array containing the sub-menu components for this menu component.
String  getUIClassID()
Returns the name of the L&F class that renders this component.
void  init(String text, Icon icon)
Initialize the menu item with the specified text and icon.
boolean  isArmed()
Returns whether the menu item is "armed".
void  menuSelectionChanged(boolean isIncluded)
Called by the MenuSelectionManager when the MenuElement is selected or unselected.
void  processKeyEvent(KeyEvent e, MenuElement[] path, MenuSelectionManager manager)
Implemented to be a MenuElement.
void  processMouseEvent(MouseEvent event, MenuElement[] path, MenuSelectionManager manager)
Process a mouse event.
void  setAccelerator(KeyStroke keyStroke)
 
void  setArmed(boolean b)
Identifies the menu item as "armed".
void  setEnabled(boolean b)
Enable or disable the menu item.
void  setUI(java.awt.swing.plaf.MenuItemUI ui)
Sets the L&F object that renders this component.
void  updateUI()
Notification from the UIFactory that the L&F has changed.
 
Methods inherited from class java.awt.swing.AbstractButton
 addActionListener, addChangeListener, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getActionCommand, getDisabledIcon, getDisabledSelectedIcon, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getLabel, getMargin, getMnemonic, getModel, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, init, isBorderPainted, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, setActionCommand, setBorderPainted, setDisabledIcon, setDisabledSelectedIcon, setEnabled, setFocusPainted, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setLabel, setMargin, setMnemonic, setMnemonic, setModel, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition, updateUI
 
Methods inherited from class java.awt.swing.JComponent
 addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getUIClassID, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setBounds, setDebugGraphicsOptions, setDoubleBuffered, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update, updateUI
 
Methods inherited from class java.awt.Container
 add, add, add, add, add, addContainerListener, addImpl, addNotify, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setLayout, update, validate, validateTree
 
Methods inherited from class java.awt.Component
 action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getColorModel, getComponentAt, getComponentAt, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getName, getParent, getPeer, getPreferredSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isEnabled, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setCursor, setDropTarget, setEnabled, setFont, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, update, validate
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JMenuItem

public JMenuItem()
Creates a menuItem with no set text or icon.

JMenuItem

public JMenuItem(Icon icon)
Creates a menuItem with an icon.
Parameters:
icon - the icon of the MenuItem.

JMenuItem

public JMenuItem(String text)
Creates a menuItem with text.
Parameters:
text - the text of the MenuItem.

JMenuItem

public JMenuItem(String text,
                 Icon icon)
Creates a menuItem with the supplied text and icon.
Parameters:
text - the text of the MenuItem.
icon - the icon of the MenuItem.

JMenuItem

public JMenuItem(String text,
                 int mnemonic)
Creates a menuItem with the specified text and keyboard mnemonic.
Parameters:
text - the text of the MenuItem.
mnemonic - the keyboard mnemonic for the MenuItem
Method Detail

init

protected void init(String text,
                    Icon icon)
Initialize the menu item with the specified text and icon.
Parameters:
text - the text of the MenuItem.
icon - the icon of the MenuItem.
Overrides:
init in class AbstractButton

setUI

public void setUI(java.awt.swing.plaf.MenuItemUI ui)
Sets the L&F object that renders this component.
Parameters:
ui - the MenuItemUI L&F object
See Also:
getUI

updateUI

public void updateUI()
Notification from the UIFactory that the L&F has changed. Called to replace the UI with the latest version from the UIFactory.
Overrides:
updateUI in class AbstractButton
See Also:
updateUI

getUIClassID

public String getUIClassID()
Returns the name of the L&F class that renders this component.
Returns:
"MenuItemUI"
Overrides:
getUIClassID in class JComponent
See Also:
getUIClassID, getUI

setArmed

public void setArmed(boolean b)
Identifies the menu item as "armed". If the mouse button is released while it is over this item, the menu's action event will fire. If the mouse button is released elsewhere, the event will not fire and the menu item will be disarmed.
Parameters:
b - true to arm the menu item so it can be selected

isArmed

public boolean isArmed()
Returns whether the menu item is "armed".
Returns:
true if the menu item is armed, and it can be selected
See Also:
setArmed

setEnabled

public void setEnabled(boolean b)
Enable or disable the menu item.
Parameters:
b - true to enable the item
Overrides:
setEnabled in class AbstractButton

setAccelerator

public void setAccelerator(KeyStroke keyStroke)

getAccelerator

public KeyStroke getAccelerator()

processMouseEvent

public void processMouseEvent(MouseEvent event,
                              MenuElement[] path,
                              MenuSelectionManager manager)
Process a mouse event. event is a MouseEvent with source being the receiving component. componentPath is the path of the receiving MenuElement in the menu hierarchy. manager is the MenuSelectionManager for the menu hierarchy. This method should process the MouseEvent and change the menu selection if necessary by using MenuSelectionManager's API.

Note: you do not have to forward the event to sub-components. This is done automatically by the MenuSelectionManager

Implements:
processMouseEvent in interface MenuElement

processKeyEvent

public void processKeyEvent(KeyEvent e,
                            MenuElement[] path,
                            MenuSelectionManager manager)
Implemented to be a MenuElement. This message is forwarded to the UI
Implements:
processKeyEvent in interface MenuElement

menuSelectionChanged

public void menuSelectionChanged(boolean isIncluded)
Called by the MenuSelectionManager when the MenuElement is selected or unselected.
Implements:
menuSelectionChanged in interface MenuElement
Parameters:
isIncluded - true if this menu item is on the part of the menu path that changed, false if this menu is part of the a menu path that changed, but this particular part of that path is still the same
See Also:
setSelectedPath(MenuElement[])

getSubElements

public MenuElement[] getSubElements()
This method returns an array containing the sub-menu components for this menu component.
Implements:
getSubElements in interface MenuElement
Returns:
an array of MenuElements

getComponent

public Component getComponent()
This method returns the java.awt.Component used to paint this object. The returned component will be used to convert events and detect if an event is inside a menu component.
Implements:
getComponent in interface MenuElement
Returns:
the Component that paints this menu item

getAccessibleContext

public AccessibleContext getAccessibleContext()
Get the AccessibleContext associated with this JComponent
Implements:
getAccessibleContext in interface Accessible
Returns:
the AccessibleContext of this JComponent
Overrides:
getAccessibleContext in class JComponent

Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.