/* * Copyright (c) 1998, 2015, 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.io.*; import java.util.*; import javax.lang.model.element.PackageElement; import javax.lang.model.element.TypeElement; 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.StringContent; import jdk.javadoc.internal.doclets.toolkit.Configuration; import jdk.javadoc.internal.doclets.toolkit.Content; import jdk.javadoc.internal.doclets.toolkit.util.DocPath; import jdk.javadoc.internal.doclets.toolkit.util.DocPaths; import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException; /** * Class to generate file for each package contents in the left-hand bottom * frame. This will list all the Class Kinds in the package. A click on any * class-kind will update the right-hand frame with the clicked class-kind page. * *

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 Atul M Dambalkar * @author Bhavesh Patel (Modified) */ public class PackageFrameWriter extends HtmlDocletWriter { /** * The package being documented. */ private PackageElement packageElement; /** * The classes to be documented. Use this to filter out classes * that will not be documented. */ private SortedSet documentedClasses; /** * Constructor to construct PackageFrameWriter object and to generate * "package-frame.html" file in the respective package directory. * For example for package "java.lang" this will generate file * "package-frame.html" file in the "java/lang" directory. It will also * create "java/lang" directory in the current or the destination directory * if it doesn't exist. * * @param configuration the configuration of the doclet. * @param packageElement PackageElement under consideration. */ public PackageFrameWriter(ConfigurationImpl configuration, PackageElement packageElement) throws IOException { super(configuration, DocPath.forPackage(packageElement).resolve(DocPaths.PACKAGE_FRAME)); this.packageElement = packageElement; if (utils.getSpecifiedPackages().isEmpty()) { documentedClasses = new TreeSet<>(utils.makeGeneralPurposeComparator()); documentedClasses.addAll(configuration.root.getIncludedClasses()); } } /** * Generate a package summary page for the left-hand bottom frame. Construct * the PackageFrameWriter object and then uses it generate the file. * * @param configuration the current configuration of the doclet. * @param packageElement The package for which "pacakge-frame.html" is to be generated. */ public static void generate(ConfigurationImpl configuration, PackageElement packageElement) { PackageFrameWriter packgen; try { packgen = new PackageFrameWriter(configuration, packageElement); String pkgName = configuration.utils.getPackageName(packageElement); HtmlTree body = packgen.getBody(false, packgen.getWindowTitle(pkgName)); Content pkgNameContent = new StringContent(pkgName); HtmlTree htmlTree = (configuration.allowTag(HtmlTag.MAIN)) ? HtmlTree.MAIN() : body; Content heading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, HtmlStyle.bar, packgen.getTargetPackageLink(packageElement, "classFrame", pkgNameContent)); htmlTree.addContent(heading); HtmlTree div = new HtmlTree(HtmlTag.DIV); div.addStyle(HtmlStyle.indexContainer); packgen.addClassListing(div); htmlTree.addContent(div); if (configuration.allowTag(HtmlTag.MAIN)) { body.addContent(htmlTree); } packgen.printHtmlDocument( configuration.metakeywords.getMetaKeywords(packageElement), false, body); packgen.close(); } catch (IOException exc) { configuration.standardmessage.error( "doclet.exception_encountered", exc.toString(), DocPaths.PACKAGE_FRAME.getPath()); throw new DocletAbortException(exc); } } /** * Add class listing for all the classes in this package. Divide class * listing as per the class kind and generate separate listing for * Classes, Interfaces, Exceptions and Errors. * * @param contentTree the content tree to which the listing will be added */ protected void addClassListing(HtmlTree contentTree) { Configuration config = configuration; if (utils.isIncluded(packageElement)) { addClassKindListing(utils.getInterfaces(packageElement), getResource("doclet.Interfaces"), contentTree); addClassKindListing(utils.getOrdinaryClasses(packageElement), getResource("doclet.Classes"), contentTree); addClassKindListing(utils.getEnums(packageElement), getResource("doclet.Enums"), contentTree); addClassKindListing(utils.getExceptions(packageElement), getResource("doclet.Exceptions"), contentTree); addClassKindListing(utils.getErrors(packageElement), getResource("doclet.Errors"), contentTree); addClassKindListing(utils.getAnnotationTypes(packageElement), getResource("doclet.AnnotationTypes"), contentTree); } else { addClassKindListing(config.classDocCatalog.interfaces(packageElement), getResource("doclet.Interfaces"), contentTree); addClassKindListing(config.classDocCatalog.ordinaryClasses(packageElement), getResource("doclet.Classes"), contentTree); addClassKindListing(config.classDocCatalog.enums(packageElement), getResource("doclet.Enums"), contentTree); addClassKindListing(config.classDocCatalog.exceptions(packageElement), getResource("doclet.Exceptions"), contentTree); addClassKindListing(config.classDocCatalog.errors(packageElement), getResource("doclet.Errors"), contentTree); addClassKindListing(config.classDocCatalog.annotationTypes(packageElement), getResource("doclet.AnnotationTypes"), contentTree); } } /** * Add specific class kind listing. Also add label to the listing. * * @param arr Array of specific class kinds, namely Class or Interface or Exception or Error * @param labelContent content tree of the label to be added * @param contentTree the content tree to which the class kind listing will be added */ protected void addClassKindListing(Iterable list, Content labelContent, HtmlTree contentTree) { SortedSet tset = utils.filterOutPrivateClasses(list, configuration.javafx); if(!tset.isEmpty()) { boolean printedHeader = false; HtmlTree htmlTree = (configuration.allowTag(HtmlTag.SECTION)) ? HtmlTree.SECTION() : contentTree; HtmlTree ul = new HtmlTree(HtmlTag.UL); ul.setTitle(labelContent); for (TypeElement typeElement : tset) { if (documentedClasses != null && !documentedClasses.contains(typeElement)) { continue; } if (!utils.isCoreClass(typeElement) || !configuration.isGeneratedDoc(typeElement)) { continue; } if (!printedHeader) { Content heading = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, true, labelContent); htmlTree.addContent(heading); printedHeader = true; } Content arr_i_name = new StringContent(utils.getSimpleName(typeElement)); if (utils.isInterface(typeElement)) arr_i_name = HtmlTree.SPAN(HtmlStyle.interfaceName, arr_i_name); Content link = getLink(new LinkInfoImpl(configuration, LinkInfoImpl.Kind.PACKAGE_FRAME, typeElement).label(arr_i_name).target("classFrame")); Content li = HtmlTree.LI(link); ul.addContent(li); } htmlTree.addContent(ul); if (configuration.allowTag(HtmlTag.SECTION)) { contentTree.addContent(htmlTree); } } } }