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.javahelp;
043:
044: import java.io.IOException;
045: import java.net.URL;
046: import javax.swing.BoundedRangeModel;
047: import javax.swing.DefaultBoundedRangeModel;
048: import javax.swing.SwingUtilities;
049:
050: import org.w3c.dom.Document;
051: import org.w3c.dom.Element;
052: import org.xml.sax.SAXException;
053:
054: import javax.help.HelpSet;
055: import javax.help.HelpSetException;
056:
057: import org.openide.cookies.InstanceCookie;
058: import org.openide.loaders.XMLDataObject;
059: import org.openide.util.Lookup;
060:
061: /** An XML processor for help set references.
062: * Provides an instance of javax.swing.HelpSet.
063: * @author Jesse Glick
064: */
065: public final class HelpSetProcessor implements XMLDataObject.Processor,
066: InstanceCookie.Of {
067:
068: /** "context" for merge attribute on helpsets
069: */
070: public static final String HELPSET_MERGE_CONTEXT = "OpenIDE"; // NOI18N
071:
072: /** attribute (type Boolean) on helpsets indicating
073: * whether they should be merged into the master or
074: * not; by default, true
075: */
076: public static final String HELPSET_MERGE_ATTR = "mergeIntoMaster"; // NOI18N
077:
078: public static final BoundedRangeModel parseModel = new DefaultBoundedRangeModel(
079: 0, 0, 0, 0);
080:
081: /** the XML file being parsed
082: */
083: private XMLDataObject xml;
084:
085: /** the cached help set
086: */
087: private HelpSet hs;
088:
089: /** Bind to an XML file.
090: * @param xml the file
091: */
092: public void attachTo(XMLDataObject xml) {
093: if (this .xml == xml)
094: return;
095: hs = null;
096: // XXX this is called way too often, why?
097: this .xml = xml;
098: Installer.log.fine("processing help set ref: "
099: + xml.getPrimaryFile());
100: BPMChanger.invoke(BPMChanger.INC_MAXIMUM);
101: }
102:
103: /** Decrement count of available help sets. */
104: protected void finalize() {
105: BPMChanger.invoke(BPMChanger.DEC_VALUE_AND_MAXIMUM);
106: }
107:
108: /** The class being produced.
109: * @throws IOException doesn't
110: * @throws ClassNotFoundException doesn't
111: * @return the class of helpsets
112: */
113: public Class instanceClass() throws IOException,
114: ClassNotFoundException {
115: return HelpSet.class;
116: }
117:
118: /** Get the name of the produced class.
119: * @return the class of helpsets
120: */
121: public String instanceName() {
122: return "javax.help.HelpSet"; // NOI18N
123: }
124:
125: /** Test whether a given superclass will be produced.
126: * @param type the superclass
127: * @return true if it is HelpSet
128: */
129: public boolean instanceOf(Class type) {
130: return type == HelpSet.class;
131: }
132:
133: /** Create the help set.
134: * @throws IOException if there was a problem parsing the XML
135: * of the helpset file or otherwise producing
136: * the helpset from its resource
137: * @throws ClassNotFoundException doesn't
138: * @return the help set
139: */
140: public synchronized Object instanceCreate() throws IOException,
141: ClassNotFoundException {
142: if (hs == null) {
143: Installer.log.fine("creating help set from ref: "
144: + xml.getPrimaryFile());
145: try {
146: Document doc = xml.getDocument();
147: Element el = doc.getDocumentElement();
148: if (!el.getNodeName().equals("helpsetref"))
149: throw new IOException(); // NOI18N
150: String url = el.getAttribute("url"); // NOI18N
151: if (url == null || url.equals(""))
152: throw new IOException(
153: "no url attr on <helpsetref>! doc.class="
154: + doc.getClass().getName()
155: + " doc.documentElement=" + el); // NOI18N
156: String mergeS = el.getAttribute("merge"); // NOI18N
157: boolean merge = (mergeS == null) || mergeS.equals("") || // NOI18N
158: Boolean.valueOf(mergeS).booleanValue();
159: // Make sure nbdocs: protocol is ready:
160: Object ignore = NbDocsStreamHandler.class; // DO NOT DELETE THIS LINE
161: hs = new HelpSet(((ClassLoader) Lookup.getDefault()
162: .lookup(ClassLoader.class)), new URL(url));
163: hs.setKeyData(HELPSET_MERGE_CONTEXT,
164: HELPSET_MERGE_ATTR, merge ? Boolean.TRUE
165: : Boolean.FALSE);
166: BPMChanger.invoke(BPMChanger.INC_VALUE);
167: } catch (SAXException saxe) {
168: throw (IOException) new IOException(saxe.toString())
169: .initCause(saxe);
170: } catch (HelpSetException hse) {
171: throw (IOException) new IOException(hse.toString())
172: .initCause(hse);
173: }
174: }
175: return hs;
176: }
177:
178: private static final class BPMChanger implements Runnable {
179: public static final int INC_MAXIMUM = 0;
180: public static final int DEC_VALUE_AND_MAXIMUM = 1;
181: public static final int INC_VALUE = 2;
182:
183: public static void invoke(int action) {
184: SwingUtilities.invokeLater(new BPMChanger(action));
185: }
186:
187: private final int action;
188:
189: private BPMChanger(int action) {
190: this .action = action;
191: }
192:
193: public void run() {
194: switch (action) {
195: case INC_MAXIMUM:
196: parseModel.setMaximum(parseModel.getMaximum() + 1);
197: break;
198: case DEC_VALUE_AND_MAXIMUM:
199: parseModel.setValue(parseModel.getValue() - 1);
200: parseModel.setMaximum(parseModel.getMaximum() - 1);
201: break;
202: case INC_VALUE:
203: parseModel.setValue(parseModel.getValue() + 1);
204: break;
205: default:
206: throw new IllegalStateException();
207: }
208: }
209: }
210:
211: }
|