com.physpics.tools.ui

Class HelpBox

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JScrollPane

com.physpics.tools.ui.HelpBox

All Implemented Interfaces:

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

public class HelpBox
extends javax.swing.JScrollPane

Establishes and manages a link between an application and a help file. As the mouse moves over the application window, it sends messages to HelpBox, which scrolls the help window to the description of the component named in the message. Creating a HelpBox component. HelpBox.create() makes a JScrollPane can also let the menu item do it Install help text. setHelpText Adding HelpBox menu items ( addHelpMenuItem(JMenu h, boolean includeF1) Registering components. assignName(Component c, String n) (or add to an Action ( putValue(HelpBox.NAMEKEY, "openProjectMenuItem"); (and have the method that uses an action (check for that key and do assignName ) Scrolling to sections. scrollToTarget(String name) Images. should be located relative to the helptext Hyperlinks. only internal (#) hyperlinks are implemented

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	HelpBox.AnchorInfo

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

javax.swing.JScrollPane.AccessibleJScrollPane, javax.swing.JScrollPane.ScrollBar

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

Modifier and Type	Field and Description
protected java.util.HashMap<java.lang.String,HelpBox.AnchorInfo>	anchorTable Map from anchors in the HTML (that is, <a id='name' ...>) to the character position in the document.
static int	BOX_HEIGHT
static int	BOX_WIDTH
static javax.swing.KeyStroke	F1
static boolean	GRAB_MOUSE GRAB_MOUSE, NO_GRAB_MOUSE arguments to showHelpbox so its argument is not mis-interpreted as visibility
static java.lang.String	NAMEKEY
static boolean	NO_GRAB_MOUSE GRAB_MOUSE, NO_GRAB_MOUSE arguments to showHelpbox so its argument is not mis-interpreted as visibility

Fields inherited from class javax.swing.JScrollPane

columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewport

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

COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT

Fields inherited from interface java.awt.image.ImageObserver

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

Method Summary

Modifier and Type	Method and Description
void	addF1(javax.swing.JComponent comp) Cause the component to respond to F1 by showing the HelpBox.
javax.swing.JMenuItem	addHelpMenuItem(javax.swing.JMenu h) Adds menu item Help to a JMenu.
static HelpBox	create() Construct an empty HelpBox.
static HelpBox	create(java.lang.Class<?> aClass, java.lang.String locator, java.net.URL base) Create a HelpBox and load it from a file.
void	dumpAnchorTable(PrintStream outstr)
void	fixAnchorTable() Fill in the global HashMap 'anchorTable' with map from anchor point names to locations CASE SENSITIVE This method must be called after loading the help document.
javax.swing.JFrame	getFrame()
HTMLPane	getHelpViewer()
java.awt.Rectangle	getScreenBounds()
static java.awt.Dimension	getScreenSize(java.awt.Component comp) Utility method to find the screen size of the screen where a component is displayed.
javax.swing.JFrame	getWindow()
void	grabMouse() Move the mouse to the upper left corner of this HelpBox.
boolean	isLeashed(int x, int y)
void	leashTo(java.awt.Rectangle r) Turn off autoscrolling until mouse has moved at least LEASHLENGTH pixels away from rectangle r
static void	main(java.lang.String[] args)
int	offsetFor(java.lang.String name)
void	processHTMLFrameHyperlinkEvent(javax.swing.text.html.HTMLFrameHyperlinkEvent e)
protected void	scrollToOffset(int off) Scroll the help document to a given offset.
void	scrollToTarget(java.lang.String name)
void	sensitize(java.awt.Component c, java.lang.String n) Add a mouse listener to a component that will call scrollToOffset.
void	sensitizeTree(java.awt.Component c, java.lang.String n) Assign a name to a component and all subcomponents.
void	setScreenBounds(int x, int y, int width, int height) Set the location of a window opened by a menu item.
void	showHelpBox(boolean grab) Cause this HelpBox to become visible at the location in screenBounds.
void	showHelpBox(boolean grab, int scrollPos) Cause this HelpBox to become visible at the location in screenBounds.

Methods inherited from class javax.swing.JScrollPane

createHorizontalScrollBar, createVerticalScrollBar, createViewport, getAccessibleContext, getColumnHeader, getCorner, getHorizontalScrollBar, getHorizontalScrollBarPolicy, getRowHeader, getUI, getUIClassID, getVerticalScrollBar, getVerticalScrollBarPolicy, getViewport, getViewportBorder, getViewportBorderBounds, isValidateRoot, isWheelScrollingEnabled, paramString, setColumnHeader, setColumnHeaderView, setComponentOrientation, setCorner, setHorizontalScrollBar, setHorizontalScrollBarPolicy, setLayout, setRowHeader, setRowHeaderView, setUI, setVerticalScrollBar, setVerticalScrollBarPolicy, setViewport, setViewportBorder, setViewportView, setWheelScrollingEnabled, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, 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, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, 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, 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, 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

F1

public static final javax.swing.KeyStroke F1

NAMEKEY

public static final java.lang.String NAMEKEY

See Also:

Constant Field Values

GRAB_MOUSE

public static final boolean GRAB_MOUSE

GRAB_MOUSE, NO_GRAB_MOUSE arguments to showHelpbox so its argument is not mis-interpreted as visibility

See Also:

Constant Field Values

NO_GRAB_MOUSE

public static final boolean NO_GRAB_MOUSE

GRAB_MOUSE, NO_GRAB_MOUSE arguments to showHelpbox so its argument is not mis-interpreted as visibility

See Also:

Constant Field Values

BOX_HEIGHT

public static final int BOX_HEIGHT

See Also:

Constant Field Values

BOX_WIDTH

public static final int BOX_WIDTH

See Also:

Constant Field Values

anchorTable

protected java.util.HashMap<java.lang.String,HelpBox.AnchorInfo> anchorTable

Map from anchors in the HTML (that is, <a id='name' ...>) to the character position in the document.

Method Detail

getHelpViewer

public HTMLPane getHelpViewer()

Returns:

the HTMLPane containing the help file contents. All the methods of HTMLPane are available to load the help contents.

getWindow

public javax.swing.JFrame getWindow()

Returns:

the window

create

public static HelpBox create()

Construct an empty HelpBox. The contents may be loaded with getHelpViewer.loadDocument; after doing so, the client must call fixAnchorTable();

Returns:

a newly created HelpBox, with no content.

create

public static HelpBox create(java.lang.Class<?> aClass,
                             java.lang.String locator,
                             java.net.URL base)

Create a HelpBox and load it from a file. This creates the object, delegates to HTMLPane.loadDocument, and calls fixAnchorTable().

Parameters:

aClass - a Class loaded from the ClassLoader containing the document to load. May be null if not loading from resource: or jardir:

locator - a locator suitable for IOUtils.getInputStream

base - an URL indicating where the embedded images are located. If null, images are expected to be in the same location as the locator

Returns:

a new HelpBox viewing the named html file.

getFrame

public javax.swing.JFrame getFrame()

Returns:

the JFrame that has been created for the HelpBox. This enables a client to change the window title.

processHTMLFrameHyperlinkEvent

public void processHTMLFrameHyperlinkEvent(javax.swing.text.html.HTMLFrameHyperlinkEvent e)

fixAnchorTable

public void fixAnchorTable()

Fill in the global HashMap 'anchorTable' with map from anchor point names to locations CASE SENSITIVE This method must be called after loading the help document.

sensitize

public void sensitize(java.awt.Component c,
                      java.lang.String n)

Add a mouse listener to a component that will call scrollToOffset. Any existing HelpTrigger listeners are removed.

Parameters:

c - The component

n - The name for the component

sensitizeTree

public void sensitizeTree(java.awt.Component c,
                          java.lang.String n)

Assign a name to a component and all subcomponents. Activate them all to emit scrollToTarget events. The name is stored in the same field as for the component's setName method.

Parameters:

c - The component

n - The name for the component and its subcomponents.

isLeashed

public boolean isLeashed(int x,
                         int y)

scrollToTarget

public void scrollToTarget(java.lang.String name)

offsetFor

public int offsetFor(java.lang.String name)

scrollToOffset

protected void scrollToOffset(int off)

Scroll the help document to a given offset.

Parameters:

off - The offset of the document character to be on the top display.

dumpAnchorTable

public void dumpAnchorTable(PrintStream outstr)

setScreenBounds

public void setScreenBounds(int x,
                            int y,
                            int width,
                            int height)

Set the location of a window opened by a menu item. If the window is already open, it will be relocated.

Parameters:

x - Window top relative to screen top of 0

y - Window left relative to screen left of 0

width - Window width

height - Window height

getScreenBounds

public java.awt.Rectangle getScreenBounds()

grabMouse

public void grabMouse()

Move the mouse to the upper left corner of this HelpBox. This is called after opening the HelpBox in a window. It gets the mouse to the HelpBox without moving across the calling window. Thus the top of the help file will be displayed.

leashTo

public void leashTo(java.awt.Rectangle r)

Turn off autoscrolling until mouse has moved at least LEASHLENGTH pixels away from rectangle r

Parameters:

r - The boundary rectangle

addHelpMenuItem

public javax.swing.JMenuItem addHelpMenuItem(javax.swing.JMenu h)

Adds menu item Help to a JMenu. Initially its text will be "Show Help".

Parameters:

h - The JMenu to be augmented.

Returns:

The added JMenuItem

addF1

public void addF1(javax.swing.JComponent comp)

Cause the component to respond to F1 by showing the HelpBox. Usually the JComponent should be the JFrame.

Parameters:

comp - The JComponent to activate for F1 help.

getScreenSize

public static java.awt.Dimension getScreenSize(java.awt.Component comp)

Utility method to find the screen size of the screen where a component is displayed.

Parameters:

comp - the Component whose screen size is wanted.

Returns:

the Dimension of the screen

showHelpBox

public void showHelpBox(boolean grab)

Cause this HelpBox to become visible at the location in screenBounds. If screenBounds are null, the window is placed in the lower left.

Parameters:

grab - Whether to warp the mouse to the newly opened window

showHelpBox

public void showHelpBox(boolean grab,
                        int scrollPos)

Cause this HelpBox to become visible at the location in screenBounds. If screenBounds are null, the window is placed in the lower left.

Parameters:

grab - Whether to warp the mouse to the newly opened window

scrollPos - A position to be scrolled to the top of the helpbox window. No scroll is done if this value is less than zero

main

public static void main(java.lang.String[] args)