Class JMenu

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JMenuItem

javax.swing.JMenu

All Implemented Interfaces:

ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, MenuElement, SwingConstants

@JavaBean(description="A popup window containing menu items displayed in a menu bar.")
public class JMenu
extends JMenuItem
implements Accessible, MenuElement

An implementation of a menu -- a popup window containing JMenuItems that is displayed when the user selects an item on the JMenuBar. In addition to JMenuItems, a JMenu can also contain JSeparators.

In essence, a menu is a button with an associated JPopupMenu. When the "button" is pressed, the JPopupMenu appears. If the "button" is on the JMenuBar, the menu is a top-level window. If the "button" is another menu item, then the JPopupMenu is "pull-right" menu.

Menus can be configured, and to some degree controlled, by Actions. Using an Action with a menu has many benefits beyond directly configuring a menu. Refer to Swing Components Supporting Action for more details, and you can find more information in How to Use Actions, a section in The Java Tutorial.

For information and examples of using menus see How to Use Menus, a section in The Java Tutorial.

Warning: Swing is not thread safe. For more information see Swing's Threading Policy.

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 JavaBeans has been added to the java.beans package. Please see XMLEncoder.

Since:

1.2

See Also:

• JMenuItem
• JSeparator
• JMenuBar
• JPopupMenu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	JMenu.AccessibleJMenu	This class implements accessibility support for the JMenu class.
protected class	JMenu.WinListener	A listener class that watches for a popup window closing.

Nested classes/interfaces declared in class JMenuItem

JMenuItem.AccessibleJMenuItem

Modifier and Type	Class	Description
protected class	JMenuItem.AccessibleJMenuItem	This class implements accessibility support for the JMenuItem class.

Nested classes/interfaces declared in class AbstractButton

AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener

Modifier and Type	Class	Description
protected class	AbstractButton.AccessibleAbstractButton	This class implements accessibility support for the AbstractButton class.
protected class	AbstractButton.ButtonChangeListener	Extends ChangeListener to be serializable.

Nested classes/interfaces declared in class JComponent

JComponent.AccessibleJComponent

Modifier and Type	Class	Description
class	JComponent.AccessibleJComponent	Inner class of JComponent used to provide default support for accessibility.

Nested classes/interfaces declared in class Container

Container.AccessibleAWTContainer

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

Nested classes/interfaces declared in class Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Modifier and Type	Class	Description
protected class	Component.AccessibleAWTComponent	Inner class of Component used to provide default support for accessibility.
static enum	Component.BaselineResizeBehavior	Enumeration of the common ways the baseline of a component can change as the size changes.
protected class	Component.BltBufferStrategy	Inner class for blitting offscreen surfaces to a component.
protected class	Component.FlipBufferStrategy	Inner class for flipping buffers on a component.

Field Summary

Fields

Modifier and Type	Field	Description
protected JMenu.WinListener	popupListener	The window-closing listener for the popup.

Fields declared in class AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

Modifier and Type	Field	Description
protected ActionListener	actionListener	The button model's ActionListener.
static final String	BORDER_PAINTED_CHANGED_PROPERTY	Identifies a change to having the border drawn, or having it not drawn.
protected ChangeEvent	changeEvent	Only one ChangeEvent is needed per button instance since the event's only state is the source property.
protected ChangeListener	changeListener	The button model's changeListener.
static final String	CONTENT_AREA_FILLED_CHANGED_PROPERTY	Identifies a change to having the button paint the content area.
static final String	DISABLED_ICON_CHANGED_PROPERTY	Identifies a change to the icon used when the button has been disabled.
static final String	DISABLED_SELECTED_ICON_CHANGED_PROPERTY	Identifies a change to the icon used when the button has been disabled and selected.
static final String	FOCUS_PAINTED_CHANGED_PROPERTY	Identifies a change to having the border highlighted when focused, or not.
static final String	HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY	Identifies a change in the button's horizontal alignment.
static final String	HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY	Identifies a change in the button's horizontal text position.
static final String	ICON_CHANGED_PROPERTY	Identifies a change to the icon that represents the button.
protected ItemListener	itemListener	The button model's ItemListener.
static final String	MARGIN_CHANGED_PROPERTY	Identifies a change in the button's margins.
static final String	MNEMONIC_CHANGED_PROPERTY	Identifies a change to the button's mnemonic.
protected ButtonModel	model	The data model that determines the button's state.
static final String	MODEL_CHANGED_PROPERTY	Identifies a change in the button model.
static final String	PRESSED_ICON_CHANGED_PROPERTY	Identifies a change to the icon used when the button has been pressed.
static final String	ROLLOVER_ENABLED_CHANGED_PROPERTY	Identifies a change from rollover enabled to disabled or back to enabled.
static final String	ROLLOVER_ICON_CHANGED_PROPERTY	Identifies a change to the icon used when the cursor is over the button.
static final String	ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY	Identifies a change to the icon used when the cursor is over the button and it has been selected.
static final String	SELECTED_ICON_CHANGED_PROPERTY	Identifies a change to the icon used when the button has been selected.
static final String	TEXT_CHANGED_PROPERTY	Identifies a change in the button's text.
static final String	VERTICAL_ALIGNMENT_CHANGED_PROPERTY	Identifies a change in the button's vertical alignment.
static final String	VERTICAL_TEXT_POSITION_CHANGED_PROPERTY	Identifies a change in the button's vertical text position.

Fields declared in class JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Modifier and Type	Field	Description
protected EventListenerList	listenerList	A list of event listeners for this component.
static final String	TOOL_TIP_TEXT_KEY	The comment to display when the cursor is over the component, also known as a "value tip", "flyover help", or "flyover label".
protected ComponentUI	ui	The look and feel delegate for this component.
static final int	UNDEFINED_CONDITION	Constant used by some of the APIs to mean that no condition is defined.
static final int	WHEN_ANCESTOR_OF_FOCUSED_COMPONENT	Constant used for registerKeyboardAction that means that the command should be invoked when the receiving component is an ancestor of the focused component or is itself the focused component.
static final int	WHEN_FOCUSED	Constant used for registerKeyboardAction that means that the command should be invoked when the component has the focus.
static final int	WHEN_IN_FOCUSED_WINDOW	Constant used for registerKeyboardAction that means that the command should be invoked when the receiving component is in the window that has the focus or is itself the focused component.

Fields declared in class Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Modifier and Type	Field	Description
protected AccessibleContext	accessibleContext	The AccessibleContext associated with this Component.
static final float	BOTTOM_ALIGNMENT	Ease-of-use constant for getAlignmentY.
static final float	CENTER_ALIGNMENT	Ease-of-use constant for getAlignmentY and getAlignmentX.
static final float	LEFT_ALIGNMENT	Ease-of-use constant for getAlignmentX.
static final float	RIGHT_ALIGNMENT	Ease-of-use constant for getAlignmentX.
static final float	TOP_ALIGNMENT	Ease-of-use constant for getAlignmentY().

Fields declared in interface ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Modifier and Type	Field	Description
static final int	ABORT	This flag in the infoflags argument to imageUpdate indicates that an image which was being tracked asynchronously was aborted before production was complete.
static final int	ALLBITS	This flag in the infoflags argument to imageUpdate indicates that a static image which was previously drawn is now complete and can be drawn again in its final form.
static final int	ERROR	This flag in the infoflags argument to imageUpdate indicates that an image which was being tracked asynchronously has encountered an error.
static final int	FRAMEBITS	This flag in the infoflags argument to imageUpdate indicates that another complete frame of a multi-frame image which was previously drawn is now available to be drawn again.
static final int	HEIGHT	This flag in the infoflags argument to imageUpdate indicates that the height of the base image is now available and can be taken from the height argument to the imageUpdate callback method.
static final int	PROPERTIES	This flag in the infoflags argument to imageUpdate indicates that the properties of the image are now available.
static final int	SOMEBITS	This flag in the infoflags argument to imageUpdate indicates that more pixels needed for drawing a scaled variation of the image are available.
static final int	WIDTH	This flag in the infoflags argument to imageUpdate indicates that the width of the base image is now available and can be taken from the width argument to the imageUpdate callback method.

Fields declared in interface SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Modifier and Type	Field	Description
static final int	BOTTOM	Box-orientation constant used to specify the bottom of a box.
static final int	CENTER	The central position in an area.
static final int	EAST	Compass-direction east (right).
static final int	HORIZONTAL	Horizontal orientation.
static final int	LEADING	Identifies the leading edge of text for use with left-to-right and right-to-left languages.
static final int	LEFT	Box-orientation constant used to specify the left side of a box.
static final int	NEXT	Identifies the next direction in a sequence.
static final int	NORTH	Compass-direction North (up).
static final int	NORTH_EAST	Compass-direction north-east (upper right).
static final int	NORTH_WEST	Compass-direction north west (upper left).
static final int	PREVIOUS	Identifies the previous direction in a sequence.
static final int	RIGHT	Box-orientation constant used to specify the right side of a box.
static final int	SOUTH	Compass-direction south (down).
static final int	SOUTH_EAST	Compass-direction south-east (lower right).
static final int	SOUTH_WEST	Compass-direction south-west (lower left).
static final int	TOP	Box-orientation constant used to specify the top of a box.
static final int	TRAILING	Identifies the trailing edge of text for use with left-to-right and right-to-left languages.
static final int	VERTICAL	Vertical orientation.
static final int	WEST	Compass-direction west (left).

