All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.JMenuBar 

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----com.sun.java.swing.JComponent
                           |
                           +----com.sun.java.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

Constructor Index

o JMenuBar()
Creates a new menu bar.

Method Index

o add(JMenu)
Appends the specified menu to the end of the menu bar.
o getAccessibleContext()
Get the AccessibleContext associated with this JComponent
o getComponent()
Implemented to be a MenuElement.
o getComponentAtIndex(int)
Returns the component at the specified index.
o getComponentIndex(Component)
Returns the index of the specified component.
o getHelpMenu()
Gets the help menu for the menu bar.
o getMargin()
Returns the margin between the menubar's border and its menus.
o getMenu(int)
Gets the menu at the specified position in the menu bar.
o getMenuCount()
Returns the number of items in the menu bar.
o getSelectionModel()
Returns the model object that handles single selections.
o getSubElements()
Implemented to be a MenuElement -- returns the menus in this menu bar.
o getUI()
Returns the menubar's current UI.
o getUIClassID()
Returns the name of the L&F class that renders this component.
o isBorderPainted()
Returns true if a the Menubar's border should be painted.
o isManagingFocus()
Returns true to indicate that this component manages focus events internally.
o isSelected()
Returns true if the MenuBar currently has a component selected
o menuSelectionChanged(boolean)
Implemented to be a MenuElement -- does nothing.
o paintBorder(Graphics)
Paint the menubar's border if BorderPainted property is true.
o processKeyEvent(KeyEvent, MenuElement[], MenuSelectionManager)
Implemented to be a MenuElement -- does nothing.
o processMouseEvent(MouseEvent, MenuElement[], MenuSelectionManager)
Implemented to be a MenuElement -- does nothing.
o remove(int)
Removes the component at the specified index.
o setBorderPainted(boolean)
Determines whether the MenuBar's current border will be painted.
o setHelpMenu(JMenu)
Sets the help menu that appears when the user selects the "help" option in the menu bar.
o setMargin(Insets)
Sets the margin between the menubar's border and its menus.
o setSelected(Component)
Sets the currently selected component, producing a a change to the selection model.
o setSelectionModel(SingleSelectionModel)
Set the model object to handle single selections.
o setUI(MenuBarUI)
Sets the L&F object that renders this component.
o updateUI()
Notification from the UIFactory that the L&F has changed.

Constructors

o JMenuBar 
 public JMenuBar()
Creates a new menu bar.

Methods

o getUI 
 public MenuBarUI getUI()
Returns the menubar's current UI.

See Also:
setUI
o setUI 
 public void setUI(MenuBarUI ui)
Sets the L&F object that renders this component.

Parameters:
ui - the new MenuBarUI L&F object
See Also:
getUI
o 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
o 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
o getSelectionModel 
 public SingleSelectionModel getSelectionModel()
Returns the model object that handles single selections.

Returns:
the SingleSelectionModel in use
See Also:
SingleSelectionModel
o setSelectionModel 
 public void setSelectionModel(SingleSelectionModel model)
Set the model object to handle single selections.

Parameters:
model - the SingleSelectionModel to use
See Also:
SingleSelectionModel
o add 
 public JMenu add(JMenu c)
Appends the specified menu to the end of the menu bar.

Parameters:
c - the JMenu component to add
o 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
o getMenuCount 
 public int getMenuCount()
Returns the number of items in the menu bar.

Returns:
the number of items in the menu bar
o 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
o 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
o getHelpMenu 
 public JMenu getHelpMenu()
Gets the help menu for the menu bar.

Returns:
the JMenu that delivers help to the user
o 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
o 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
o 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
o isSelected 
 public boolean isSelected()
Returns true if the MenuBar currently has a component selected

Returns:
true if a selection has been made, else false
o 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
o 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
o 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
o 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
o 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
o processMouseEvent 
 public void processMouseEvent(MouseEvent event,
                               MenuElement path[],
                               MenuSelectionManager manager)
Implemented to be a MenuElement -- does nothing.

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

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

See Also:
getSubElements
o 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.

o getComponent 
 public Component getComponent()
Implemented to be a MenuElement. Returns this object.

Returns:
the current Component (this)
See Also:
getSubElements
o getAccessibleContext 
 public AccessibleContext getAccessibleContext()
Get the AccessibleContext associated with this JComponent

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

Returns:
true
Overrides:
isManagingFocus in class JComponent 
All Packages  Class Hierarchy  This Package  Previous  Next  Index