javax.swing
Class JMenuItem

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.AbstractButton
                          |
                          +--javax.swing.JMenuItem

All Implemented Interfaces:

Accessible, java.awt.image.ImageObserver, ItemSelectable, MenuContainer, MenuElement, Serializable, SwingConstants

Direct Known Subclasses:

JCheckBoxMenuItem, JMenu, JRadioButtonMenuItem

public class JMenuItem

extends AbstractButton

implements Accessible, MenuElement

Safe: An implementation of an item in a menu. 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.

For further documentation and for examples, see How to Use Menus in The Java Tutorial. For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the JMenuItem key assignments.

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 applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans^TM has been added to the java.beans package. Please see java.beans.XMLEncoder.

Version:

1.109 01/19/03

Author:

Georges Saab, David Karlton

See Also:

JPopupMenu, JMenu, JCheckBoxMenuItem, JRadioButtonMenuItem, Serialized Form

Field Summary

private KeyStroke	accelerator
private static boolean	DEBUG
private boolean	isMouseDragged
private static boolean	TRACE
private static String	uiClassID
private static boolean	VERBOSE

Fields inherited from class javax.swing.AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

Fields inherited from class javax.swing.JComponent

_bounds, accessibleContext, listenerList, paintingChild, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Container

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

JMenuItem()
Enabled: Creates a JMenuItem with no set text or icon.

JMenuItem(Action a)
Enabled: Creates a menu item whose properties are taken from the specified Action.

JMenuItem(Icon icon)
Enabled: Creates a JMenuItem with the specified icon.

JMenuItem(String text)
Enabled: Creates a JMenuItem with the specified text.

JMenuItem(String text, Icon icon)
Enabled: Creates a JMenuItem with the specified text and icon.

JMenuItem(String text, int mnemonic)
Enabled: Creates a JMenuItem with the specified text and keyboard mnemonic.

Method Summary

void	addMenuDragMouseListener(MenuDragMouseListener l) Enabled: Adds a MenuDragMouseListener to the menu item.
void	addMenuKeyListener(MenuKeyListener l) Enabled: Adds a MenuKeyListener to the menu item.
(package private) boolean	alwaysOnTop() Returns true since Menus, by definition, should always be on top of all other windows.
protected void	configurePropertiesFromAction(Action a) Factory method which sets the ActionEvent source's properties according to values from the Action instance.
protected java.beans.PropertyChangeListener	createActionPropertyChangeListener(Action a) Factory method which creates the PropertyChangeListener used to update the ActionEvent source as properties change on its Action instance.
protected void	fireMenuDragMouseDragged(MenuDragMouseEvent event) Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuDragMouseEntered(MenuDragMouseEvent event) Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuDragMouseExited(MenuDragMouseEvent event) Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuDragMouseReleased(MenuDragMouseEvent event) Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuKeyPressed(MenuKeyEvent event) Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuKeyReleased(MenuKeyEvent event) Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuKeyTyped(MenuKeyEvent event) Notifies all listeners that have registered interest for notification on this event type.
KeyStroke	getAccelerator() Enabled: Returns the KeyStroke which serves as an accelerator for the menu item.
AccessibleContext	getAccessibleContext() Suppressed: Returns the AccessibleContext associated with this JMenuItem.
Component	getComponent() Enabled: Returns the java.awt.Component used to paint this object.
MenuDragMouseListener[]	getMenuDragMouseListeners() Suppressed: Returns an array of all the MenuDragMouseListeners added to this JMenuItem with addMenuDragMouseListener().
MenuKeyListener[]	getMenuKeyListeners() Suppressed: Returns an array of all the MenuKeyListeners added to this JMenuItem with addMenuKeyListener().
MenuElement[]	getSubElements() Enabled: This method returns an array containing the sub-menu components for this menu component.
String	getUIClassID() Enabled: Returns the suffix used to construct the name of the L&F class used to render this component.
protected void	init(String text, Icon icon) Initializes the menu item with the specified text and icon.
(package private) void	initFocusability() Inititalizes the focusability of the the JMenuItem.
boolean	isArmed() Enabled: Returns whether the menu item is "armed".
void	menuSelectionChanged(boolean isIncluded) Enabled: Called by the MenuSelectionManager when the MenuElement is selected or unselected.
protected String	paramString() Returns a string representation of this JMenuItem.
void	processKeyEvent(KeyEvent e, MenuElement[] path, MenuSelectionManager manager) Suppressed: Processes a key event forwarded from the MenuSelectionManager and changes the menu selection, if necessary, by using MenuSelectionManager's API.
void	processMenuDragMouseEvent(MenuDragMouseEvent e) Suppressed: Handles mouse drag in a menu.
void	processMenuKeyEvent(MenuKeyEvent e) Suppressed: Handles a keystroke in a menu.
void	processMouseEvent(MouseEvent e, MenuElement[] path, MenuSelectionManager manager) Suppressed: Processes a mouse event forwarded from the MenuSelectionManager and changes the menu selection, if necessary, by using the MenuSelectionManager's API.
private void	readObject(ObjectInputStream s) See JComponent.readObject() for information about serialization in Swing.
void	removeMenuDragMouseListener(MenuDragMouseListener l) Enabled: Removes a MenuDragMouseListener from the menu item.
void	removeMenuKeyListener(MenuKeyListener l) Enabled: Removes a MenuKeyListener from the menu item.
void	setAccelerator(KeyStroke keyStroke) Enabled: Sets the key combination which invokes the menu item's action listeners without navigating the menu hierarchy.
void	setArmed(boolean b) Enabled: Identifies the menu item as "armed".
void	setEnabled(boolean b) Enabled: Enables or disables the menu item.
void	setUI(javax.swing.plaf.MenuItemUI ui) Enabled: Sets the look and feel object that renders this component.
void	updateUI() Enabled: Resets the UI property with a value from the current look and feel.
private void	writeObject(ObjectOutputStream s) Before writing a JComponent to an ObjectOutputStream we temporarily uninstall its UI.

