Serializable
, Accessible
CheckboxMenuItem
, Menu
All items in a menu must belong to the class
MenuItem
, or one of its subclasses.
The default MenuItem
object embodies a simple labeled menu item.
This picture of a menu bar shows five menu items:
The first two items are simple menu items, labeled "Basic"
and "Simple"
. Following these two items is a separator, which is itself a menu item, created with the label "-"
. Next is an instance of CheckboxMenuItem
labeled "Check"
. The final menu item is a submenu labeled "More Examples"
, and this submenu is an instance of Menu
.
When a menu item is selected, AWT sends an action event to the menu item. Since the event is an instance of ActionEvent
, the processEvent
method examines the event and passes it along to processActionEvent
. The latter method redirects the event to any ActionListener
objects that have registered an interest in action events generated by this menu item.
Note that the subclass Menu
overrides this behavior and does not send any event to the frame until one of its subitems is selected.
Nested Classes
protected class
Inner class of MenuItem used to provide default support for accessibility.
Constructors
Constructs a new MenuItem with an empty label and no keyboard shortcut.
Constructs a new MenuItem with the specified label and no keyboard shortcut.
Create a menu item with an associated keyboard shortcut.
void
Adds the specified action listener to receive action events from this menu item.
void
Creates the menu item's peer.
void
Delete any MenuShortcut
object associated with this menu item.
void
protected final void
Disables event delivery to this menu item for events defined by the specified event mask parameter.
void
void
protected final void
Enables event delivery to this menu item for events to be defined by the specified event mask parameter
Gets the AccessibleContext associated with this MenuItem.
Gets the command name of the action event that is fired by this menu item.
Returns an array of all the action listeners registered on this menu item.
Gets the label for this menu item.
Returns an array of all the objects currently registered as FooListener
s upon this MenuItem
.
Get the MenuShortcut
object associated with this menu item,
boolean
Checks whether this menu item is enabled.
Returns a string representing the state of this MenuItem
.
protected void
Processes action events occurring on this menu item, by dispatching them to any registered ActionListener
objects.
protected void
Processes events on this menu item.
void
Removes the specified action listener so it no longer receives action events from this menu item.
void
Sets the command name of the action event that is fired by this menu item.
void
Sets whether or not this menu item can be chosen.
void
Sets the label for this menu item to the specified label.
void
Set the MenuShortcut
object associated with this menu item.
Constructs a new MenuItem with an empty label and no keyboard shortcut.
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true.
Constructs a new MenuItem with the specified label and no keyboard shortcut. Note that use of "-" in a label is reserved to indicate a separator between menu items. By default, all menu items except for separators are enabled.
label
- the label for this menu item.
HeadlessException
- if GraphicsEnvironment.isHeadless() returns true.
public void addNotify()
Creates the menu item's peer. The peer allows us to modify the appearance of the menu item without changing its functionality.
Gets the label for this menu item.
null
if this menu item has no label.
Sets the label for this menu item to the specified label.
label
- the new label, or null
for no label.
public boolean isEnabled()
Checks whether this menu item is enabled.
true
if the item is enabled; otherwise false
public void setEnabled(boolean b)
Sets whether or not this menu item can be chosen.
b
- if true
, enables this menu item; if false
, disables it.
Sets whether or not this menu item can be chosen.
b
- if true
, enables this menu item; otherwise disables
Get the MenuShortcut
object associated with this menu item,
null
if none has been specified.
public void deleteShortcut()
Delete any MenuShortcut
object associated with this menu item.
protected final void enableEvents(long eventsToEnable)
Since event types are automatically enabled when a listener for that type is added to the menu item, this method only needs to be invoked by subclasses of MenuItem
which desire to have the specified event types delivered to processEvent
regardless of whether a listener is registered.
eventsToEnable
- the event mask defining the event types
protected final void disableEvents(long eventsToDisable)
Disables event delivery to this menu item for events defined by the specified event mask parameter.
eventsToDisable
- the event mask defining the event types
By default, the action command is set to the label of the menu item.
command
- the action command to be set for this menu item.
()
Gets the command name of the action event that is fired by this menu item.
Refer to AWT Threading Issues for details on AWT's threading model.
l
- the action listener.
Refer to AWT Threading Issues for details on AWT's threading model.
l
- the action listener.
Returns an array of all the action listeners registered on this menu item.
ActionListener
s or an empty array if no action listeners are currently registered
Returns an array of all the objects currently registered as
FooListener
s upon this
MenuItem
.
FooListener
s are registered using the
addFooListener
method.
You can specify the listenerType
argument with a class literal, such as FooListener.class
. For example, you can query a MenuItem m
for its action listeners with the following code:
ActionListener[] als = (ActionListener[])(m.getListeners(ActionListener.class));
If no such listeners exist, this method returns an empty array.
T
- the type of the listeners
listenerType
- the type of listeners requested; this parameter should specify an interface that descends from java.util.EventListener
FooListener
s on this menu item, or an empty array if no such listeners have been added
ClassCastException
- if listenerType
doesn't specify a class or interface that implements java.util.EventListener
Processes events on this menu item. If the event is an instance of
ActionEvent
, it invokes
processActionEvent
, another method defined by
MenuItem
.
Currently, menu items only support action events.
Note that if the event parameter is null
the behavior is unspecified and may result in an exception.
processEvent
in class MenuComponent
e
- the event
Processes action events occurring on this menu item, by dispatching them to any registered
ActionListener
objects. This method is not called unless action events are enabled for this component. Action events are enabled when one of the following occurs:
ActionListener
object is registered via addActionListener
.enableEvents
.Note that if the event parameter is null
the behavior is unspecified and may result in an exception.
e
- the action event
Returns a string representing the state of this MenuItem
. 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 MenuComponent
Gets the AccessibleContext associated with this MenuItem. For menu items, the AccessibleContext takes the form of an AccessibleAWTMenuItem. A new AccessibleAWTMenuItem instance is created if necessary.
getAccessibleContext
in interface Accessible
getAccessibleContext
in class MenuComponent
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4