OpenJDK 27 · javax.swing.JMenuItem · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
protected class	JMenuItem.AccessibleJMenuItem This class implements accessibility support for the `JMenuItem` class.
private static class	JMenuItem.MenuItemFocusListener

Modifier and Type	Field and Description
private KeyStroke	accelerator
private static final boolean	DEBUG
private boolean	isMouseDragged
private static final boolean	TRACE
private static final String	uiClassID Hides javax.swing.JComponent.uiClassID.
private static final boolean	VERBOSE

Access	Constructor and Description
public	JMenuItem() Creates a `JMenuItem` with no set text or icon.
public	JMenuItem(Icon the icon of the `JMenuItem` icon) Creates a `JMenuItem` with the specified icon.
public	JMenuItem(String the text of the `JMenuItem` text) Creates a `JMenuItem` with the specified text.
public	JMenuItem(Action the action of the `JMenuItem` a) Creates a menu item whose properties are taken from the specified `Action`.
public	JMenuItem(String the text of the `JMenuItem` text, Icon the icon of the `JMenuItem` icon) Creates a `JMenuItem` with the specified text and icon.
public	JMenuItem(String the text of the `JMenuItem` text, int the keyboard mnemonic for the `JMenuItem` mnemonic) Creates a `JMenuItem` with the specified text and keyboard mnemonic.

Method Summary