Methods inherited from class javax.swing.AbstractButton

addActionListener, addChangeListener, addItemListener, checkHorizontalKey, checkVerticalKey, configurePropertiesFromAction, createActionListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setFocusPainted, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

Methods inherited from class javax.swing.JComponent

_paintImmediately, addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, checkIfChildObscuredBySibling, componentInputMapChanged, computeVisibleRect, computeVisibleRect, compWriteObjectNotify, contains, createToolTip, disable, enable, enableSerialization, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getCreatedDoubleBuffer, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getManagingFocusBackwardTraversalKeys, getManagingFocusForwardTraversalKeys, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getWriteObjCounter, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyBindings, processKeyBindingsForAllComponents, processKeyEvent, processMouseMotionEvent, putClientProperty, rectangleIsObscured, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setCreatedDoubleBuffer, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPaintingChild, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, setWriteObjCounter, shouldDebugGraphics, superProcessMouseMotionEvent, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, get, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, iterate, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, size, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, toString, transferFocus, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

uiClassID

private static final String uiClassID

See Also:

getUIClassID(), readObject(java.io.ObjectInputStream)

TRACE

private static final boolean TRACE

VERBOSE

private static final boolean VERBOSE

DEBUG

private static final boolean DEBUG

isMouseDragged

private boolean isMouseDragged

accelerator

private KeyStroke accelerator

Constructor Detail

JMenuItem

public JMenuItem()

Enabled: Creates a JMenuItem with no set text or icon.

JMenuItem

public JMenuItem(Icon icon)

Enabled: Creates a JMenuItem with the specified icon.

Parameters:

icon - the icon of the JMenuItem

JMenuItem

public JMenuItem(String text)

Enabled: Creates a JMenuItem with the specified text.

Parameters:

text - the text of the JMenuItem

JMenuItem

public JMenuItem(Action a)

Enabled: Creates a menu item whose properties are taken from the specified Action.

Parameters:

a - the action of the JMenuItem

Since:

1.3

JMenuItem

public JMenuItem(String text,
                 Icon icon)

Enabled: Creates a JMenuItem with the specified text and icon.

Parameters:

text - the text of the JMenuItem

icon - the icon of the JMenuItem

JMenuItem

public JMenuItem(String text,
                 int mnemonic)

Enabled: Creates a JMenuItem with the specified text and keyboard mnemonic.

Parameters:

text - the text of the JMenuItem

mnemonic - the keyboard mnemonic for the JMenuItem

Method Detail

initFocusability

void initFocusability()

Inititalizes the focusability of the the JMenuItem. JMenuItem's are focusable, but subclasses may want to be, this provides them the opportunity to override this and invoke something else, or nothing at all. Refer to javax.swing.JMenu#initFocusability for the motivation of this.

init

protected void init(String text,
                    Icon icon)

Initializes the menu item with the specified text and icon.

Overrides:

init in class AbstractButton

Parameters:

text - the text of the JMenuItem

icon - the icon of the JMenuItem

setUI

public void setUI(javax.swing.plaf.MenuItemUI ui)

Enabled: Sets the look and feel object that renders this component.

Parameters:

ui - the JMenuItemUI L&F object

