src/jalview/gui/Help.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.gui;
  22
  23 import java.awt.Point;
  24 import java.net.URL;
  25
  26 import javax.help.BadIDException;
  27 import javax.help.HelpBroker;
  28 import javax.help.HelpSet;
  29 import javax.help.HelpSetException;
  30
  31 /**
  32  * Utility class to show the help documentation window
  33  *
  34  * @author gmcarstairs
  35  */
  36 public class Help
  37 {
  38   public enum HelpId
  39   {
  40     Home("home"), SequenceFeatureSettings("seqfeatures.settings"),
  41     StructureViewer("viewingpdbs"), PdbFts("pdbfts"),
  42     UniprotFts("uniprotfts");
  43
  44     private String id;
  45
  46     private HelpId(String loc)
  47     {
  48       this.id = loc;
  49     }
  50
  51     @Override
  52     public String toString()
  53     {
  54       return this.id;
  55     }
  56   }
  57
  58   private static HelpBroker hb;
  59
  60   /**
  61    * Not instantiable
  62    */
  63   private Help()
  64   {
  65
  66   }
  67
  68   /**
  69    * Shows the help window, at the entry specified by the given helpId
  70    *
  71    * @param id
  72    *
  73    * @throws HelpSetException
  74    */
  75   public static void showHelpWindow(HelpId id) throws HelpSetException
  76   {
  77     ClassLoader cl = Desktop.class.getClassLoader();
  78     URL url = HelpSet.findHelpSet(cl, "help/help"); // $NON-NLS-$
  79     HelpSet hs = new HelpSet(cl, url);
  80
  81     if (hb == null)
  82     {
  83       /*
  84        * create help broker first time (only)
  85        */
  86       hb = hs.createHelpBroker();
  87     }
  88
  89     try
  90     {
  91       hb.setCurrentID(id.toString());
  92     } catch (BadIDException bad)
  93     {
  94       System.out.println("Bad help link: " + id.toString()
  95               + ": must match a target in help.jhm");
  96       throw bad;
  97     }
  98
  99     /*
 100      * set Help visible - at its current location if it is already shown,
 101      * else at a location as determined by the window manager
 102      */
 103     Point p = hb.getLocation();
 104     hb.setLocation(p);
 105     hb.setDisplayed(true);
 106   }
 107
 108   /**
 109    * Show the Help window at the root entry
 110    *
 111    * @throws HelpSetException
 112    */
 113   public static void showHelpWindow() throws HelpSetException
 114   {
 115     showHelpWindow(HelpId.Home);
 116   }
 117 }