Modifier and Type	Method and Description
protected void	actionPropertyChanged(Action action, String propertyName) Overrides javax.swing.AbstractButton.actionPropertyChanged. Updates the button's state in response to property changes in the associated action.
public void	addMenuDragMouseListener(MenuDragMouseListener the `MenuDragMouseListener` to be added l) Adds a `MenuDragMouseListener` to the menu item.
public void	addMenuKeyListener(MenuKeyListener the `MenuKeyListener` to be added l) Adds a `MenuKeyListener` to the menu item.
pack-priv boolean	alwaysOnTop() Overrides javax.swing.JComponent.alwaysOnTop. Returns true since `Menu`s, by definition, should always be on top of all other windows.
pack-priv void	configureAcceleratorFromAction(Action a)
protected void	configurePropertiesFromAction(Action a) Overrides javax.swing.AbstractButton.configurePropertiesFromAction. Sets the properties on this button to match those in the specified `Action`.
protected void	fireMenuDragMouseDragged(MenuDragMouseEvent a `MenuDragMouseEvent` event) Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuDragMouseEntered(MenuDragMouseEvent a `MenuMouseDragEvent` event) Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuDragMouseExited(MenuDragMouseEvent a `MenuDragMouseEvent` event) Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuDragMouseReleased(MenuDragMouseEvent a `MenuDragMouseEvent` event) Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuKeyPressed(MenuKeyEvent a `MenuKeyEvent` event) Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuKeyReleased(MenuKeyEvent a `MenuKeyEvent` event) Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuKeyTyped(MenuKeyEvent a `MenuKeyEvent` event) Notifies all listeners that have registered interest for notification on this event type.
public KeyStroke	Returns: a `KeyStroke` object identifying the accelerator key getAccelerator() Returns the `KeyStroke` which serves as an accelerator for the menu item.
public AccessibleContext	Returns: an `AccessibleJMenuItem` that serves as the `AccessibleContext` of this `JMenuItem` getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Returns the `AccessibleContext` associated with this `JMenuItem`.
public Component	Returns: the `Component` that paints this menu item getComponent() Implements javax.swing.MenuElement.getComponent. Returns the `java.awt.Component` used to paint this object.
public MenuDragMouseListener[]	Returns: all of the `MenuDragMouseListener`s added or an empty array if no listeners have been added getMenuDragMouseListeners() Returns an array of all the `MenuDragMouseListener`s added to this JMenuItem with addMenuDragMouseListener().
public MenuKeyListener[]	Returns: all of the `MenuKeyListener`s added or an empty array if no listeners have been added getMenuKeyListeners() Returns an array of all the `MenuKeyListener`s added to this JMenuItem with addMenuKeyListener().
public MenuElement[]	Returns: an array of `MenuElement`s getSubElements() Implements javax.swing.MenuElement.getSubElements. This method returns an array containing the sub-menu components for this menu component.
public String	Returns: the string "MenuItemUI" getUIClassID() Overrides javax.swing.JComponent.getUIClassID. Returns the suffix used to construct the name of the L&F class used to render this component.
protected void	init(String the text of the `JMenuItem` text, Icon the icon of the `JMenuItem` icon) Overrides javax.swing.AbstractButton.init. Initializes the menu item with the specified text and icon.
pack-priv void	initFocusability() Initializes the focusability of the `JMenuItem`.
public boolean	Returns: true if the menu item is armed, and it can be selected isArmed() Returns whether the menu item is "armed".
pack-priv void	largeIconChanged(Action a) Overrides javax.swing.AbstractButton.largeIconChanged.
public void	menuSelectionChanged(boolean 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 isIncluded) Implements javax.swing.MenuElement.menuSelectionChanged. Called by the `MenuSelectionManager` when the `MenuElement` is selected or unselected.
protected String	Returns: a string representation of this `JMenuItem` paramString() Overrides javax.swing.AbstractButton.paramString. Returns a string representation of this `JMenuItem`.
public void	processKeyEvent(KeyEvent a `KeyEvent` e, MenuElement[] the `MenuElement` path array path, MenuSelectionManager the `MenuSelectionManager` manager) Implements javax.swing.MenuElement.processKeyEvent. Processes a key event forwarded from the `MenuSelectionManager` and changes the menu selection, if necessary, by using `MenuSelectionManager`'s API.
public void	processMenuDragMouseEvent(MenuDragMouseEvent a `MenuDragMouseEvent` object e) Handles mouse drag in a menu.
public void	processMenuKeyEvent(MenuKeyEvent a `MenuKeyEvent` object e) Handles a keystroke in a menu.
public void	processMouseEvent(MouseEvent a `MouseEvent` e, MenuElement[] the `MenuElement` path array path, MenuSelectionManager the `MenuSelectionManager` manager) Implements javax.swing.MenuElement.processMouseEvent. 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) Hides javax.swing.JComponent.readObject. See JComponent.readObject() for information about serialization in Swing.
public void	removeMenuDragMouseListener(MenuDragMouseListener the `MenuDragMouseListener` to be removed l) Removes a `MenuDragMouseListener` from the menu item.
public void	removeMenuKeyListener(MenuKeyListener the `MenuKeyListener` to be removed l) Removes a `MenuKeyListener` from the menu item.
public void	setAccelerator(KeyStroke the `KeyStroke` which will serve as an accelerator keyStroke) Sets the key combination which invokes the menu item's action listeners without navigating the menu hierarchy.
public void	setArmed(boolean true to arm the menu item so it can be selected b) Identifies the menu item as "armed".
public void	setEnabled(boolean true to enable the item b) Overrides javax.swing.AbstractButton.setEnabled. Enables or disables the menu item.
pack-priv void	setIconFromAction(Action a) Overrides javax.swing.AbstractButton.setIconFromAction.
public void	setModel(ButtonModel newModel) Overrides javax.swing.AbstractButton.setModel. Sets the model that this button represents.
public void	setUI(MenuItemUI the `JMenuItemUI` L&F object ui) Sets the look and feel object that renders this component.
pack-priv void	smallIconChanged(Action a) Overrides javax.swing.AbstractButton.smallIconChanged.
public void	updateUI() Overrides javax.swing.AbstractButton.updateUI. Resets the UI property with a value from the current look and feel.
private void	writeObject(ObjectOutputStream s) Hides javax.swing.JComponent.writeObject. Before writing a `JComponent` to an `ObjectOutputStream` we temporarily uninstall its UI.

Inherited from javax.swing.AbstractButton:: addActionListener addChangeListener addImpl addItemListener checkHorizontalKey checkVerticalKey clientPropertyChanged createActionListener createActionPropertyChangeListener createActionPropertyChangeListener0 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 setUIProperty setVerticalAlignment setVerticalTextPosition shouldUpdateSelectedStateFromAction

accelerator	back to summary
private KeyStroke accelerator

DEBUG	back to summary
private static final boolean DEBUG

