diff --git a/javahelp/apichanges.xml b/javahelp/apichanges.xml --- a/javahelp/apichanges.xml +++ b/javahelp/apichanges.xml @@ -110,6 +110,23 @@ + + + Added class HelpUtils + + + + + +

+ Provide a method for merging of a custom HelpSet object to the + master helpset. +

+ + + + + Added @HelpSetRegistration diff --git a/javahelp/manifest.mf b/javahelp/manifest.mf --- a/javahelp/manifest.mf +++ b/javahelp/manifest.mf @@ -1,7 +1,7 @@ Manifest-Version: 1.0 OpenIDE-Module: org.netbeans.modules.javahelp/1 OpenIDE-Module-Localizing-Bundle: org/netbeans/modules/javahelp/resources/Bundle.properties -OpenIDE-Module-Specification-Version: 2.33 +OpenIDE-Module-Specification-Version: 2.34 OpenIDE-Module-Provides: org.netbeans.api.javahelp.Help OpenIDE-Module-Requires: org.openide.modules.InstalledFileLocator, org.openide.modules.ModuleFormat2 OpenIDE-Module-Layer: org/netbeans/modules/javahelp/resources/layer.xml diff --git a/javahelp/src/org/netbeans/api/javahelp/HelpUtils.java b/javahelp/src/org/netbeans/api/javahelp/HelpUtils.java new file mode 100644 --- /dev/null +++ b/javahelp/src/org/netbeans/api/javahelp/HelpUtils.java @@ -0,0 +1,74 @@ +/* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. + * + * Copyright 2013 Oracle and/or its affiliates. All rights reserved. + * + * Oracle and Java are registered trademarks of Oracle and/or its affiliates. + * Other names may be trademarks of their respective owners. + * + * The contents of this file are subject to the terms of either the GNU + * General Public License Version 2 only ("GPL") or the Common + * Development and Distribution License("CDDL") (collectively, the + * "License"). You may not use this file except in compliance with the + * License. You can obtain a copy of the License at + * http://www.netbeans.org/cddl-gplv2.html + * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the + * specific language governing permissions and limitations under the + * License. When distributing the software, include this License Header + * Notice in each file and include the License file at + * nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the GPL Version 2 section of the License file that + * accompanied this code. If applicable, add the following below the + * License Header, with the fields enclosed by brackets [] replaced by + * your own identifying information: + * "Portions Copyrighted [year] [name of copyright owner]" + * + * If you wish your version of this file to be governed by only the CDDL + * or only the GPL Version 2, indicate your decision by adding + * "[Contributor] elects to include this software in this distribution + * under the [CDDL or GPL Version 2] license." If you do not indicate a + * single choice of license, a recipient has the option to distribute + * your version of this file under either the CDDL, the GPL Version 2 or + * to extend the choice of license to its licensees as provided above. + * However, if you add GPL Version 2 code and therefore, elected the GPL + * Version 2 license, then the option applies only if the new code is + * made subject to such option by the copyright holder. + * + * Contributor(s): + * + * Portions Copyrighted 2013 Sun Microsystems, Inc. + */ +package org.netbeans.api.javahelp; + +import javax.help.HelpSet; +import org.netbeans.modules.javahelp.HelpConstants; + +/** + * Utility methods for helpsets. + * + * @since javahelp/2.34 + * @author jhavlin + */ +public final class HelpUtils { + + /** + * Merge a custom helpset to the master helpset. + *

+ * Merge helpsets registered using e.g. + * {@code @ServiceProvider(service=HelpSet.class)} to the master helpset. + *

+ *

+ * You may need this method if you create helpsets that use some special + * sources of data, e.g. the web. See bug 234144. + *

+ * + * @param customHelpSet The custom help set. + */ + public static void mergeCustomHelpset(HelpSet customHelpSet) { + customHelpSet.setKeyData( + HelpConstants.HELPSET_MERGE_CONTEXT, + HelpConstants.HELPSET_MERGE_ATTR, + true); + } +} diff --git a/javahelp/src/org/netbeans/modules/javahelp/JavaHelp.java b/javahelp/src/org/netbeans/modules/javahelp/JavaHelp.java --- a/javahelp/src/org/netbeans/modules/javahelp/JavaHelp.java +++ b/javahelp/src/org/netbeans/modules/javahelp/JavaHelp.java @@ -73,7 +73,9 @@ import java.util.logging.LogRecord; import javax.help.HelpSet; import javax.help.HelpSetException; +import javax.help.InvalidHelpSetContextException; import javax.help.JHelp; +import javax.help.Map.ID; import javax.help.NavigatorView; import javax.help.search.MergingSearchEngine; import javax.help.search.SearchEngine; @@ -913,7 +915,17 @@ if (helpID != null && ! helpID.equals(MASTER_ID)) { HelpSet hs = jh.getModel().getHelpSet(); if (hs.getCombinedMap().isValidID(helpID, hs)) { - jh.setCurrentID(helpID); + HelpSet helpsetForId = findHelpSetForID(helpID); // #234143 + if (helpsetForId != getMaster()) { + ID id = ID.create(helpID, helpsetForId); + try { + jh.setCurrentID(id); + } catch (InvalidHelpSetContextException ex) { + jh.setCurrentID(helpID); + } + } else { + jh.setCurrentID(helpID); + } } else { warnBadID(helpID); } diff --git a/javahelp/test/unit/src/org/netbeans/api/javahelp/HelpUtilsTest.java b/javahelp/test/unit/src/org/netbeans/api/javahelp/HelpUtilsTest.java new file mode 100644 --- /dev/null +++ b/javahelp/test/unit/src/org/netbeans/api/javahelp/HelpUtilsTest.java @@ -0,0 +1,65 @@ +/* + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. + * + * Copyright 2013 Oracle and/or its affiliates. All rights reserved. + * + * Oracle and Java are registered trademarks of Oracle and/or its affiliates. + * Other names may be trademarks of their respective owners. + * + * The contents of this file are subject to the terms of either the GNU + * General Public License Version 2 only ("GPL") or the Common + * Development and Distribution License("CDDL") (collectively, the + * "License"). You may not use this file except in compliance with the + * License. You can obtain a copy of the License at + * http://www.netbeans.org/cddl-gplv2.html + * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the + * specific language governing permissions and limitations under the + * License. When distributing the software, include this License Header + * Notice in each file and include the License file at + * nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the GPL Version 2 section of the License file that + * accompanied this code. If applicable, add the following below the + * License Header, with the fields enclosed by brackets [] replaced by + * your own identifying information: + * "Portions Copyrighted [year] [name of copyright owner]" + * + * If you wish your version of this file to be governed by only the CDDL + * or only the GPL Version 2, indicate your decision by adding + * "[Contributor] elects to include this software in this distribution + * under the [CDDL or GPL Version 2] license." If you do not indicate a + * single choice of license, a recipient has the option to distribute + * your version of this file under either the CDDL, the GPL Version 2 or + * to extend the choice of license to its licensees as provided above. + * However, if you add GPL Version 2 code and therefore, elected the GPL + * Version 2 license, then the option applies only if the new code is + * made subject to such option by the copyright holder. + * + * Contributor(s): + * + * Portions Copyrighted 2013 Sun Microsystems, Inc. + */ +package org.netbeans.api.javahelp; + +import javax.help.HelpSet; +import org.junit.Test; +import static org.junit.Assert.*; +import org.netbeans.modules.javahelp.HelpConstants; + +/** + * + * @author jhavlin + */ +public class HelpUtilsTest { + + public HelpUtilsTest() { + } + + @Test + public void testMergeCustomHelpset() { + HelpSet hs = new HelpSet(); + HelpUtils.mergeCustomHelpset(hs); + assertEquals(true, hs.getKeyData(HelpConstants.HELPSET_MERGE_CONTEXT, + HelpConstants.HELPSET_MERGE_ATTR)); + } +}