Constructor Summary

Constructors

Constructor	Description
JMenu()	Constructs a new JMenu with no text.
JMenu(String s)	Constructs a new JMenu with the supplied string as its text.
JMenu(String s, boolean b)	Constructs a new JMenu with the supplied string as its text and specified as a tear-off menu or not.
JMenu(Action a)	Constructs a menu whose properties are taken from the Action supplied.

Method Summary

Modifier and Type	Method	Description
Component	add(Component c)	Appends a component to the end of this menu.
Component	add(Component c, int index)	Adds the specified component to this container at the given position.
JMenuItem	add(String s)	Creates a new menu item with the specified text and appends it to the end of this menu.
JMenuItem	add(Action a)	Creates a new menu item attached to the specified Action object and appends it to the end of this menu.
JMenuItem	add(JMenuItem menuItem)	Appends a menu item to the end of this menu.
void	addMenuListener(MenuListener l)	Adds a listener for menu events.
void	addSeparator()	Appends a new separator to the end of the menu.
void	applyComponentOrientation(ComponentOrientation o)	Sets the ComponentOrientation property of this menu and all components contained within it.
protected PropertyChangeListener	createActionChangeListener(JMenuItem b)	Returns a properly configured PropertyChangeListener which updates the control as changes to the Action occur.
protected JMenuItem	createActionComponent(Action a)	Factory method which creates the JMenuItem for Actions added to the JMenu.
protected JMenu.WinListener	createWinListener(JPopupMenu p)	Creates a window-closing listener for the popup.
void	doClick(int pressTime)	Programmatically performs a "click".
protected void	fireMenuCanceled()	Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuDeselected()	Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuSelected()	Notifies all listeners that have registered interest for notification on this event type.
AccessibleContext	getAccessibleContext()	Gets the AccessibleContext associated with this JMenu.
Component	getComponent()	Returns the java.awt.Component used to paint this MenuElement.
int	getDelay()	Returns the suggested delay, in milliseconds, before submenus are popped up or down.
JMenuItem	getItem(int pos)	Returns the JMenuItem at the specified position.
int	getItemCount()	Returns the number of items on the menu, including separators.
Component	getMenuComponent(int n)	Returns the component at position n.
int	getMenuComponentCount()	Returns the number of components on the menu.
Component[]	getMenuComponents()	Returns an array of Components of the menu's subcomponents.
MenuListener[]	getMenuListeners()	Returns an array of all the MenuListeners added to this JMenu with addMenuListener().
JPopupMenu	getPopupMenu()	Returns the popupmenu associated with this menu.
protected Point	getPopupMenuOrigin()	Computes the origin for the JMenu's popup menu.
MenuElement[]	getSubElements()	Returns an array of MenuElements containing the submenu for this menu component.
String	getUIClassID()	Returns the name of the L&F class that renders this component.
void	insert(String s, int pos)	Inserts a new menu item with the specified text at a given position.
JMenuItem	insert(Action a, int pos)	Inserts a new menu item attached to the specified Action object at a given position.
JMenuItem	insert(JMenuItem mi, int pos)	Inserts the specified JMenuitem at a given position.
void	insertSeparator(int index)	Inserts a separator at the specified position.
boolean	isMenuComponent(Component c)	Returns true if the specified component exists in the submenu hierarchy.
boolean	isPopupMenuVisible()	Returns true if the menu's popup window is visible.
boolean	isSelected()	Returns true if the menu is currently selected (highlighted).
boolean	isTearOff()	Returns true if the menu can be torn off.
boolean	isTopLevelMenu()	Returns true if the menu is a 'top-level menu', that is, if it is the direct child of a menubar.
void	menuSelectionChanged(boolean isIncluded)	Messaged when the menubar selection changes to activate or deactivate this menu.
protected String	paramString()	Returns a string representation of this JMenu.
protected void	processKeyEvent(KeyEvent evt)	Processes key stroke events such as mnemonics and accelerators.
void	remove(int pos)	Removes the menu item at the specified index from this menu.
void	remove(Component c)	Removes the component c from this menu.
void	remove(JMenuItem item)	Removes the specified menu item from this menu.
void	removeAll()	Removes all menu items from this menu.
void	removeMenuListener(MenuListener l)	Removes a listener for menu events.
void	setAccelerator(KeyStroke keyStroke)	setAccelerator is not defined for JMenu.
void	setComponentOrientation(ComponentOrientation o)	Sets the orientation for this menu and its associated popup menu determined by the ComponentOrientation argument.
void	setDelay(int d)	Sets the suggested delay before the menu's PopupMenu is popped up or down.
void	setMenuLocation(int x, int y)	Sets the location of the popup component.
void	setModel(ButtonModel newModel)	Sets the data model for the "menu button" -- the label that the user clicks to open or close the menu.
void	setPopupMenuVisible(boolean b)	Sets the visibility of the menu's popup.
void	setSelected(boolean b)	Sets the selection status of the menu.
void	updateUI()	Resets the UI property with a value from the current look and feel.

Methods declared in class JMenuItem

actionPropertyChanged, addMenuDragMouseListener, addMenuKeyListener, configurePropertiesFromAction, fireMenuDragMouseDragged, fireMenuDragMouseEntered, fireMenuDragMouseExited, fireMenuDragMouseReleased, fireMenuKeyPressed, fireMenuKeyReleased, fireMenuKeyTyped, getAccelerator, getMenuDragMouseListeners, getMenuKeyListeners, init, isArmed, processKeyEvent, processMenuDragMouseEvent, processMenuKeyEvent, processMouseEvent, removeMenuDragMouseListener, removeMenuKeyListener, setArmed, setEnabled, setUI

Modifier and Type	Method	Description
protected void	actionPropertyChanged(Action action, String propertyName)	Updates the button's state in response to property changes in the associated action.
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)	Sets the properties on this button to match those in the specified Action.
protected void	fireMenuDragMouseDragged(MenuDragMouseEvent event)	Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuDragMouseEntered(MenuDragMouseEvent event)	Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuDragMouseExited(MenuDragMouseEvent event)	Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuDragMouseReleased(MenuDragMouseEvent event)	Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuKeyPressed(MenuKeyEvent event)	Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuKeyReleased(MenuKeyEvent event)	Notifies all listeners that have registered interest for notification on this event type.
protected void	fireMenuKeyTyped(MenuKeyEvent event)	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.
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().
protected void	init(String text, Icon icon)	Initializes the menu item with the specified text and icon.
boolean	isArmed()	Returns whether the menu item is "armed".
void	processKeyEvent(KeyEvent e, MenuElement[] path, MenuSelectionManager manager)	Processes a key event forwarded from the MenuSelectionManager and changes the menu selection, if necessary, by using MenuSelectionManager's API.
void	processMenuDragMouseEvent(MenuDragMouseEvent e)	Handles mouse drag in a menu.
void	processMenuKeyEvent(MenuKeyEvent e)	Handles a keystroke in a menu.
void	processMouseEvent(MouseEvent e, MenuElement[] path, MenuSelectionManager manager)	Processes a mouse event forwarded from the MenuSelectionManager and changes the menu selection, if necessary, by using the MenuSelectionManager's API.
void	removeMenuDragMouseListener(MenuDragMouseListener l)	Removes a MenuDragMouseListener from the menu item.
void	removeMenuKeyListener(MenuKeyListener l)	Removes a MenuKeyListener from the menu item.
void	setArmed(boolean b)	Identifies the menu item as "armed".
void	setEnabled(boolean b)	Enables or disables the menu item.
void	setUI(MenuItemUI ui)	Sets the look and feel object that renders this component.

Methods declared in class AbstractButton

addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, paintBorder, removeActionListener, removeChangeListener, removeItemListener, removeNotify, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

Modifier and Type	Method	Description
void	addActionListener(ActionListener l)	Adds an ActionListener to the button.
void	addChangeListener(ChangeListener l)	Adds a ChangeListener to the button.
protected void	addImpl(Component comp, Object constraints, int index)	Adds the specified component to this container at the specified index, refer to Container.addImpl(Component, Object, int) for a complete description of this method.
void	addItemListener(ItemListener l)	Adds an ItemListener to the checkbox.
protected int	checkHorizontalKey(int key, String exception)	Verify that the key argument is a legal value for the horizontalAlignment and horizontalTextPosition properties.
protected int	checkVerticalKey(int key, String exception)	Verify that the key argument is a legal value for the vertical properties.
protected ActionListener	createActionListener()	Returns ActionListener that is added to model.
protected PropertyChangeListener	createActionPropertyChangeListener(Action a)	Creates and returns a PropertyChangeListener that is responsible for listening for changes from the specified Action and updating the appropriate properties.
protected ChangeListener	createChangeListener()	Subclasses that want to handle ChangeEvents differently can override this to return another ChangeListener implementation.
protected ItemListener	createItemListener()	Returns ItemListener that is added to model.
void	doClick()	Programmatically perform a "click".
protected void	fireActionPerformed(ActionEvent event)	Notifies all listeners that have registered interest for notification on this event type.
protected void	fireItemStateChanged(ItemEvent event)	Notifies all listeners that have registered interest for notification on this event type.
protected void	fireStateChanged()	Notifies all listeners that have registered interest for notification on this event type.
Action	getAction()	Returns the currently set Action for this ActionEvent source, or null if no Action is set.
String	getActionCommand()	Returns the action command for this button.
ActionListener[]	getActionListeners()	Returns an array of all the ActionListeners added to this AbstractButton with addActionListener().
ChangeListener[]	getChangeListeners()	Returns an array of all the ChangeListeners added to this AbstractButton with addChangeListener().
Icon	getDisabledIcon()	Returns the icon used by the button when it's disabled.
Icon	getDisabledSelectedIcon()	Returns the icon used by the button when it's disabled and selected.
int	getDisplayedMnemonicIndex()	Returns the character, as an index, that the look and feel should provide decoration for as representing the mnemonic character.
boolean	getHideActionText()	Returns the value of the hideActionText property, which determines whether the button displays text from the Action.
int	getHorizontalAlignment()	Returns the horizontal alignment of the icon and text.
int	getHorizontalTextPosition()	Returns the horizontal position of the text relative to the icon.
Icon	getIcon()	Returns the default icon.
int	getIconTextGap()	Returns the amount of space between the text and the icon displayed in this button.
ItemListener[]	getItemListeners()	Returns an array of all the ItemListeners added to this AbstractButton with addItemListener().
String	getLabel()	Deprecated. - Replaced by getText
Insets	getMargin()	Returns the margin between the button's border and the label.
int	getMnemonic()	Returns the keyboard mnemonic from the current model.
ButtonModel	getModel()	Returns the model that this button represents.
long	getMultiClickThreshhold()	Gets the amount of time (in milliseconds) required between mouse press events for the button to generate the corresponding action events.
Icon	getPressedIcon()	Returns the pressed icon for the button.
Icon	getRolloverIcon()	Returns the rollover icon for the button.
Icon	getRolloverSelectedIcon()	Returns the rollover selection icon for the button.
Icon	getSelectedIcon()	Returns the selected icon for the button.
Object[]	getSelectedObjects()	Returns an array (length 1) containing the label or null if the button is not selected.
String	getText()	Returns the button's text.
ButtonUI	getUI()	Returns the L&F object that renders this component.
int	getVerticalAlignment()	Returns the vertical alignment of the text and icon.
int	getVerticalTextPosition()	Returns the vertical position of the text relative to the icon.
boolean	imageUpdate(Image img, int infoflags, int x, int y, int w, int h)	If the button icon for the current button state is either null or not an ImageIcon with an Image equal to the passed in Image, return false; otherwise it will delegate to the super-class.
boolean	isBorderPainted()	Gets the borderPainted property.
boolean	isContentAreaFilled()	Gets the contentAreaFilled property.
boolean	isFocusPainted()	Gets the paintFocus property.
boolean	isRolloverEnabled()	Gets the rolloverEnabled property.
protected void	paintBorder(Graphics g)	Paint the button's border if BorderPainted property is true and the button has a border.
void	removeActionListener(ActionListener l)	Removes an ActionListener from the button.
void	removeChangeListener(ChangeListener l)	Removes a ChangeListener from the button.
void	removeItemListener(ItemListener l)	Removes an ItemListener from the button.
void	removeNotify()	Notifies this component that it no longer has a parent component.
void	setAction(Action a)	Sets the Action.
void	setActionCommand(String actionCommand)	Sets the action command for this button.
void	setBorderPainted(boolean b)	Sets the borderPainted property.
void	setContentAreaFilled(boolean b)	Sets the contentAreaFilled property.
void	setDisabledIcon(Icon disabledIcon)	Sets the disabled icon for the button.
void	setDisabledSelectedIcon(Icon disabledSelectedIcon)	Sets the disabled selection icon for the button.
void	setDisplayedMnemonicIndex(int index)	Provides a hint to the look and feel as to which character in the text should be decorated to represent the mnemonic.
void	setFocusPainted(boolean b)	Sets the paintFocus property, which must be true for the focus state to be painted.
void	setHideActionText(boolean hideActionText)	Sets the hideActionText property, which determines whether the button displays text from the Action.
void	setHorizontalAlignment(int alignment)	Sets the horizontal alignment of the icon and text.
void	setHorizontalTextPosition(int textPosition)	Sets the horizontal position of the text relative to the icon.
void	setIcon(Icon defaultIcon)	Sets the button's default icon.
void	setIconTextGap(int iconTextGap)	If both the icon and text properties are set, this property defines the space between them.
void	setLabel(String label)	Deprecated. - Replaced by setText(text)
void	setLayout(LayoutManager mgr)	Sets the layout manager for this container, refer to Container.setLayout(LayoutManager) for a complete description of this method.
void	setMargin(Insets m)	Sets space for margin between the button's border and the label.
void	setMnemonic(char mnemonic)	This method is now obsolete, please use setMnemonic(int) to set the mnemonic for a button.
void	setMnemonic(int mnemonic)	Sets the keyboard mnemonic on the current model.
void	setMultiClickThreshhold(long threshold)	Sets the amount of time (in milliseconds) required between mouse press events for the button to generate the corresponding action events.
void	setPressedIcon(Icon pressedIcon)	Sets the pressed icon for the button.
void	setRolloverEnabled(boolean b)	Sets the rolloverEnabled property, which must be true for rollover effects to occur.
void	setRolloverIcon(Icon rolloverIcon)	Sets the rollover icon for the button.
void	setRolloverSelectedIcon(Icon rolloverSelectedIcon)	Sets the rollover selected icon for the button.
void	setSelectedIcon(Icon selectedIcon)	Sets the selected icon for the button.
void	setText(String text)	Sets the button's text.
void	setUI(ButtonUI ui)	Sets the L&F object that renders this component.
void	setVerticalAlignment(int alignment)	Sets the vertical alignment of the icon and text.
void	setVerticalTextPosition(int textPosition)	Sets the vertical position of the text relative to the icon.

Methods declared in class JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Modifier and Type	Method	Description
void	addAncestorListener(AncestorListener listener)	Registers listener so that it will receive AncestorEvents when it or any of its ancestors move or are made visible or invisible.
void	addNotify()	Notifies this component that it now has a parent component.
void	addVetoableChangeListener(VetoableChangeListener listener)	Adds a VetoableChangeListener to the listener list.
void	computeVisibleRect(Rectangle visibleRect)	Returns the Component's "visible rect rectangle" - the intersection of the visible rectangles for this component and all of its ancestors.
boolean	contains(int x, int y)	Gives the UI delegate an opportunity to define the precise shape of this component for the sake of mouse processing.
JToolTip	createToolTip()	Returns the instance of JToolTip that should be used to display the tooltip.
void	disable()	Deprecated. As of JDK version 1.1, replaced by java.awt.Component.setEnabled(boolean).
void	enable()	Deprecated. As of JDK version 1.1, replaced by java.awt.Component.setEnabled(boolean).
void	firePropertyChange(String propertyName, boolean oldValue, boolean newValue)	Support for reporting bound property changes for boolean properties.
void	firePropertyChange(String propertyName, int oldValue, int newValue)	Support for reporting bound property changes for integer properties.
protected void	fireVetoableChange(String propertyName, Object oldValue, Object newValue)	Supports reporting constrained property changes.
ActionListener	getActionForKeyStroke(KeyStroke aKeyStroke)	Returns the object that will perform the action registered for a given keystroke.
final ActionMap	getActionMap()	Returns the ActionMap used to determine what Action to fire for particular KeyStroke binding.
float	getAlignmentX()	Overrides Container.getAlignmentX to return the horizontal alignment.
float	getAlignmentY()	Overrides Container.getAlignmentY to return the vertical alignment.
AncestorListener[]	getAncestorListeners()	Returns an array of all the ancestor listeners registered on this component.
boolean	getAutoscrolls()	Gets the autoscrolls property.
int	getBaseline(int width, int height)	Returns the baseline.
Component.BaselineResizeBehavior	getBaselineResizeBehavior()	Returns an enum indicating how the baseline of the component changes as the size changes.
Border	getBorder()	Returns the border of this component or null if no border is currently set.
Rectangle	getBounds(Rectangle rv)	Stores the bounds of this component into "return value" rv and returns rv.
final Object	getClientProperty(Object key)	Returns the value of the property with the specified key.
protected Graphics	getComponentGraphics(Graphics g)	Returns the graphics object used to paint this component.
JPopupMenu	getComponentPopupMenu()	Returns JPopupMenu that assigned for this component.
int	getConditionForKeyStroke(KeyStroke aKeyStroke)	Returns the condition that determines whether a registered action occurs in response to the specified keystroke.
int	getDebugGraphicsOptions()	Returns the state of graphics debugging.
static Locale	getDefaultLocale()	Returns the default locale used to initialize each JComponent's locale property upon creation.
FontMetrics	getFontMetrics(Font font)	Gets the FontMetrics for the specified Font.
Graphics	getGraphics()	Returns this component's graphics context, which lets you draw on a component.
int	getHeight()	Returns the current height of this component.
boolean	getInheritsPopupMenu()	Returns true if the JPopupMenu should be inherited from the parent.
final InputMap	getInputMap()	Returns the InputMap that is used when the component has focus.
final InputMap	getInputMap(int condition)	Returns the InputMap that is used during condition.
InputVerifier	getInputVerifier()	Returns the input verifier for this component.
Insets	getInsets()	If a border has been set on this component, returns the border's insets; otherwise calls super.getInsets.
Insets	getInsets(Insets insets)	Returns an Insets object containing this component's inset values.
<T extends EventListener> T[]	getListeners(Class<T> listenerType)	Returns an array of all the objects currently registered as FooListeners upon this JComponent.
Point	getLocation(Point rv)	Stores the x,y origin of this component into "return value" rv and returns rv.
Dimension	getMaximumSize()	If the maximum size has been set to a non-null value just returns it.
Dimension	getMinimumSize()	If the minimum size has been set to a non-null value just returns it.
Component	getNextFocusableComponent()	Deprecated. As of 1.4, replaced by FocusTraversalPolicy.
Point	getPopupLocation(MouseEvent event)	Returns the preferred location to display the popup menu in this component's coordinate system.
Dimension	getPreferredSize()	If the preferredSize has been set to a non-null value just returns it.
KeyStroke[]	getRegisteredKeyStrokes()	Returns the KeyStrokes that will initiate registered actions.
JRootPane	getRootPane()	Returns the JRootPane ancestor for this component.
Dimension	getSize(Dimension rv)	Stores the width/height of this component into "return value" rv and returns rv.
Point	getToolTipLocation(MouseEvent event)	Returns the tooltip location in this component's coordinate system.
String	getToolTipText()	Returns the tooltip string that has been set with setToolTipText.
String	getToolTipText(MouseEvent event)	Returns the string to be used as the tooltip for event.
Container	getTopLevelAncestor()	Returns the top-level ancestor of this component (the containing Window) or null if this component has not been added to any container.
TransferHandler	getTransferHandler()	Gets the transferHandler property.
boolean	getVerifyInputWhenFocusTarget()	Returns the value that indicates whether the input verifier for the current focus owner will be called before this component requests focus.
VetoableChangeListener[]	getVetoableChangeListeners()	Returns an array of all the vetoable change listeners registered on this component.
Rectangle	getVisibleRect()	Returns the Component's "visible rectangle" - the intersection of this component's visible rectangle, new Rectangle(0, 0, getWidth(), getHeight()), and all of its ancestors' visible rectangles.
int	getWidth()	Returns the current width of this component.
int	getX()	Returns the current x coordinate of the component's origin.
int	getY()	Returns the current y coordinate of the component's origin.
void	grabFocus()	Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.
void	hide()	Deprecated.
boolean	isDoubleBuffered()	Returns whether this component should use a buffer to paint.
static boolean	isLightweightComponent(Component c)	Returns true if this component is lightweight, that is, if it doesn't have a native window system peer.
boolean	isManagingFocus()	Deprecated. As of 1.4, replaced by Component.setFocusTraversalKeys(int, Set) and Container.setFocusCycleRoot(boolean).
boolean	isOpaque()	Returns true if this component is completely opaque.
boolean	isOptimizedDrawingEnabled()	Returns true if this component tiles its children -- that is, if it can guarantee that the children will not overlap.
final boolean	isPaintingForPrint()	Returns true if the current painting operation on this component is part of a print operation.
protected boolean	isPaintingOrigin()	Returns true if a paint triggered on a child component should cause painting to originate from this Component, or one of its ancestors.
boolean	isPaintingTile()	Returns true if the component is currently painting a tile.
boolean	isRequestFocusEnabled()	Returns true if this JComponent should get focus; otherwise returns false.
boolean	isValidateRoot()	If this method returns true, revalidate calls by descendants of this component will cause the entire tree beginning with this root to be validated.
void	paint(Graphics g)	Invoked by Swing to draw components.
protected void	paintChildren(Graphics g)	Paints this component's children.
protected void	paintComponent(Graphics g)	Calls the UI delegate's paint method, if the UI delegate is non-null.
void	paintImmediately(int x, int y, int w, int h)	Paints the specified region in this component and all of its descendants that overlap the region, immediately.
void	paintImmediately(Rectangle r)	Paints the specified region now.
void	print(Graphics g)	Invoke this method to print the component to the specified Graphics.
void	printAll(Graphics g)	Invoke this method to print the component.
protected void	printBorder(Graphics g)	Prints the component's border.
protected void	printChildren(Graphics g)	Prints this component's children.
protected void	printComponent(Graphics g)	This is invoked during a printing operation.
protected void	processComponentKeyEvent(KeyEvent e)	Processes any key events that the component itself recognizes.
protected boolean	processKeyBinding(KeyStroke ks, KeyEvent e, int condition, boolean pressed)	Invoked to process the key bindings for ks as the result of the KeyEvent e.
protected void	processMouseEvent(MouseEvent e)	Processes mouse events occurring on this component by dispatching them to any registered MouseListener objects, refer to Component.processMouseEvent(MouseEvent) for a complete description of this method.
protected void	processMouseMotionEvent(MouseEvent e)	Processes mouse motion events, such as MouseEvent.MOUSE_DRAGGED.
final void	putClientProperty(Object key, Object value)	Adds an arbitrary key/value "client property" to this component.
void	registerKeyboardAction(ActionListener anAction, String aCommand, KeyStroke aKeyStroke, int aCondition)	This method is now obsolete, please use a combination of getActionMap() and getInputMap() for similar behavior.
void	registerKeyboardAction(ActionListener anAction, KeyStroke aKeyStroke, int aCondition)	This method is now obsolete, please use a combination of getActionMap() and getInputMap() for similar behavior.
void	removeAncestorListener(AncestorListener listener)	Unregisters listener so that it will no longer receive AncestorEvents.
void	removeVetoableChangeListener(VetoableChangeListener listener)	Removes a VetoableChangeListener from the listener list.
void	repaint(long tm, int x, int y, int width, int height)	Adds the specified region to the dirty region list if the component is showing.
void	repaint(Rectangle r)	Adds the specified region to the dirty region list if the component is showing.
boolean	requestDefaultFocus()	Deprecated. As of 1.4, replaced by FocusTraversalPolicy.getDefaultComponent(Container).requestFocus()
void	requestFocus()	Requests that this Component gets the input focus.
boolean	requestFocus(boolean temporary)	Requests that this Component gets the input focus.
boolean	requestFocusInWindow()	Requests that this Component gets the input focus.
protected boolean	requestFocusInWindow(boolean temporary)	Requests that this Component gets the input focus.
void	resetKeyboardActions()	Unregisters all the bindings in the first tier InputMaps and ActionMap.
void	reshape(int x, int y, int w, int h)	Deprecated. As of JDK 5, replaced by Component.setBounds(int, int, int, int).
void	revalidate()	Supports deferred automatic layout.
void	scrollRectToVisible(Rectangle aRect)	Forwards the scrollRectToVisible() message to the JComponent's parent.
final void	setActionMap(ActionMap am)	Sets the ActionMap to am.
void	setAlignmentX(float alignmentX)	Sets the horizontal alignment.
void	setAlignmentY(float alignmentY)	Sets the vertical alignment.
void	setAutoscrolls(boolean autoscrolls)	Sets the autoscrolls property.
void	setBackground(Color bg)	Sets the background color of this component.
void	setBorder(Border border)	Sets the border of this component.
void	setComponentPopupMenu(JPopupMenu popup)	Sets the JPopupMenu for this JComponent.
void	setDebugGraphicsOptions(int debugOptions)	Enables or disables diagnostic information about every graphics operation performed within the component or one of its children.
static void	setDefaultLocale(Locale l)	Sets the default locale used to initialize each JComponent's locale property upon creation.
void	setDoubleBuffered(boolean aFlag)	Sets whether this component should use a buffer to paint.
void	setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes)	Sets the focus traversal keys for a given traversal operation for this Component.
void	setFont(Font font)	Sets the font for this component.
void	setForeground(Color fg)	Sets the foreground color of this component.
void	setInheritsPopupMenu(boolean value)	Sets whether or not getComponentPopupMenu should delegate to the parent if this component does not have a JPopupMenu assigned to it.
final void	setInputMap(int condition, InputMap map)	Sets the InputMap to use under the condition condition to map.
void	setInputVerifier(InputVerifier inputVerifier)	Sets the input verifier for this component.
void	setMaximumSize(Dimension maximumSize)	Sets the maximum size of this component to a constant value.
void	setMinimumSize(Dimension minimumSize)	Sets the minimum size of this component to a constant value.
void	setNextFocusableComponent(Component aComponent)	Deprecated. As of 1.4, replaced by FocusTraversalPolicy
void	setOpaque(boolean isOpaque)	If true the component paints every pixel within its bounds.
void	setPreferredSize(Dimension preferredSize)	Sets the preferred size of this component.
void	setRequestFocusEnabled(boolean requestFocusEnabled)	Provides a hint as to whether or not this JComponent should get focus.
void	setToolTipText(String text)	Registers the text to display in a tool tip.
void	setTransferHandler(TransferHandler newHandler)	Sets the TransferHandler, which provides support for transfer of data into and out of this component via cut/copy/paste and drag and drop.
protected void	setUI(ComponentUI newUI)	Sets the look and feel delegate for this component.
void	setVerifyInputWhenFocusTarget(boolean verifyInputWhenFocusTarget)	Sets the value to indicate whether input verifier for the current focus owner will be called before this component requests focus.
void	setVisible(boolean aFlag)	Makes the component visible or invisible.
void	unregisterKeyboardAction(KeyStroke aKeyStroke)	This method is now obsolete.
void	update(Graphics g)	Calls paint.

Methods declared in class Container

add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTree

Modifier and Type	Method	Description
void	add(Component comp, Object constraints)	Adds the specified component to the end of this container.
void	add(Component comp, Object constraints, int index)	Adds the specified component to this container with the specified constraints at the specified index.
Component	add(String name, Component comp)	Adds the specified component to this container.
void	addContainerListener(ContainerListener l)	Adds the specified container listener to receive container events from this container.
void	addPropertyChangeListener(PropertyChangeListener listener)	Adds a PropertyChangeListener to the listener list.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener)	Adds a PropertyChangeListener to the listener list for a specific property.
boolean	areFocusTraversalKeysSet(int id)	Returns whether the Set of focus traversal keys for the given focus traversal operation has been explicitly defined for this Container.
int	countComponents()	Deprecated. As of JDK version 1.1, replaced by getComponentCount().
void	deliverEvent(Event e)	Deprecated. As of JDK version 1.1, replaced by dispatchEvent(AWTEvent e)
void	doLayout()	Causes this container to lay out its components.
Component	findComponentAt(int x, int y)	Locates the visible child component that contains the specified position.
Component	findComponentAt(Point p)	Locates the visible child component that contains the specified point.
Component	getComponent(int n)	Gets the nth component in this container.
Component	getComponentAt(int x, int y)	Locates the component that contains the x,y position.
Component	getComponentAt(Point p)	Gets the component that contains the specified point.
int	getComponentCount()	Gets the number of components in this panel.
Component[]	getComponents()	Gets all the components in this container.
int	getComponentZOrder(Component comp)	Returns the z-order index of the component inside the container.
ContainerListener[]	getContainerListeners()	Returns an array of all the container listeners registered on this container.
Set<AWTKeyStroke>	getFocusTraversalKeys(int id)	Returns the Set of focus traversal keys for a given traversal operation for this Container.
FocusTraversalPolicy	getFocusTraversalPolicy()	Returns the focus traversal policy that will manage keyboard traversal of this Container's children, or null if this Container is not a focus cycle root.
LayoutManager	getLayout()	Gets the layout manager for this container.
Point	getMousePosition(boolean allowChildren)	Returns the position of the mouse pointer in this Container's coordinate space if the Container is under the mouse pointer, otherwise returns null.
Insets	insets()	Deprecated. As of JDK version 1.1, replaced by getInsets().
void	invalidate()	Invalidates the container.
boolean	isAncestorOf(Component c)	Checks if the component is contained in the component hierarchy of this container.
boolean	isFocusCycleRoot()	Returns whether this Container is the root of a focus traversal cycle.
boolean	isFocusCycleRoot(Container container)	Returns whether the specified Container is the focus cycle root of this Container's focus traversal cycle.
final boolean	isFocusTraversalPolicyProvider()	Returns whether this container provides focus traversal policy.
boolean	isFocusTraversalPolicySet()	Returns whether the focus traversal policy has been explicitly set for this Container.
void	layout()	Deprecated. As of JDK version 1.1, replaced by doLayout().
void	list(PrintStream out, int indent)	Prints a listing of this container to the specified output stream.
void	list(PrintWriter out, int indent)	Prints out a list, starting at the specified indentation, to the specified print writer.
Component	locate(int x, int y)	Deprecated. As of JDK version 1.1, replaced by getComponentAt(int, int).
Dimension	minimumSize()	Deprecated. As of JDK version 1.1, replaced by getMinimumSize().
void	paintComponents(Graphics g)	Paints each of the components in this container.
Dimension	preferredSize()	Deprecated. As of JDK version 1.1, replaced by getPreferredSize().
void	printComponents(Graphics g)	Prints each of the components in this container.
protected void	processContainerEvent(ContainerEvent e)	Processes container events occurring on this container by dispatching them to any registered ContainerListener objects.
protected void	processEvent(AWTEvent e)	Processes events on this container.
void	removeContainerListener(ContainerListener l)	Removes the specified container listener so it no longer receives container events from this container.
void	setComponentZOrder(Component comp, int index)	Moves the specified component to the specified z-order index in the container.
void	setFocusCycleRoot(boolean focusCycleRoot)	Sets whether this Container is the root of a focus traversal cycle.
void	setFocusTraversalPolicy(FocusTraversalPolicy policy)	Sets the focus traversal policy that will manage keyboard traversal of this Container's children, if this Container is a focus cycle root.
final void	setFocusTraversalPolicyProvider(boolean provider)	Sets whether this container will be used to provide focus traversal policy.
void	transferFocusDownCycle()	Transfers the focus down one focus traversal cycle.
void	validate()	Validates this container and all of its subcomponents.
protected void	validateTree()	Recursively descends the container tree and recomputes the layout for any subtrees marked as needing it (those marked as invalid).

Methods declared in class Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Modifier and Type	Method	Description
boolean	action(Event evt, Object what)	Deprecated. As of JDK version 1.1, should register this component as ActionListener on component which fires action events.
void	add(PopupMenu popup)	Adds the specified popup menu to the component.
void	addComponentListener(ComponentListener l)	Adds the specified component listener to receive component events from this component.
void	addFocusListener(FocusListener l)	Adds the specified focus listener to receive focus events from this component when this component gains input focus.
void	addHierarchyBoundsListener(HierarchyBoundsListener l)	Adds the specified hierarchy bounds listener to receive hierarchy bounds events from this component when the hierarchy to which this container belongs changes.
void	addHierarchyListener(HierarchyListener l)	Adds the specified hierarchy listener to receive hierarchy changed events from this component when the hierarchy to which this container belongs changes.
void	addInputMethodListener(InputMethodListener l)	Adds the specified input method listener to receive input method events from this component.
void	addKeyListener(KeyListener l)	Adds the specified key listener to receive key events from this component.
void	addMouseListener(MouseListener l)	Adds the specified mouse listener to receive mouse events from this component.
void	addMouseMotionListener(MouseMotionListener l)	Adds the specified mouse motion listener to receive mouse motion events from this component.
void	addMouseWheelListener(MouseWheelListener l)	Adds the specified mouse wheel listener to receive mouse wheel events from this component.
Rectangle	bounds()	Deprecated. As of JDK version 1.1, replaced by getBounds().
int	checkImage(Image image, int width, int height, ImageObserver observer)	Returns the status of the construction of a screen representation of the specified image.
int	checkImage(Image image, ImageObserver observer)	Returns the status of the construction of a screen representation of the specified image.
protected AWTEvent	coalesceEvents(AWTEvent existingEvent, AWTEvent newEvent)	Potentially coalesce an event being posted with an existing event.
boolean	contains(Point p)	Checks whether this component "contains" the specified point, where the point's x and y coordinates are defined to be relative to the coordinate system of this component.
Image	createImage(int width, int height)	Creates an off-screen drawable image to be used for double buffering.
Image	createImage(ImageProducer producer)	Creates an image from the specified image producer.
VolatileImage	createVolatileImage(int width, int height)	Creates a volatile off-screen drawable image to be used for double buffering.
VolatileImage	createVolatileImage(int width, int height, ImageCapabilities caps)	Creates a volatile off-screen drawable image, with the given capabilities.
protected final void	disableEvents(long eventsToDisable)	Disables the events defined by the specified event mask parameter from being delivered to this component.
final void	dispatchEvent(AWTEvent e)	Dispatches an event to this component or one of its sub components.
void	enable(boolean b)	Deprecated. As of JDK version 1.1, replaced by setEnabled(boolean).
protected final void	enableEvents(long eventsToEnable)	Enables the events defined by the specified event mask parameter to be delivered to this component.
void	enableInputMethods(boolean enable)	Enables or disables input method support for this component.
void	firePropertyChange(String propertyName, byte oldValue, byte newValue)	Reports a bound property change.
void	firePropertyChange(String propertyName, char oldValue, char newValue)	Reports a bound property change.
void	firePropertyChange(String propertyName, double oldValue, double newValue)	Reports a bound property change.
void	firePropertyChange(String propertyName, float oldValue, float newValue)	Reports a bound property change.
void	firePropertyChange(String propertyName, long oldValue, long newValue)	Reports a bound property change.
void	firePropertyChange(String propertyName, short oldValue, short newValue)	Reports a bound property change.
protected void	firePropertyChange(String propertyName, Object oldValue, Object newValue)	Support for reporting bound property changes for Object properties.
Color	getBackground()	Gets the background color of this component.
Rectangle	getBounds()	Gets the bounds of this component in the form of a Rectangle object.
ColorModel	getColorModel()	Gets the instance of ColorModel used to display the component on the output device.
ComponentListener[]	getComponentListeners()	Returns an array of all the component listeners registered on this component.
ComponentOrientation	getComponentOrientation()	Retrieves the language-sensitive orientation that is to be used to order the elements or text within this component.
Cursor	getCursor()	Gets the cursor set in the component.
DropTarget	getDropTarget()	Gets the DropTarget associated with this Component.
Container	getFocusCycleRootAncestor()	Returns the Container which is the focus cycle root of this Component's focus traversal cycle.
FocusListener[]	getFocusListeners()	Returns an array of all the focus listeners registered on this component.
boolean	getFocusTraversalKeysEnabled()	Returns whether focus traversal keys are enabled for this Component.
Font	getFont()	Gets the font of this component.
Color	getForeground()	Gets the foreground color of this component.
GraphicsConfiguration	getGraphicsConfiguration()	Gets the GraphicsConfiguration associated with this Component.
HierarchyBoundsListener[]	getHierarchyBoundsListeners()	Returns an array of all the hierarchy bounds listeners registered on this component.
HierarchyListener[]	getHierarchyListeners()	Returns an array of all the hierarchy listeners registered on this component.
boolean	getIgnoreRepaint()	Returns whether or not paint messages received from the operating system should be ignored.
InputContext	getInputContext()	Gets the input context used by this component for handling the communication with input methods when text is entered in this component.
InputMethodListener[]	getInputMethodListeners()	Returns an array of all the input method listeners registered on this component.
InputMethodRequests	getInputMethodRequests()	Gets the input method request handler which supports requests from input methods for this component.
KeyListener[]	getKeyListeners()	Returns an array of all the key listeners registered on this component.
Locale	getLocale()	Gets the locale of this component.
Point	getLocation()	Gets the location of this component in the form of a point specifying the component's top-left corner.
Point	getLocationOnScreen()	Gets the location of this component in the form of a point specifying the component's top-left corner in the screen's coordinate space.
MouseListener[]	getMouseListeners()	Returns an array of all the mouse listeners registered on this component.
MouseMotionListener[]	getMouseMotionListeners()	Returns an array of all the mouse motion listeners registered on this component.
Point	getMousePosition()	Returns the position of the mouse pointer in this Component's coordinate space if the Component is directly under the mouse pointer, otherwise returns null.
MouseWheelListener[]	getMouseWheelListeners()	Returns an array of all the mouse wheel listeners registered on this component.
String	getName()	Gets the name of the component.
Container	getParent()	Gets the parent of this component.
PropertyChangeListener[]	getPropertyChangeListeners()	Returns an array of all the property change listeners registered on this component.
PropertyChangeListener[]	getPropertyChangeListeners(String propertyName)	Returns an array of all the listeners which have been associated with the named property.
Dimension	getSize()	Returns the size of this component in the form of a Dimension object.
Toolkit	getToolkit()	Gets the toolkit of this component.
final Object	getTreeLock()	Gets this component's locking object (the object that owns the thread synchronization monitor) for AWT component-tree and layout operations.
boolean	gotFocus(Event evt, Object what)	Deprecated. As of JDK version 1.1, replaced by processFocusEvent(FocusEvent).
boolean	handleEvent(Event evt)	Deprecated. As of JDK version 1.1 replaced by processEvent(AWTEvent).
boolean	hasFocus()	Returns true if this Component is the focus owner.
boolean	inside(int x, int y)	Deprecated. As of JDK version 1.1, replaced by contains(int, int).
boolean	isBackgroundSet()	Returns whether the background color has been explicitly set for this Component.
boolean	isCursorSet()	Returns whether the cursor has been explicitly set for this Component.
boolean	isDisplayable()	Determines whether this component is displayable.
boolean	isEnabled()	Determines whether this component is enabled.
boolean	isFocusable()	Returns whether this Component can be focused.
boolean	isFocusOwner()	Returns true if this Component is the focus owner.
boolean	isFocusTraversable()	Deprecated. As of 1.4, replaced by isFocusable().
boolean	isFontSet()	Returns whether the font has been explicitly set for this Component.
boolean	isForegroundSet()	Returns whether the foreground color has been explicitly set for this Component.
boolean	isLightweight()	A lightweight component doesn't have a native toolkit peer.
boolean	isMaximumSizeSet()	Returns true if the maximum size has been set to a non-null value otherwise returns false.
boolean	isMinimumSizeSet()	Returns whether or not setMinimumSize has been invoked with a non-null value.
boolean	isPreferredSizeSet()	Returns true if the preferred size has been set to a non-null value otherwise returns false.
boolean	isShowing()	Determines whether this component is showing on screen.
boolean	isValid()	Determines whether this component is valid.
boolean	isVisible()	Determines whether this component should be visible when its parent is visible.
boolean	keyDown(Event evt, int key)	Deprecated. As of JDK version 1.1, replaced by processKeyEvent(KeyEvent).
boolean	keyUp(Event evt, int key)	Deprecated. As of JDK version 1.1, replaced by processKeyEvent(KeyEvent).
void	list()	Prints a listing of this component to the standard system output stream System.out.
void	list(PrintStream out)	Prints a listing of this component to the specified output stream.
void	list(PrintWriter out)	Prints a listing to the specified print writer.
Point	location()	Deprecated. As of JDK version 1.1, replaced by getLocation().
boolean	lostFocus(Event evt, Object what)	Deprecated. As of JDK version 1.1, replaced by processFocusEvent(FocusEvent).
boolean	mouseDown(Event evt, int x, int y)	Deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
boolean	mouseDrag(Event evt, int x, int y)	Deprecated. As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).
boolean	mouseEnter(Event evt, int x, int y)	Deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
boolean	mouseExit(Event evt, int x, int y)	Deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
boolean	mouseMove(Event evt, int x, int y)	Deprecated. As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).
boolean	mouseUp(Event evt, int x, int y)	Deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
void	move(int x, int y)	Deprecated. As of JDK version 1.1, replaced by setLocation(int, int).
void	nextFocus()	Deprecated. As of JDK version 1.1, replaced by transferFocus().
void	paintAll(Graphics g)	Paints this component and all of its subcomponents.
boolean	postEvent(Event e)	Deprecated. As of JDK version 1.1, replaced by dispatchEvent(AWTEvent).
boolean	prepareImage(Image image, int width, int height, ImageObserver observer)	Prepares an image for rendering on this component at the specified width and height.
boolean	prepareImage(Image image, ImageObserver observer)	Prepares an image for rendering on this component.
protected void	processComponentEvent(ComponentEvent e)	Processes component events occurring on this component by dispatching them to any registered ComponentListener objects.
protected void	processFocusEvent(FocusEvent e)	Processes focus events occurring on this component by dispatching them to any registered FocusListener objects.
protected void	processHierarchyBoundsEvent(HierarchyEvent e)	Processes hierarchy bounds events occurring on this component by dispatching them to any registered HierarchyBoundsListener objects.
protected void	processHierarchyEvent(HierarchyEvent e)	Processes hierarchy events occurring on this component by dispatching them to any registered HierarchyListener objects.
protected void	processInputMethodEvent(InputMethodEvent e)	Processes input method events occurring on this component by dispatching them to any registered InputMethodListener objects.
protected void	processMouseWheelEvent(MouseWheelEvent e)	Processes mouse wheel events occurring on this component by dispatching them to any registered MouseWheelListener objects.
void	remove(MenuComponent popup)	Removes the specified popup menu from the component.
void	removeComponentListener(ComponentListener l)	Removes the specified component listener so that it no longer receives component events from this component.
void	removeFocusListener(FocusListener l)	Removes the specified focus listener so that it no longer receives focus events from this component.
void	removeHierarchyBoundsListener(HierarchyBoundsListener l)	Removes the specified hierarchy bounds listener so that it no longer receives hierarchy bounds events from this component.
void	removeHierarchyListener(HierarchyListener l)	Removes the specified hierarchy listener so that it no longer receives hierarchy changed events from this component.
void	removeInputMethodListener(InputMethodListener l)	Removes the specified input method listener so that it no longer receives input method events from this component.
void	removeKeyListener(KeyListener l)	Removes the specified key listener so that it no longer receives key events from this component.
void	removeMouseListener(MouseListener l)	Removes the specified mouse listener so that it no longer receives mouse events from this component.
void	removeMouseMotionListener(MouseMotionListener l)	Removes the specified mouse motion listener so that it no longer receives mouse motion events from this component.
void	removeMouseWheelListener(MouseWheelListener l)	Removes the specified mouse wheel listener so that it no longer receives mouse wheel events from this component.
void	removePropertyChangeListener(PropertyChangeListener listener)	Removes a PropertyChangeListener from the listener list.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener)	Removes a PropertyChangeListener from the listener list for a specific property.
void	repaint()	Repaints this component.
void	repaint(int x, int y, int width, int height)	Repaints the specified rectangle of this component.
void	repaint(long tm)	Repaints the component.
protected boolean	requestFocus(boolean temporary, FocusEvent.Cause cause)	Requests by the reason of cause that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.
void	requestFocus(FocusEvent.Cause cause)	Requests by the reason of cause that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.
boolean	requestFocusInWindow(FocusEvent.Cause cause)	Requests by the reason of cause that this Component get the input focus, if this Component's top-level ancestor is already the focused Window.
void	resize(int width, int height)	Deprecated. As of JDK version 1.1, replaced by setSize(int, int).
void	resize(Dimension d)	Deprecated. As of JDK version 1.1, replaced by setSize(Dimension).
void	setBounds(int x, int y, int width, int height)	Moves and resizes this component.
void	setBounds(Rectangle r)	Moves and resizes this component to conform to the new bounding rectangle r.
void	setCursor(Cursor cursor)	Sets the cursor image to the specified cursor.
void	setDropTarget(DropTarget dt)	Associate a DropTarget with this component.
void	setFocusable(boolean focusable)	Sets the focusable state of this Component to the specified value.
void	setFocusTraversalKeysEnabled(boolean focusTraversalKeysEnabled)	Sets whether focus traversal keys are enabled for this Component.
void	setIgnoreRepaint(boolean ignoreRepaint)	Sets whether or not paint messages received from the operating system should be ignored.
void	setLocale(Locale l)	Sets the locale of this component.
void	setLocation(int x, int y)	Moves this component to a new location.
void	setLocation(Point p)	Moves this component to a new location.
void	setMixingCutoutShape(Shape shape)	Sets a 'mixing-cutout' shape for this lightweight component.
void	setName(String name)	Sets the name of the component to the specified string.
void	setSize(int width, int height)	Resizes this component so that it has width width and height height.
void	setSize(Dimension d)	Resizes this component so that it has width d.width and height d.height.
void	show()	Deprecated. As of JDK version 1.1, replaced by setVisible(boolean).
void	show(boolean b)	Deprecated. As of JDK version 1.1, replaced by setVisible(boolean).
Dimension	size()	Deprecated. As of JDK version 1.1, replaced by getSize().
String	toString()	Returns a string representation of this component and its values.
void	transferFocus()	Transfers the focus to the next component, as though this Component were the focus owner.
void	transferFocusBackward()	Transfers the focus to the previous component, as though this Component were the focus owner.
void	transferFocusUpCycle()	Transfers the focus up one focus traversal cycle.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Modifier and Type	Method	Description
protected Object	clone()	Creates and returns a copy of this object.
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
final Class<?>	getClass()	Returns the runtime class of this Object.
int	hashCode()	Returns a hash code value for this object.
final void	notify()	Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll()	Wakes up all threads that are waiting on this object's monitor.
final void	wait()	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
final void	wait(long timeoutMillis)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
final void	wait(long timeoutMillis, int nanos)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Field Details

popupListener

protected JMenu.WinListener popupListener

The window-closing listener for the popup.

See Also:

• JMenu.WinListener

Constructor Details

JMenu

public JMenu()

Constructs a new JMenu with no text.

JMenu

public JMenu(String s)

Constructs a new JMenu with the supplied string as its text.

Parameters:

s - the text for the menu label

JMenu

public JMenu(Action a)

Constructs a menu whose properties are taken from the Action supplied.

Parameters:

a - an Action

Since:

1.3

JMenu

public JMenu(String s,
 boolean b)

Constructs a new JMenu with the supplied string as its text and specified as a tear-off menu or not.

Parameters:

s - the text for the menu label

b - can the menu be torn off (not yet implemented)

Method Details

updateUI

public void updateUI()

Resets the UI property with a value from the current look and feel.

Overrides:

updateUI in class JMenuItem

See Also:

• JComponent.updateUI()

getUIClassID

@BeanProperty(bound=false)
public String getUIClassID()

Returns the name of the L&F class that renders this component.

Overrides:

getUIClassID in class JMenuItem

Returns:

the string "MenuUI"

See Also:

• JComponent.getUIClassID()
• UIDefaults.getUI(JComponent)

setModel

public void setModel(ButtonModel newModel)

Sets the data model for the "menu button" -- the label that the user clicks to open or close the menu.

Overrides:

setModel in class AbstractButton

Parameters:

newModel - the ButtonModel

See Also:

• AbstractButton.getModel()

isSelected

public boolean isSelected()

Returns true if the menu is currently selected (highlighted).

Overrides:

isSelected in class AbstractButton

Returns:

true if the menu is selected, else false

setSelected

@BeanProperty(expert=true,
              hidden=true,
              description="When the menu is selected, its popup child is shown.")
public void setSelected(boolean b)

Sets the selection status of the menu.

Overrides:

setSelected in class AbstractButton

Parameters:

b - true to select (highlight) the menu; false to de-select the menu

isPopupMenuVisible

public boolean isPopupMenuVisible()

Returns true if the menu's popup window is visible.

Returns:

true if the menu is visible, else false

setPopupMenuVisible

@BeanProperty(bound=false,
              expert=true,
              hidden=true,
              description="The popup menu's visibility")
public void setPopupMenuVisible(boolean b)

Sets the visibility of the menu's popup. If the menu is not enabled, this method will have no effect.

Parameters:

b - a boolean value -- true to make the menu visible, false to hide it

getPopupMenuOrigin

protected Point getPopupMenuOrigin()

Computes the origin for the JMenu's popup menu. This method uses Look and Feel properties named Menu.menuPopupOffsetX, Menu.menuPopupOffsetY, Menu.submenuPopupOffsetX, and Menu.submenuPopupOffsetY to adjust the exact location of popup.

Returns:

a Point in the coordinate space of the menu which should be used as the origin of the JMenu's popup menu

Since:

1.3

getDelay

public int getDelay()

Returns the suggested delay, in milliseconds, before submenus are popped up or down. Each look and feel (L&F) may determine its own policy for observing the delay property. In most cases, the delay is not observed for top level menus or while dragging. The default for delay is 0. This method is a property of the look and feel code and is used to manage the idiosyncrasies of the various UI implementations.

Returns:

the delay property

setDelay

@BeanProperty(bound=false,
              expert=true,
              description="The delay between menu selection and making the popup menu visible")
public void setDelay(int d)

Sets the suggested delay before the menu's PopupMenu is popped up or down. Each look and feel (L&F) may determine it's own policy for observing the delay property. In most cases, the delay is not observed for top level menus or while dragging. This method is a property of the look and feel code and is used to manage the idiosyncrasies of the various UI implementations.

Parameters:

d - the number of milliseconds to delay

Throws:

IllegalArgumentException - if d is less than 0

setMenuLocation

public void setMenuLocation(int x,
 int y)

Sets the location of the popup component.

Parameters:

x - the x coordinate of the popup's new position

y - the y coordinate of the popup's new position

add

public JMenuItem add(JMenuItem menuItem)

Appends a menu item to the end of this menu. Returns the menu item added.

Parameters:

menuItem - the JMenuitem to be added

Returns:

the JMenuItem added

add

public Component add(Component c)

Appends a component to the end of this menu. Returns the component added.

Overrides:

add in class Container

Parameters:

c - the Component to add

Returns:

the Component added

See Also:

• Container.addImpl(Component, Object, int)
• Container.invalidate()
• Container.validate()
• JComponent.revalidate()

add

public Component add(Component c,
 int index)

Adds the specified component to this container at the given position. If index equals -1, the component will be appended to the end.

Overrides:

add in class Container

Parameters:

c - the Component to add

index - the position at which to insert the component

Returns:

the Component added

See Also:

• remove(JMenuItem)
• Container.add(Component, int)

add

public JMenuItem add(String s)

Creates a new menu item with the specified text and appends it to the end of this menu.

Parameters:

s - the string for the menu item to be added

Returns:

the new JMenuItem

add

public JMenuItem add(Action a)

Creates a new menu item attached to the specified Action object and appends it to the end of this menu.

Parameters:

a - the Action for the menu item to be added

Returns:

the new JMenuItem

See Also:

• Action

createActionComponent

protected JMenuItem createActionComponent(Action a)

Factory method which creates the JMenuItem for Actions added to the JMenu.

Parameters:

a - the Action for the menu item to be added

Returns:

the new menu item

Since:

1.3

See Also:

• Action

createActionChangeListener

protected PropertyChangeListener createActionChangeListener(JMenuItem b)

Returns a properly configured PropertyChangeListener which updates the control as changes to the Action occur.

Parameters:

b - a menu item for which to create a PropertyChangeListener

Returns:

a PropertyChangeListener for b

addSeparator

public void addSeparator()

Appends a new separator to the end of the menu.

insert

public void insert(String s,
 int pos)

Inserts a new menu item with the specified text at a given position.

Parameters:

s - the text for the menu item to add

pos - an integer specifying the position at which to add the new menu item

Throws:

IllegalArgumentException - when the value of pos < 0

insert

public JMenuItem insert(JMenuItem mi,
 int pos)

Inserts the specified JMenuitem at a given position.

Parameters:

mi - the JMenuitem to add

pos - an integer specifying the position at which to add the new JMenuitem

Returns:

the new menu item

Throws:

IllegalArgumentException - if the value of pos < 0

insert

public JMenuItem insert(Action a,
 int pos)

Inserts a new menu item attached to the specified Action object at a given position.

Parameters:

a - the Action object for the menu item to add

pos - an integer specifying the position at which to add the new menu item

Returns:

the new menu item

Throws:

IllegalArgumentException - if the value of pos < 0

insertSeparator

public void insertSeparator(int index)

Inserts a separator at the specified position.

Parameters:

index - an integer specifying the position at which to insert the menu separator

Throws:

IllegalArgumentException - if the value of index < 0

getItem

public JMenuItem getItem(int pos)

Returns the JMenuItem at the specified position. If the component at pos is not a menu item, null is returned. This method is included for AWT compatibility.

Parameters:

pos - an integer specifying the position

Returns:

the menu item at the specified position; or null if the item as the specified position is not a menu item

Throws:

IllegalArgumentException - if the value of pos < 0

getItemCount

@BeanProperty(bound=false)
public int getItemCount()

Returns the number of items on the menu, including separators. This method is included for AWT compatibility.

Returns:

an integer equal to the number of items on the menu

See Also:

• getMenuComponentCount()

isTearOff

@BeanProperty(bound=false)
public boolean isTearOff()

Returns true if the menu can be torn off. This method is not yet implemented.

Returns:

true if the menu can be torn off, else false

Throws:

Error - if invoked -- this method is not yet implemented

remove

public void remove(JMenuItem item)

Removes the specified menu item from this menu. If there is no popup menu, this method will have no effect.

Parameters:

item - the JMenuItem to be removed from the menu

remove

public void remove(int pos)

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

Overrides:

remove in class Container

Parameters:

pos - the position of the item to be removed

Throws:

IllegalArgumentException - if the value of pos < 0, or if pos is greater than the number of menu items

See Also:

• Container.add(Component)
• Container.invalidate()
• Container.validate()
• Container.getComponentCount()

remove

public void remove(Component c)

Removes the component c from this menu.

Overrides:

remove in class Container

Parameters:

c - the component to be removed

See Also:

• Container.add(Component)
• Container.invalidate()
• Container.validate()
• Container.remove(int)

removeAll

public void removeAll()

Removes all menu items from this menu.

Overrides:

removeAll in class Container

See Also:

• Container.add(Component)
• Container.remove(int)
• Container.invalidate()

getMenuComponentCount

@BeanProperty(bound=false)
public int getMenuComponentCount()

Returns the number of components on the menu.

Returns:

an integer containing the number of components on the menu

getMenuComponent

public Component getMenuComponent(int n)

Returns the component at position n.

Parameters:

n - the position of the component to be returned

Returns:

the component requested, or null if there is no popup menu

getMenuComponents

@BeanProperty(bound=false)
public Component[] getMenuComponents()

Returns an array of Components of the menu's subcomponents. Note that this returns all Components in the popup menu, including separators.

Returns:

an array of Components or an empty array if there is no popup menu

isTopLevelMenu

@BeanProperty(bound=false)
public boolean isTopLevelMenu()

Returns true if the menu is a 'top-level menu', that is, if it is the direct child of a menubar.

Returns:

true if the menu is activated from the menu bar; false if the menu is activated from a menu item on another menu

isMenuComponent

public boolean isMenuComponent(Component c)

Returns true if the specified component exists in the submenu hierarchy.

Parameters:

c - the Component to be tested

Returns:

true if the Component exists, false otherwise

getPopupMenu

@BeanProperty(bound=false)
public JPopupMenu getPopupMenu()

Returns the popupmenu associated with this menu. If there is no popupmenu, it will create one.

Returns:

the JPopupMenu associated with this menu

addMenuListener

public void addMenuListener(MenuListener l)

Adds a listener for menu events.

Parameters:

l - the listener to be added

removeMenuListener

public void removeMenuListener(MenuListener l)

Removes a listener for menu events.

Parameters:

l - the listener to be removed

getMenuListeners

@BeanProperty(bound=false)
public MenuListener[] getMenuListeners()

Returns an array of all the MenuListeners added to this JMenu with addMenuListener().

Returns:

all of the MenuListeners added or an empty array if no listeners have been added

Since:

1.4

fireMenuSelected

protected void fireMenuSelected()

Notifies all listeners that have registered interest for notification on this event type. The event instance is created lazily.

Throws:

Error - if there is a null listener

See Also:

• EventListenerList

fireMenuDeselected

protected void fireMenuDeselected()

Notifies all listeners that have registered interest for notification on this event type. The event instance is created lazily.

Throws:

Error - if there is a null listener

See Also:

• EventListenerList

fireMenuCanceled

protected void fireMenuCanceled()

Notifies all listeners that have registered interest for notification on this event type. The event instance is created lazily.

Throws:

Error - if there is a null listener

See Also:

• EventListenerList

createWinListener

protected JMenu.WinListener createWinListener(JPopupMenu p)

Creates a window-closing listener for the popup.

Parameters:

p - the JPopupMenu

Returns:

the new window-closing listener

See Also:

• JMenu.WinListener

menuSelectionChanged

public void menuSelectionChanged(boolean isIncluded)

Messaged when the menubar selection changes to activate or deactivate this menu. Overrides JMenuItem.menuSelectionChanged.

Specified by:

menuSelectionChanged in interface MenuElement

Overrides:

menuSelectionChanged in class JMenuItem

Parameters:

isIncluded - true if this menu is active, false if it is not

See Also:

• MenuSelectionManager.setSelectedPath(MenuElement[])

getSubElements

@BeanProperty(bound=false)
public MenuElement[] getSubElements()

Returns an array of MenuElements containing the submenu for this menu component. If popup menu is null returns an empty array. This method is required to conform to the MenuElement interface. Note that since JSeparators do not conform to the MenuElement interface, this array will only contain JMenuItems.

Specified by:

getSubElements in interface MenuElement

Overrides:

getSubElements in class JMenuItem

Returns:

an array of MenuElement objects

getComponent

public Component getComponent()

Returns the java.awt.Component used to paint this MenuElement. The returned component is used to convert events and detect if an event is inside a menu component.

Specified by:

getComponent in interface MenuElement

Overrides:

getComponent in class JMenuItem

Returns:

the Component that paints this menu item

applyComponentOrientation

public void applyComponentOrientation(ComponentOrientation o)

Sets the ComponentOrientation property of this menu and all components contained within it. This includes all components returned by getMenuComponents.

Overrides:

applyComponentOrientation in class Container

Parameters:

o - the new component orientation of this menu and the components contained within it.

Throws:

NullPointerException - if orientation is null.

Since:

1.4

See Also:

• Component.setComponentOrientation(ComponentOrientation)
• Component.getComponentOrientation()

setComponentOrientation

public void setComponentOrientation(ComponentOrientation o)

Sets the orientation for this menu and its associated popup menu determined by the ComponentOrientation argument.

Overrides:

setComponentOrientation in class Component

Parameters:

o - the new orientation for this menu and its associated popup menu.

See Also:

• ComponentOrientation
• Component.invalidate()

setAccelerator

public void setAccelerator(KeyStroke keyStroke)

setAccelerator is not defined for JMenu. Use setMnemonic instead.

Overrides:

setAccelerator in class JMenuItem

Parameters:

keyStroke - the keystroke combination which will invoke the JMenuItem's actionlisteners without navigating the menu hierarchy

Throws:

Error - if invoked -- this method is not defined for JMenu. Use setMnemonic instead

processKeyEvent

protected void processKeyEvent(KeyEvent evt)

Processes key stroke events such as mnemonics and accelerators.

Overrides:

processKeyEvent in class JComponent

Parameters:

evt - the key event to be processed

See Also:

• KeyEvent
• KeyListener
• KeyboardFocusManager
• DefaultKeyboardFocusManager
• Component.processEvent(AWTEvent)
• Component.dispatchEvent(AWTEvent)
• Component.addKeyListener(KeyListener)
• Component.enableEvents(long)
• Component.isShowing()

doClick

public void doClick(int pressTime)

Programmatically performs a "click". This overrides the method AbstractButton.doClick in order to make the menu pop up.

Overrides:

doClick in class AbstractButton

Parameters:

pressTime - indicates the number of milliseconds the button was pressed for

paramString

protected String paramString()

Returns a string representation of this JMenu. 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.

Overrides:

paramString in class JMenuItem

Returns:

a string representation of this JMenu.

getAccessibleContext

@BeanProperty(bound=false)
public AccessibleContext getAccessibleContext()

Gets the AccessibleContext associated with this JMenu. For JMenus, the AccessibleContext takes the form of an AccessibleJMenu. A new AccessibleJMenu instance is created if necessary.

Specified by:

getAccessibleContext in interface Accessible

Overrides:

getAccessibleContext in class JMenuItem

Returns:

an AccessibleJMenu that serves as the AccessibleContext of this JMenu