isMouseDragged	back to summary
private boolean isMouseDragged

TRACE	back to summary
private static final boolean TRACE

uiClassID	back to summary
private static final String uiClassID Hides javax.swing.JComponent.uiClassID. See Also `getUIClassID`, `readObject`

VERBOSE	back to summary
private static final boolean VERBOSE

JMenuItem	back to summary
public JMenuItem() Creates a `JMenuItem` with no set text or icon.

JMenuItem	back to summary
public JMenuItem(Icon icon) Creates a `JMenuItem` with the specified icon. Parameters icon:Icon the icon of the `JMenuItem`

JMenuItem	back to summary
public JMenuItem(String text) Creates a `JMenuItem` with the specified text. Parameters text:String the text of the `JMenuItem`

JMenuItem	back to summary
public JMenuItem(Action a) Creates a menu item whose properties are taken from the specified `Action`. Parameters a:Action the action of the `JMenuItem` Since 1.3

JMenuItem	back to summary
public JMenuItem(String text, Icon icon) Creates a `JMenuItem` with the specified text and icon. Parameters text:String the text of the `JMenuItem` icon:Icon the icon of the `JMenuItem`

JMenuItem	back to summary
public JMenuItem(String text, int mnemonic) Creates a `JMenuItem` with the specified text and keyboard mnemonic. Parameters text:String the text of the `JMenuItem` mnemonic:int the keyboard mnemonic for the `JMenuItem`

Method Detail

actionPropertyChanged back to summary

actionPropertyChanged	back to summary
protected void actionPropertyChanged(Action action, String propertyName) Overrides javax.swing.AbstractButton.actionPropertyChanged. Doc from javax.swing.AbstractButton.actionPropertyChanged. Updates the button's state in response to property changes in the associated action. This method is invoked from the `PropertyChangeListener` returned from `createActionPropertyChangeListener`. Subclasses do not normally need to invoke this. Subclasses that support additional `Action` properties should override this and `configurePropertiesFromAction`. Refer to the table at Swing Components Supporting `Action` for a list of the properties this method sets. Since 1.6

protected void actionPropertyChanged(Action action, String propertyName)

Overrides javax.swing.AbstractButton.actionPropertyChanged.

Doc from javax.swing.AbstractButton.actionPropertyChanged.

Updates the button's state in response to property changes in the associated action. This method is invoked from the PropertyChangeListener returned from createActionPropertyChangeListener. Subclasses do not normally need to invoke this. Subclasses that support additional Action properties should override this and configurePropertiesFromAction.

Refer to the table at Swing Components Supporting Action for a list of the properties this method sets.

Since: 1.6

addMenuDragMouseListener back to summary

addMenuDragMouseListener	back to summary
public void addMenuDragMouseListener(MenuDragMouseListener l) Adds a `MenuDragMouseListener` to the menu item. Parameters l:MenuDragMouseListener the `MenuDragMouseListener` to be added

public void addMenuDragMouseListener(MenuDragMouseListener l)

Adds a MenuDragMouseListener to the menu item.

Parameters

l:MenuDragMouseListener: the MenuDragMouseListener to be added

addMenuKeyListener back to summary

addMenuKeyListener	back to summary
public void addMenuKeyListener(MenuKeyListener l) Adds a `MenuKeyListener` to the menu item. Parameters l:MenuKeyListener the `MenuKeyListener` to be added

public void addMenuKeyListener(MenuKeyListener l)

Adds a MenuKeyListener to the menu item.

Parameters

l:MenuKeyListener: the MenuKeyListener to be added

alwaysOnTop back to summary

alwaysOnTop	back to summary
pack-priv boolean alwaysOnTop() Overrides javax.swing.JComponent.alwaysOnTop. Returns true since `Menu`s, 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.

pack-priv boolean alwaysOnTop()

Overrides javax.swing.JComponent.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.

configureAcceleratorFromAction	back to summary
pack-priv void configureAcceleratorFromAction(Action a)

configurePropertiesFromAction back to summary

