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 jalview.util.BrowserLauncher;
  24 import jalview.util.Platform;
  25
  26 import java.awt.Point;
  27 import java.io.IOException;
  28 import java.net.URL;
  29
  30 import javax.help.BadIDException;
  31 import javax.help.HelpBroker;
  32 import javax.help.HelpSet;
  33 import javax.help.HelpSetException;
  34
  35 /**
  36  * Utility class to show the help documentation window
  37  *
  38  * @author gmcarstairs
  39  */
  40 public class Help
  41 {
  42   public enum HelpId
  43   {
  44     Home("home"), SequenceFeatureSettings("seqfeatures.settings"),
  45     StructureViewer("viewingpdbs"), PdbFts("pdbfts"),
  46     UniprotFts("uniprotfts");
  47
  48     private String id;
  49
  50     private HelpId(String loc)
  51     {
  52       this.id = loc;
  53     }
  54
  55     @Override
  56     public String toString()
  57     {
  58       return this.id;
  59     }
  60   }
  61
  62   private static HelpBroker hb;
  63
  64   /**
  65    * Not instantiable
  66    */
  67   private Help()
  68   {
  69
  70   }
  71
  72   /**
  73    * Shows the help window, at the entry specified by the given helpId
  74    *
  75    * @param id
  76    *
  77    * @throws HelpSetException
  78    */
  79   public static void showHelpWindow(HelpId id) throws HelpSetException
  80   {
  81         if (Platform.isJS())
  82         {
  83           try
  84           {
  85                 BrowserLauncher.openURL("http://www.jalview.org/help.html");
  86           } catch (IOException e) {}
  87             return;
  88         }
  89
  90     ClassLoader cl = Desktop.class.getClassLoader();
  91     URL url = HelpSet.findHelpSet(cl, "help/help"); // $NON-NLS-$
  92     HelpSet hs = new HelpSet(cl, url);
  93
  94     if (hb == null)
  95     {
  96       /*
  97        * create help broker first time (only)
  98        */
  99       hb = hs.createHelpBroker();
 100     }
 101
 102     try
 103     {
 104       hb.setCurrentID(id.toString());
 105     } catch (BadIDException bad)
 106     {
 107       System.out.println("Bad help link: " + id.toString()
 108               + ": must match a target in help.jhm");
 109       throw bad;
 110     }
 111
 112     /*
 113      * set Help visible - at its current location if it is already shown,
 114      * else at a location as determined by the window manager
 115      */
 116     Point p = hb.getLocation();
 117     hb.setLocation(p);
 118     hb.setDisplayed(true);
 119   }
 120
 121   /**
 122    * Show the Help window at the root entry
 123    *
 124    * @throws HelpSetException
 125    */
 126   public static void showHelpWindow() throws HelpSetException
 127   {
 128     showHelpWindow(HelpId.Home);
 129   }
 130 }