001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.apisupport.project.ui;
043:
044: import java.net.URL;
045: import java.net.MalformedURLException;
046: import org.openide.ErrorManager;
047: import org.openide.awt.HtmlBrowser;
048: import org.openide.awt.StatusDisplayer;
049: import org.openide.filesystems.FileObject;
050: import org.openide.filesystems.URLMapper;
051: import org.openide.nodes.Node;
052: import org.openide.util.NbBundle;
053: import org.openide.util.HelpCtx;
054: import org.openide.util.actions.NodeAction;
055:
056: // XXX this class is more or less copy-pasted PlatformNode from j2seproject.
057: // Get rid of it as soon as "some" Libraries Node API is provided.
058:
059: /**
060: * Action for showing Javadoc. The action looks up
061: * the {@link ShowJavadocAction.JavadocProvider} in the
062: * activated node's Lookup and delegates to it.
063: * @author Tomas Zezula
064: */
065: final class ShowJavadocAction extends NodeAction {
066:
067: /**
068: * Implementation of this interfaces has to be placed
069: * into the node's Lookup to allow {@link ShowJavadocAction}
070: * on the node.
071: */
072: public static interface JavadocProvider {
073:
074: /**
075: * Checks if the node can provide Javaodc
076: * @return true if the action should be enabled
077: */
078: public abstract boolean hasJavadoc();
079:
080: /**
081: * Opens javadoc page in the browser
082: */
083: public abstract void showJavadoc();
084: }
085:
086: protected void performAction(Node[] activatedNodes) {
087: if (activatedNodes.length != 1) {
088: return;
089: }
090: JavadocProvider jd = (JavadocProvider) activatedNodes[0]
091: .getLookup().lookup(JavadocProvider.class);
092: if (jd == null) {
093: return;
094: }
095: jd.showJavadoc();
096: }
097:
098: protected boolean enable(Node[] activatedNodes) {
099: if (activatedNodes.length != 1) {
100: return false;
101: }
102: JavadocProvider jd = (JavadocProvider) activatedNodes[0]
103: .getLookup().lookup(JavadocProvider.class);
104: if (jd == null) {
105: return false;
106: }
107: return jd.hasJavadoc();
108: }
109:
110: public final String getName() {
111: return NbBundle.getMessage(ShowJavadocAction.class,
112: "CTL_ShowJavadoc");
113: }
114:
115: public final HelpCtx getHelpCtx() {
116: return new HelpCtx(ShowJavadocAction.class);
117: }
118:
119: public final boolean asynchronous() {
120: return false;
121: }
122:
123: /**
124: * Opens the IDE default browser with given URL
125: * @param javadoc URL of the javadoc page
126: * @param displayName the name of file to be displayed, typically the package name for class
127: * or project name for project.
128: */
129: static void showJavaDoc(URL javadoc, String displayName) {
130: if (javadoc != null) {
131: HtmlBrowser.URLDisplayer.getDefault().showURL(javadoc);
132: } else {
133: StatusDisplayer.getDefault().setStatusText(
134: NbBundle.getMessage(ShowJavadocAction.class,
135: "TXT_NoJavadoc", displayName));
136: }
137: }
138:
139: /**
140: * Locates a javadoc page by a relative name and an array of javadoc roots
141: * @param resource the relative name of javadoc page
142: * @param urls the array of javadoc roots
143: * @return the URL of found javadoc page or null if there is no such a page.
144: */
145: static URL findJavadoc(String resource, URL urls[]) {
146: for (int i = 0; i < urls.length; i++) {
147: String base = urls[i].toExternalForm();
148: if (!base.endsWith("/")) { // NOI18N
149: base += "/"; // NOI18N
150: }
151: try {
152: URL u = new URL(base + resource);
153: FileObject fo = URLMapper.findFileObject(u);
154: if (fo != null) {
155: return u;
156: }
157: } catch (MalformedURLException ex) {
158: ErrorManager.getDefault().log(
159: ErrorManager.ERROR,
160: "Cannot create URL for " + base + resource
161: + ". " + ex.toString()); //NOI18N
162: continue;
163: }
164: }
165: return null;
166: }
167:
168: }
|