configurePropertiesFromAction	back to summary
protected void configurePropertiesFromAction(Action a) Overrides javax.swing.AbstractButton.configurePropertiesFromAction. Doc from javax.swing.AbstractButton.configurePropertiesFromAction. Sets the properties on this button to match those in the specified `Action`. Refer to Swing Components Supporting `Action` for more details as to which properties this sets. Since 1.3

protected void configurePropertiesFromAction(Action a)

Overrides javax.swing.AbstractButton.configurePropertiesFromAction.

Doc from javax.swing.AbstractButton.configurePropertiesFromAction.

Sets the properties on this button to match those in the specified Action. Refer to Swing Components Supporting Action for more details as to which properties this sets.

Since: 1.3

fireMenuDragMouseDragged back to summary

fireMenuDragMouseDragged	back to summary
protected void fireMenuDragMouseDragged(MenuDragMouseEvent event) Notifies all listeners that have registered interest for notification on this event type. Parameters event:MenuDragMouseEvent a `MenuDragMouseEvent` See Also `EventListenerList`

protected void fireMenuDragMouseDragged(MenuDragMouseEvent event)

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

Parameters

event:MenuDragMouseEvent: a MenuDragMouseEvent

See Also

EventListenerList

fireMenuDragMouseEntered back to summary

fireMenuDragMouseEntered	back to summary
protected void fireMenuDragMouseEntered(MenuDragMouseEvent event) Notifies all listeners that have registered interest for notification on this event type. Parameters event:MenuDragMouseEvent a `MenuMouseDragEvent` See Also `EventListenerList`

protected void fireMenuDragMouseEntered(MenuDragMouseEvent event)

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

Parameters

event:MenuDragMouseEvent: a MenuMouseDragEvent

See Also

EventListenerList

fireMenuDragMouseExited back to summary

fireMenuDragMouseExited	back to summary
protected void fireMenuDragMouseExited(MenuDragMouseEvent event) Notifies all listeners that have registered interest for notification on this event type. Parameters event:MenuDragMouseEvent a `MenuDragMouseEvent` See Also `EventListenerList`

protected void fireMenuDragMouseExited(MenuDragMouseEvent event)

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

Parameters

event:MenuDragMouseEvent: a MenuDragMouseEvent

See Also

EventListenerList

fireMenuDragMouseReleased back to summary

fireMenuDragMouseReleased	back to summary
protected void fireMenuDragMouseReleased(MenuDragMouseEvent event) Notifies all listeners that have registered interest for notification on this event type. Parameters event:MenuDragMouseEvent a `MenuDragMouseEvent` See Also `EventListenerList`

protected void fireMenuDragMouseReleased(MenuDragMouseEvent event)

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

Parameters

event:MenuDragMouseEvent: a MenuDragMouseEvent

See Also

EventListenerList

fireMenuKeyPressed back to summary

fireMenuKeyPressed	back to summary
protected void fireMenuKeyPressed(MenuKeyEvent event) Notifies all listeners that have registered interest for notification on this event type. Parameters event:MenuKeyEvent a `MenuKeyEvent` See Also `EventListenerList`

protected void fireMenuKeyPressed(MenuKeyEvent event)

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

Parameters

event:MenuKeyEvent: a MenuKeyEvent

See Also

EventListenerList

fireMenuKeyReleased back to summary

fireMenuKeyReleased	back to summary
protected void fireMenuKeyReleased(MenuKeyEvent event) Notifies all listeners that have registered interest for notification on this event type. Parameters event:MenuKeyEvent a `MenuKeyEvent` See Also `EventListenerList`

protected void fireMenuKeyReleased(MenuKeyEvent event)

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

Parameters

event:MenuKeyEvent: a MenuKeyEvent

See Also

EventListenerList

fireMenuKeyTyped back to summary

fireMenuKeyTyped	back to summary
protected void fireMenuKeyTyped(MenuKeyEvent event) Notifies all listeners that have registered interest for notification on this event type. Parameters event:MenuKeyEvent a `MenuKeyEvent` See Also `EventListenerList`

protected void fireMenuKeyTyped(MenuKeyEvent event)

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

Parameters

event:MenuKeyEvent: a MenuKeyEvent

See Also

EventListenerList

getAccelerator back to summary

