|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object![]()
![]()
![]()
java.awt.Component
![]()
![]()
![]()
java.awt.Container
![]()
![]()
![]()
javax.swing.JComponent
![]()
![]()
![]()
javax.swing.AbstractButton
![]()
![]()
![]()
javax.swing.JMenuItem
, ItemSelectable
, MenuContainer
, Serializable
, Accessible
, MenuElement
, SwingConstants

, JMenu
, JRadioButtonMenuItem

public class JMenuItem

, MenuElement

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.
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 JavaBeansTM
has been added to the java.beans package.
Please see XMLEncoder
.
JPopupMenu
,
JMenu
,
JCheckBoxMenuItem
,
JRadioButtonMenuItem
,
Serialized Form| Nested Class Summary | |
|---|---|
protected class |
JMenuItem.AccessibleJMenuItem
This class implements accessibility support for the JMenuItem class. |
Nested classes/interfaces inherited from class javax.swing.AbstractButton ![]() |
|---|
AbstractButton.AccessibleAbstractButton |
Nested classes/interfaces inherited from class javax.swing.JComponent ![]() |
|---|
JComponent.AccessibleJComponent |
Nested classes/interfaces inherited from class java.awt.Container ![]() |
|---|
Container.AccessibleAWTContainer |
Nested classes/interfaces inherited from class java.awt.Component ![]() |
|---|
Component.AccessibleAWTComponent |
| Field Summary |
|---|
Fields inherited from class javax.swing.JComponent ![]() |
|---|
accessibleContext |
Fields inherited from class java.awt.Component ![]() |
|---|
BOTTOM_ALIGNMENT |
Fields inherited from interface javax.swing.SwingConstants ![]() |
|---|
BOTTOM |
Fields inherited from interface java.awt.image.ImageObserver ![]() |
|---|
ABORT |
| Constructor Summary | |
|---|---|
JMenuItem
Creates a JMenuItem with no set text or icon. |
|
JMenuItem
Creates a menu item whose properties are taken from the specified Action. |
|
JMenuItem
Creates a JMenuItem with the specified icon. |
|
JMenuItem
Creates a JMenuItem with the specified text. |
|
JMenuItem
Creates a JMenuItem with the specified text and icon. |
|
JMenuItem
Creates a JMenuItem with the specified text and
keyboard mnemonic. |
|
| Method Summary | |
|---|---|
void |
addMenuDragMouseListener
Adds a MenuDragMouseListener to the menu item. |
void |
addMenuKeyListener
Adds a MenuKeyListener to the menu item. |
protected void |
configurePropertiesFromAction
Factory method which sets the ActionEvent source's
properties according to values from the Action instance. |
protected PropertyChangeListener |
createActionPropertyChangeListener
Factory method which creates the PropertyChangeListener
used to update the ActionEvent source as properties
change on its Action instance. |
protected void |
fireMenuDragMouseDragged
Notifies all listeners that have registered interest for notification on this event type. |
protected void |
fireMenuDragMouseEntered
Notifies all listeners that have registered interest for notification on this event type. |
protected void |
fireMenuDragMouseExited
Notifies all listeners that have registered interest for notification on this event type. |
protected void |
fireMenuDragMouseReleased
Notifies all listeners that have registered interest for notification on this event type. |
protected void |
fireMenuKeyPressed
Notifies all listeners that have registered interest for notification on this event type. |
protected void |
fireMenuKeyReleased
Notifies all listeners that have registered interest for notification on this event type. |
protected void |
fireMenuKeyTyped
Notifies all listeners that have registered interest for notification on this event type. |
KeyStroke |
getAccelerator
Returns the KeyStroke which serves as an accelerator
for the menu item. |
AccessibleContext |
getAccessibleContext
Returns the AccessibleContext associated with this
JMenuItem. |
Component |
getComponent
Returns the java.awt.Component used to paint
this object. |
MenuDragMouseListener |
getMenuDragMouseListeners
Returns an array of all the MenuDragMouseListeners added
to this JMenuItem with addMenuDragMouseListener(). |
MenuKeyListener |
getMenuKeyListeners
Returns an array of all the MenuKeyListeners added
to this JMenuItem with addMenuKeyListener(). |
MenuElement |
getSubElements
This method returns an array containing the sub-menu components for this menu component. |
String |
getUIClassID
Returns the suffix used to construct the name of the L&F class used to render this component. |
protected void |
init
Initializes the menu item with the specified text and icon. |
boolean |
isArmed
Returns whether the menu item is "armed". |
void |
menuSelectionChanged
Called by the MenuSelectionManager when the
MenuElement is selected or unselected. |
protected String |
paramString
Returns a string representation of this JMenuItem. |
void |
processKeyEvent
Processes a key event forwarded from the MenuSelectionManager and changes the menu selection,
if necessary, by using MenuSelectionManager's API. |
void |
processMenuDragMouseEvent
Handles mouse drag in a menu. |
void |
processMenuKeyEvent
Handles a keystroke in a menu. |
void |
processMouseEvent
Processes a mouse event forwarded from the MenuSelectionManager and changes the menu
selection, if necessary, by using the
MenuSelectionManager's API. |
void |
removeMenuDragMouseListener
Removes a MenuDragMouseListener from the menu item. |
void |
removeMenuKeyListener
Removes a MenuKeyListener from the menu item. |
void |
setAccelerator
Sets the key combination which invokes the menu item's action listeners without navigating the menu hierarchy. |
void |
setArmed
Identifies the menu item as "armed". |
void |
setEnabled
Enables or disables the menu item. |
void |
setUI
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 inherited from class java.lang.Object ![]() |
|---|
clone |
| Constructor Detail |
|---|

