Modifier and Type	Class and Description
protected class	Menu.AccessibleAWTMenu Inner class of Menu used to provide default support for accessibility.

Modifier and Type	Field and Description
private static final String	base Hides java.awt.MenuItem.base.
pack-priv volatile boolean	isHelpMenu This field will be set to `true` if the Menu in question is actually a help menu.
private final Vector<MenuItem>	items A vector of the items that will be part of the Menu.
private int	menuSerializedDataVersion The menu serialized Data Version.
private static int	nameCounter Hides java.awt.MenuItem.nameCounter.
private static final long	serialVersionUID Hides java.awt.MenuItem.serialVersionUID. Use serialVersionUID from JDK 1.1 for interoperability.
private final boolean	tearOff This field indicates whether the menu has the tear of property or not.

Access	Constructor and Description
public	Menu() Constructs a new menu with an empty label.
public	Menu(String the menu's label in the menu bar, or in another menu of which this menu is a submenu. label) Constructs a new menu with the specified label.
public	Menu(String the menu's label in the menu bar, or in another menu of which this menu is a submenu. label, boolean if `true`, the menu is a tear-off menu. tearOff) Constructs a new menu with the specified label, indicating whether the menu can be torn off.

Method Summary

Modifier and Type	Method and Description
public MenuItem	Returns: the menu item added add(MenuItem the menu item to be added mi) Adds the specified menu item to this menu.
public void	add(String the text on the item label) Adds an item with the specified label to this menu.
public void	addNotify() Overrides java.awt.MenuItem.addNotify. Creates the menu's peer.
public void	addSeparator() Adds a separator line, or a hyphen, to the menu at the current position.
pack-priv String	constructComponentName() Overrides java.awt.MenuItem.constructComponentName. Construct a name for this MenuComponent.
public int	Returns: the number of items in this menu countItems() Deprecated As of JDK version 1.1, replaced by `getItemCount()`. Returns the number of items in this menu.
pack-priv final int	countItemsImpl()
pack-priv void	deleteShortcut(MenuShortcut s) Overrides java.awt.MenuItem.deleteShortcut.
pack-priv int	getAccessibleChildIndex(MenuComponent child) Overrides java.awt.MenuComponent.getAccessibleChildIndex. Defined in MenuComponent.
public AccessibleContext	Returns: an AccessibleAWTMenu that serves as the AccessibleContext of this Menu getAccessibleContext() Overrides java.awt.MenuItem.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Gets the AccessibleContext associated with this Menu.
public MenuItem	Returns: the item located at the specified index. getItem(int the position of the item to be returned. index) Gets the item located at the specified index of this menu.
public int	Returns: the number of items in this menu getItemCount() Get the number of items in this menu.
pack-priv final MenuItem	getItemImpl(int index)
pack-priv MenuItem	getShortcutMenuItem(MenuShortcut s) Overrides java.awt.MenuItem.getShortcutMenuItem.
pack-priv boolean	handleShortcut(KeyEvent e) Overrides java.awt.MenuItem.handleShortcut.
private static native void	initIDs() Hides java.awt.MenuItem.initIDs. Initialize JNI field and method IDs
public void	insert(MenuItem the menu item to be inserted. menuitem, int the position at which the menu item should be inserted. index) Inserts a menu item into this menu at the specified position.
public void	insert(String the text on the item label, int the position at which the menu item should be inserted index) Inserts a menu item with the specified label into this menu at the specified position.
public void	insertSeparator(int the position at which the menu separator should be inserted. index) Inserts a separator at the specified position.
public boolean	Returns: `true` if this is a tear-off menu; `false` otherwise. isTearOff() Indicates whether this menu is a tear-off menu.
public String	Returns: the parameter string of this menu paramString() Overrides java.awt.MenuItem.paramString. Returns a string representing the state of this `Menu`.
private void	readObject(ObjectInputStream the `ObjectInputStream` to read s) Hides java.awt.MenuItem.readObject. Reads the `ObjectInputStream`.
public void	remove(int the position of the item to be removed. index) Removes the menu item at the specified index from this menu.
public void	remove(MenuComponent the item to be removed from the menu. If `item` is `null` or is not in this menu, this method does nothing. item) Implements java.awt.MenuContainer.remove. Removes the specified menu item from this menu.
public void	removeAll() Removes all items from this menu.
public void	removeNotify() Overrides java.awt.MenuComponent.removeNotify. Removes the menu's peer.
pack-priv synchronized Enumeration<MenuShortcut>	shortcuts()
private void	writeObject(ObjectOutputStream the `ObjectOutputStream` to write s) Hides java.awt.MenuItem.writeObject. Writes default serializable fields to stream.

Field Detail

base	back to summary
private static final String base Hides java.awt.MenuItem.base.

isHelpMenu	back to summary
pack-priv volatile boolean isHelpMenu This field will be set to `true` if the Menu in question is actually a help menu. Otherwise it will be set to `false`.

items back to summary

items	back to summary
private final Vector<MenuItem> items A vector of the items that will be part of the Menu. See Also `countItems()`

private final Vector<MenuItem> items

A vector of the items that will be part of the Menu.

See Also: countItems()

menuSerializedDataVersion	back to summary
private int menuSerializedDataVersion The menu serialized Data Version.

nameCounter	back to summary
private static int nameCounter Hides java.awt.MenuItem.nameCounter.

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.awt.MenuItem.serialVersionUID. Use serialVersionUID from JDK 1.1 for interoperability. Annotations @Serial

serialVersionUID

back to summary

private static final long serialVersionUID

Hides java.awt.MenuItem.serialVersionUID.

Use serialVersionUID from JDK 1.1 for interoperability.

Annotations

@Serial

tearOff back to summary

tearOff	back to summary
private final boolean tearOff This field indicates whether the menu has the tear of property or not. It will be set to `true` if the menu has the tear off property and it will be set to `false` if it does not. A torn off menu can be deleted by a user when it is no longer needed. See Also `isTearOff()`

private final boolean tearOff

This field indicates whether the menu has the tear of property or not. It will be set to true if the menu has the tear off property and it will be set to false if it does not. A torn off menu can be deleted by a user when it is no longer needed.

See Also: isTearOff()

Constructor Detail

Menu back to summary

Menu	back to summary
public Menu() throws HeadlessException Constructs a new menu with an empty label. This menu is not a tear-off menu. Exceptions HeadlessException: if GraphicsEnvironment.isHeadless() returns true. Since 1.1 See Also `java.awt.GraphicsEnvironment#isHeadless`

public Menu() throws HeadlessException

Constructs a new menu with an empty label. This menu is not a tear-off menu.

Exceptions

HeadlessException:: if GraphicsEnvironment.isHeadless() returns true.

Since

1.1

Menu back to summary

Menu	back to summary
public Menu(String label) throws HeadlessException Constructs a new menu with the specified label. This menu is not a tear-off menu. Parameters label:String the menu's label in the menu bar, or in another menu of which this menu is a submenu. Exceptions HeadlessException: if GraphicsEnvironment.isHeadless() returns true. See Also `java.awt.GraphicsEnvironment#isHeadless`

public Menu(String label) throws HeadlessException

Constructs a new menu with the specified label. This menu is not a tear-off menu.

Parameters

label:String: the menu's label in the menu bar, or in another menu of which this menu is a submenu.

Exceptions

HeadlessException:: if GraphicsEnvironment.isHeadless() returns true.

Menu back to summary

Menu	back to summary
public Menu(String label, boolean tearOff) throws HeadlessException Constructs a new menu with the specified label, indicating whether the menu can be torn off. Tear-off functionality may not be supported by all implementations of AWT. If a particular implementation doesn't support tear-off menus, this value is silently ignored. Parameters label:String the menu's label in the menu bar, or in another menu of which this menu is a submenu. tearOff:boolean if `true`, the menu is a tear-off menu. Exceptions HeadlessException: if GraphicsEnvironment.isHeadless() returns true. See Also `java.awt.GraphicsEnvironment#isHeadless`

public Menu(String label, boolean tearOff) throws HeadlessException

Constructs a new menu with the specified label, indicating whether the menu can be torn off.

Tear-off functionality may not be supported by all implementations of AWT. If a particular implementation doesn't support tear-off menus, this value is silently ignored.

Parameters

label:String: the menu's label in the menu bar, or in another menu of which this menu is a submenu.
tearOff:boolean: if true, the menu is a tear-off menu.

Exceptions

HeadlessException:: if GraphicsEnvironment.isHeadless() returns true.

Method Detail

add back to summary

add	back to summary
public MenuItem add(MenuItem mi) Adds the specified menu item to this menu. If the menu item has been part of another menu, removes it from that menu. Parameters mi:MenuItem the menu item to be added Returns:MenuItem the menu item added See Also `java.awt.Menu#insert(java.lang.String, int)`, `java.awt.Menu#insert(java.awt.MenuItem, int)`

public MenuItem add(MenuItem mi)

Adds the specified menu item to this menu. If the menu item has been part of another menu, removes it from that menu.

Parameters

mi:MenuItem: the menu item to be added

Returns:MenuItem

the menu item added

add back to summary

add	back to summary
public void add(String label) Adds an item with the specified label to this menu. Parameters label:String the text on the item See Also `java.awt.Menu#insert(java.lang.String, int)`, `java.awt.Menu#insert(java.awt.MenuItem, int)`

public void add(String label)

Adds an item with the specified label to this menu.

Parameters

label:String: the text on the item

addNotify	back to summary
public void addNotify() Overrides java.awt.MenuItem.addNotify. Creates the menu's peer. The peer allows us to modify the appearance of the menu without changing its functionality.

addNotify

back to summary

public void addNotify()

Overrides java.awt.MenuItem.addNotify.

Creates the menu's peer. The peer allows us to modify the appearance of the menu without changing its functionality.

addSeparator back to summary

addSeparator	back to summary
public void addSeparator() Adds a separator line, or a hyphen, to the menu at the current position. See Also `java.awt.Menu#insertSeparator(int)`

public void addSeparator()

Adds a separator line, or a hyphen, to the menu at the current position.

See Also: java.awt.Menu#insertSeparator(int)

constructComponentName	back to summary
pack-priv String constructComponentName() Overrides java.awt.MenuItem.constructComponentName. Construct a name for this MenuComponent. Called by getName() when the name is null.

constructComponentName

back to summary

pack-priv String constructComponentName()

Overrides java.awt.MenuItem.constructComponentName.

Construct a name for this MenuComponent. Called by getName() when the name is null.

countItems back to summary

countItems	back to summary
public int countItems() Deprecated As of JDK version 1.1, replaced by `getItemCount()`. Returns the number of items in this menu. Returns:int the number of items in this menu Annotations @Deprecated

public int countItems()

Deprecated

As of JDK version 1.1, replaced by getItemCount().

Returns the number of items in this menu.

Returns:int

the number of items in this menu

Annotations

@Deprecated

countItemsImpl	back to summary
pack-priv final int countItemsImpl()

deleteShortcut	back to summary
pack-priv void deleteShortcut(MenuShortcut s) Overrides java.awt.MenuItem.deleteShortcut.

getAccessibleChildIndex	back to summary
pack-priv int getAccessibleChildIndex(MenuComponent child) Overrides java.awt.MenuComponent.getAccessibleChildIndex. Defined in MenuComponent. Overridden here.

getAccessibleChildIndex

back to summary

pack-priv int getAccessibleChildIndex(MenuComponent child)

Overrides java.awt.MenuComponent.getAccessibleChildIndex.

Defined in MenuComponent. Overridden here.

getAccessibleContext	back to summary
public AccessibleContext getAccessibleContext() Overrides java.awt.MenuItem.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Gets the AccessibleContext associated with this Menu. For menus, the AccessibleContext takes the form of an AccessibleAWTMenu. A new AccessibleAWTMenu instance is created if necessary. Returns:AccessibleContext an AccessibleAWTMenu that serves as the AccessibleContext of this Menu Since 1.3

getAccessibleContext

back to summary

public AccessibleContext getAccessibleContext()

Overrides java.awt.MenuItem.getAccessibleContext.

Implements javax.accessibility.Accessible.getAccessibleContext.

Gets the AccessibleContext associated with this Menu. For menus, the AccessibleContext takes the form of an AccessibleAWTMenu. A new AccessibleAWTMenu instance is created if necessary.

Returns:AccessibleContext: an AccessibleAWTMenu that serves as the AccessibleContext of this Menu
Since: 1.3

getItem	back to summary
public MenuItem getItem(int index) Gets the item located at the specified index of this menu. Parameters index:int the position of the item to be returned. Returns:MenuItem the item located at the specified index.

getItem

back to summary

public MenuItem getItem(int index)

Gets the item located at the specified index of this menu.

Parameters

index:int: the position of the item to be returned.

Returns:MenuItem

the item located at the specified index.

getItemCount	back to summary
public int getItemCount() Get the number of items in this menu. Returns:int the number of items in this menu Since 1.1

getItemCount

back to summary

public int getItemCount()

Get the number of items in this menu.

Returns:int: the number of items in this menu
Since: 1.1

getItemImpl	back to summary
pack-priv final MenuItem getItemImpl(int index)

getShortcutMenuItem	back to summary
pack-priv MenuItem getShortcutMenuItem(MenuShortcut s) Overrides java.awt.MenuItem.getShortcutMenuItem.

handleShortcut	back to summary
pack-priv boolean handleShortcut(KeyEvent e) Overrides java.awt.MenuItem.handleShortcut.

initIDs	back to summary
private static native void initIDs() Hides java.awt.MenuItem.initIDs. Initialize JNI field and method IDs

initIDs

back to summary

private static native void initIDs()

Hides java.awt.MenuItem.initIDs.

Initialize JNI field and method IDs

insert back to summary

insert	back to summary
public void insert(MenuItem menuitem, int index) Inserts a menu item into this menu at the specified position. Parameters menuitem:MenuItem the menu item to be inserted. index:int the position at which the menu item should be inserted. Exceptions IllegalArgumentException: if the value of `index` is less than zero Since 1.1 See Also `java.awt.Menu#add(java.lang.String)`, `java.awt.Menu#add(java.awt.MenuItem)`

public void insert(MenuItem menuitem, int index)

Inserts a menu item into this menu at the specified position.

Parameters

menuitem:MenuItem: the menu item to be inserted.
index:int: the position at which the menu item should be inserted.

Exceptions

IllegalArgumentException:: if the value of index is less than zero

Since

1.1

insert back to summary

insert	back to summary
public void insert(String label, int index) Inserts a menu item with the specified label into this menu at the specified position. This is a convenience method for `insert(menuItem, index)`. Parameters label:String the text on the item index:int the position at which the menu item should be inserted Exceptions IllegalArgumentException: if the value of `index` is less than zero Since 1.1 See Also `java.awt.Menu#add(java.lang.String)`, `java.awt.Menu#add(java.awt.MenuItem)`

public void insert(String label, int index)

Inserts a menu item with the specified label into this menu at the specified position. This is a convenience method for insert(menuItem, index).

Parameters

label:String: the text on the item
index:int: the position at which the menu item should be inserted

Exceptions

IllegalArgumentException:: if the value of index is less than zero

Since

1.1

insertSeparator back to summary

insertSeparator	back to summary
public void insertSeparator(int index) Inserts a separator at the specified position. Parameters index:int the position at which the menu separator should be inserted. Exceptions IllegalArgumentException: if the value of `index` is less than 0. Since 1.1 See Also `java.awt.Menu#addSeparator`

public void insertSeparator(int index)

Inserts a separator at the specified position.

Parameters

index:int: the position at which the menu separator should be inserted.

Exceptions

IllegalArgumentException:: if the value of index is less than 0.

Since

1.1

See Also

java.awt.Menu#addSeparator

isTearOff back to summary

isTearOff	back to summary
public boolean isTearOff() Indicates whether this menu is a tear-off menu. Tear-off functionality may not be supported by all implementations of AWT. If a particular implementation doesn't support tear-off menus, this value is silently ignored. Returns:boolean `true` if this is a tear-off menu; `false` otherwise.

public boolean isTearOff()

Indicates whether this menu is a tear-off menu.

Tear-off functionality may not be supported by all implementations of AWT. If a particular implementation doesn't support tear-off menus, this value is silently ignored.

Returns:boolean: true if this is a tear-off menu; false otherwise.

paramString back to summary

paramString	back to summary
public String paramString() Overrides java.awt.MenuItem.paramString. Returns a string representing the state of this `Menu`. 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 the parameter string of this menu

public String paramString()

Overrides java.awt.MenuItem.paramString.

Returns a string representing the state of this Menu. 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: the parameter string of this menu

readObject back to summary

readObject	back to summary
private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException, HeadlessException Hides java.awt.MenuItem.readObject. Reads the `ObjectInputStream`. Unrecognized keys or values will be ignored. Parameters s:ObjectInputStream the `ObjectInputStream` to read Annotations @Serial Exceptions IOException: if an I/O error occurs ClassNotFoundException: if the class of a serialized object could not be found HeadlessException: if `GraphicsEnvironment.isHeadless()` returns `true` See Also `java.awt.GraphicsEnvironment#isHeadless`, `writeObject(ObjectOutputStream)`

private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException, HeadlessException

Hides java.awt.MenuItem.readObject.

Reads the ObjectInputStream. Unrecognized keys or values will be ignored.

Parameters

s:ObjectInputStream: the ObjectInputStream to read

Annotations

@Serial

Exceptions

IOException:: if an I/O error occurs
ClassNotFoundException:: if the class of a serialized object could not be found
HeadlessException:: if GraphicsEnvironment.isHeadless() returns true

remove	back to summary
public void remove(int index) Removes the menu item at the specified index from this menu. Parameters index:int the position of the item to be removed.

remove

back to summary

public void remove(int index)

Removes the menu item at the specified index from this menu.

Parameters

index:int: the position of the item to be removed.

remove back to summary

remove	back to summary
public void remove(MenuComponent item) Implements java.awt.MenuContainer.remove. Removes the specified menu item from this menu. Parameters item:MenuComponent the item to be removed from the menu. If `item` is `null` or is not in this menu, this method does nothing.

public void remove(MenuComponent item)

Implements java.awt.MenuContainer.remove.

Removes the specified menu item from this menu.

Parameters

item:MenuComponent: the item to be removed from the menu. If item is null or is not in this menu, this method does nothing.

removeAll	back to summary
public void removeAll() Removes all items from this menu. Since 1.1

removeAll

back to summary

public void removeAll()

Removes all items from this menu.

Since: 1.1

removeNotify	back to summary
public void removeNotify() Overrides java.awt.MenuComponent.removeNotify. Removes the menu's peer. The peer allows us to modify the appearance of the menu without changing its functionality.

removeNotify

back to summary

public void removeNotify()

Overrides java.awt.MenuComponent.removeNotify.

Removes the menu's peer. The peer allows us to modify the appearance of the menu without changing its functionality.

shortcuts	back to summary
pack-priv synchronized Enumeration<MenuShortcut> shortcuts()

writeObject back to summary

writeObject	back to summary
private void writeObject(ObjectOutputStream s) throws IOException Hides java.awt.MenuItem.writeObject. Writes default serializable fields to stream. Parameters s:ObjectOutputStream the `ObjectOutputStream` to write Annotations @Serial Exceptions IOException: if an I/O error occurs See Also `AWTEventMulticaster#save(ObjectOutputStream, String, EventListener)`, `readObject(ObjectInputStream)`

private void writeObject(ObjectOutputStream s) throws IOException

Hides java.awt.MenuItem.writeObject.

Writes default serializable fields to stream.

Parameters

s:ObjectOutputStream: the ObjectOutputStream to write

Annotations

@Serial

Exceptions

IOException:: if an I/O error occurs

java.awt back to summary

protected Class Menu.AccessibleAWTMenu

Class Inheritance

extends AccessibleAWTMenuItem

java.lang.Object
javax.accessibility.AccessibleContext
java.awt.MenuComponent.AccessibleAWTMenuComponent
java.awt.MenuItem.AccessibleAWTMenuItem
java.awt.Menu.AccessibleAWTMenu

Known Direct Subclasses

java.awt.PopupMenu.AccessibleAWTPopupMenu

Inner class of Menu used to provide default support for accessibility. This class is not meant to be used directly by application developers, but is instead meant only to be subclassed by menu component developers.

This class implements accessibility support for the Menu class. It provides an implementation of the Java Accessibility API appropriate to menu user-interface elements.

Since: 1.3

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides java.awt.MenuItem.AccessibleAWTMenuItem.serialVersionUID. Use serialVersionUID from JDK 1.3 for interoperability.

Access	Constructor and Description
protected	AccessibleAWTMenu() Constructs an `AccessibleAWTMenu`.

Method Summary

Modifier and Type	Method and Description
public AccessibleRole	Returns: an instance of AccessibleRole describing the role of the object getAccessibleRole() Overrides java.awt.MenuItem.AccessibleAWTMenuItem.getAccessibleRole. Get the role of this object.

Inherited from java.awt.MenuItem.AccessibleAWTMenuItem:: doAccessibleAction getAccessibleAction getAccessibleActionCount getAccessibleActionDescription getAccessibleName getAccessibleValue getCurrentAccessibleValue getMaximumAccessibleValue getMinimumAccessibleValue setCurrentAccessibleValue

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.awt.MenuItem.AccessibleAWTMenuItem.serialVersionUID. Use serialVersionUID from JDK 1.3 for interoperability. Annotations @Serial

serialVersionUID

back to summary

private static final long serialVersionUID

Hides java.awt.MenuItem.AccessibleAWTMenuItem.serialVersionUID.

Use serialVersionUID from JDK 1.3 for interoperability.

Annotations

@Serial

AccessibleAWTMenu	back to summary
protected AccessibleAWTMenu() Constructs an `AccessibleAWTMenu`.

Method Detail

getAccessibleRole	back to summary
public AccessibleRole getAccessibleRole() Overrides java.awt.MenuItem.AccessibleAWTMenuItem.getAccessibleRole. Get the role of this object. Returns:AccessibleRole an instance of AccessibleRole describing the role of the object

getAccessibleRole

back to summary

public AccessibleRole getAccessibleRole()

Overrides java.awt.MenuItem.AccessibleAWTMenuItem.getAccessibleRole.

Get the role of this object.

Returns:AccessibleRole: an instance of AccessibleRole describing the role of the object

public Class Menu

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class Menu.AccessibleAWTMenu

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail