edu.kzoo.grid.gui.nuggets
Class BasicHelpMenu

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.AbstractButton
                          |
                          +--javax.swing.JMenuItem
                                |
                                +--javax.swing.JMenu
                                      |
                                      +--edu.kzoo.grid.gui.nuggets.BasicHelpMenu

All Implemented Interfaces:

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

public class BasicHelpMenu

extends javax.swing.JMenu

Grid GUI Nuggets Package (Handy Grid GUI Components):
A BasicHelpMenu object represents a Help menu with two standard entries: "About Application_Name" and "Help", where "Application_Name" is the name of the application provided in a parameter to the constructor. Selecting the "About" menu item brings up an informational dialog box with the name of the application, and, for example, its authors, and a date or version number. Selecting the "Help" menu item displays the contents of a document in a scrolling dialog box.

Version:

31 March 2004

Author:

Alyce Brady (based on code by Julie Zelenski)

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.JMenu

popupListener

Fields inherited from class javax.swing.AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

BasicHelpMenu()
Constructs an empty Help menu.

BasicHelpMenu(java.lang.String applName, java.lang.String aboutMessage)
Constructs a Help menu with one "About This_Application" entry, where This_Application is replaced with applName.

BasicHelpMenu(java.lang.String applName, java.lang.String aboutMessage, java.lang.String helpDocumentURL)
Constructs a Help menu with two standard entries: "About This_Application" and "Help", where This_Application is replaced with applName.

BasicHelpMenu(java.lang.String applName, java.lang.String authors, java.lang.String acknowledgements, java.lang.String versionInfo)
Constructs a Help menu with one "About This_Application" entry, where This_Application is replaced with applName.

BasicHelpMenu(java.lang.String applName, java.lang.String authors, java.lang.String acknowledgements, java.lang.String versionInfo, java.lang.String helpDocumentURL)
Constructs a Help menu with two standard entries: "About This_Application" and "Help", where This_Application is replaced with applName.

Method Summary

void	addAboutMenuItem(java.lang.String applName, java.lang.String additionalInfo) Adds an "About This_Application" menu option to this menu, where This_Application is replaced with applName.
void	addHelpDocMenuItem(java.lang.String documentURL) Adds a "Help" menu option to this menu that, when selected, displays the specified help document in a scrolling dialog window.
protected static java.lang.String	makeAboutMessage(java.lang.String authors, java.lang.String acknowledgements, java.lang.String versionInfo)
void	setFrame(javax.swing.JFrame frame) Sets the frame to which this menu bar is attached.

Methods inherited from class javax.swing.JMenu

add, add, add, add, add, addMenuListener, addSeparator, applyComponentOrientation, configurePropertiesFromAction, createActionChangeListener, createActionComponent, createWinListener, doClick, fireMenuCanceled, fireMenuDeselected, fireMenuSelected, getAccessibleContext, getComponent, getDelay, getItem, getItemCount, getMenuComponent, getMenuComponentCount, getMenuComponents, getMenuListeners, getPopupMenu, getPopupMenuOrigin, getSubElements, getUIClassID, insert, insert, insert, insertSeparator, isMenuComponent, isPopupMenuVisible, isSelected, isTearOff, isTopLevelMenu, menuSelectionChanged, paramString, processKeyEvent, remove, remove, remove, removeAll, removeMenuListener, setAccelerator, setComponentOrientation, setDelay, setMenuLocation, setModel, setPopupMenuVisible, setSelected, updateUI

Methods inherited from class javax.swing.JMenuItem

addMenuDragMouseListener, addMenuKeyListener, createActionPropertyChangeListener, fireMenuDragMouseDragged, fireMenuDragMouseEntered, fireMenuDragMouseExited, fireMenuDragMouseReleased, fireMenuKeyPressed, fireMenuKeyReleased, fireMenuKeyTyped, getAccelerator, getMenuDragMouseListeners, getMenuKeyListeners, init, isArmed, processKeyEvent, processMenuDragMouseEvent, processMenuKeyEvent, processMouseEvent, removeMenuDragMouseListener, removeMenuKeyListener, setArmed, setEnabled, setUI

Methods inherited from class javax.swing.AbstractButton

addActionListener, addChangeListener, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createChangeListener, createItemListener, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, paintBorder, removeActionListener, removeChangeListener, removeItemListener, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setFocusPainted, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setMargin, setMnemonic, setMnemonic, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, 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, addContainerListener, addImpl, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, 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

Methods inherited from interface javax.swing.MenuElement

processKeyEvent, processMouseEvent

Constructor Detail

BasicHelpMenu

public BasicHelpMenu()

Constructs an empty Help menu.

BasicHelpMenu

public BasicHelpMenu(java.lang.String applName,
                     java.lang.String aboutMessage)

Constructs a Help menu with one "About This_Application" entry, where This_Application is replaced with applName. Selecting the About option brings up a dialog box that displays the application name and the specified additional information.

Parameters:

applName - the name of this application, to be used in the "About This_Application" menu item; null if there should not be an "About This_Application" menu item

aboutMessage - additional information to be displayed in the "About This_Application" dialog box; null if there should not be an "About This_Application" menu item

BasicHelpMenu

public BasicHelpMenu(java.lang.String applName,
                     java.lang.String authors,
                     java.lang.String acknowledgements,
                     java.lang.String versionInfo)

Constructs a Help menu with one "About This_Application" entry, where This_Application is replaced with applName. Selecting the About option brings up a dialog box that displays the application name, and the specified author(s), acknowledgements, and version information, each preceded with an appropriate label. If any of those parameters is null, the associated label will not be included.

Parameters:

applName - the name of this application, to be used in the "About This_Application" menu item; null if there should not be an "About This_Application" menu item

authors - the name(s) of the author(s) to be displayed in the "About This_Application" dialog box; null if the "About" information should not include author information

acknowledgements - acknowledgement information to be included in the "About This_Application" dialog box; null if the "About" information should not include acknowledgements

versionInfo - version information (for example, date or version number) to be included in the "About This_Application" dialog box; null if the "About" information should not include version information

BasicHelpMenu

public BasicHelpMenu(java.lang.String applName,
                     java.lang.String aboutMessage,
                     java.lang.String helpDocumentURL)

Constructs a Help menu with two standard entries: "About This_Application" and "Help", where This_Application is replaced with applName. Selecting the About option brings up a dialog box that displays the application name and the specified additional information. Selecting the "Help" menu item displays the specified help document in a scrolling dialog window. The name of the help document should be a well-formed URL such as "file:helpFile.html" or "http://aWebSite/helpFile.html". The Help menu may have only one of the two standard entries if any of the parameters are null or if the name of the helpDocumentURL is a malformed URL.

Parameters:

applName - the name of this application, to be used in the "About This_Application" menu item; null if there should not be an "About This_Application" menu item

aboutMessage - additional information to be displayed in the "About This_Application" dialog box; null if there should not be an "About This_Application" menu item

helpDocumentURL - the URL for the document to be displayed in a new window when the "Help" menu item is selected; null if there should not be a menu item for a help document

BasicHelpMenu

public BasicHelpMenu(java.lang.String applName,
                     java.lang.String authors,
                     java.lang.String acknowledgements,
                     java.lang.String versionInfo,
                     java.lang.String helpDocumentURL)

Constructs a Help menu with two standard entries: "About This_Application" and "Help", where This_Application is replaced with applName. Selecting the About option brings up a dialog box that displays the application name, and the specified author(s), acknowledgements, and version information, each preceded with an appropriate label. If any of those parameters is null, the associated label will not be included. Selecting the "Help" menu item displays the specified help document in a scrolling dialog window. The name of the help document should be a well-formed URL such as "file:helpFile.html" or "http://aWebSite/helpFile.html". The Help menu may have only one of the two standard entries if applName or helpDocumentURL is null or if the name of the helpDocumentURL is a malformed URL.

Parameters:

applName - the name of this application, to be used in the "About This_Application" menu item; null if there should not be an "About This_Application" menu item

authors - the name(s) of the author(s) to be displayed in the "About This_Application" dialog box; null if the "About" information should not include author information

acknowledgements - acknowledgement information to be included in the "About This_Application" dialog box; null if the "About" information should not include acknowledgements

versionInfo - version information (for example, date or version number) to be included in the "About This_Application" dialog box; null if the "About" information should not include version information

helpDocumentURL - the URL for the document to be displayed in a new window when the "Help" menu item is selected; null if there should not be a menu item for a help document

Method Detail

makeAboutMessage

protected static java.lang.String makeAboutMessage(java.lang.String authors,
                                                   java.lang.String acknowledgements,
                                                   java.lang.String versionInfo)

setFrame

public void setFrame(javax.swing.JFrame frame)

Sets the frame to which this menu bar is attached. The menu bar does not need this information but will use it, if provided, to locate the window that displays help information.

addAboutMenuItem

public void addAboutMenuItem(java.lang.String applName,
                             java.lang.String additionalInfo)

Adds an "About This_Application" menu option to this menu, where This_Application is replaced with applName. Selecting this option brings up a dialog box that displays the application name (applName) and the specified additional information.

Parameters:

applName - the name of this application to be used in the menu item and as a title for the information in the dialog box

additionalInfo - additional information to be displayed in the dialog box

addHelpDocMenuItem

public void addHelpDocMenuItem(java.lang.String documentURL)

Adds a "Help" menu option to this menu that, when selected, displays the specified help document in a scrolling dialog window.

Parameters:

documentURL - the URL for the document to be displayed in a new window when the "Help" menu option is selected