X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FHelp.java;h=658b34fbbad3ce98152659f054b59d1d947db972;hb=ea7aa18440e6140ec7485e6cefdfb1dffb945580;hp=9d8955f8346e9cfd335a9d8708de5ed55299ad15;hpb=634afceda19c45e6d9790bfc23294a647b237fbc;p=jalview.git diff --git a/src/jalview/gui/Help.java b/src/jalview/gui/Help.java index 9d8955f..658b34f 100644 --- a/src/jalview/gui/Help.java +++ b/src/jalview/gui/Help.java @@ -28,31 +28,52 @@ import javax.help.HelpBroker; import javax.help.HelpSet; import javax.help.HelpSetException; +import jalview.util.BrowserLauncher; +import jalview.util.Platform; + /** - * 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 HelpId(String loc) + private String path; + + private HelpId(String hepLoc, String htmlPath) { - this.id = loc; + this.id = hepLoc; + this.path = htmlPath; } - @Override - public String toString() + String getId() { return this.id; } + + String getPath() + { + return this.path; + } } private static HelpBroker hb; @@ -74,35 +95,57 @@ public class Help */ public static void showHelpWindow(HelpId id) throws HelpSetException { - ClassLoader cl = Desktop.class.getClassLoader(); - URL url = HelpSet.findHelpSet(cl, "help/help"); // $NON-NLS-$ - HelpSet hs = new HelpSet(cl, url); - - if (hb == null) + if (Platform.isJS()) { /* - * create help broker first time (only) - */ - hb = hs.createHelpBroker(); + try + { + */ + BrowserLauncher.openURL(HELP_PAGE_ROOT + id.getPath()); + /* + } catch (IOException e) + { + } + */ } - - try - { - hb.setCurrentID(id.toString()); - } catch (BadIDException bad) + else + /** + * Java only + * + * @j2sIgnore + */ { - System.out.println("Bad help link: " + id.toString() - + ": 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); + ClassLoader cl = Desktop.class.getClassLoader(); + URL url = HelpSet.findHelpSet(cl, "help/help"); // $NON-NLS-$ + HelpSet hs = new HelpSet(cl, url); + + if (hb == null) + { + /* + * create help broker first time (only) + */ + hb = hs.createHelpBroker(); + } + + try + { + hb.setCurrentID(id.getId()); + } catch (BadIDException bad) + { + 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); + } } /**