HelpFrame.java
| Index Score | ||
|---|---|---|
 |
 |
edu.rice.cs.drjava.ui |
 |
 |
DrJava |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
/*BEGIN_COPYRIGHT_BLOCK
*
* Copyright (c) 2001-2008, JavaPLT group at Rice University (drjava@rice.edu)
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the names of DrJava, the JavaPLT group, Rice University, nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software is Open Source Initiative approved Open Source Software.
* Open Source Initative Approved is a trademark of the Open Source Initiative.
*
* This file is part of DrJava. Download the current version of this project
* from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/
*
* END_COPYRIGHT_BLOCK*/
package edu.rice.cs.drjava.ui;
import edu.rice.cs.drjava.CodeStatus;
import edu.rice.cs.drjava.platform.PlatformFactory;
import javax.swing.event.HyperlinkListener;
import javax.swing.event.HyperlinkEvent;
import java.net.URL;
import java.net.MalformedURLException;
/**
* The frame for displaying the HTML help files.
* @version $Id: HelpFrame.java 4447 2008-04-18 16:06:34Z rcartwright $
*/
public class HelpFrame extends HTMLFrame {
private static final String HELP_PATH = "/edu/rice/cs/drjava/docs/user/";
protected static final String CONTENTS_PAGE = "index.html";
protected static final String HOME_PAGE = "intro.html";
private static final URL INTRO_URL = HTMLFrame.class.getResource(HELP_PATH + HOME_PAGE);
protected static final String ICON = "DrJavaHelp.png";
public HelpFrame() {
super("Help on using DrJava", INTRO_URL, HelpFrame.class.getResource(HELP_PATH + CONTENTS_PAGE), ICON);
addHyperlinkListener(_linkListener);
}
/** Used by subclass QuickStartFrame to instantiate fields of frame.
*/
public HelpFrame(String frameName, URL introUrl, URL indexUrl, String iconString) {
super(frameName, introUrl, indexUrl, iconString);
}
protected String getErrorText(URL url) {
// The help files are made available by running "ant docs"
return "The Help files are currently unavailable.";
}
/** Shows the page selected by the hyperlink event. Changed to anonymous inner class for
* encapsulation purposes */
private HyperlinkListener _linkListener = new HyperlinkListener() {
public void hyperlinkUpdate(HyperlinkEvent event) {
if (event.getEventType() == HyperlinkEvent.EventType.ACTIVATED) {
// Only follow links within the documentation
URL url = event.getURL();
String protocol = url.getProtocol();
if (!"file".equals(protocol) && !"jar".equals(protocol)) {
// try to open in the platform's web browser, since we can't
// view it effectively here if it isn't in the jar
// (we only handle file/jar protocols)
PlatformFactory.ONLY.openURL(url);
return;
}
// perform path testing
String path = url.getPath();
if (path.indexOf(HELP_PATH+CONTENTS_PAGE) >= 0) {
try { url = new URL(url,HOME_PAGE); } // redirect to home, not content
catch(MalformedURLException murle) {
/* do nothing */
}
}
else if (path.indexOf(HELP_PATH) < 0) return; // not anywhere in the help section
if (url.sameFile(_history.contents)) return; // we're already here!
jumpTo(url);
}
}
};
}
The table below shows all metrics for HelpFrame.java.
| Metric | Value | Description | |
|---|---|---|---|