public JMenuItem()
JMenuItem with no set text or icon.

public JMenuItem(Icon![]()
![]()
icon)
JMenuItem with the specified icon.
icon - the icon of the JMenuItem

public JMenuItem(String![]()
![]()
text)
JMenuItem with the specified text.
text - the text of the JMenuItem

public JMenuItem(Action![]()
![]()
a)
Action.
a - the action of the JMenuItem

public JMenuItem(String![]()
![]()
text, Icon
![]()
![]()
icon)
JMenuItem with the specified text and icon.
text - the text of the JMenuItemicon - the icon of the JMenuItem

public JMenuItem(String![]()
![]()
text, int mnemonic)
JMenuItem with the specified text and
keyboard mnemonic.
text - the text of the JMenuItemmnemonic - the keyboard mnemonic for the JMenuItem| Method Detail |
|---|

protected void init(String![]()
![]()
text, Icon
![]()
![]()
icon)
init

in class AbstractButton

text - the text of the JMenuItemicon - the icon of the JMenuItem

public void setUI(MenuItemUI![]()
![]()
ui)
ui - the JMenuItemUI L&F objectUIDefaults.getUI(javax.swing.JComponent)


public void updateUI()
updateUI

in class AbstractButton

JComponent.updateUI()


public String![]()
![]()
getUIClassID()
getUIClassID

in class JComponent

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


public void setArmed(boolean b)
b - true to arm the menu item so it can be selected

public boolean isArmed()
setArmed(boolean)


public void setEnabled(boolean b)
setEnabled

in class AbstractButton

b - true to enable the itemComponent.isEnabled()
,
Component.isLightweight()


public void setAccelerator(KeyStroke![]()
![]()
keyStroke)
keyStroke - the KeyStroke which will
serve as an accelerator

public KeyStroke![]()
![]()
getAccelerator()
KeyStroke which serves as an accelerator
for the menu item.
KeyStroke object identifying the
accelerator key

protected void configurePropertiesFromAction(Action![]()
![]()
a)
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.
configurePropertiesFromAction

in class AbstractButton

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


protected PropertyChangeListener![]()
![]()
createActionPropertyChangeListener(Action
![]()
![]()
a)
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.
createActionPropertyChangeListener

in class AbstractButton

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


