org.gjt.universe.gui
Class MicroHelp

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--org.gjt.universe.gui.UniverseJDialog
                                      |
                                      +--org.gjt.universe.gui.MicroHelp

All Implemented Interfaces:

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

public class MicroHelp

extends UniverseJDialog

See Also:

Serialized Form

Nested Class Summary

(package private) class	MicroHelp.History Maintain document history.
(package private) class	MicroHelp.LabelUpdater Part of the thread-safe changer
(package private) class	MicroHelp.LinkListener Listen to HyperLink events, and handle them appropriately.
(package private) class	MicroHelp.PropListener This listens to the editor kit.

Field Summary

(package private) javax.swing.JButton	back
(package private) MicroHelp.History	base
(package private) javax.swing.JButton	cont
private java.lang.String	DEFAULT_MSG
(package private) javax.swing.JButton	forward
(package private) MicroHelp.History	history
(package private) javax.swing.JEditorPane	html
(package private) javax.swing.JLabel	indicator
(package private) MicroHelp.LabelUpdater	labelupd
(package private) javax.swing.JPanel	navPanel

Fields inherited from class org.gjt.universe.gui.UniverseJDialog

img, img_h, img_w

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

Fields inherited from class java.awt.Window

Fields inherited from class java.awt.Container

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

MicroHelp(javax.swing.JFrame parent, boolean singlePage, java.lang.String title)
Create a MicroHelp display dialog, using the specified options.

Method Summary

private void	goBack() follow the chain backwards.
private void	goContents() Go to the contents page.
private void	goForward() go forward in a list of links.
private void	makeNavPanel(boolean spage) create the navigation panel.
void	setContents(java.lang.String url) Sets the initial page of the dialog.
private void	setFrozen(boolean value) Freeze (disable) all buttons while a page is loading.
void	setLabel(java.lang.String text) Allows us to change the 'indicator' label safely from the event thread.
private void	setPage(java.lang.String url) Set a page; if an error occured, inform the user politely.

Methods inherited from class org.gjt.universe.gui.UniverseJDialog

close, createRootPane, dialogInit, getProperFrame, makeLabel, setBackgroundTile, setDefaultCloseOperation

Methods inherited from class javax.swing.JDialog

addImpl, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Dialog

addNotify, dispose, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MSG

private final java.lang.String DEFAULT_MSG

See Also:

Constant Field Values

navPanel

javax.swing.JPanel navPanel

html

javax.swing.JEditorPane html

back

javax.swing.JButton back

forward

javax.swing.JButton forward

cont

javax.swing.JButton cont

indicator

javax.swing.JLabel indicator

history

MicroHelp.History history

base

MicroHelp.History base

labelupd

MicroHelp.LabelUpdater labelupd

Constructor Detail

MicroHelp

public MicroHelp(javax.swing.JFrame parent,
                 boolean singlePage,
                 java.lang.String title)

Create a MicroHelp display dialog, using the specified options. For single-page mode, hyperlinks are not enabled, and the navigation bar is replaced with an OK button which closes the dialog. It is ideal for displaying a single text page, e.g., for license agreements.

Parameters:

parent - The parent JFrame.

singlePage - true for single-page mode.

title - Dialog title.

Method Detail

setContents

public void setContents(java.lang.String url)

Sets the initial page of the dialog. If not in single-page mode, this is also the page to which the Contents button returns.

Parameters:

url - The root URL.

makeNavPanel

private void makeNavPanel(boolean spage)

create the navigation panel.

goForward

private void goForward()

go forward in a list of links.

goBack

private void goBack()

follow the chain backwards.

goContents

private void goContents()

Go to the contents page. This resets all previous forward & backward links.

setFrozen

private void setFrozen(boolean value)

Freeze (disable) all buttons while a page is loading. This reduces various Swing exceptions which can be generated if a user flips back & forth between pages which are still loading. It is a bit restrictive, however.

setPage

private void setPage(java.lang.String url)

Set a page; if an error occured, inform the user politely.

setLabel

public void setLabel(java.lang.String text)

Allows us to change the 'indicator' label safely from the event thread.