2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
23 import java.awt.Point;
26 import javax.help.BadIDException;
27 import javax.help.HelpBroker;
28 import javax.help.HelpSet;
29 import javax.help.HelpSetException;
32 * Utility class to show the help documentation window
40 Home("home"), SequenceFeatureSettings("seqfeatures.settings"),
41 StructureViewer("viewingpdbs"), PdbFts("pdbfts"),
42 UniprotFts("uniprotfts");
46 private HelpId(String loc)
52 public String toString()
58 private static HelpBroker hb;
69 * Shows the help window, at the entry specified by the given helpId
73 * @throws HelpSetException
75 public static void showHelpWindow(HelpId id) throws HelpSetException
77 ClassLoader cl = Desktop.class.getClassLoader();
78 URL url = HelpSet.findHelpSet(cl, "help/help"); // $NON-NLS-$
79 HelpSet hs = new HelpSet(cl, url);
84 * create help broker first time (only)
86 hb = hs.createHelpBroker();
91 hb.setCurrentID(id.toString());
92 } catch (BadIDException bad)
94 System.out.println("Bad help link: " + id.toString()
95 + ": must match a target in help.jhm");
100 * set Help visible - at its current location if it is already shown,
101 * else at a location as determined by the window manager
103 Point p = hb.getLocation();
105 hb.setDisplayed(true);
109 * Show the Help window at the root entry
111 * @throws HelpSetException
113 public static void showHelpWindow() throws HelpSetException
115 showHelpWindow(HelpId.Home);