Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Class java.awt.swing.JMenuBar

java.lang.Object
    |
    +----java.awt.Component
            |
            +----java.awt.Container
                    |
                    +----java.awt.swing.JComponent
                            |
                            +----java.awt.swing.JMenuBar

public class JMenuBar
extends JComponent
implements Accessible, MenuElement
An implementation of a MenuBar. You add 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.

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 Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

See Also:
JMenu, JPopupMenu, JMenuItem

Inner Class Summary
 JMenuBar.AccessibleJMenuBar
The class used to obtain the accessible role for this object.
 
Inner classes inherited from class java.awt.swing.JComponent
 JComponent.AccessibleJComponent
 

Fields inherited from class java.awt.swing.JComponent
 accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
 BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 

Constructor Summary
 JMenuBar()
Creates a new menu bar.
 

Method Summary
JMenu  add(JMenu c)
Appends the specified menu to the end of the menu bar.
AccessibleContext  getAccessibleContext()
Get the AccessibleContext associated with this JComponent
Component  getComponent()
Implemented to be a MenuElement.
Component  getComponentAtIndex(int i)
Returns the component at the specified index.
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)
Gets 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.
java.awt.swing.plaf.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 a the Menubar's border should be painted.
boolean  isManagingFocus()
Returns true to indicate that this component manages focus events internally.
boolean  isSelected()
Returns true if the MenuBar currently has a component selected
void  menuSelectionChanged(boolean isIncluded)
Implemented to be a MenuElement -- does nothing.
void  paintBorder(Graphics g)
Paint the menubar's border if BorderPainted property is true.
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  remove(int index)
Removes the component at the specified index.
void  setBorderPainted(boolean s)
Determines whether the MenuBar's current border will 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 margin)
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)
Set the model object to handle single selections.
void  setUI(java.awt.swing.plaf.MenuBarUI ui)
Sets the L&F object that renders this component.
void  updateUI()
Notification from the UIFactory that the L&F has changed.
 
Methods inherited from class java.awt.swing.JComponent
 addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getUIClassID, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setBounds, setDebugGraphicsOptions, setDoubleBuffered, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update, updateUI
 
Methods inherited from class java.awt.Container
 add, add, add, add, add, addContainerListener, addImpl, addNotify, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setLayout, update, validate, validateTree
 
Methods inherited from class java.awt.Component
 action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getColorModel, getComponentAt, getComponentAt, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getName, getParent, getPeer, getPreferredSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isEnabled, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setCursor, setDropTarget, setEnabled, setFont, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, update, validate
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JMenuBar

public JMenuBar()
Creates a new menu bar.
Method Detail

getUI

public java.awt.swing.plaf.MenuBarUI getUI()
Returns the menubar's current UI.
See Also:
setUI

setUI

public void setUI(java.awt.swing.plaf.MenuBarUI ui)
Sets the L&F object that renders this component.
Parameters:
ui - the new MenuBarUI L&F object
See Also:
getUI

updateUI

public void updateUI()
Notification from the UIFactory that the L&F has changed. Called to replace the UI with the latest version from the UIFactory.
Overrides:
updateUI in class JComponent
See Also:
updateUI

getUIClassID

public String getUIClassID()
Returns the name of the L&F class that renders this component.
Returns:
"MenuBarUI"
Overrides:
getUIClassID in class JComponent
See Also:
getUIClassID, getUI

getSelectionModel

public SingleSelectionModel getSelectionModel()
Returns the model object that handles single selections.
Returns:
the SingleSelectionModel in use
See Also:
SingleSelectionModel

setSelectionModel

public void setSelectionModel(SingleSelectionModel model)
Set the model object to handle single selections.
Parameters:
model - the SingleSelectionModel to use
See Also:
SingleSelectionModel

add

public JMenu add(JMenu c)
Appends the specified menu to the end of the menu bar.
Parameters:
c - the JMenu component to add

getMenu

