com.portal.bas.comp

Class PMenuBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JMenuBar

com.portal.bas.comp.PMenuBar

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, MenuElement

public class PMenuBar
extends JMenuBar

This is a derivitive of JMenuBar that provides 2 extra capabilities for BAS. First, it can be used as a vertical menu. Second, when BASActions are added, it provides menu merging features.

Version:

%version: 19 % %date_modified: Wed Oct 24 10:19:55 2001 %, %version: 19 % %date_modified: Wed Oct 24 10:19:55 2001 %

Author:

larrylf

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JMenuBar

JMenuBar.AccessibleJMenuBar

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor and Description
PMenuBar() Contruct a default (vertical) MenuBar
PMenuBar(boolean vert) Contruct a MenuBar instance.

Method Summary

Modifier and Type	Method and Description
void	add(PBASAction a) Add a BASAction to the menu.
void	add(Vector v) Will add a whole vector of BASActions to the menu.
Icon	getIcon() Get the icon displayed at the bottom of the menu column
JMenu	getJMenu(String key) Get a JMenu from PMenuBar.
String	getResourceBase() Get the resource base string.
void	paint(Graphics g)
void	remove(PBASAction a) Remove a BASAction from the menu.
void	remove(Vector v) Will remove a whole vector of BASActions from the menu.
void	setEnabled(boolean b) Override setEnabled to affect each menu in the menubar
void	setIcon(Icon icn) Set an icon to display at the bottom of the menu column
void	setImageLoading(boolean loadImages) Set icon image loading.
void	setResourceBase(String base) The the resource base string.

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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, 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, 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, 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

Constructor Detail

PMenuBar

public PMenuBar()

Contruct a default (vertical) MenuBar

PMenuBar

public PMenuBar(boolean vert)

Contruct a MenuBar instance.

Parameters:

vert - Set to true for a vertical menu, or false for a JMenuBar like horizontal menu.

Method Detail

setIcon

public void setIcon(Icon icn)

Set an icon to display at the bottom of the menu column

Parameters:

icn - The icon to display

getIcon

public Icon getIcon()

Get the icon displayed at the bottom of the menu column

Returns:

The icon displayed

getJMenu

public JMenu getJMenu(String key)

Get a JMenu from PMenuBar.

Parameters:

key - A String to name the JMenu to search for.

Returns:

The requested JMenu as defined by key. If the menu is not found null is returned.

setImageLoading

public void setImageLoading(boolean loadImages)

Set icon image loading.

Parameters:

loadImages - Set to true to load associated images along as part of the menu item, or false for no images to be loaded. The default is set to true.

add

public void add(PBASAction a)

Add a BASAction to the menu. This function provides full menu merging capabilities. If there is already a menu item with the same name, then the action is added to the list of actions called when the item is selected. The BASAction class provides a 'preferred menu' string. This is a non-localized string like 'file' or 'edit'. The actual localized name put on the menubar is determined by pre-pending the name with this classes resource base string, and looking up that resource in the main resource properties file.

Parameters:

a - A BASAction to add to the menu

paint

public void paint(Graphics g)

Overrides:

paint in class JComponent

remove

public void remove(PBASAction a)

Remove a BASAction from the menu. If there are more then one menu item with the same name, then this action is just removed from the list of actions to call. If it is the last such, then the menu item is removed from the menu.

Parameters:

a - The BASAction to remove.

setEnabled

public void setEnabled(boolean b)

Override setEnabled to affect each menu in the menubar

Overrides:

setEnabled in class JComponent

Parameters:

b - the desired state of the menubar

setResourceBase

public void setResourceBase(String base)

The the resource base string. THis string is prepended to the menu name to determin the resource to look up to find the actual localized string to label the menu with.

Parameters:

base - The resource base string.

getResourceBase

public String getResourceBase()

Get the resource base string.

Returns:

A string containing the resource base

add

public void add(Vector v)

Will add a whole vector of BASActions to the menu.

Parameters:

v - A vector of PBASActions

remove

public void remove(Vector v)

Will remove a whole vector of BASActions from the menu.

Parameters:

v - A vector of PBASActions