|
JavaTM 2 Platform Std. Ed. v1.3.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | 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
An implementation of an item in a menu. A menu item is essentially a button sitting in a list. When the user selects the "button", the action associated with the menu item is performed. A JMenuItem contained in a JPopupMenu performs exactly that function.
For further documentation and for examples, see How to Use Menus in The Java Tutorial. For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the JMenuItem key assignments.
Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. A future release of Swing will provide support for long term persistence.
JPopupMenu
,
JMenu
,
JCheckBoxMenuItem
,
JRadioButtonMenuItem
, Serialized FormInner Class Summary | |
protected class |
JMenuItem.AccessibleJMenuItem
This class implements accessibility support for the JMenuItem class. |
Inner classes inherited from class javax.swing.AbstractButton |
AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener |
Inner classes inherited from class javax.swing.JComponent |
JComponent.AccessibleJComponent |
Inner classes inherited from class java.awt.Container |
Container.AccessibleAWTContainer |
Inner classes inherited from class java.awt.Component |
Component.AccessibleAWTComponent |
Fields inherited from class javax.swing.JComponent |
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
Fields inherited from class java.awt.Component |
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface javax.swing.SwingConstants |
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NORTH, NORTH_EAST, NORTH_WEST, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST |
Fields inherited from interface java.awt.image.ImageObserver |
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
JMenuItem()
Creates a menuItem with no set text or icon. |
|
JMenuItem(Action a)
Creates a menu item whose properties are taken from the Action supplied. |
|
JMenuItem(Icon icon)
Creates a menuItem with an icon. |
|
JMenuItem(String text)
Creates a menuItem with text. |
|
JMenuItem(String text,
Icon icon)
Creates a menu item with the supplied text and icon. |
|
JMenuItem(String text,
int mnemonic)
Creates a menuItem with the specified text and keyboard mnemonic. |
Method Summary | |
void |
addMenuDragMouseListener(MenuDragMouseListener l)
Adds a MenuDragMouseListener to the menu item |
void |
addMenuKeyListener(MenuKeyListener l)
Adds a MenuKeyListener to the menu item |
protected void |
configurePropertiesFromAction(Action a)
Factory method which sets the ActionEvent source's properties according to values from the Action instance. |
protected PropertyChangeListener |
createActionPropertyChangeListener(Action a)
Factory method which creates the PropertyChangeListener used to update the ActionEvent source as properties change on its Action instance. |
protected void |
fireMenuDragMouseDragged(MenuDragMouseEvent event)
|
protected void |
fireMenuDragMouseEntered(MenuDragMouseEvent event)
|
protected void |
fireMenuDragMouseExited(MenuDragMouseEvent event)
|
protected void |
fireMenuDragMouseReleased(MenuDragMouseEvent event)
|
protected void |
fireMenuKeyPressed(MenuKeyEvent event)
|
protected void |
fireMenuKeyReleased(MenuKeyEvent event)
|
protected void |
fireMenuKeyTyped(MenuKeyEvent event)
|
KeyStroke |
getAccelerator()
Returns the KeyStroke which serves as an accelerator for the menu item. |
AccessibleContext |
getAccessibleContext()
Gets the AccessibleContext associated with this JMenuItem. |
Component |
getComponent()
This method returns the java.awt.Component used to paint this object. |
MenuElement[] |
getSubElements()
This method returns an array containing the sub-menu components for this menu component. |
String |
getUIClassID()
Returns the name of the L&F class that renders this component. |
protected void |
init(String text,
Icon icon)
Initialize the menu item with the specified text and icon. |
boolean |
isArmed()
Returns whether the menu item is "armed". |
void |
menuSelectionChanged(boolean isIncluded)
Called by the MenuSelectionManager when the MenuElement is selected or unselected. |
protected String |
paramString()
Returns a string representation of this JMenuItem. |
void |
processKeyEvent(KeyEvent e,
MenuElement[] path,
MenuSelectionManager manager)
Process a key event forwarded from the MenuSelectionManager. |
void |
processMenuDragMouseEvent(MenuDragMouseEvent e)
Handle mouse drag in a menu. |
void |
processMenuKeyEvent(MenuKeyEvent e)
Handle a keystroke in a menu. |
void |
processMouseEvent(MouseEvent e,
MenuElement[] path,
MenuSelectionManager manager)
Process a mouse event forwarded from the MenuSelectionManager. |
void |
removeMenuDragMouseListener(MenuDragMouseListener l)
Removes a MenuDragMouseListener from the menu item |
void |
removeMenuKeyListener(MenuKeyListener l)
Removes a MenuKeyListener from the menu item |
void |
setAccelerator(KeyStroke keyStroke)
Set 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)
Enable or disable the menu item. |
void |
setUI(MenuItemUI ui)
Sets the L&F 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.awt.Container |
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public JMenuItem()
public JMenuItem(Icon icon)
icon
- the icon of the MenuItem.public JMenuItem(String text)
text
- the text of the MenuItem.public JMenuItem(Action a)
public JMenuItem(String text, Icon icon)
text
- the text of the MenuItem.icon
- the icon of the MenuItem.public JMenuItem(String text, int mnemonic)
text
- the text of the MenuItem.mnemonic
- the keyboard mnemonic for the MenuItemMethod Detail |
protected void init(String text, Icon icon)
init
in class AbstractButton
text
- the text of the MenuItem.icon
- the icon of the MenuItem.public void setUI(MenuItemUI ui)
ui
- the MenuItemUI 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 selectedpublic boolean isArmed()
setArmed(boolean)
public void setEnabled(boolean b)
setEnabled
in class AbstractButton
b
- true to enable the itempublic void setAccelerator(KeyStroke keyStroke)
keyStroke
- the KeyStroke which will serve as an acceleratorpublic KeyStroke getAccelerator()
protected void configurePropertiesFromAction(Action a)
configurePropertiesFromAction
in class AbstractButton
a
- the Action from which to get the properties, or nullAction
,
AbstractButton.setAction(javax.swing.Action)
protected PropertyChangeListener createActionPropertyChangeListener(Action a)
createActionPropertyChangeListener
in class AbstractButton
Action
,
AbstractButton.setAction(javax.swing.Action)
public void processMouseEvent(MouseEvent e, MenuElement[] path, MenuSelectionManager manager)
processMouseEvent
in interface MenuElement
event
- A MouseEvent with source being the receiving component.componentPath
- The MenuElement path array to the receiving component.manager
- The MenuSelectionManager for the menu hierarchy.
This method should process the MouseEvent and change 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
public void processKeyEvent(KeyEvent e, MenuElement[] path, MenuSelectionManager manager)
processKeyEvent
in interface MenuElement
event
- A KeyEvent with source being the receiving component.componentPath
- The MenuElement path array to the receiving component.manager
- The MenuSelectionManager for the menu hierarchy.
This method should process the KeyEvent and change 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
public void processMenuDragMouseEvent(MenuDragMouseEvent e)
e
- a MenuDragMouseEvent objectpublic void processMenuKeyEvent(MenuKeyEvent e)
e
- a MenuKeyEvent objectprotected void fireMenuDragMouseEntered(MenuDragMouseEvent event)
protected void fireMenuDragMouseExited(MenuDragMouseEvent event)
protected void fireMenuDragMouseDragged(MenuDragMouseEvent event)
protected void fireMenuDragMouseReleased(MenuDragMouseEvent event)
protected void fireMenuKeyPressed(MenuKeyEvent event)
protected void fireMenuKeyReleased(MenuKeyEvent event)
protected void fireMenuKeyTyped(MenuKeyEvent event)
public void menuSelectionChanged(boolean isIncluded)
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
public Component getComponent()
getComponent
in interface MenuElement
public void addMenuDragMouseListener(MenuDragMouseListener l)
public void removeMenuDragMouseListener(MenuDragMouseListener l)
public void addMenuKeyListener(MenuKeyListener l)
public void removeMenuKeyListener(MenuKeyListener l)
protected String paramString()
null
.paramString
in class AbstractButton
public AccessibleContext getAccessibleContext()
getAccessibleContext
in interface Accessible
getAccessibleContext
in class JComponent
|
JavaTM 2 Platform Std. Ed. v1.3.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2001 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.