org.fife.ui.app
Class MenuBar

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JMenuBar
                  extended by org.fife.ui.app.MenuBar
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.MenuElement
Direct Known Subclasses:
RTextMenuBar

public class MenuBar
extends javax.swing.JMenuBar

The menu bar used by instances of GUIApplication.

Version:
0.1
Author:
Robert Futrell
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JMenuBar
javax.swing.JMenuBar.AccessibleJMenuBar
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class javax.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
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
MenuBar()
           
 
Method Summary
 void addExtraMenu(javax.swing.JMenu menu)
          Adds an "extra" menu to this menu bar.
protected  javax.swing.JCheckBoxMenuItem createCheckBoxMenuItem(javax.swing.Action action)
          Returns a check box menu item configured from an action.
protected  javax.swing.JMenu createMenu(java.util.ResourceBundle msg, java.lang.String textKey)
          Returns an JMenu with the specified text.
protected  javax.swing.JMenuItem createMenuItem(javax.swing.Action a)
          Returns a menu item with the passed-in properties.
protected  javax.swing.JMenuItem createMenuItem(javax.swing.Action a, java.util.ResourceBundle bundle, java.lang.String textKey, java.lang.String mnemonicKey)
          Returns an JMenuItem with the specified text and mnemonic that performs the specified action when clicked.
protected  javax.swing.JMenuItem createMenuItem(javax.swing.Action a, java.util.ResourceBundle bundle, java.lang.String textKey, java.lang.String mnemonicKey, javax.swing.KeyStroke accelerator)
          Returns an JMenuItem with the specified text and mnemonic that performs the specified action when clicked.
protected  javax.swing.JMenuItem createMenuItem(javax.swing.Action a, java.lang.String desc)
          Returns a menu item with the passed-in properties.
protected  javax.swing.JMenuItem createMenuItem(java.util.ResourceBundle msg, java.lang.String textKey)
          Returns a menu item with the specified text.
protected  javax.swing.JRadioButtonMenuItem createRadioButtonMenuItem(javax.swing.Action a, java.lang.String description)
          Returns a radio button menu item with the passed-in properties.
 javax.swing.JMenu getMenuByName(java.lang.String name)
          Returns the menu registered with the specified name.
 void registerMenuByName(java.lang.String name, javax.swing.JMenu menu)
          Associates a name with a menu.
 
Methods inherited from class javax.swing.JMenuBar
add, addNotify, getAccessibleContext, getComponent, getComponentAtIndex, getComponentIndex, getHelpMenu, getMargin, getMenu, getMenuCount, getSelectionModel, getSubElements, getUI, getUIClassID, isBorderPainted, isSelected, menuSelectionChanged, paintBorder, paramString, processKeyBinding, processKeyEvent, processMouseEvent, removeNotify, setBorderPainted, setHelpMenu, setMargin, setSelected, setSelectionModel, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
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, 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, update
 
Methods inherited from class java.awt.Container
add, 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, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.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, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MenuBar

public MenuBar()
Method Detail

addExtraMenu

public void addExtraMenu(javax.swing.JMenu menu)
Adds an "extra" menu to this menu bar.

Parameters:
menu - The menu to add.

createCheckBoxMenuItem

protected javax.swing.JCheckBoxMenuItem createCheckBoxMenuItem(javax.swing.Action action)
Returns a check box menu item configured from an action.

Parameters:
action - The action associated with the menu item.
Returns:
The menu item.

createMenu

protected javax.swing.JMenu createMenu(java.util.ResourceBundle msg,
                                       java.lang.String textKey)
Returns an JMenu with the specified text. Further, if there is an entry in the specified resource bundle with name textKey + ".Mnemonic", it is taken to contain the mnemonic for the menu.

Parameters:
msg - The resource bundle in which to get the text.
textKey - The key into the bundle containing the string text value.
Returns:
The JMenu.

createMenuItem

protected javax.swing.JMenuItem createMenuItem(java.util.ResourceBundle msg,
                                               java.lang.String textKey)
Returns a menu item with the specified text. Further, if there is an entry in the specified resource bundle with name textKey + ".Mnemonic", it is taken to contain the mnemonic for the menu.

Parameters:
msg - The resource bundle in which to get the text.
textKey - The key into the bundle containing the string text value.
Returns:
The menu item.

createMenuItem

protected javax.swing.JMenuItem createMenuItem(javax.swing.Action a,
                                               java.util.ResourceBundle bundle,
                                               java.lang.String textKey,
                                               java.lang.String mnemonicKey)
Returns an JMenuItem with the specified text and mnemonic that performs the specified action when clicked.

Parameters:
a - The action that occurs when this item is clicked.
bundle - The resource bundle in which to get the text.
textKey - The key into the bundle containing the string text value.
mnemonicKey - The key into the bundle containing a single-char String value for the mnemonic.
Returns:
The JMenuItem.

createMenuItem

protected javax.swing.JMenuItem createMenuItem(javax.swing.Action a,
                                               java.util.ResourceBundle bundle,
                                               java.lang.String textKey,
                                               java.lang.String mnemonicKey,
                                               javax.swing.KeyStroke accelerator)
Returns an JMenuItem with the specified text and mnemonic that performs the specified action when clicked.

Parameters:
a - The action that occurs when this item is clicked.
bundle - The resource bundle in which to get the text.
textKey - The key into the bundle containing the string text value.
mnemonicKey - The key into the bundle containing a single-char String value for the mnemonic.
accelerator - The accelerator for the menu item.
Returns:
The JMenuItem.

createMenuItem

protected javax.swing.JMenuItem createMenuItem(javax.swing.Action a,
                                               java.lang.String desc)
Returns a menu item with the passed-in properties.

Parameters:
a - The action that occurs on clicking this menu item.
desc - The accessible description.
Returns:
The menu item.

createMenuItem

protected javax.swing.JMenuItem createMenuItem(javax.swing.Action a)
Returns a menu item with the passed-in properties.

Parameters:
a - The action that occurs on clicking this menu item.
Returns:
The menu item.

createRadioButtonMenuItem

protected javax.swing.JRadioButtonMenuItem createRadioButtonMenuItem(javax.swing.Action a,
                                                                     java.lang.String description)
Returns a radio button menu item with the passed-in properties.

Parameters:
a - The action that occurs on clicking this menu item.
description - The accessible description.
Returns:
The radio button menu item.

getMenuByName

public javax.swing.JMenu getMenuByName(java.lang.String name)
Returns the menu registered with the specified name.

Parameters:
name - The name.
Returns:
The menu, or null if no menu was registered with that name.
See Also:
registerMenuByName(String, JMenu)

registerMenuByName

public void registerMenuByName(java.lang.String name,
                               javax.swing.JMenu menu)
Associates a name with a menu. This allows applications to easily grab specific menus in this menu bar, without knowing the order of the menus.

Parameters:
name - The name. This cannot be null.
menu - The menu.
See Also:
getMenuByName(String)