public JMenu getMenu(int index)
Gets the menu at the specified position in the menu bar.
Parameters:
index - an int giving the position in the menu bar, where 0 is the first position
Returns:
the JMenu at that position

getMenuCount

public int getMenuCount()
Returns the number of items in the menu bar.
Returns:
the number of items in the menu bar

remove

public void remove(int index)
Removes the component at the specified index.
Parameters:
index - an int specifying the menu bar position, where 0 = first
Overrides:
remove in class Container

setHelpMenu

public void setHelpMenu(JMenu menu)
Sets the help menu that appears when the user selects the "help" option in the menu bar.
Parameters:
menu - the JMenu that delivers help to the user

getHelpMenu

public JMenu getHelpMenu()
Gets the help menu for the menu bar.
Returns:
the JMenu that delivers help to the user

getComponentAtIndex

public Component getComponentAtIndex(int i)
Returns the component at the specified index.
Parameters:
i - an int specifying the position, where 0 = first
Returns:
the Component at the position, or null for an invalid index

getComponentIndex

public int getComponentIndex(Component c)
Returns the index of the specified component.
Parameters:
c - the Component to find
Returns:
an int giving the component's position, where 0 = first

setSelected

public void setSelected(Component sel)
Sets the currently selected component, producing a a change to the selection model.
Parameters:
sel - the Component to select

isSelected

public boolean isSelected()
Returns true if the MenuBar currently has a component selected
Returns:
true if a selection has been made, else false

isBorderPainted

public boolean isBorderPainted()
Returns true if a the Menubar's border should be painted.
Returns:
true if the border should be painted, else false

setBorderPainted

public void setBorderPainted(boolean s)
Determines whether the MenuBar's current border will be painted.
Parameters:
s - true if the border should be painted, else false

paintBorder

protected void paintBorder(Graphics g)
Paint the menubar's border if BorderPainted property is true.
Parameters:
g - the Graphics context to use for painting
Overrides:
paintBorder in class JComponent
See Also:
paint, setBorder

setMargin

public void setMargin(Insets margin)
Sets the margin between the menubar's border and its menus. Setting to null will cause the menubar to use the default margins.
Parameters:
margin - an Insets object containing the margin values
See Also:
Insets

getMargin

public Insets getMargin()
Returns the margin between the menubar's border and its menus.
Returns:
an Insets object containing the margin values
See Also:
Insets

processMouseEvent

public void processMouseEvent(MouseEvent event,
                              MenuElement[] path,
                              MenuSelectionManager manager)
Implemented to be a MenuElement -- does nothing.
Implements:
processMouseEvent in interface MenuElement
See Also:
getSubElements

processKeyEvent

public void processKeyEvent(KeyEvent e,
                            MenuElement[] path,
                            MenuSelectionManager manager)
Implemented to be a MenuElement -- does nothing.
Implements:
processKeyEvent in interface MenuElement
See Also:
getSubElements

menuSelectionChanged

public void menuSelectionChanged(boolean isIncluded)
Implemented to be a MenuElement -- does nothing.
Implements:
menuSelectionChanged in interface MenuElement
See Also:
getSubElements

getSubElements

public MenuElement[] getSubElements()
Implemented to be a 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.
Implements:
getSubElements in interface MenuElement

getComponent

public Component getComponent()
Implemented to be a MenuElement. Returns this object.
Implements:
getComponent in interface MenuElement
Returns:
the current Component (this)
See Also:
getSubElements

getAccessibleContext

public AccessibleContext getAccessibleContext()
Get the AccessibleContext associated with this JComponent
Implements:
getAccessibleContext in interface Accessible
Returns:
the AccessibleContext of this JComponent
Overrides:
getAccessibleContext in class JComponent

isManagingFocus

public boolean isManagingFocus()
Returns true to indicate that this component manages focus events internally.
Returns:
true
Overrides:
isManagingFocus in class JComponent

Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.