See Also:

UIDefaults.getUI(javax.swing.JComponent)

updateUI

public void updateUI()

Enabled: Resets the UI property with a value from the current look and feel.

Overrides:

updateUI in class AbstractButton

See Also:

JComponent.updateUI()

getUIClassID

public String getUIClassID()

Enabled: Returns the suffix used to construct the name of the L&F class used to render this component.

Overrides:

getUIClassID in class JComponent

Returns:

the string "MenuItemUI"

See Also:

JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

setArmed

public void setArmed(boolean b)

Enabled: 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()

Enabled: Returns whether the menu item is "armed".

Returns:

true if the menu item is armed, and it can be selected

See Also:

setArmed(boolean)

setEnabled

public void setEnabled(boolean b)

Enabled: Enables or disables the menu item.

Overrides:

setEnabled in class AbstractButton

Parameters:

b - true to enable the item

alwaysOnTop

boolean alwaysOnTop()

Returns true since Menus, by definition, should always be on top of all other windows. If the menu is in an internal frame false is returned due to the rollover effect for windows laf where the menu is not always on top.

Overrides:

alwaysOnTop in class JComponent

Returns:

always returns false

setAccelerator

public void setAccelerator(KeyStroke keyStroke)

Enabled: Sets the key combination which invokes the menu item's action listeners without navigating the menu hierarchy. It is the UI's responsibility to install the correct action. Note that when the keyboard accelerator is typed, it will work whether or not the menu is currently displayed.

Parameters:

keyStroke - the KeyStroke which will serve as an accelerator

getAccelerator

public KeyStroke getAccelerator()

Enabled: Returns the KeyStroke which serves as an accelerator for the menu item.

Returns:

a KeyStroke object identifying the accelerator key

configurePropertiesFromAction

protected void configurePropertiesFromAction(Action a)

Factory method which sets the ActionEvent source's properties according to values from the Action instance. The properties which are set may differ for subclasses. By default, this method sets the same properties as AbstractButton.configurePropertiesFromAction(), plus Accelerator.

Overrides:

configurePropertiesFromAction in class AbstractButton

Parameters:

a - the Action from which to get the properties, or null

Since:

1.3

See Also:

Action

createActionPropertyChangeListener

protected java.beans.PropertyChangeListener createActionPropertyChangeListener(Action a)

Factory method which creates the PropertyChangeListener used to update the ActionEvent source as properties change on its Action instance. Subclasses may override this in order to provide their own PropertyChangeListener if the set of properties which should be kept up to date differs.

Note that PropertyChangeListeners should avoid holding strong references to the ActionEvent source, as this may hinder garbage collection of the ActionEvent source and all components in its containment hierarchy.

Overrides:

createActionPropertyChangeListener in class AbstractButton

Parameters:

a - the Action from which to get the properties, or null

Since:

1.3

See Also:

Action

processMouseEvent

public void processMouseEvent(MouseEvent e,
                              MenuElement[] path,
                              MenuSelectionManager manager)

Suppressed: Processes a mouse event forwarded from the MenuSelectionManager and changes the menu selection, if necessary, by using the MenuSelectionManager's API.

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

Specified by:

processMouseEvent in interface MenuElement

Parameters:

e - a MouseEvent

path - the MenuElement path array

manager - the MenuSelectionManager

processKeyEvent

public void processKeyEvent(KeyEvent e,
                            MenuElement[] path,
                            MenuSelectionManager manager)

Suppressed: Processes a key event forwarded from the MenuSelectionManager and changes 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.

Specified by:

processKeyEvent in interface MenuElement

Parameters:

e - a KeyEvent

path - the MenuElement path array

manager - the MenuSelectionManager

processMenuDragMouseEvent

public void processMenuDragMouseEvent(MenuDragMouseEvent e)

Suppressed: Handles mouse drag in a menu.

Parameters:

e - a MenuDragMouseEvent object

processMenuKeyEvent

public void processMenuKeyEvent(MenuKeyEvent e)

Suppressed: Handles a keystroke in a menu.

Parameters:

e - a MenuKeyEvent object

fireMenuDragMouseEntered

protected void fireMenuDragMouseEntered(MenuDragMouseEvent event)

Notifies all listeners that have registered interest for notification on this event type.

Parameters:

event - a MenuMouseDragEvent

See Also:

EventListenerList

fireMenuDragMouseExited

protected void fireMenuDragMouseExited(MenuDragMouseEvent event)

Notifies all listeners that have registered interest for notification on this event type.

Parameters:

event - a MenuDragMouseEvent

See Also:

EventListenerList

