util
Class HelpDialog

java.lang.Object
  extended byutil.HelpDialog

public class HelpDialog
extends java.lang.Object

Defines the class used to display the help dialogs.

Author:
Mikael Jönsson & Per Klingnäs

Nested Class Summary
(package private)  class HelpDialog.ActionHandler
          Used to hide the window when the user closes it by clicking the close button.
(package private)  class HelpDialog.HelpWindow
          The class defining the window to show the help in.
(package private)  class HelpDialog.Hyperactive
          Class used to handle the hyperlinks in the HelpWindow.
(package private)  class HelpDialog.ListHandler
          Defines a ListSelectionLister that is used to detect on which topic the user clicks.
(package private)  class HelpDialog.WindowHandler
          Used to hide the window when the user closes it by clicking the close icon in the titlebar.
 
Field Summary
private  java.lang.String[] helpFiles
           
private  javax.swing.JList helpTopics
           
private  HelpDialog.HelpWindow helpWindow
           
private  javax.swing.JEditorPane infoPane
           
 
Constructor Summary
HelpDialog()
          Constructs a help dialog.
 
Method Summary
private  java.lang.String[] getHelpTopics()
          Gets the available help topics.
 void showHelpText(java.lang.String helpfile)
          Show the selected help file in the HelpWindow.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

helpWindow

private HelpDialog.HelpWindow helpWindow

infoPane

private javax.swing.JEditorPane infoPane

helpTopics

private javax.swing.JList helpTopics

helpFiles

private java.lang.String[] helpFiles
Constructor Detail

HelpDialog

public HelpDialog()
Constructs a help dialog.

Method Detail

getHelpTopics

private java.lang.String[] getHelpTopics()
Gets the available help topics.

Returns:
an array with the available topics

showHelpText

public void showHelpText(java.lang.String helpfile)
Show the selected help file in the HelpWindow.

Parameters:
helpfile - the file to be shown