- 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
Actions. 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
Nested ClassesModifier and TypeClassDescriptionprotected classThis class implements accessibility support for theJMenuItemclass.Nested classes/interfaces declared in class javax.swing.AbstractButton
AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListenerNested classes/interfaces declared in class javax.swing.JComponent
JComponent.AccessibleJComponentNested classes/interfaces declared in class java.awt.Container
Container.AccessibleAWTContainerNested 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_PROPERTYFields declared in class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields declared in class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields declared in interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTHFields 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
ConstructorsConstructorDescriptionCreates aJMenuItemwith no set text or icon.Creates aJMenuItemwith the specified text.Creates aJMenuItemwith the specified text and keyboard mnemonic.Creates aJMenuItemwith the specified text and icon.Creates a menu item whose properties are taken from the specifiedAction.Creates aJMenuItemwith the specified icon. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidactionPropertyChanged(Action action, String propertyName) Updates the button's state in response to property changes in the associated action.voidAdds aMenuDragMouseListenerto the menu item.voidAdds aMenuKeyListenerto the menu item.protected voidSets the properties on this button to match those in the specifiedAction.protected voidNotifies all listeners that have registered interest for notification on this event type.protected voidNotifies all listeners that have registered interest for notification on this event type.protected voidNotifies all listeners that have registered interest for notification on this event type.protected voidNotifies all listeners that have registered interest for notification on this event type.protected voidfireMenuKeyPressed(MenuKeyEvent event) Notifies all listeners that have registered interest for notification on this event type.protected voidfireMenuKeyReleased(MenuKeyEvent event) Notifies all listeners that have registered interest for notification on this event type.protected voidfireMenuKeyTyped(MenuKeyEvent event) Notifies all listeners that have registered interest for notification on this event type.Returns theKeyStrokewhich serves as an accelerator for the menu item.Returns theAccessibleContextassociated with thisJMenuItem.Returns thejava.awt.Componentused to paint this object.Returns an array of all theMenuDragMouseListeners added to this JMenuItem with addMenuDragMouseListener().Returns an array of all theMenuKeyListeners 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 voidInitializes the menu item with the specified text and icon.booleanisArmed()Returns whether the menu item is "armed".voidmenuSelectionChanged(boolean isIncluded) Called by theMenuSelectionManagerwhen theMenuElementis selected or unselected.protected StringReturns a string representation of thisJMenuItem.voidprocessKeyEvent(KeyEvent e, MenuElement[] path, MenuSelectionManager manager) Processes a key event forwarded from theMenuSelectionManagerand changes the menu selection, if necessary, by usingMenuSelectionManager's API.voidHandles mouse drag in a menu.voidHandles a keystroke in a menu.voidprocessMouseEvent(MouseEvent e, MenuElement[] path, MenuSelectionManager manager) Processes a mouse event forwarded from theMenuSelectionManagerand changes the menu selection, if necessary, by using theMenuSelectionManager's API.voidRemoves aMenuDragMouseListenerfrom the menu item.voidRemoves aMenuKeyListenerfrom the menu item.voidsetAccelerator(KeyStroke keyStroke) Sets the key combination which invokes the menu item's action listeners without navigating the menu hierarchy.voidsetArmed(boolean b) Identifies the menu item as "armed".voidsetEnabled(boolean b) Enables or disables the menu item.voidsetModel(ButtonModel newModel) Sets the model that this button represents.voidsetUI(MenuItemUI ui) Sets the look and feel object that renders this component.voidupdateUI()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, setVerticalTextPositionMethods 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, updateMethods 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, validateTreeMethods 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 aJMenuItemwith no set text or icon. -
JMenuItem
Creates aJMenuItemwith the specified icon.- Parameters:
icon- the icon of theJMenuItem
-
JMenuItem
Creates aJMenuItemwith 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 aJMenuItemwith the specified text and keyboard mnemonic.- Parameters:
text- the text of theJMenuItemmnemonic- the keyboard mnemonic for theJMenuItem
-
-
Method Details
-
setModel
Sets the model that this button represents.- Overrides:
setModelin classAbstractButton- Parameters:
newModel- the newButtonModel- See Also:
-
init
Initializes the menu item with the specified text and icon.- Overrides:
initin classAbstractButton- Parameters:
text- the text of theJMenuItemicon- 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- theJMenuItemUIL&F object- See Also:
-
updateUI
public void updateUI()Resets the UI property with a value from the current look and feel.- Overrides:
updateUIin classAbstractButton- See Also:
-
getUIClassID
Returns the suffix used to construct the name of the L&F class used to render this component.- Overrides:
getUIClassIDin 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:
setEnabledin 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- theKeyStrokewhich will serve as an accelerator
-
getAccelerator
Returns theKeyStrokewhich serves as an accelerator for the menu item.- Returns:
- a
KeyStrokeobject identifying the accelerator key
-
configurePropertiesFromAction
Sets the properties on this button to match those in the specifiedAction. Refer to Swing Components SupportingActionfor more details as to which properties this sets.- Overrides:
configurePropertiesFromActionin classAbstractButton- Parameters:
a- theActionfrom 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 thePropertyChangeListenerreturned fromcreateActionPropertyChangeListener. Subclasses do not normally need to invoke this. Subclasses that support additionalActionproperties should override this andconfigurePropertiesFromAction.Refer to the table at Swing Components Supporting
Actionfor a list of the properties this method sets.- Overrides:
actionPropertyChangedin classAbstractButton- Parameters:
action- theActionassociated with this buttonpropertyName- the name of the property that changed- Since:
- 1.6
- See Also:
-
processMouseEvent
Processes a mouse event forwarded from theMenuSelectionManagerand 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:
processMouseEventin interfaceMenuElement- Parameters:
e- aMouseEventpath- theMenuElementpath arraymanager- theMenuSelectionManager
-
processKeyEvent
Processes a key event forwarded from theMenuSelectionManagerand 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:
processKeyEventin interfaceMenuElement- Parameters:
e- aKeyEventpath- theMenuElementpath arraymanager- theMenuSelectionManager
-
processMenuDragMouseEvent
Handles mouse drag in a menu.- Parameters:
e- aMenuDragMouseEventobject
-
processMenuKeyEvent
Handles a keystroke in a menu.- Parameters:
e- aMenuKeyEventobject
-
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:
getSubElementsin interfaceMenuElement- Returns:
- an array of
MenuElements
-
getComponent
Returns thejava.awt.Componentused 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:
getComponentin interfaceMenuElement- Returns:
- the
Componentthat paints this menu item
-
addMenuDragMouseListener
Adds aMenuDragMouseListenerto the menu item.- Parameters:
l- theMenuDragMouseListenerto be added
-
removeMenuDragMouseListener
Removes aMenuDragMouseListenerfrom the menu item.- Parameters:
l- theMenuDragMouseListenerto be removed
-
getMenuDragMouseListeners
Returns an array of all theMenuDragMouseListeners 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
Adds aMenuKeyListenerto the menu item.- Parameters:
l- theMenuKeyListenerto be added
-
removeMenuKeyListener
Removes aMenuKeyListenerfrom the menu item.- Parameters:
l- theMenuKeyListenerto be removed
-
getMenuKeyListeners
Returns an array of all theMenuKeyListeners 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
-
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:
paramStringin classAbstractButton- Returns:
- a string representation of this
JMenuItem
-
getAccessibleContext
Returns theAccessibleContextassociated with thisJMenuItem. ForJMenuItems, theAccessibleContexttakes the form of anAccessibleJMenuItem. A newAccessibleJMenuIteminstance is created if necessary.- Specified by:
getAccessibleContextin interfaceAccessible- Overrides:
getAccessibleContextin classComponent- Returns:
- an
AccessibleJMenuItemthat serves as theAccessibleContextof thisJMenuItem
-