diff -r 4ebc2e2fb97c -r 71c04702a3d5 src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModulePackageIndexFrameWriter.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModulePackageIndexFrameWriter.java Tue Sep 12 19:03:39 2017 +0200 @@ -0,0 +1,229 @@ +/* + * Copyright (c) 2013, 2017, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +package jdk.javadoc.internal.doclets.formats.html; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import javax.lang.model.element.ModuleElement; +import javax.lang.model.element.PackageElement; + +import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants; +import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle; +import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag; +import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree; +import jdk.javadoc.internal.doclets.formats.html.markup.RawHtml; +import jdk.javadoc.internal.doclets.formats.html.markup.StringContent; +import jdk.javadoc.internal.doclets.toolkit.Content; +import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException; +import jdk.javadoc.internal.doclets.toolkit.util.DocPath; +import jdk.javadoc.internal.doclets.toolkit.util.DocPaths; + +/** + * Generate the module package index for the left-hand frame in the generated output. + * A click on the package name in this frame will update the page in the bottom + * left hand frame with the listing of contents of the clicked module package. + * + *

This is NOT part of any supported API. + * If you write code that depends on this, you do so at your own risk. + * This code and its internal interfaces are subject to change or + * deletion without notice. + * + * @author Bhavesh Patel + */ +public class ModulePackageIndexFrameWriter extends AbstractModuleIndexWriter { + + /** + * Construct the ModulePackageIndexFrameWriter object. + * + * @param configuration the configuration object + * @param filename Name of the package index file to be generated. + */ + public ModulePackageIndexFrameWriter(HtmlConfiguration configuration, DocPath filename) { + super(configuration, filename); + } + + /** + * Generate the module package index file. + * @throws DocFileIOException + * @param configuration the configuration object + * @param mdle the module being documented + */ + public static void generate(HtmlConfiguration configuration, ModuleElement mdle) throws DocFileIOException { + DocPath filename = DocPaths.moduleFrame(mdle); + ModulePackageIndexFrameWriter modpackgen = new ModulePackageIndexFrameWriter(configuration, filename); + modpackgen.buildModulePackagesIndexFile("doclet.Window_Overview", false, mdle); + } + + /** + * {@inheritDoc} + */ + protected void addModulePackagesList(Map> modules, String text, + String tableSummary, Content body, ModuleElement mdle) { + Content profNameContent = new StringContent(mdle.getQualifiedName().toString()); + Content heading = HtmlTree.HEADING(HtmlConstants.PACKAGE_HEADING, true, + getTargetModuleLink("classFrame", profNameContent, mdle)); + heading.addContent(Contents.SPACE); + heading.addContent(contents.packagesLabel); + HtmlTree htmlTree = (configuration.allowTag(HtmlTag.MAIN)) + ? HtmlTree.MAIN(HtmlStyle.indexContainer, heading) + : HtmlTree.DIV(HtmlStyle.indexContainer, heading); + HtmlTree ul = new HtmlTree(HtmlTag.UL); + ul.setTitle(contents.packagesLabel); + List packages = new ArrayList<>(modules.get(mdle)); + for (PackageElement pkg : packages) { + if ((!(configuration.nodeprecated && utils.isDeprecated(pkg)))) { + ul.addContent(getPackage(pkg, mdle)); + } + } + htmlTree.addContent(ul); + body.addContent(htmlTree); + } + + /** + * {@inheritDoc} + */ + protected void addModulePackagesList(Set modules, String text, + String tableSummary, Content body, ModuleElement mdle) { + Content moduleNameContent = new StringContent(mdle.getQualifiedName().toString()); + Content heading = HtmlTree.HEADING(HtmlConstants.PACKAGE_HEADING, true, + getTargetModuleLink("classFrame", moduleNameContent, mdle)); + heading.addContent(Contents.SPACE); + heading.addContent(contents.packagesLabel); + HtmlTree htmlTree = (configuration.allowTag(HtmlTag.MAIN)) + ? HtmlTree.MAIN(HtmlStyle.indexContainer, heading) + : HtmlTree.DIV(HtmlStyle.indexContainer, heading); + HtmlTree ul = new HtmlTree(HtmlTag.UL); + ul.setTitle(contents.packagesLabel); + Set modulePackages = configuration.modulePackages.get(mdle); + for (PackageElement pkg: modulePackages) { + if ((!(configuration.nodeprecated && utils.isDeprecated(pkg)))) { + ul.addContent(getPackage(pkg, mdle)); + } + } + htmlTree.addContent(ul); + body.addContent(htmlTree); + } + + /** + * Returns each package name as a separate link. + * + * @param pkg PackageElement + * @param mdle the module being documented + * @return content for the package link + */ + protected Content getPackage(PackageElement pkg, ModuleElement mdle) { + Content packageLinkContent; + Content pkgLabel; + if (!pkg.isUnnamed()) { + pkgLabel = getPackageLabel(utils.getPackageName(pkg)); + packageLinkContent = getHyperLink(pathString(pkg, + DocPaths.PACKAGE_FRAME), pkgLabel, "", + "packageFrame"); + } else { + pkgLabel = new StringContent(""); + packageLinkContent = getHyperLink(DocPaths.PACKAGE_FRAME, + pkgLabel, "", "packageFrame"); + } + Content li = HtmlTree.LI(packageLinkContent); + return li; + } + + /** + * {@inheritDoc} + */ + protected void addNavigationBarHeader(Content body) { + Content headerContent; + if (configuration.packagesheader.length() > 0) { + headerContent = new RawHtml(replaceDocRootDir(configuration.packagesheader)); + } else { + headerContent = new RawHtml(replaceDocRootDir(configuration.header)); + } + Content heading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, true, + HtmlStyle.bar, headerContent); + body.addContent(heading); + } + + /** + * Do nothing as there is no overview information in this page. + */ + protected void addOverviewHeader(Content body) { + } + + protected void addModulesList(Collection modules, String text, + String tableSummary, Content body) { + } + + /** + * Adds "All Classes" link for the top of the left-hand frame page to the + * documentation tree. + * + * @param ul the Content object to which the all classes link should be added + */ + protected void addAllClassesLink(Content ul) { + Content linkContent = getHyperLink(DocPaths.ALLCLASSES_FRAME, + contents.allClassesLabel, "", "packageFrame"); + Content li = HtmlTree.LI(linkContent); + ul.addContent(li); + } + + /** + * Adds "All Packages" link for the top of the left-hand frame page to the + * documentation tree. + * + * @param ul the Content object to which the all packages link should be added + */ + protected void addAllPackagesLink(Content ul) { + Content linkContent = getHyperLink(DocPaths.OVERVIEW_FRAME, + contents.allPackagesLabel, "", "packageListFrame"); + Content li = HtmlTree.LI(linkContent); + ul.addContent(li); + } + + /** + * Adds "All Modules" link for the top of the left-hand frame page to the + * documentation tree. + * + * @param ul the Content object to which the all modules link should be added + */ + protected void addAllModulesLink(Content ul) { + Content linkContent = getHyperLink(DocPaths.MODULE_OVERVIEW_FRAME, + contents.allModulesLabel, "", "packageListFrame"); + Content li = HtmlTree.LI(linkContent); + ul.addContent(li); + } + + /** + * {@inheritDoc} + */ + protected void addNavigationBarFooter(Content body) { + Content p = HtmlTree.P(Contents.SPACE); + body.addContent(p); + } +}