X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FHelp.java;h=8bd01ea42916fa907c0249ae3426b932663588be;hb=9d2408483e451285fd555c3cd6e0273977acbaa7;hp=f2d81139d3f5cf878af872939d31ff0b6411cee2;hpb=853624fb32058cccc544ae7d13af6ad4b0800b6c;p=jalview.git diff --git a/src/jalview/gui/Help.java b/src/jalview/gui/Help.java index f2d8113..8bd01ea 100644 --- a/src/jalview/gui/Help.java +++ b/src/jalview/gui/Help.java @@ -20,6 +20,11 @@ */ package jalview.gui; +import jalview.util.BrowserLauncher; +import jalview.util.Platform; + +import java.awt.Point; +import java.io.IOException; import java.net.URL; import javax.help.BadIDException; @@ -28,35 +33,47 @@ import javax.help.HelpSet; import javax.help.HelpSetException; /** - * Utility class to show the help documentation window. + * Utility class to show the help documentation window * * @author gmcarstairs - * */ public class Help { + private static final String HELP_PAGE_ROOT = "http://www.jalview.org/help/"; + + /** + * Defines selected help targets with links to inbuilt (Java) help page target, + * and externally hosted help page. Will need to be maintained manually if help + * pages are reorganised in future. + */ public enum HelpId { - Home("home"), SequenceFeatureSettings("seqfeatures.settings"), - StructureViewer("viewingpdbs"); + Home("home", "help.html"), SequenceFeatureSettings("seqfeatures.settings", "html/features/featuresettings.html"), + StructureViewer("viewingpdbs", "html/features/viewingpdbs.html"), PdbFts("pdbfts", "html/features/pdbsequencefetcher.html#pdbfts"), + UniprotFts("uniprotfts", "html/features/uniprotsequencefetcher.html#uniprotfts"); private String id; + + private String path; - private HelpId(String loc) + private HelpId(String hepLoc, String htmlPath) { - this.id = loc; + this.id = hepLoc; + this.path = htmlPath; } - @Override - public String toString() + String getId() { return this.id; } - } - private static final long HALF_A_MO = 500; // half a second + String getPath() + { + return this.path; + } + } - private static long lastOpenedTime = 0L; + private static HelpBroker hb; /** * Not instantiable @@ -67,42 +84,68 @@ public class Help } /** - * Show help text in a new window. But do nothing if within half a second of - * the last invocation. - * - * This is a workaround for issue JAL-914 - both Desktop and AlignFrame - * responding to F1 key, resulting in duplicate help windows opened. + * Shows the help window, at the entry specified by the given helpId * * @param id - * TODO * * @throws HelpSetException */ public static void showHelpWindow(HelpId id) throws HelpSetException { - long timeNow = System.currentTimeMillis(); - - if (timeNow - lastOpenedTime > HALF_A_MO) + if (Platform.isJS()) { - lastOpenedTime = timeNow; + try + { + BrowserLauncher.openURL(HELP_PAGE_ROOT + id.getPath()); + } catch (IOException e) + { + } + } + else + /** + * Java only + * + * @j2sIgnore + */ + { + ClassLoader cl = Desktop.class.getClassLoader(); URL url = HelpSet.findHelpSet(cl, "help/help"); // $NON-NLS-$ HelpSet hs = new HelpSet(cl, url); - HelpBroker hb = hs.createHelpBroker(); + if (hb == null) + { + /* + * create help broker first time (only) + */ + hb = hs.createHelpBroker(); + } + try { - hb.setCurrentID(id.toString()); + hb.setCurrentID(id.getId()); } catch (BadIDException bad) { - System.out.println("Bad help link: " + id.toString() + System.out.println("Bad help link: " + id.getId() + ": must match a target in help.jhm"); throw bad; } + + /* + * set Help visible - at its current location if it is already shown, + * else at a location as determined by the window manager + */ + Point p = hb.getLocation(); + hb.setLocation(p); hb.setDisplayed(true); } } + /** + * Show the Help window at the root entry + * + * @throws HelpSetException + */ public static void showHelpWindow() throws HelpSetException { showHelpWindow(HelpId.Home);