- All Implemented Interfaces:
ImageObserver
,ItemSelectable
,MenuContainer
,Serializable
,Accessible
,MenuElement
,SwingConstants
- Direct Known Subclasses:
JCheckBoxMenuItem
,JMenu
,JRadioButtonMenuItem
JMenuItem
contained in a JPopupMenu
performs exactly that function.
Menu items can be configured, and to some degree controlled, by
Action
s. Using an
Action
with a menu item has many benefits beyond directly
configuring a menu item. Refer to
Swing Components Supporting Action
for more
details, and you can find more information in How
to Use Actions, a section in The Java Tutorial.
For further documentation and for examples, see How to Use Menus in The Java Tutorial.
Warning: Swing is not thread safe. For more information see Swing's Threading Policy.
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
has been added to the java.beans
package.
Please see XMLEncoder
.
- Since:
- 1.2
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected class
This class implements accessibility support for theJMenuItem
class.Nested classes/interfaces declared in class javax.swing.AbstractButton
AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener
Nested classes/interfaces declared in class javax.swing.JComponent
JComponent.AccessibleJComponent
Nested classes/interfaces declared in class java.awt.Container
Container.AccessibleAWTContainer
Nested classes/interfaces declared in class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
Field Summary
Fields declared in 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 declared in class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Fields declared in class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Fields declared in interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Fields declared in 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
ConstructorDescriptionCreates aJMenuItem
with no set text or icon.Creates aJMenuItem
with the specified text.Creates aJMenuItem
with the specified text and keyboard mnemonic.Creates aJMenuItem
with the specified text and icon.Creates a menu item whose properties are taken from the specifiedAction
.Creates aJMenuItem
with the specified icon. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
actionPropertyChanged
(Action action, String propertyName) Updates the button's state in response to property changes in the associated action.void
Adds aMenuDragMouseListener
to the menu item.void
Adds aMenuKeyListener
to the menu item.protected void
Sets the properties on this button to match those in the specifiedAction
.protected void
Notifies all listeners that have registered interest for notification on this event type.protected void
Notifies all listeners that have registered interest for notification on this event type.protected void
Notifies all listeners that have registered interest for notification on this event type.protected void
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.Returns theKeyStroke
which serves as an accelerator for the menu item.Returns theAccessibleContext
associated with thisJMenuItem
.Returns thejava.awt.Component
used to paint this object.Returns an array of all theMenuDragMouseListener
s added to this JMenuItem with addMenuDragMouseListener().Returns an array of all theMenuKeyListener
s added to this JMenuItem with addMenuKeyListener().This method returns an array containing the sub-menu components for this menu component.Returns the suffix used to construct the name of the L&F class used to render this component.protected void
Initializes the menu item with the specified text and icon.boolean
isArmed()
Returns whether the menu item is "armed".void
menuSelectionChanged
(boolean isIncluded) Called by theMenuSelectionManager
when theMenuElement
is selected or unselected.protected String
Returns a string representation of thisJMenuItem
.void
processKeyEvent
(KeyEvent e, MenuElement[] path, MenuSelectionManager manager) Processes a key event forwarded from theMenuSelectionManager
and changes the menu selection, if necessary, by usingMenuSelectionManager
's API.void
Handles mouse drag in a menu.void
Handles a keystroke in a menu.void
processMouseEvent
(MouseEvent e, MenuElement[] path, MenuSelectionManager manager) Processes a mouse event forwarded from theMenuSelectionManager
and changes the menu selection, if necessary, by using theMenuSelectionManager
's API.void
Removes aMenuDragMouseListener
from the menu item.void
Removes aMenuKeyListener
from the menu item.void
setAccelerator
(KeyStroke keyStroke) Sets the key combination which invokes the menu item's action listeners without navigating the menu hierarchy.void
setArmed
(boolean b) Identifies the menu item as "armed".void
setEnabled
(boolean b) Enables or disables the menu item.void
setModel
(ButtonModel newModel) Sets the model that this button represents.void
setUI
(MenuItemUI ui) Sets the look and feel object that renders this component.void
updateUI()
Resets the UI property with a value from the current look and feel.Methods declared in class javax.swing.AbstractButton
addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, 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, removeNotify, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition
Methods declared in class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
Methods declared in class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTree
Methods declared in 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Constructor Details
-
JMenuItem
public JMenuItem()Creates aJMenuItem
with no set text or icon. -
JMenuItem
Creates aJMenuItem
with the specified icon.- Parameters:
icon
- the icon of theJMenuItem
-
JMenuItem
Creates aJMenuItem
with the specified text.- Parameters:
text
- the text of theJMenuItem
-
JMenuItem
Creates a menu item whose properties are taken from the specifiedAction
.- Parameters:
a
- the action of theJMenuItem
- Since:
- 1.3
-
JMenuItem
-
JMenuItem
Creates aJMenuItem
with the specified text and keyboard mnemonic.- Parameters:
text
- the text of theJMenuItem
mnemonic
- the keyboard mnemonic for theJMenuItem
-
-
Method Details
-
setModel
Sets the model that this button represents.- Overrides:
setModel
in classAbstractButton
- Parameters:
newModel
- the newButtonModel
- See Also:
-
init
Initializes the menu item with the specified text and icon.- Overrides:
init
in classAbstractButton
- Parameters:
text
- the text of theJMenuItem
icon
- the icon of theJMenuItem
-
setUI
@BeanProperty(hidden=true, visualUpdate=true, description="The UI object that implements the LookAndFeel.") public void setUI(MenuItemUI ui) Sets the look and feel object that renders this component.- Parameters:
ui
- theJMenuItemUI
L&F object- See Also:
-
updateUI
public void updateUI()Resets the UI property with a value from the current look and feel.- Overrides:
updateUI
in classAbstractButton
- See Also:
-
getUIClassID
Returns the suffix used to construct the name of the L&F class used to render this component.- Overrides:
getUIClassID
in classJComponent
- Returns:
- the string "MenuItemUI"
- See Also:
-
setArmed
@BeanProperty(bound=false, hidden=true, description="Mouse release will fire an action event") 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:
-
setEnabled
@BeanProperty(preferred=true, description="The enabled state of the component.") public void setEnabled(boolean b) Enables or disables the menu item.- Overrides:
setEnabled
in classAbstractButton
- Parameters:
b
- true to enable the item- See Also:
-
setAccelerator
@BeanProperty(preferred=true, description="The keystroke combination which will invoke the JMenuItem\'s actionlisteners without navigating the menu hierarchy") public void setAccelerator(KeyStroke keyStroke) 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
- theKeyStroke
which will serve as an accelerator
-
getAccelerator
Returns theKeyStroke
which serves as an accelerator for the menu item.- Returns:
- a
KeyStroke
object identifying the accelerator key
-
configurePropertiesFromAction
Sets the properties on this button to match those in the specifiedAction
. Refer to Swing Components SupportingAction
for more details as to which properties this sets.- Overrides:
configurePropertiesFromAction
in classAbstractButton
- Parameters:
a
- theAction
from which to get the properties, ornull
- Since:
- 1.3
- See Also:
-
actionPropertyChanged
Updates the button's state in response to property changes in the associated action. This method is invoked from thePropertyChangeListener
returned fromcreateActionPropertyChangeListener
. Subclasses do not normally need to invoke this. Subclasses that support additionalAction
properties should override this andconfigurePropertiesFromAction
.Refer to the table at Swing Components Supporting
Action
for a list of the properties this method sets.- Overrides:
actionPropertyChanged
in classAbstractButton
- Parameters:
action
- theAction
associated with this buttonpropertyName
- the name of the property that changed- Since:
- 1.6
- See Also:
-
processMouseEvent
Processes a mouse event forwarded from theMenuSelectionManager
and changes the menu selection, if necessary, by using theMenuSelectionManager
'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 interfaceMenuElement
- Parameters:
e
- aMouseEvent
path
- theMenuElement
path arraymanager
- theMenuSelectionManager
-
processKeyEvent
Processes a key event forwarded from theMenuSelectionManager
and changes the menu selection, if necessary, by usingMenuSelectionManager
'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 interfaceMenuElement
- Parameters:
e
- aKeyEvent
path
- theMenuElement
path arraymanager
- theMenuSelectionManager
-
processMenuDragMouseEvent
Handles mouse drag in a menu.- Parameters:
e
- aMenuDragMouseEvent
object
-
processMenuKeyEvent
Handles a keystroke in a menu.- Parameters:
e
- aMenuKeyEvent
object
-
fireMenuDragMouseEntered
Notifies all listeners that have registered interest for notification on this event type.- Parameters:
event
- aMenuMouseDragEvent
- See Also:
-
fireMenuDragMouseExited
Notifies all listeners that have registered interest for notification on this event type.- Parameters:
event
- aMenuDragMouseEvent
- See Also:
-
fireMenuDragMouseDragged
Notifies all listeners that have registered interest for notification on this event type.- Parameters:
event
- aMenuDragMouseEvent
- See Also:
-
fireMenuDragMouseReleased
Notifies all listeners that have registered interest for notification on this event type.- Parameters:
event
- aMenuDragMouseEvent
- See Also:
-
fireMenuKeyPressed
Notifies all listeners that have registered interest for notification on this event type.- Parameters:
event
- aMenuKeyEvent
- See Also:
-
fireMenuKeyReleased
Notifies all listeners that have registered interest for notification on this event type.- Parameters:
event
- aMenuKeyEvent
- See Also:
-
fireMenuKeyTyped
Notifies all listeners that have registered interest for notification on this event type.- Parameters:
event
- aMenuKeyEvent
- See Also:
-
getSubElements
This method returns an array containing the sub-menu components for this menu component.- Specified by:
getSubElements
in interfaceMenuElement
- Returns:
- an array of
MenuElement
s
-
getComponent
Returns thejava.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 interfaceMenuElement
- Returns:
- the
Component
that paints this menu item
-
addMenuDragMouseListener
Adds aMenuDragMouseListener
to the menu item.- Parameters:
l
- theMenuDragMouseListener
to be added
-
removeMenuDragMouseListener
Removes aMenuDragMouseListener
from the menu item.- Parameters:
l
- theMenuDragMouseListener
to be removed
-
getMenuDragMouseListeners
Returns an array of all theMenuDragMouseListener
s added to this JMenuItem with addMenuDragMouseListener().- Returns:
- all of the
MenuDragMouseListener
s added or an empty array if no listeners have been added - Since:
- 1.4
-
addMenuKeyListener
Adds aMenuKeyListener
to the menu item.- Parameters:
l
- theMenuKeyListener
to be added
-
removeMenuKeyListener
Removes aMenuKeyListener
from the menu item.- Parameters:
l
- theMenuKeyListener
to be removed
-
getMenuKeyListeners
Returns an array of all theMenuKeyListener
s added to this JMenuItem with addMenuKeyListener().- Returns:
- all of the
MenuKeyListener
s added or an empty array if no listeners have been added - Since:
- 1.4
-
paramString
Returns a string representation of thisJMenuItem
. 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 benull
.- Overrides:
paramString
in classAbstractButton
- Returns:
- a string representation of this
JMenuItem
-
getAccessibleContext
Returns theAccessibleContext
associated with thisJMenuItem
. ForJMenuItem
s, theAccessibleContext
takes the form of anAccessibleJMenuItem
. A newAccessibleJMenuItem
instance is created if necessary.- Specified by:
getAccessibleContext
in interfaceAccessible
- Overrides:
getAccessibleContext
in classComponent
- Returns:
- an
AccessibleJMenuItem
that serves as theAccessibleContext
of thisJMenuItem
-