net.sf.freecol.client.gui.menu
Class FreeColMenuBar

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JMenuBar
                  net.sf.freecol.client.gui.menu.FreeColMenuBar

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.MenuElement

Direct Known Subclasses:

InGameMenuBar, MapEditorMenuBar

public abstract class FreeColMenuBar
extends javax.swing.JMenuBar

The menu bar that is displayed on the top left corner of the Canvas.

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

protected ActionManager	am
protected FreeColClient	freeColClient
protected GUI	gui
private static java.util.logging.Logger	logger

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

protected

FreeColMenuBar(FreeColClient f, GUI gui) Creates a new FreeColMenuBar.

Method Summary

protected void	buildColopediaMenu()
protected javax.swing.JCheckBoxMenuItem	getCheckBoxMenuItem(java.lang.String actionID) Creates a default FreeCol JCheckBoxMenuItem.
protected javax.swing.JMenuItem	getMenuItem(java.lang.String actionID) Creates a default FreeCol JMenuItem.
protected javax.swing.JMenuItem	getMenuItem(java.lang.String actionID, java.awt.event.ActionListener actionListener) Creates a default FreeCol JMenuItem.
protected javax.swing.JRadioButtonMenuItem	getRadioButtonMenuItem(java.lang.String actionID, javax.swing.ButtonGroup group) Creates a default FreeCol JRadioButtonMenuItem.
void	paintComponent(java.awt.Graphics g) Paints the background and borders of the menubar.
abstract void	reset() Resets this menu bar.
void	setEnabled(boolean enabled) When a FreeColMenuBar is disabled, it does not show the "in game options".
void	update() Updates this FreeColMenuBar.

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, 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, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final java.util.logging.Logger logger

freeColClient

protected final FreeColClient freeColClient

am

protected ActionManager am

gui

protected GUI gui

Constructor Detail

FreeColMenuBar

protected FreeColMenuBar(FreeColClient f,
                         GUI gui)

Creates a new FreeColMenuBar. This menu bar will include all of the submenus and items.

Parameters:

f - The main controller.

Method Detail

reset

public abstract void reset()

Resets this menu bar.

For subclasses: This method should reset both the texts and the accelerator keys used by the menu items.

getMenuItem

protected javax.swing.JMenuItem getMenuItem(java.lang.String actionID)

Creates a default FreeCol JMenuItem.

Parameters:

actionID - The ID given to the action manager.

Returns:

The menu item.

getMenuItem

protected javax.swing.JMenuItem getMenuItem(java.lang.String actionID,
                                            java.awt.event.ActionListener actionListener)

Creates a default FreeCol JMenuItem.

Parameters:

actionID - The ID given to the action manager.

actionListener - An ActionListener that will be added to the menu item.

Returns:

The menu item with the ActionListener added.

getCheckBoxMenuItem

protected javax.swing.JCheckBoxMenuItem getCheckBoxMenuItem(java.lang.String actionID)

Creates a default FreeCol JCheckBoxMenuItem.

Parameters:

actionID - The ID given to the action manager.

Returns:

The menu item.

getRadioButtonMenuItem

protected javax.swing.JRadioButtonMenuItem getRadioButtonMenuItem(java.lang.String actionID,
                                                                  javax.swing.ButtonGroup group)

Creates a default FreeCol JRadioButtonMenuItem.

Parameters:

actionID - The ID given to the action manager.

group - The ButtonGroup to add this item to

Returns:

The menu item.

update

public void update()

Updates this FreeColMenuBar.

setEnabled

public void setEnabled(boolean enabled)

When a FreeColMenuBar is disabled, it does not show the "in game options".

Overrides:

setEnabled in class javax.swing.JComponent

buildColopediaMenu

protected void buildColopediaMenu()

paintComponent

public void paintComponent(java.awt.Graphics g)

Paints the background and borders of the menubar.

Overrides:

paintComponent in class javax.swing.JComponent