|
|||||||||||||||||||
| Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
| HelpFrame.java | 0% | 15.8% | 50% | 15.2% |
|
||||||||||||||
| 1 | /*BEGIN_COPYRIGHT_BLOCK | |
| 2 | * | |
| 3 | * Copyright (c) 2001-2010, JavaPLT group at Rice University (drjava@rice.edu) | |
| 4 | * All rights reserved. | |
| 5 | * | |
| 6 | * Redistribution and use in source and binary forms, with or without | |
| 7 | * modification, are permitted provided that the following conditions are met: | |
| 8 | * * Redistributions of source code must retain the above copyright | |
| 9 | * notice, this list of conditions and the following disclaimer. | |
| 10 | * * Redistributions in binary form must reproduce the above copyright | |
| 11 | * notice, this list of conditions and the following disclaimer in the | |
| 12 | * documentation and/or other materials provided with the distribution. | |
| 13 | * * Neither the names of DrJava, the JavaPLT group, Rice University, nor the | |
| 14 | * names of its contributors may be used to endorse or promote products | |
| 15 | * derived from this software without specific prior written permission. | |
| 16 | * | |
| 17 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
| 18 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
| 19 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
| 20 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR | |
| 21 | * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, | |
| 22 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, | |
| 23 | * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | |
| 24 | * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | |
| 25 | * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | |
| 26 | * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| 27 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| 28 | * | |
| 29 | * This software is Open Source Initiative approved Open Source Software. | |
| 30 | * Open Source Initative Approved is a trademark of the Open Source Initiative. | |
| 31 | * | |
| 32 | * This file is part of DrJava. Download the current version of this project | |
| 33 | * from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/ | |
| 34 | * | |
| 35 | * END_COPYRIGHT_BLOCK*/ | |
| 36 | ||
| 37 | package edu.rice.cs.drjava.ui; | |
| 38 | ||
| 39 | import edu.rice.cs.drjava.platform.PlatformFactory; | |
| 40 | ||
| 41 | import javax.swing.event.HyperlinkListener; | |
| 42 | import javax.swing.event.HyperlinkEvent; | |
| 43 | import java.net.URL; | |
| 44 | import java.net.MalformedURLException; | |
| 45 | ||
| 46 | /** | |
| 47 | * The frame for displaying the HTML help files. | |
| 48 | * @version $Id: HelpFrame.java 5175 2010-01-20 08:46:32Z mgricken $ | |
| 49 | */ | |
| 50 | public class HelpFrame extends HTMLFrame { | |
| 51 | private static final String HELP_PATH = "/edu/rice/cs/drjava/docs/user/"; | |
| 52 | protected static final String CONTENTS_PAGE = "index.html"; | |
| 53 | protected static final String HOME_PAGE = "ch01.html"; | |
| 54 | private static final URL INTRO_URL = HTMLFrame.class.getResource(HELP_PATH + HOME_PAGE); | |
| 55 | protected static final String ICON = "DrJavaHelp.png"; | |
| 56 | ||
| 57 | 38 | public HelpFrame() { |
| 58 | 38 | super("Help on using DrJava", INTRO_URL, HelpFrame.class.getResource(HELP_PATH + CONTENTS_PAGE), ICON); |
| 59 | 38 | addHyperlinkListener(_linkListener); |
| 60 | } | |
| 61 | ||
| 62 | /** Used by subclass QuickStartFrame to instantiate fields of frame. | |
| 63 | */ | |
| 64 | 38 | public HelpFrame(String frameName, URL introUrl, URL indexUrl, String iconString) { |
| 65 | 38 | super(frameName, introUrl, indexUrl, iconString); |
| 66 | } | |
| 67 | ||
| 68 | 0 | protected String getErrorText(URL url) { |
| 69 | // The help files are made available by running "ant docs" | |
| 70 | 0 | return "The Help files are currently unavailable."; |
| 71 | } | |
| 72 | ||
| 73 | /** Shows the page selected by the hyperlink event. Changed to anonymous inner class for | |
| 74 | * encapsulation purposes */ | |
| 75 | private HyperlinkListener _linkListener = new HyperlinkListener() { | |
| 76 | 0 | public void hyperlinkUpdate(HyperlinkEvent event) { |
| 77 | 0 | if (event.getEventType() == HyperlinkEvent.EventType.ACTIVATED) { |
| 78 | // Only follow links within the documentation | |
| 79 | 0 | URL url = event.getURL(); |
| 80 | 0 | String protocol = url.getProtocol(); |
| 81 | ||
| 82 | 0 | if (!"file".equals(protocol) && !"jar".equals(protocol)) { |
| 83 | // try to open in the platform's web browser, since we can't | |
| 84 | // view it effectively here if it isn't in the jar | |
| 85 | // (we only handle file/jar protocols) | |
| 86 | 0 | PlatformFactory.ONLY.openURL(url); |
| 87 | 0 | return; |
| 88 | } | |
| 89 | ||
| 90 | // perform path testing | |
| 91 | 0 | String path = url.getPath(); |
| 92 | ||
| 93 | 0 | if (path.indexOf(HELP_PATH+CONTENTS_PAGE) >= 0) { |
| 94 | 0 | try { url = new URL(url,HOME_PAGE); } // redirect to home, not content |
| 95 | catch(MalformedURLException murle) { | |
| 96 | /* do nothing */ | |
| 97 | } | |
| 98 | } | |
| 99 | 0 | else if (path.indexOf(HELP_PATH) < 0) return; // not anywhere in the help section |
| 100 | ||
| 101 | 0 | if (url.sameFile(_history.contents)) return; // we're already here! |
| 102 | 0 | jumpTo(url); |
| 103 | } | |
| 104 | } | |
| 105 | }; | |
| 106 | } |
|
||||||||||