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.j2ee.common.project.ui;
043:
044: import java.net.URL;
045: import java.net.MalformedURLException;
046: import java.text.MessageFormat;
047: import java.util.logging.Level;
048: import java.util.logging.Logger;
049: import org.openide.awt.HtmlBrowser;
050: import org.openide.awt.StatusDisplayer;
051: import org.openide.filesystems.FileObject;
052: import org.openide.filesystems.URLMapper;
053: import org.openide.nodes.Node;
054: import org.openide.util.NbBundle;
055: import org.openide.util.HelpCtx;
056: import org.openide.util.actions.NodeAction;
057:
058: /**
059: * Action for showing Javadoc. The action looks up
060: * the {@link ShowJavadocAction.JavadocProvider} in the
061: * activated node's Lookup and delegates to it.
062: * @author Tomas Zezula
063: */
064: final class ShowJavadocAction extends NodeAction {
065:
066: /**
067: * Implementation of this interfaces has to be placed
068: * into the node's Lookup to allow {@link ShowJavadocAction}
069: * on the node.
070: */
071: public static interface JavadocProvider {
072:
073: /**
074: * Checks if the node can provide Javaodc
075: * @return true if the action should be enabled
076: */
077: public abstract boolean hasJavadoc();
078:
079: /**
080: * Opens javadoc page in the browser
081: */
082: public abstract void showJavadoc();
083: }
084:
085: protected void performAction(Node[] activatedNodes) {
086: if (activatedNodes.length != 1) {
087: return;
088: }
089: JavadocProvider jd = (JavadocProvider) activatedNodes[0]
090: .getLookup().lookup(JavadocProvider.class);
091: if (jd == null) {
092: return;
093: }
094: jd.showJavadoc();
095: }
096:
097: protected boolean enable(Node[] activatedNodes) {
098: if (activatedNodes.length != 1) {
099: return false;
100: }
101: JavadocProvider jd = (JavadocProvider) activatedNodes[0]
102: .getLookup().lookup(JavadocProvider.class);
103: if (jd == null) {
104: return false;
105: }
106: return jd.hasJavadoc();
107: }
108:
109: public String getName() {
110: return NbBundle.getMessage(ShowJavadocAction.class,
111: "CTL_ShowJavadoc");
112: }
113:
114: public HelpCtx getHelpCtx() {
115: return new HelpCtx(ShowJavadocAction.class);
116: }
117:
118: public boolean asynchronous() {
119: return false;
120: }
121:
122: /**
123: * Opens the IDE default browser with given URL
124: * @param javadoc URL of the javadoc page
125: * @param displayName the name of file to be displayed, typically the package name for class
126: * or project name for project.
127: */
128: static void showJavaDoc(URL javadoc, String displayName) {
129: if (javadoc != null) {
130: HtmlBrowser.URLDisplayer.getDefault().showURL(javadoc);
131: } else {
132: StatusDisplayer.getDefault().setStatusText(
133: MessageFormat.format(NbBundle.getMessage(
134: ShowJavadocAction.class, "TXT_NoJavadoc"),
135: new Object[] { displayName })); //NOI18N
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: Logger.getLogger("global").log(
159: Level.SEVERE,
160: "Cannot create URL for " + base + resource
161: + ". " + ex.toString());
162: continue;
163: }
164: }
165: return null;
166: }
167: }
|