uk.ac.essex.ia.helpview
Class HelpViewer

java.lang.Object
  uk.ac.essex.ia.helpview.HelpViewer

public class HelpViewer
extends java.lang.Object

This is the jHelp for the help system it make use of the JavaHelp API. The helpset is loaded of the classpath

See Also:

You should have received a copy of GNU public license with this code. If not please visit this site

Field Summary

protected javax.swing.JFrame	frame
static java.lang.String	HELP_SET

Method Summary

javax.swing.JFrame	getGUI()
javax.help.HelpSet	getHelpSet()
static HelpViewer	getInstance()
void	loadContentsAll() Loads the main contents page
void	loadContentsHelp() Loads the contents page of the help files
void	loadHelpID(java.lang.String helpID)
void	loadJavadoc() Load the javadoc
void	loadTutorial() Load the tutorial
static void	main(java.lang.String[] args)
void	setFile(java.lang.String fileName) Set the file and display it
void	show() Shows the frame

Methods inherited from class java.lang.Object

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

Field Detail

HELP_SET

public static final java.lang.String HELP_SET

See Also:

Constant Field Values

frame

protected javax.swing.JFrame frame

Method Detail

getInstance

public static HelpViewer getInstance()

Returns:

getHelpSet

public javax.help.HelpSet getHelpSet()

Returns:

HelpSet - The help set used

getGUI

public javax.swing.JFrame getGUI()

Returns:

the JFrame

show

public void show()

Shows the frame

loadContentsAll

public void loadContentsAll()

Loads the main contents page

loadContentsHelp

public void loadContentsHelp()

Loads the contents page of the help files

loadTutorial

public void loadTutorial()

Load the tutorial

loadJavadoc

public void loadJavadoc()

Load the javadoc

setFile

public void setFile(java.lang.String fileName)
             throws java.net.MalformedURLException,
                    java.io.IOException

Set the file and display it

Parameters:

fileName - - The file to load

Throws:

java.net.MalformedURLException - - If URL to load is bad

java.io.IOException - - If file cannot be loaded

loadHelpID

public void loadHelpID(java.lang.String helpID)

main

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