org.fife.help
Class HelpDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      org.fife.help.HelpDialog

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class HelpDialog

extends javax.swing.JFrame

implements java.awt.event.ActionListener

A help dialog similar to those found in most Microsoft Windows programs. The dialog contains a pane with Contents, Index, and Search tabs, each of which yields the expected way to find help. Help pages should be HTML.

Features of HelpDialog include:

• Contents/Index/Search pane - Works just like most Windows programs' Contents/Index/Search. Pick your favorite way to find help.
• Search/Index options automatically find all help documents (which you pass to HelpDialog) containing the word/phrase for which the user wants to find help.
• History - The HelpDialog class will remember the help documents the user has previously visited, and the user can use the Back and Forward buttons to easily traverse previous help.
• HTML Help - Help documents are HTML, to allow for easy formatting.

Notes:
In your HTML documentation, anchors can be used as hyperlinks; however, if you have a hyperlink that is simply an anchor to another place in the current HTML file (a href="#anchor" as opposed to a href="file2.html#anchor"), you need to explicitly state that the anchor is in the current file (i.e., a href="file2.html#anchor") for this class to parse it correctly.

Version:

1.0

Author:

Robert Futrell

See Also:

Serialized Form

Nested Class Summary

protected class

HelpDialog.HelpListener Listens for events in the help dialog.

Nested classes inherited from class javax.swing.JFrame

javax.swing.JFrame.AccessibleJFrame

Nested classes inherited from class java.awt.Frame

java.awt.Frame.AccessibleAWTFrame

Nested classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

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

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

HelpDialog(GUIApplication owner, java.lang.String contentsFile, java.lang.String baseDir)
Creates a new help dialog.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e)
java.lang.String	getContentsTabText() Returns the label on the "Contents" tab.
java.lang.String	getDisplayButtonText() Returns the label on the "Display" button on the Index and Search panels.
java.lang.String	getIndexTabText() Returns the label on the "Index" tab.
java.lang.String	getKeywordFieldLabelText() Returns the text label above the "Type in a keyword to find" text boxes.
java.lang.String	getListTopicsButtonText() Returns the label on the "List Topics" button on the Search panels.
java.lang.String	getSearchTabText() Returns the label on the "Search" tab.
java.lang.String	getTopicToDisplayFieldLabelText() Returns the text label above the "Select topic to display" text box.
void	setBackButtonIcon(javax.swing.Icon icon) Sets the icon to use for the "back" button.
void	setBaseURL(java.net.URL url) Sets the "base URL" from which all links will be searched for.
void	setContentsTabText(java.lang.String text) Sets the label on the "Contents" tab.
void	setDisplayButtonText(java.lang.String text) Sets the label on the "Display" button on the Index and Search panels.
void	setForwardButtonIcon(javax.swing.Icon icon) Sets the icon to use for the "forward" button.
void	setIndexTabText(java.lang.String text) Sets the label on the "Index" tab.
void	setKeywordFieldLabelText(java.lang.String text) Sets the text label above the "Type in a keyword to find" text boxes.
void	setListTopicsButtonText(java.lang.String text) Sets the label on the "List Topics" button on the Search panels.
void	setSearchTabText(java.lang.String text) Sets the label on the "Search" tab.
void	setTopicToDisplayFieldLabelText(java.lang.String text) Sets the text label above the "Select topic to display" text box.

Methods inherited from class javax.swing.JFrame

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

Methods inherited from class java.awt.Frame

addNotify, finalize, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setIconImage, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, show, 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, 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, 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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

HelpDialog

public HelpDialog(GUIApplication owner,
                  java.lang.String contentsFile,
                  java.lang.String baseDir)

Creates a new help dialog.

Parameters:

owner - The frame that owns this dialog.

contentsFile - The XML file specifying the structure of this online help.

baseDir - The directory in which all help stuff is stored. This will also be used as the base directory for relative links in the HTML of the online help.

Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

