|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.AbstractButton
javax.swing.JMenuItem
public class JMenuItem
JMenuItem represents element in the menu. It inherits most of its functionality from AbstractButton, however its behavior somewhat varies from it. JMenuItem fire different kinds of events. PropertyChangeEvents are fired when menuItems properties are modified; ChangeEvents are fired when menuItem's state changes and actionEvents are fired when menu item is selected. In addition to this events menuItem also fire MenuDragMouseEvent and MenuKeyEvents when mouse is dragged over the menu item or associated key with menu item is invoked respectively.
Nested Class Summary | |
---|---|
protected class |
JMenuItem.AccessibleJMenuItem
Provides the accessibility features for the JMenuItem
component. |
Nested classes/interfaces inherited from class javax.swing.AbstractButton |
---|
AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener |
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, Component.BltBufferStrategy, Component.FlipBufferStrategy |
Field Summary |
---|
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, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, 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 new JMenuItem object. |
|
JMenuItem(Action action)
Creates a new JMenuItem associated with the specified action. |
|
JMenuItem(Icon icon)
Creates a new JMenuItem with the given icon. |
|
JMenuItem(String text)
Creates a new JMenuItem with the given label. |
|
JMenuItem(String text,
Icon icon)
Creates a new JMenuItem with specified text and icon. |
|
JMenuItem(String text,
int mnemonic)
Creates a new JMenuItem object. |
Method Summary | |
---|---|
void |
addMenuDragMouseListener(MenuDragMouseListener listener)
Adds a MenuDragMouseListener to this menu item. |
void |
addMenuKeyListener(MenuKeyListener listener)
Adds an MenuKeyListener to this menu item. |
protected void |
configurePropertiesFromAction(Action action)
Configures menu items' properties from properties of the specified action. |
protected PropertyChangeListener |
createActionPropertyChangeListener(Action action)
Creates PropertyChangeListener to listen for the changes in action properties. |
protected void |
fireMenuDragMouseDragged(MenuDragMouseEvent event)
Fires MenuDragMouseEvent to all of the menuItem's MouseInputListeners. |
protected void |
fireMenuDragMouseEntered(MenuDragMouseEvent event)
Fires MenuDragMouseEvent to all of the menuItem's MouseInputListeners. |
protected void |
fireMenuDragMouseExited(MenuDragMouseEvent event)
Fires MenuDragMouseEvent to all of the menuItem's MouseInputListeners. |
protected void |
fireMenuDragMouseReleased(MenuDragMouseEvent event)
This method fires a MenuDragMouseEvent to all the MenuItem's MouseInputListeners. |
protected void |
fireMenuKeyPressed(MenuKeyEvent event)
This method fires a MenuKeyEvent to all the MenuItem's MenuKeyListeners. |
protected void |
fireMenuKeyReleased(MenuKeyEvent event)
This method fires a MenuKeyEvent to all the MenuItem's MenuKeyListeners. |
protected void |
fireMenuKeyTyped(MenuKeyEvent event)
This method fires a MenuKeyEvent to all the MenuItem's MenuKeyListeners. |
KeyStroke |
getAccelerator()
Return accelerator for this menu item. |
AccessibleContext |
getAccessibleContext()
Returns the object that provides accessibility features for this JMenuItem component. |
Component |
getComponent()
Returns reference to the component that will paint this menu item. |
MenuDragMouseListener[] |
getMenuDragMouseListeners()
Returns all added MenuDragMouseListener objects. |
MenuKeyListener[] |
getMenuKeyListeners()
Returns all added MenuKeyListener objects. |
MenuElement[] |
getSubElements()
Method of the MenuElement interface. |
String |
getUIClassID()
This method returns a name to identify which look and feel class will be the UI delegate for the menuItem. |
protected void |
init(String text,
Icon icon)
Initializes this menu item |
boolean |
isArmed()
Returns true if button's model is armed and false otherwise. |
void |
menuSelectionChanged(boolean changed)
Method of the MenuElement interface. |
protected String |
paramString()
Returns a string describing the attributes for the JMenuItem
component, for use in debugging. |
void |
processKeyEvent(KeyEvent event,
MenuElement[] path,
MenuSelectionManager manager)
Process key events forwarded from MenuSelectionManager. |
void |
processMenuDragMouseEvent(MenuDragMouseEvent event)
This method fires MenuDragMouseEvents to registered listeners. |
void |
processMenuKeyEvent(MenuKeyEvent event)
This method fires MenuKeyEvent to registered listeners. |
void |
processMouseEvent(MouseEvent ev,
MenuElement[] path,
MenuSelectionManager manager)
Process mouse events forwarded from MenuSelectionManager. |
void |
removeMenuDragMouseListener(MenuDragMouseListener listener)
Removes a MenuDragMouseListener from the menuItem's listener list. |
void |
removeMenuKeyListener(MenuKeyListener listener)
Removes an MenuKeyListener from the menuItem's listener list. |
void |
setAccelerator(KeyStroke keystroke)
Sets the key combination which invokes the menu item's action listeners without navigating the menu hierarchy. |
void |
setArmed(boolean armed)
Sets menuItem's "ARMED" property |
void |
setEnabled(boolean enabled)
Enable or disable menu item. |
void |
setUI(MenuItemUI ui)
Set the "UI" property of the menu item, which is a look and feel class responsible for handling menuItem's input events and painting it. |
void |
updateUI()
This method sets this menuItem's UI to the UIManager's default for the current look and feel. |
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
- Icon that will be displayed on the menu itempublic JMenuItem(String text)
text
- label for the menu itempublic JMenuItem(Action action)
action
- action for this menu itempublic JMenuItem(String text, Icon icon)
text
- label for this menu itemicon
- icon that will be displayed on this menu itempublic JMenuItem(String text, int mnemonic)
text
- label for this menu itemmnemonic
- - Single key that can be used with a
look-and-feel meta key to activate this menu item. However
menu item should be visible on the screen when mnemonic is used.Method Detail |
---|
protected void init(String text, Icon icon)
init
in class AbstractButton
text
- label for this menu itemicon
- icon to be displayed for this menu itempublic void setUI(MenuItemUI ui)
ui
- The new "UI" propertypublic void updateUI()
updateUI
in class AbstractButton
public String getUIClassID()
getUIClassID
in class JComponent
JComponent.setUI(javax.swing.plaf.ComponentUI)
,
JComponent.updateUI()
public boolean isArmed()
public void setArmed(boolean armed)
armed
- DOCUMENT ME!public void setEnabled(boolean enabled)
setEnabled
in class AbstractButton
enabled
- if true enable menu item, and disable otherwise.Component.isEnabled()
,
Component.isLightweight()
public KeyStroke getAccelerator()
public void setAccelerator(KeyStroke keystroke)
keystroke
- accelerator for this menu item.protected void configurePropertiesFromAction(Action action)
configurePropertiesFromAction
in class AbstractButton
action
- action to configure properties fromprotected PropertyChangeListener createActionPropertyChangeListener(Action action)
createActionPropertyChangeListener
in class AbstractButton
action
- action to listen to for property changes
public void processMouseEvent(MouseEvent ev, MenuElement[] path, MenuSelectionManager manager)
processMouseEvent
in interface MenuElement
ev
- event forwarded from MenuSelectionManagerpath
- path to the menu element from which event was generatedmanager
- MenuSelectionManager for the current menu hierarchypublic void processKeyEvent(KeyEvent event, MenuElement[] path, MenuSelectionManager manager)
processKeyEvent
in interface MenuElement
event
- event forwarded from MenuSelectionManagerpath
- path to the menu element from which event was generatedmanager
- MenuSelectionManager for the current menu hierarchypublic void processMenuDragMouseEvent(MenuDragMouseEvent event)
event
- Mousepublic void processMenuKeyEvent(MenuKeyEvent event)
event
- DOCUMENT ME!protected void fireMenuDragMouseEntered(MenuDragMouseEvent event)
event
- The event signifying that mouse entered menuItem while it was draggedprotected void fireMenuDragMouseExited(MenuDragMouseEvent event)
event
- The event signifying that mouse has exited menu item, while it was draggedprotected void fireMenuDragMouseDragged(MenuDragMouseEvent event)
event
- The event signifying that mouse is being dragged over the menuItemprotected void fireMenuDragMouseReleased(MenuDragMouseEvent event)
event
- The event signifying that mouse was released while it was dragged over the menuItemprotected void fireMenuKeyPressed(MenuKeyEvent event)
event
- The event signifying that key associated with this menu was pressedprotected void fireMenuKeyReleased(MenuKeyEvent event)
event
- The event signifying that key associated with this menu was releasedprotected void fireMenuKeyTyped(MenuKeyEvent event)
event
- The event signifying that key associated with this menu was typed.
The key is typed when it was pressed and then releasedpublic void menuSelectionChanged(boolean changed)
menuSelectionChanged
in interface MenuElement
changed
- indicates selection status of this menu item. If changed is
true then menu item is selected and deselected otherwise.public MenuElement[] getSubElements()
getSubElements
in interface MenuElement
public Component getComponent()
getComponent
in interface MenuElement
public void addMenuDragMouseListener(MenuDragMouseListener listener)
listener
- The new listener to addpublic void removeMenuDragMouseListener(MenuDragMouseListener listener)
listener
- The listener to removepublic MenuDragMouseListener[] getMenuDragMouseListeners()
public void addMenuKeyListener(MenuKeyListener listener)
listener
- The new listener to addpublic void removeMenuKeyListener(MenuKeyListener listener)
listener
- The listener to removepublic MenuKeyListener[] getMenuKeyListeners()
protected String paramString()
JMenuItem
component, for use in debugging. The return value is guaranteed to be
non-null
, but the format of the string may vary between
implementations.
paramString
in class AbstractButton
JMenuItem
.public AccessibleContext getAccessibleContext()
JMenuItem
component.
getAccessibleContext
in interface Accessible
getAccessibleContext
in class JComponent
JMenuItem.AccessibleJMenuItem
).
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |