public class JMenuBar extends JComponent implements Accessible, MenuElement
JMenu objects to the
menu bar to construct a menu. When the user selects a JMenu
object, its associated JPopupMenu is displayed, allowing the
user to select one of the JMenuItems on it.
For information and examples of using menu bars 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 JavaBeansTM
has been added to the java.beans package.
Please see XMLEncoder.
JMenu,
JPopupMenu,
JMenuItem| Modifier and Type | Class and Description |
|---|---|
protected class |
JMenuBar.AccessibleJMenuBar
This class implements accessibility support for the
JMenuBar class. |
JComponent.AccessibleJComponentContainer.AccessibleAWTContainerComponent.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategyaccessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWBOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH| Constructor and Description |
|---|
JMenuBar()
Creates a new menu bar.
|
| Modifier and Type | Method and Description |
|---|---|
JMenu |
add(JMenu c)
Appends the specified menu to the end of the menu bar.
|
void |
addNotify()
Overrides
JComponent.addNotify to register this
menu bar with the current keyboard manager. |
AccessibleContext |
getAccessibleContext()
Gets the AccessibleContext associated with this JMenuBar.
|
Component |
getComponent()
Implemented to be a
MenuElement. |
Component |
getComponentAtIndex(int i)
Deprecated.
replaced by
getComponent(int i) |
int |
getComponentIndex(Component c)
Returns the index of the specified component.
|
JMenu |
getHelpMenu()
Gets the help menu for the menu bar.
|
Insets |
getMargin()
Returns the margin between the menubar's border and
its menus.
|
JMenu |
getMenu(int index)
Returns the menu at the specified position in the menu bar.
|
int |
getMenuCount()
Returns the number of items in the menu bar.
|
SingleSelectionModel |
getSelectionModel()
Returns the model object that handles single selections.
|
MenuElement[] |
getSubElements()
Implemented to be a
MenuElement -- returns the
menus in this menu bar. |
MenuBarUI |
getUI()
Returns the menubar's current UI.
|
String |
getUIClassID()
Returns the name of the L&F class that renders this component.
|
boolean |
isBorderPainted()
Returns true if the menu bars border should be painted.
|
boolean |
isSelected()
Returns true if the menu bar currently has a component selected.
|
void |
menuSelectionChanged(boolean isIncluded)
Implemented to be a
MenuElement -- does nothing. |
protected void |
paintBorder(Graphics g)
Paints the menubar's border if
BorderPainted
property is true. |
protected String |
paramString()
Returns a string representation of this
JMenuBar. |
protected boolean |
processKeyBinding(KeyStroke ks,
KeyEvent e,
int condition,
boolean pressed)
Subclassed to check all the child menus.
|
void |
processKeyEvent(KeyEvent e,
MenuElement[] path,
MenuSelectionManager manager)
Implemented to be a
MenuElement -- does nothing. |
void |
processMouseEvent(MouseEvent event,
MenuElement[] path,
MenuSelectionManager manager)
Implemented to be a
MenuElement -- does nothing. |
void |
removeNotify()
Overrides
JComponent.removeNotify to unregister this
menu bar with the current keyboard manager. |
void |
setBorderPainted(boolean b)
Sets whether the border should be painted.
|
void |
setHelpMenu(JMenu menu)
Sets the help menu that appears when the user selects the
"help" option in the menu bar.
|
void |
setMargin(Insets m)
Sets the margin between the menubar's border and
its menus.
|
void |
setSelected(Component sel)
Sets the currently selected component, producing a
a change to the selection model.
|
void |
setSelectionModel(SingleSelectionModel model)
Sets the model object to handle single selections.
|
void |
setUI(MenuBarUI ui)
Sets the L&F object that renders this component.
|
void |
updateUI()
Resets the UI property with a value from the current look and feel.
|
addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyEvent, 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, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, updateadd, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTreeaction, 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, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCyclepublic MenuBarUI getUI()
setUI(javax.swing.plaf.MenuBarUI)public void setUI(MenuBarUI ui)
ui - the new MenuBarUI L&F objectUIDefaults.getUI(javax.swing.JComponent)public void updateUI()
updateUI in class JComponentJComponent.updateUI()public String getUIClassID()
getUIClassID in class JComponentJComponent.getUIClassID(),
UIDefaults.getUI(javax.swing.JComponent)public SingleSelectionModel getSelectionModel()
SingleSelectionModel propertySingleSelectionModelpublic void setSelectionModel(SingleSelectionModel model)
model - the SingleSelectionModel to useSingleSelectionModelpublic JMenu add(JMenu c)
c - the JMenu component to addpublic JMenu getMenu(int index)
index - an integer giving the position in the menu bar, where
0 is the first positionJMenu at that position, or null if
if there is no JMenu at that position (ie. if
it is a JMenuItem)public int getMenuCount()
public void setHelpMenu(JMenu menu)
menu - the JMenu that delivers help to the userpublic JMenu getHelpMenu()
JMenu that delivers help to the user@Deprecated public Component getComponentAtIndex(int i)
getComponent(int i)i - an integer specifying the position, where 0 is firstComponent at the position,
or null for an invalid indexpublic int getComponentIndex(Component c)
c - the Component to findpublic void setSelected(Component sel)
sel - the Component to selectpublic boolean isSelected()
public boolean isBorderPainted()
public void setBorderPainted(boolean b)
b - if true and border property is not null,
the border is painted.isBorderPainted()protected void paintBorder(Graphics g)
BorderPainted
property is true.paintBorder in class JComponentg - the Graphics context to use for paintingJComponent.paint(java.awt.Graphics),
JComponent.setBorder(javax.swing.border.Border)public void setMargin(Insets m)
null will cause the menubar to
use the default margins.m - an Insets object containing the margin valuesInsetspublic Insets getMargin()
Insets object containing the margin valuesInsetspublic void processMouseEvent(MouseEvent event, MenuElement[] path, MenuSelectionManager manager)
MenuElement -- does nothing.processMouseEvent in interface MenuElementgetSubElements()public void processKeyEvent(KeyEvent e, MenuElement[] path, MenuSelectionManager manager)
MenuElement -- does nothing.processKeyEvent in interface MenuElementgetSubElements()public void menuSelectionChanged(boolean isIncluded)
MenuElement -- does nothing.menuSelectionChanged in interface MenuElementgetSubElements()public MenuElement[] getSubElements()
MenuElement -- returns the
menus in this menu bar.
This is the reason for implementing the MenuElement
interface -- so that the menu bar can be treated the same as
other menu elements.getSubElements in interface MenuElementpublic Component getComponent()
MenuElement. Returns this object.getComponent in interface MenuElementComponent (this)getSubElements()protected String paramString()
JMenuBar.
This method
is intended to be used only for debugging purposes, and the
content and format of the returned string may vary between
implementations. The returned string may be empty but may not
be null.paramString in class JComponentJMenuBarpublic AccessibleContext getAccessibleContext()
getAccessibleContext in interface AccessiblegetAccessibleContext in class JComponentprotected boolean processKeyBinding(KeyStroke ks, KeyEvent e, int condition, boolean pressed)
processKeyBinding in class JComponentks - the KeyStroke queriede - the KeyEventcondition - one of the following values:
pressed - true if the key is pressedpublic void addNotify()
JComponent.addNotify to register this
menu bar with the current keyboard manager.public void removeNotify()
JComponent.removeNotify to unregister this
menu bar with the current keyboard manager. Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b138