Package ucar.unidata.ui

Class Help

java.lang.Object
ucar.unidata.ui.Help
public class Help extends Object
Convenience routines for accessing JavaHelp. These are static routines, so that they can be accessed from deeeply nested methods without having to pass the HekpSet object all over the place. The assumption is that there is only one helpset per application. The application should call setTopDir() to set the root directory, before any other calls are made into the help system. The helpset is then found at: 
 //HelpSet.hs
Inside the application, Help is accessed by ucar.unidata.ui.Help.getDefaultHelp().gotoTarget("top"); The actual target names must be valid names in the Map.xml file. I use "top" as the convention for the general Help page.
Version:
$Revision: 1.21 $ $Date: 2007/07/20 22:20:09 $
Author:
caron

  • Constructor Details

    • Help

      public Help()
      _more_

    • Help

      public Help(String helpSetName, boolean makeBroker)
      _more_
      Parameters:
      helpSetName - _more_
      makeBroker - _more_

  • Method Details

    • getDefaultHelp

      public static Help getDefaultHelp()
      _more_
      Returns:
      _more_

    • setTopDir

      public static void setTopDir(String topDir)
      _more_
      Parameters:
      topDir -

    • getJHelp

      public javax.help.JHelp getJHelp()
      _more_
      Returns:
      _more_

    • gotoTarget

      public boolean gotoTarget(List ids)
      Go to the first target in the array that is valid. If none are valid then return false
      Parameters:
      ids - Array of target help ids
      Returns:
      _more_

    • gotoTarget

      public void gotoTarget(String id)
      Go to the specified target in the HelpSet. If the display window for the help is not visible, show it and bring it to the front.
      Parameters:
      id - target help id

    • isValidID

      public boolean isValidID(String id)
      Is the given help id valid
      Parameters:
      id - The help id to check for validity
      Returns:
      Is the id valid, i.e., is it defined in the helpset

    • gotoTarget

      public void gotoTarget(String id, boolean setVisible)
      Go to the specified target in the HelpSet.
      Parameters:
      id - target help id
      setVisible - if true, create the help display window (if needed) the display window for the help is not visible, show it and bring it to the front. and bring it to the front.