getContentsTabText

public final java.lang.String getContentsTabText()

Returns the label on the "Contents" tab.

Returns:

The text on the "Contents" tab.

See Also:

setContentsTabText(java.lang.String)

getDisplayButtonText

public final java.lang.String getDisplayButtonText()

Returns the label on the "Display" button on the Index and Search panels.

Returns:

The text on the "Display" buttons.

See Also:

setDisplayButtonText(java.lang.String)

getIndexTabText

public final java.lang.String getIndexTabText()

Returns the label on the "Index" tab.

Returns:

The text on the "Index" tab.

See Also:

setIndexTabText(java.lang.String)

getKeywordFieldLabelText

public final java.lang.String getKeywordFieldLabelText()

Returns the text label above the "Type in a keyword to find" text boxes.

Returns:

The text label.

See Also:

setKeywordFieldLabelText(java.lang.String)

getListTopicsButtonText

public final java.lang.String getListTopicsButtonText()

Returns the label on the "List Topics" button on the Search panels.

Returns:

The text on the "List Topics" button.

See Also:

setListTopicsButtonText(java.lang.String)

getSearchTabText

public final java.lang.String getSearchTabText()

Returns the label on the "Search" tab.

Returns:

The text on the "Search" tab.

See Also:

setSearchTabText(java.lang.String)

getTopicToDisplayFieldLabelText

public final java.lang.String getTopicToDisplayFieldLabelText()

Returns the text label above the "Select topic to display" text box.

Returns:

The text label.

See Also:

setTopicToDisplayFieldLabelText(java.lang.String)

setBackButtonIcon

public void setBackButtonIcon(javax.swing.Icon icon)

Sets the icon to use for the "back" button.

Parameters:

icon - The icon to use. If null, no icon will be used.

See Also:

setForwardButtonIcon(javax.swing.Icon)

setBaseURL

public void setBaseURL(java.net.URL url)

Sets the "base URL" from which all links will be searched for. That is, all HTML pages loaded will have their links treated as relative to this URL.

Parameters:

url - The base URL.

setContentsTabText

public void setContentsTabText(java.lang.String text)

Sets the label on the "Contents" tab.

Parameters:

text - The text for the "Contents" tab.

See Also:

getContentsTabText()

setDisplayButtonText

public void setDisplayButtonText(java.lang.String text)

Sets the label on the "Display" button on the Index and Search panels.

Parameters:

text - The text for the "Display" button.

See Also:

getDisplayButtonText()

setForwardButtonIcon

public void setForwardButtonIcon(javax.swing.Icon icon)

Sets the icon to use for the "forward" button.

Parameters:

icon - The icon to use. If null, no icon will be used.

See Also:

setBackButtonIcon(javax.swing.Icon)

setIndexTabText

public void setIndexTabText(java.lang.String text)

Sets the label on the "Index" tab.

Parameters:

text - The text for the "Index" tab.

See Also:

getIndexTabText()

setKeywordFieldLabelText

public void setKeywordFieldLabelText(java.lang.String text)

Sets the text label above the "Type in a keyword to find" text boxes.

Parameters:

text - The text label.

See Also:

getKeywordFieldLabelText()

setListTopicsButtonText

public void setListTopicsButtonText(java.lang.String text)

Sets the label on the "List Topics" button on the Search panels.

Parameters:

text - The text for the "List Topics" button.

See Also:

getListTopicsButtonText()

setSearchTabText

public void setSearchTabText(java.lang.String text)

Sets the label on the "Search" tab.

Parameters:

text - The text for the "Search" tab.

See Also:

getSearchTabText()

setTopicToDisplayFieldLabelText

public void setTopicToDisplayFieldLabelText(java.lang.String text)

Sets the text label above the "Select topic to display" text box.

Parameters:

text - The text label.

See Also:

getTopicToDisplayFieldLabelText()