X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FHelp.java;h=8bd01ea42916fa907c0249ae3426b932663588be;hb=1cec732f963ab102c9d8381203df8c8cba2a9ee4;hp=651d265c1625983ea1b612c4275ce71e1c984637;hpb=b3d6aed35086ad23b97d6ec7a80e6af036805175;p=jalview.git diff --git a/src/jalview/gui/Help.java b/src/jalview/gui/Help.java index 651d265..8bd01ea 100644 --- a/src/jalview/gui/Help.java +++ b/src/jalview/gui/Help.java @@ -39,24 +39,38 @@ import javax.help.HelpSetException; */ 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"), PdbFts("pdbfts"), - UniprotFts("uniprotfts"); + 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; } + + String getPath() + { + return this.path; + } } private static HelpBroker hb; @@ -78,44 +92,53 @@ public class Help */ public static void showHelpWindow(HelpId id) throws HelpSetException { - if (Platform.isJS()) - { - try - { - BrowserLauncher.openURL("http://www.jalview.org/help.html"); - } catch (IOException e) {} - return; - } - - 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); + } } /**