public void processMouseEvent(MouseEvent![]()
![]()
e, MenuElement
![]()
![]()
[] path, MenuSelectionManager
![]()
![]()
manager)
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.
processMouseEvent

in interface MenuElement

e - a MouseEventpath - the MenuElement path arraymanager - the MenuSelectionManager

public void processKeyEvent(KeyEvent![]()
![]()
e, MenuElement
![]()
![]()
[] path, MenuSelectionManager
![]()
![]()
manager)
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.
processKeyEvent

in interface MenuElement

e - a KeyEventpath - the MenuElement path arraymanager - the MenuSelectionManager

public void processMenuDragMouseEvent(MenuDragMouseEvent![]()
![]()
e)
e - a MenuDragMouseEvent object

public void processMenuKeyEvent(MenuKeyEvent![]()
![]()
e)
e - a MenuKeyEvent object

protected void fireMenuDragMouseEntered(MenuDragMouseEvent![]()
![]()
event)
event - a MenuMouseDragEventEventListenerList


protected void fireMenuDragMouseExited(MenuDragMouseEvent![]()
![]()
event)
event - a MenuDragMouseEventEventListenerList


protected void fireMenuDragMouseDragged(MenuDragMouseEvent![]()
![]()
event)
event - a MenuDragMouseEventEventListenerList


protected void fireMenuDragMouseReleased(MenuDragMouseEvent![]()
![]()
event)
event - a MenuDragMouseEventEventListenerList


protected void fireMenuKeyPressed(MenuKeyEvent![]()
![]()
event)
event - a MenuKeyEventEventListenerList


protected void fireMenuKeyReleased(MenuKeyEvent![]()
![]()
event)
event - a MenuKeyEventEventListenerList


protected void fireMenuKeyTyped(MenuKeyEvent![]()
![]()
event)
event - a MenuKeyEventEventListenerList


public void menuSelectionChanged(boolean isIncluded)
MenuSelectionManager when the
MenuElement is selected or unselected.
menuSelectionChanged

in interface MenuElement

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 sameMenuSelectionManager.setSelectedPath(MenuElement[])


public MenuElement![]()
![]()
[] getSubElements()
getSubElements

in interface MenuElement

MenuElements

public Component![]()
![]()
getComponent()
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.
getComponent

in interface MenuElement

Component that paints this menu item

public void addMenuDragMouseListener(MenuDragMouseListener![]()
![]()
l)
MenuDragMouseListener to the menu item.
l - the MenuDragMouseListener to be added

public void removeMenuDragMouseListener(MenuDragMouseListener![]()
![]()
l)
MenuDragMouseListener from the menu item.
l - the MenuDragMouseListener to be removed

public MenuDragMouseListener![]()
![]()
[] getMenuDragMouseListeners()
MenuDragMouseListeners added
to this JMenuItem with addMenuDragMouseListener().
MenuDragMouseListeners added or an empty
array if no listeners have been added

public void addMenuKeyListener(MenuKeyListener![]()
![]()
l)
MenuKeyListener to the menu item.
l - the MenuKeyListener to be added

public void removeMenuKeyListener(MenuKeyListener![]()
![]()
l)
MenuKeyListener from the menu item.
l - the MenuKeyListener to be removed

public MenuKeyListener![]()
![]()
[] getMenuKeyListeners()
MenuKeyListeners added
to this JMenuItem with addMenuKeyListener().
MenuKeyListeners added or an empty
array if no listeners have been added

protected String![]()
![]()
paramString()
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.
paramString

in class AbstractButton

JMenuItem

public AccessibleContext![]()
![]()
getAccessibleContext()
AccessibleContext associated with this
JMenuItem. For JMenuItems,
the AccessibleContext takes the form of an
AccessibleJMenuItem.
A new AccessibleJMenuItme instance is created if necessary.
getAccessibleContext

in interface Accessible

getAccessibleContext

in class JComponent

AccessibleJMenuItem that serves as the
AccessibleContext of this JMenuItem
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||