getAccelerator	back to summary
public KeyStroke getAccelerator() Returns the `KeyStroke` which serves as an accelerator for the menu item. Returns:KeyStroke a `KeyStroke` object identifying the accelerator key

public KeyStroke getAccelerator()

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

Returns:KeyStroke: a KeyStroke object identifying the accelerator key

getAccessibleContext back to summary

getAccessibleContext	back to summary
public AccessibleContext getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Returns the `AccessibleContext` associated with this `JMenuItem`. For `JMenuItem`s, the `AccessibleContext` takes the form of an `AccessibleJMenuItem`. A new `AccessibleJMenuItem` instance is created if necessary. Returns:AccessibleContext an `AccessibleJMenuItem` that serves as the `AccessibleContext` of this `JMenuItem` Annotations @BeanProperty bound:false

public AccessibleContext getAccessibleContext()

Overrides java.awt.Component.getAccessibleContext.

Implements javax.accessibility.Accessible.getAccessibleContext.

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

Returns:AccessibleContext

an AccessibleJMenuItem that serves as the AccessibleContext of this JMenuItem

Annotations

@BeanProperty
bound:false

getComponent back to summary

getComponent	back to summary
public Component getComponent() Implements javax.swing.MenuElement.getComponent. 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. Returns:Component the `Component` that paints this menu item

public Component getComponent()

Implements javax.swing.MenuElement.getComponent.

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.

Returns:Component: the Component that paints this menu item

getMenuDragMouseListeners back to summary

getMenuDragMouseListeners	back to summary
public MenuDragMouseListener[] getMenuDragMouseListeners() Returns an array of all the `MenuDragMouseListener`s added to this JMenuItem with addMenuDragMouseListener(). Returns:MenuDragMouseListener[] all of the `MenuDragMouseListener`s added or an empty array if no listeners have been added Annotations @BeanProperty bound:false Since 1.4

public MenuDragMouseListener[] getMenuDragMouseListeners()

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

Returns:MenuDragMouseListener[]

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

Annotations

@BeanProperty
bound:false

Since

1.4

getMenuKeyListeners back to summary

getMenuKeyListeners	back to summary
public MenuKeyListener[] getMenuKeyListeners() Returns an array of all the `MenuKeyListener`s added to this JMenuItem with addMenuKeyListener(). Returns:MenuKeyListener[] all of the `MenuKeyListener`s added or an empty array if no listeners have been added Annotations @BeanProperty bound:false Since 1.4

public MenuKeyListener[] getMenuKeyListeners()

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

Returns:MenuKeyListener[]

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

Annotations

@BeanProperty
bound:false

Since

1.4

getSubElements back to summary

getSubElements	back to summary
public MenuElement[] getSubElements() Implements javax.swing.MenuElement.getSubElements. This method returns an array containing the sub-menu components for this menu component. Returns:MenuElement[] an array of `MenuElement`s Annotations @BeanProperty bound:false

public MenuElement[] getSubElements()

Implements javax.swing.MenuElement.getSubElements.

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

Returns:MenuElement[]

an array of MenuElements

Annotations

@BeanProperty
bound:false

getUIClassID back to summary

getUIClassID	back to summary
public String getUIClassID() Overrides javax.swing.JComponent.getUIClassID. Returns the suffix used to construct the name of the L&F class used to render this component. Returns:String the string "MenuItemUI" Annotations @BeanProperty bound:false See Also `JComponent#getUIClassID`, `UIDefaults#getUI`

public String getUIClassID()

Overrides javax.swing.JComponent.getUIClassID.

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

Returns:String

the string "MenuItemUI"

Annotations

@BeanProperty
bound:false

init back to summary

init	back to summary
protected void init(String text, Icon icon) Overrides javax.swing.AbstractButton.init. Initializes the menu item with the specified text and icon. Parameters text:String the text of the `JMenuItem` icon:Icon the icon of the `JMenuItem`

protected void init(String text, Icon icon)

Overrides javax.swing.AbstractButton.init.

Initializes the menu item with the specified text and icon.

Parameters

text:String: the text of the JMenuItem
icon:Icon: the icon of the JMenuItem

