Package adams.gui.help

Class HelpFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

adams.gui.core.BaseFrame

adams.gui.help.HelpFrame

All Implemented Interfaces:

LoggingSupporter, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class HelpFrame
extends BaseFrame

For displaying help as plain text or html.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HelpFrame.HelpHyperlinkListener	Default handler for hyperlinks.

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow, Window.Type

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

Modifier and Type	Field	Description
protected JMenuItem	m_MenuItemClear	the clear menu item.
protected JMenuItem	m_MenuItemClose	the close menu item.
protected JMenuItem	m_MenuItemSaveAs	the save as menu item.
protected HelpHistoryPanel	m_PanelHistory	for displaying the help.
protected static HelpFrame	m_Singleton	the singleton.
protected BaseSplitPane	m_SplitPane	the split pane.
protected BaseHtmlEditorPane	m_Text	the editor pane.

Fields inherited from class adams.gui.core.BaseFrame

m_Logger, m_MaximizationFixWindowListener, m_UISettingsApplied, m_UISettingsPrefix, m_UISettingsStored, m_UseMaximizationFix

Fields inherited from class javax.swing.JFrame

accessibleContext, 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 java.awt.image.ImageObserver

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HelpFrame()	Initializes the frame.

Method Summary

Modifier and Type	Method	Description
protected JMenuBar	createMenu()	Generates the menu.
protected KeyListener	getKeyListener()	Returns the KeyListener to use for text and button.
static HelpFrame	getSingleton()	Gives access to the singleton.
protected void	initGUI()	Initializes the widgets.
static void	showHelp(Class cls)	Shows the help in the frame.
static void	showHelp(Class cls, String help, boolean html)	Shows the help in the frame.
static void	showHelp(Object obj)	Shows the help in the frame.
void	showHelp(String key, HelpContainer cont)	Shows the help.
static void	showHelp(String key, String help, boolean html)	Shows the help in the frame.
protected void	updateMenu()	Updates the state of the menu items.

Methods inherited from class adams.gui.core.BaseFrame

afterHide, afterShow, applyUISettings, beforeHide, beforeShow, finishInit, forName, getLogger, getUISettingsApplied, getUISettingsPrefix, initialize, initializeLogger, isLoggingEnabled, performInitialization, runFrame, setBounds, setLocationRelativeTo, setUISettingsPrefix, setUISettingsPrefix, setVisible, storeUISettings

Methods inherited from class javax.swing.JFrame

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

Methods inherited from class java.awt.Frame

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

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setMinimumSize, setModalExclusionType, setSize, setSize, setType, 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, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

m_Singleton

protected static HelpFrame m_Singleton

the singleton.

m_PanelHistory

protected HelpHistoryPanel m_PanelHistory

for displaying the help.

m_SplitPane

protected BaseSplitPane m_SplitPane

the split pane.

m_Text

protected BaseHtmlEditorPane m_Text

the editor pane.

m_MenuItemClear

protected JMenuItem m_MenuItemClear

the clear menu item.

m_MenuItemSaveAs

protected JMenuItem m_MenuItemSaveAs

the save as menu item.

m_MenuItemClose

protected JMenuItem m_MenuItemClose

the close menu item.

Constructor Detail

HelpFrame

protected HelpFrame()

Initializes the frame.

Method Detail

initGUI

protected void initGUI()

Initializes the widgets.

Overrides:

initGUI in class BaseFrame

createMenu

protected JMenuBar createMenu()

Generates the menu.

updateMenu

protected void updateMenu()

Updates the state of the menu items.

getKeyListener

protected KeyListener getKeyListener()

Returns the KeyListener to use for text and button.

Returns:

the listener

showHelp

public void showHelp(String key,
                     HelpContainer cont)

Shows the help.

Parameters:

key - the key for the help

cont - the help

getSingleton

public static HelpFrame getSingleton()

Gives access to the singleton.

Returns:

the singleton

showHelp

public static void showHelp(Class cls)

Shows the help in the frame.

Parameters:

cls - the class to generate the help for

showHelp

public static void showHelp(Object obj)

Shows the help in the frame.

Parameters:

obj - the object to generate the help for

showHelp

public static void showHelp(Class cls,
                            String help,
                            boolean html)

Shows the help in the frame.

Parameters:

cls - the class identifying the help screen

help - the help to display

html - true if to display as HTML

showHelp

public static void showHelp(String key,
                            String help,
                            boolean html)

Shows the help in the frame.

Parameters:

key - the key identifying the help screen

help - the help to display

html - true if to display as HTML