duke@1: /* duke@1: * Copyright 1998-2005 Sun Microsystems, Inc. All Rights Reserved. duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. duke@1: * duke@1: * This code is free software; you can redistribute it and/or modify it duke@1: * under the terms of the GNU General Public License version 2 only, as duke@1: * published by the Free Software Foundation. Sun designates this duke@1: * particular file as subject to the "Classpath" exception as provided duke@1: * by Sun in the LICENSE file that accompanied this code. duke@1: * duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License duke@1: * version 2 for more details (a copy is included in the LICENSE file that duke@1: * accompanied this code). duke@1: * duke@1: * You should have received a copy of the GNU General Public License version duke@1: * 2 along with this work; if not, write to the Free Software Foundation, duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. duke@1: * duke@1: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, duke@1: * CA 95054 USA or visit www.sun.com if you need additional information or duke@1: * have any questions. duke@1: */ duke@1: duke@1: package com.sun.tools.doclets.formats.html; duke@1: bpatel@233: import java.io.*; bpatel@233: bpatel@233: import com.sun.javadoc.*; duke@1: import com.sun.tools.doclets.internal.toolkit.util.*; duke@1: duke@1: /** duke@1: * Class to generate Tree page for a package. The name of the file generated is duke@1: * "package-tree.html" and it is generated in the respective package directory. duke@1: * duke@1: * @author Atul M Dambalkar duke@1: */ duke@1: public class PackageTreeWriter extends AbstractTreeWriter { duke@1: duke@1: /** duke@1: * Package for which tree is to be generated. duke@1: */ duke@1: protected PackageDoc packagedoc; duke@1: duke@1: /** duke@1: * The previous package name in the alpha-order list. duke@1: */ duke@1: protected PackageDoc prev; duke@1: duke@1: /** duke@1: * The next package name in the alpha-order list. duke@1: */ duke@1: protected PackageDoc next; duke@1: duke@1: /** duke@1: * Constructor. duke@1: * @throws IOException duke@1: * @throws DocletAbortException duke@1: */ duke@1: public PackageTreeWriter(ConfigurationImpl configuration, duke@1: String path, String filename, duke@1: PackageDoc packagedoc, duke@1: PackageDoc prev, PackageDoc next) duke@1: throws IOException { duke@1: super(configuration, path, filename, duke@1: new ClassTree( duke@1: configuration.classDocCatalog.allClasses(packagedoc), duke@1: configuration), duke@1: packagedoc); duke@1: this.packagedoc = packagedoc; duke@1: this.prev = prev; duke@1: this.next = next; duke@1: } duke@1: duke@1: /** duke@1: * Construct a PackageTreeWriter object and then use it to generate the duke@1: * package tree page. duke@1: * duke@1: * @param pkg Package for which tree file is to be generated. duke@1: * @param prev Previous package in the alpha-ordered list. duke@1: * @param next Next package in the alpha-ordered list. duke@1: * @param noDeprecated If true, do not generate any information for duke@1: * deprecated classe or interfaces. duke@1: * @throws DocletAbortException duke@1: */ duke@1: public static void generate(ConfigurationImpl configuration, duke@1: PackageDoc pkg, PackageDoc prev, duke@1: PackageDoc next, boolean noDeprecated) { duke@1: PackageTreeWriter packgen; duke@1: String path = DirectoryManager.getDirectoryPath(pkg); duke@1: String filename = "package-tree.html"; duke@1: try { duke@1: packgen = new PackageTreeWriter(configuration, path, filename, pkg, duke@1: prev, next); duke@1: packgen.generatePackageTreeFile(); duke@1: packgen.close(); duke@1: } catch (IOException exc) { duke@1: configuration.standardmessage.error( duke@1: "doclet.exception_encountered", duke@1: exc.toString(), filename); duke@1: throw new DocletAbortException(); duke@1: } duke@1: } duke@1: duke@1: /** duke@1: * Generate a separate tree file for each package. duke@1: */ duke@1: protected void generatePackageTreeFile() throws IOException { duke@1: printHtmlHeader(packagedoc.name() + " " duke@1: + configuration.getText("doclet.Window_Class_Hierarchy"), null, true); duke@1: duke@1: printPackageTreeHeader(); duke@1: duke@1: if (configuration.packages.length > 1) { duke@1: printLinkToMainTree(); duke@1: } duke@1: duke@1: generateTree(classtree.baseclasses(), "doclet.Class_Hierarchy"); duke@1: generateTree(classtree.baseinterfaces(), "doclet.Interface_Hierarchy"); duke@1: generateTree(classtree.baseAnnotationTypes(), "doclet.Annotation_Type_Hierarchy"); duke@1: generateTree(classtree.baseEnums(), "doclet.Enum_Hierarchy"); duke@1: duke@1: printPackageTreeFooter(); duke@1: printBottom(); duke@1: printBodyHtmlEnd(); duke@1: } duke@1: duke@1: /** duke@1: * Print the navigation bar header for the package tree file. duke@1: */ duke@1: protected void printPackageTreeHeader() { duke@1: printTop(); duke@1: navLinks(true); duke@1: hr(); duke@1: center(); duke@1: h2(configuration.getText("doclet.Hierarchy_For_Package", duke@1: Util.getPackageName(packagedoc))); duke@1: centerEnd(); duke@1: } duke@1: duke@1: /** duke@1: * Generate a link to the tree for all the packages. duke@1: */ duke@1: protected void printLinkToMainTree() { duke@1: dl(); duke@1: dt(); bpatel@182: strongText("doclet.Package_Hierarchies"); bpatel@233: dtEnd(); duke@1: dd(); duke@1: navLinkMainTree(configuration.getText("doclet.All_Packages")); bpatel@233: ddEnd(); duke@1: dlEnd(); duke@1: hr(); duke@1: } duke@1: duke@1: /** duke@1: * Print the navigation bar footer for the package tree file. duke@1: */ duke@1: protected void printPackageTreeFooter() { duke@1: hr(); duke@1: navLinks(false); duke@1: } duke@1: duke@1: /** duke@1: * Link for the previous package tree file. duke@1: */ duke@1: protected void navLinkPrevious() { duke@1: if (prev == null) { duke@1: navLinkPrevious(null); duke@1: } else { duke@1: String path = DirectoryManager.getRelativePath(packagedoc.name(), duke@1: prev.name()); duke@1: navLinkPrevious(path + "package-tree.html"); duke@1: } duke@1: } duke@1: duke@1: /** duke@1: * Link for the next package tree file. duke@1: */ duke@1: protected void navLinkNext() { duke@1: if (next == null) { duke@1: navLinkNext(null); duke@1: } else { duke@1: String path = DirectoryManager.getRelativePath(packagedoc.name(), duke@1: next.name()); duke@1: navLinkNext(path + "package-tree.html"); duke@1: } duke@1: } duke@1: duke@1: /** duke@1: * Link to the package summary page for the package of this tree. duke@1: */ duke@1: protected void navLinkPackage() { duke@1: navCellStart(); duke@1: printHyperLink("package-summary.html", "", configuration.getText("doclet.Package"), duke@1: true, "NavBarFont1"); duke@1: navCellEnd(); duke@1: } duke@1: }