initFocusability	back to summary
pack-priv void initFocusability() Initializes the focusability of the `JMenuItem`. `JMenuItem`'s are non-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.

isArmed back to summary

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

public boolean isArmed()

Returns whether the menu item is "armed".

Returns:boolean: true if the menu item is armed, and it can be selected
See Also: setArmed

largeIconChanged	back to summary
pack-priv void largeIconChanged(Action a) Overrides javax.swing.AbstractButton.largeIconChanged.

menuSelectionChanged back to summary

menuSelectionChanged	back to summary
public void menuSelectionChanged(boolean isIncluded) Implements javax.swing.MenuElement.menuSelectionChanged. Called by the `MenuSelectionManager` when the `MenuElement` is selected or unselected. Parameters isIncluded:boolean 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[])`

public void menuSelectionChanged(boolean isIncluded)

Implements javax.swing.MenuElement.menuSelectionChanged.

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

Parameters

isIncluded:boolean: 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

paramString back to summary

paramString	back to summary
protected String paramString() Overrides javax.swing.AbstractButton.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`. Returns:String a string representation of this `JMenuItem`

protected String paramString()

Overrides javax.swing.AbstractButton.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.

Returns:String: a string representation of this JMenuItem

processKeyEvent back to summary

processKeyEvent	back to summary
public void processKeyEvent(KeyEvent e, MenuElement[] path, MenuSelectionManager manager) Implements javax.swing.MenuElement.processKeyEvent. 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`. Parameters e:KeyEvent a `KeyEvent` path:MenuElement[] the `MenuElement` path array manager:MenuSelectionManager the `MenuSelectionManager` Annotations @SuppressWarnings:deprecation

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

Implements javax.swing.MenuElement.processKeyEvent.

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.

Parameters

e:KeyEvent: a KeyEvent
path:MenuElement[]: the MenuElement path array
manager:MenuSelectionManager: the MenuSelectionManager

Annotations

@SuppressWarnings:deprecation

processMenuDragMouseEvent back to summary

processMenuDragMouseEvent	back to summary
public void processMenuDragMouseEvent(MenuDragMouseEvent e) Handles mouse drag in a menu. Parameters e:MenuDragMouseEvent a `MenuDragMouseEvent` object

public void processMenuDragMouseEvent(MenuDragMouseEvent e)

Handles mouse drag in a menu.

Parameters

e:MenuDragMouseEvent: a MenuDragMouseEvent object

processMenuKeyEvent back to summary

processMenuKeyEvent	back to summary
public void processMenuKeyEvent(MenuKeyEvent e) Handles a keystroke in a menu. Parameters e:MenuKeyEvent a `MenuKeyEvent` object

public void processMenuKeyEvent(MenuKeyEvent e)

Handles a keystroke in a menu.

Parameters

e:MenuKeyEvent: a MenuKeyEvent object

processMouseEvent back to summary

processMouseEvent	back to summary
public void processMouseEvent(MouseEvent e, MenuElement[] path, MenuSelectionManager manager) Implements javax.swing.MenuElement.processMouseEvent. 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`. Parameters e:MouseEvent a `MouseEvent` path:MenuElement[] the `MenuElement` path array manager:MenuSelectionManager the `MenuSelectionManager` Annotations @SuppressWarnings:deprecation

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

Implements javax.swing.MenuElement.processMouseEvent.

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.

Parameters

e:MouseEvent: a MouseEvent
path:MenuElement[]: the MenuElement path array
manager:MenuSelectionManager: the MenuSelectionManager

Annotations

@SuppressWarnings:deprecation

readObject	back to summary
private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException Hides javax.swing.JComponent.readObject. See JComponent.readObject() for information about serialization in Swing. Annotations @Serial Exceptions IOException: Doc from java.awt.Container.readObject. if an I/O error occurs ClassNotFoundException: Doc from java.awt.Container.readObject. if the class of a serialized object could not be found

readObject

back to summary

private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException

Hides javax.swing.JComponent.readObject.

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

Annotations

@Serial

Exceptions

IOException:

Doc from java.awt.Container.readObject.

if an I/O error occurs

