Class HelpWindow

All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class HelpWindow extends AuxWindow
Window for displaying the help browser. Get the instance of this singleton class using the getInstance(java.awt.Component) method. Sun's JavaHelp package is used for the hard work.
Author:
Mark Taylor (Starlink)
See Also:
  • Field Details

    • HELPSET_LOCATION

      public static final String HELPSET_LOCATION
      Location of the HelpSet file relative to this class.
      See Also:
  • Method Details

    • getInstance

      public static HelpWindow getInstance(Component parent)
      Returns the sole instance of this class. If supplied, a parent window is used only for positioning.
      Parameters:
      parent - parent window
    • getJHelp

      public javax.help.JHelp getJHelp()
      Returns the JHelp window which does the viewing of the pages in this window.
      Returns:
      the JHelp component
    • setID

      public void setID(String helpID)
      Sets the current help ID to the one represented by the given string. If helpID is null, or does not refer to a real ID in this HelpSet, no change is made to the current view.
      Parameters:
      helpID - the ID to change to