fireMenuDragMouseDragged

protected void fireMenuDragMouseDragged(MenuDragMouseEvent event)

Notifies all listeners that have registered interest for notification on this event type.

Parameters:

event - a MenuDragMouseEvent

See Also:

EventListenerList

fireMenuDragMouseReleased

protected void fireMenuDragMouseReleased(MenuDragMouseEvent event)

Notifies all listeners that have registered interest for notification on this event type.

Parameters:

event - a MenuDragMouseEvent

See Also:

EventListenerList

fireMenuKeyPressed

protected void fireMenuKeyPressed(MenuKeyEvent event)

Notifies all listeners that have registered interest for notification on this event type.

See Also:

EventListenerList

fireMenuKeyReleased

protected void fireMenuKeyReleased(MenuKeyEvent event)

Notifies all listeners that have registered interest for notification on this event type.

See Also:

EventListenerList

fireMenuKeyTyped

protected void fireMenuKeyTyped(MenuKeyEvent event)

Notifies all listeners that have registered interest for notification on this event type.

Parameters:

event - a MenuKeyEvent

See Also:

EventListenerList

menuSelectionChanged

public void menuSelectionChanged(boolean isIncluded)

Enabled: Called by the MenuSelectionManager when the MenuElement is selected or unselected.

Specified by:

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:

MenuSelectionManager.setSelectedPath(MenuElement[])

getSubElements

public MenuElement[] getSubElements()

Enabled: This method returns an array containing the sub-menu components for this menu component.

Specified by:

getSubElements in interface MenuElement

Returns:

an array of MenuElements

getComponent

public Component getComponent()

Enabled: 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.

Specified by:

getComponent in interface MenuElement

Returns:

the Component that paints this menu item

addMenuDragMouseListener

public void addMenuDragMouseListener(MenuDragMouseListener l)

Enabled: Adds a MenuDragMouseListener to the menu item.

Parameters:

l - the MenuDragMouseListener to be added

removeMenuDragMouseListener

public void removeMenuDragMouseListener(MenuDragMouseListener l)

Enabled: Removes a MenuDragMouseListener from the menu item.

Parameters:

l - the MenuDragMouseListener to be removed

getMenuDragMouseListeners

public MenuDragMouseListener[] getMenuDragMouseListeners()

Suppressed: Returns an array of all the MenuDragMouseListeners added to this JMenuItem with addMenuDragMouseListener().

Returns:

all of the MenuDragMouseListeners added or an empty array if no listeners have been added

Since:

1.4

addMenuKeyListener

public void addMenuKeyListener(MenuKeyListener l)

Enabled: Adds a MenuKeyListener to the menu item.

Parameters:

l - the MenuKeyListener to be added

removeMenuKeyListener

public void removeMenuKeyListener(MenuKeyListener l)

Enabled: Removes a MenuKeyListener from the menu item.

Parameters:

l - the MenuKeyListener to be removed

getMenuKeyListeners

public MenuKeyListener[] getMenuKeyListeners()

Suppressed: Returns an array of all the MenuKeyListeners added to this JMenuItem with addMenuKeyListener().

Returns:

all of the MenuKeyListeners added or an empty array if no listeners have been added

Since:

1.4

readObject

private void readObject(ObjectInputStream s)
                 throws IOException,
                        ClassNotFoundException

See JComponent.readObject() for information about serialization in Swing.

Parameters:

s - the ObjectInputStream from which to read

IOException

ClassNotFoundException

See Also:

ReadObjectCallback

writeObject

private void writeObject(ObjectOutputStream s)
                  throws IOException

Description copied from class: JComponent

Before writing a JComponent to an ObjectOutputStream we temporarily uninstall its UI. This is tricky to do because we want to uninstall the UI before any of the JComponent's children (or its LayoutManager etc.) are written, and we don't want to restore the UI until the most derived JComponent subclass has been been stored.

Parameters:

s - the ObjectOutputStream in which to write

IOException

paramString

protected String paramString()

Returns a string representation of this JMenuItem. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overrides:

paramString in class AbstractButton

Returns:

a string representation of this JMenuItem

getAccessibleContext

public AccessibleContext getAccessibleContext()

Suppressed: Returns the AccessibleContext associated with this JMenuItem. For JMenuItems, the AccessibleContext takes the form of an AccessibleJMenuItem. A new AccessibleJMenuItme instance is created if necessary.

Specified by:

getAccessibleContext in interface Accessible

Overrides:

getAccessibleContext in class JComponent

Returns:

an AccessibleJMenuItem that serves as the AccessibleContext of this JMenuItem