ClassNotFoundException:

Doc from java.awt.Container.readObject.

if the class of a serialized object could not be found

removeMenuDragMouseListener back to summary

removeMenuDragMouseListener	back to summary
public void removeMenuDragMouseListener(MenuDragMouseListener l) Removes a `MenuDragMouseListener` from the menu item. Parameters l:MenuDragMouseListener the `MenuDragMouseListener` to be removed

public void removeMenuDragMouseListener(MenuDragMouseListener l)

Removes a MenuDragMouseListener from the menu item.

Parameters

l:MenuDragMouseListener: the MenuDragMouseListener to be removed

removeMenuKeyListener back to summary

removeMenuKeyListener	back to summary
public void removeMenuKeyListener(MenuKeyListener l) Removes a `MenuKeyListener` from the menu item. Parameters l:MenuKeyListener the `MenuKeyListener` to be removed

public void removeMenuKeyListener(MenuKeyListener l)

Removes a MenuKeyListener from the menu item.

Parameters

l:MenuKeyListener: the MenuKeyListener to be removed

setAccelerator back to summary

setAccelerator	back to summary
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:KeyStroke the `KeyStroke` which will serve as an accelerator Annotations @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:KeyStroke: the KeyStroke which will serve as an accelerator

Annotations

@BeanProperty
preferred:true
description:The keystroke combination which will invoke the JMenuItem\'s actionlisteners without navigating the menu hierarchy

setArmed

back to summary

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:boolean: true to arm the menu item so it can be selected

Annotations

@BeanProperty
bound:false
hidden:true
description:Mouse release will fire an action event

setEnabled

back to summary

public void setEnabled(boolean b)

Overrides javax.swing.AbstractButton.setEnabled.

Enables or disables the menu item.

Parameters

b:boolean: true to enable the item

Annotations

@BeanProperty
preferred:true
description:The enabled state of the component.

setIconFromAction	back to summary
pack-priv void setIconFromAction(Action a) Overrides javax.swing.AbstractButton.setIconFromAction.

setModel

back to summary

public void setModel(ButtonModel newModel)

Overrides javax.swing.AbstractButton.setModel.

Doc from javax.swing.AbstractButton.setModel.

Sets the model that this button represents.

setUI back to summary

public void setUI(MenuItemUI ui)

Sets the look and feel object that renders this component.

Parameters

ui:MenuItemUI: the JMenuItemUI L&F object

Annotations

@BeanProperty
hidden:true
visualUpdate:true
description:The UI object that implements the LookAndFeel.

See Also

UIDefaults#getUI

smallIconChanged	back to summary
pack-priv void smallIconChanged(Action a) Overrides javax.swing.AbstractButton.smallIconChanged.

updateUI back to summary

public void updateUI()

Overrides javax.swing.AbstractButton.updateUI.

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

See Also: JComponent#updateUI

writeObject back to summary

private void writeObject(ObjectOutputStream s) throws IOException

Hides javax.swing.JComponent.writeObject.

Doc from javax.swing.JComponent.writeObject.

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 stored.

Annotations

@Serial

Exceptions

IOException:

Doc from java.awt.Container.writeObject.

if an I/O error occurs

public Class JMenuItem

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class JMenuItem.AccessibleJMenuItem

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class JMenuItem.MenuItemFocusListener

Constructor Summary

Method Summary

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private boolean	hasFocus
private boolean	isArmed
private boolean	isPressed
private boolean	isSelected

Modifier and Type	Method and Description
private void	fireAccessibilityFocusedEvent(JMenuItem toCheck)
public AccessibleRole	Returns: an instance of AccessibleRole describing the role of the object getAccessibleRole() Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleRole. Get the role of this object.
public void	stateChanged(ChangeEvent e) Implements javax.swing.event.ChangeListener.stateChanged. Supports the change listener interface and fires property changes.

Modifier and Type	Method and Description
public void	focusGained(FocusEvent event) Implements java.awt.event.FocusListener.focusGained. Invoked when a component gains the keyboard focus.
public void	focusLost(FocusEvent event) Implements java.awt.event.FocusListener.focusLost. Invoked when a component loses the keyboard focus.