Package de.sciss.gui

Class HelpFrame

java.lang.Object

de.sciss.gui.HelpFrame

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener, javax.swing.event.HyperlinkListener

public class HelpFrame
extends java.lang.Object
implements javax.swing.event.HyperlinkListener, java.beans.PropertyChangeListener

A frame displaying online HTML help pages.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.Object	COMP_HELP	Identifier for Application.getComponent
protected javax.swing.JButton	ggBack
protected javax.swing.JButton	ggEdit
protected java.util.ArrayList	history
protected int	historyIndex
protected AbstractWindow	win

Constructor Summary

Constructors

Constructor	Description
HelpFrame()	Creates a new help frame.

Method Summary

Modifier and Type	Method	Description
void	dispose()
void	hyperlinkUpdate(javax.swing.event.HyperlinkEvent e)
void	loadHelpFile(java.lang.String fileName)	Replaces the window's contents by a new HTML file.
void	loadHelpFile(java.net.URL url)
protected void	loadURL()
protected void	openInBrowser()
static void	openViewerAndLoadHelpFile(java.lang.String fileName)	Views a help document.
static void	openViewerAndLoadHelpFile(java.net.URL url)
void	propertyChange(java.beans.PropertyChangeEvent e)

Methods inherited from class java.lang.Object

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

Field Detail

COMP_HELP

public static final java.lang.Object COMP_HELP

Identifier for Application.getComponent

ggEdit

protected final javax.swing.JButton ggEdit

ggBack

protected final javax.swing.JButton ggBack

history

protected final java.util.ArrayList history

historyIndex

protected int historyIndex

win

protected final AbstractWindow win

Constructor Detail

HelpFrame

public HelpFrame()

Creates a new help frame. Use loadHelpFile to change the content.

See Also:

loadHelpFile( String )

Method Detail

dispose

public void dispose()

openViewerAndLoadHelpFile

public static void openViewerAndLoadHelpFile(java.lang.String fileName)

Views a help document. If no help viewer has been opened, a new one will be created and installed with the current application (component ID = COMP_HELP).

Parameters:

fileName - relative file name of the help text, omitting the directory and the ".html" suffix

openViewerAndLoadHelpFile

public static void openViewerAndLoadHelpFile(java.net.URL url)

loadHelpFile

public void loadHelpFile(java.lang.String fileName)

Replaces the window's contents by a new HTML file.

Parameters:

fileName - relative file name of the help text, omitting the directory and the ".html" suffix

loadHelpFile

public void loadHelpFile(java.net.URL url)

loadURL

protected void loadURL()
                throws java.io.IOException

Throws:

java.io.IOException

openInBrowser

protected void openInBrowser()

hyperlinkUpdate

public void hyperlinkUpdate(javax.swing.event.HyperlinkEvent e)

Specified by:

hyperlinkUpdate in interface javax.swing.event.HyperlinkListener

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent e)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener