• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/tools/doclets/formats/html/TreeWriter.java@93012e2a5d1d (annotated)

src/share/classes/com/sun/tools/doclets/formats/html/TreeWriter.java

Sat, 07 Nov 2020 10:30:02 +0800

author

aoqi

date

Sat, 07 Nov 2020 10:30:02 +0800

changeset 3938

93012e2a5d1d

parent 2525

2eb010b6cb22

permissions

-rw-r--r--

Added tag mips-jdk8u275-b01 for changeset eb6ee6a5f2fe

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.tools.doclets.formats.html;
aoqi@0	27
aoqi@0	28	import java.io.*;
aoqi@0	29
aoqi@0	30	import com.sun.javadoc.*;
aoqi@0	31	import com.sun.tools.doclets.formats.html.markup.*;
aoqi@0	32	import com.sun.tools.doclets.internal.toolkit.*;
aoqi@0	33	import com.sun.tools.doclets.internal.toolkit.util.*;
aoqi@0	34
aoqi@0	35	/**
aoqi@0	36	* Generate Class Hierarchy page for all the Classes in this run. Use
aoqi@0	37	* ClassTree for building the Tree. The name of
aoqi@0	38	* the generated file is "overview-tree.html" and it is generated in the
aoqi@0	39	* current or the destination directory.
aoqi@0	40	*
aoqi@0	41	* <p><b>This is NOT part of any supported API.
aoqi@0	42	* If you write code that depends on this, you do so at your own risk.
aoqi@0	43	* This code and its internal interfaces are subject to change or
aoqi@0	44	* deletion without notice.</b>
aoqi@0	45	*
aoqi@0	46	* @author Atul M Dambalkar
aoqi@0	47	* @author Bhavesh Patel (Modified)
aoqi@0	48	*/
aoqi@0	49	public class TreeWriter extends AbstractTreeWriter {
aoqi@0	50
aoqi@0	51	/**
aoqi@0	52	* Packages in this run.
aoqi@0	53	*/
aoqi@0	54	private PackageDoc[] packages;
aoqi@0	55
aoqi@0	56	/**
aoqi@0	57	* True if there are no packages specified on the command line,
aoqi@0	58	* False otherwise.
aoqi@0	59	*/
aoqi@0	60	private boolean classesonly;
aoqi@0	61
aoqi@0	62	/**
aoqi@0	63	* Constructor to construct TreeWriter object.
aoqi@0	64	*
aoqi@0	65	* @param configuration the current configuration of the doclet.
aoqi@0	66	* @param filename String filename
aoqi@0	67	* @param classtree the tree being built.
aoqi@0	68	*/
aoqi@0	69	public TreeWriter(ConfigurationImpl configuration,
aoqi@0	70	DocPath filename, ClassTree classtree)
aoqi@0	71	throws IOException {
aoqi@0	72	super(configuration, filename, classtree);
aoqi@0	73	packages = configuration.packages;
aoqi@0	74	classesonly = packages.length == 0;
aoqi@0	75	}
aoqi@0	76
aoqi@0	77	/**
aoqi@0	78	* Create a TreeWriter object and use it to generate the
aoqi@0	79	* "overview-tree.html" file.
aoqi@0	80	*
aoqi@0	81	* @param classtree the class tree being documented.
aoqi@0	82	* @throws DocletAbortException
aoqi@0	83	*/
aoqi@0	84	public static void generate(ConfigurationImpl configuration,
aoqi@0	85	ClassTree classtree) {
aoqi@0	86	TreeWriter treegen;
aoqi@0	87	DocPath filename = DocPaths.OVERVIEW_TREE;
aoqi@0	88	try {
aoqi@0	89	treegen = new TreeWriter(configuration, filename, classtree);
aoqi@0	90	treegen.generateTreeFile();
aoqi@0	91	treegen.close();
aoqi@0	92	} catch (IOException exc) {
aoqi@0	93	configuration.standardmessage.error(
aoqi@0	94	"doclet.exception_encountered",
aoqi@0	95	exc.toString(), filename);
aoqi@0	96	throw new DocletAbortException(exc);
aoqi@0	97	}
aoqi@0	98	}
aoqi@0	99
aoqi@0	100	/**
aoqi@0	101	* Generate the interface hierarchy and class hierarchy.
aoqi@0	102	*/
aoqi@0	103	public void generateTreeFile() throws IOException {
aoqi@0	104	Content body = getTreeHeader();
aoqi@0	105	Content headContent = getResource("doclet.Hierarchy_For_All_Packages");
aoqi@0	106	Content heading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, false,
aoqi@0	107	HtmlStyle.title, headContent);
aoqi@0	108	Content div = HtmlTree.DIV(HtmlStyle.header, heading);
aoqi@0	109	addPackageTreeLinks(div);
aoqi@0	110	body.addContent(div);
aoqi@0	111	HtmlTree divTree = new HtmlTree(HtmlTag.DIV);
aoqi@0	112	divTree.addStyle(HtmlStyle.contentContainer);
aoqi@0	113	addTree(classtree.baseclasses(), "doclet.Class_Hierarchy", divTree);
aoqi@0	114	addTree(classtree.baseinterfaces(), "doclet.Interface_Hierarchy", divTree);
aoqi@0	115	addTree(classtree.baseAnnotationTypes(), "doclet.Annotation_Type_Hierarchy", divTree);
aoqi@0	116	addTree(classtree.baseEnums(), "doclet.Enum_Hierarchy", divTree);
aoqi@0	117	body.addContent(divTree);
aoqi@0	118	addNavLinks(false, body);
aoqi@0	119	addBottom(body);
aoqi@0	120	printHtmlDocument(null, true, body);
aoqi@0	121	}
aoqi@0	122
aoqi@0	123	/**
aoqi@0	124	* Add the links to all the package tree files.
aoqi@0	125	*
aoqi@0	126	* @param contentTree the content tree to which the links will be added
aoqi@0	127	*/
aoqi@0	128	protected void addPackageTreeLinks(Content contentTree) {
aoqi@0	129	//Do nothing if only unnamed package is used
aoqi@0	130	if (packages.length == 1 && packages[0].name().length() == 0) {
aoqi@0	131	return;
aoqi@0	132	}
aoqi@0	133	if (!classesonly) {
aoqi@0	134	Content span = HtmlTree.SPAN(HtmlStyle.packageHierarchyLabel,
aoqi@0	135	getResource("doclet.Package_Hierarchies"));
aoqi@0	136	contentTree.addContent(span);
aoqi@0	137	HtmlTree ul = new HtmlTree(HtmlTag.UL);
aoqi@0	138	ul.addStyle(HtmlStyle.horizontal);
aoqi@0	139	for (int i = 0; i < packages.length; i++) {
aoqi@0	140	// If the package name length is 0 or if -nodeprecated option
aoqi@0	141	// is set and the package is marked as deprecated, do not include
aoqi@0	142	// the page in the list of package hierarchies.
aoqi@0	143	if (packages[i].name().length() == 0 ||
aoqi@0	144	(configuration.nodeprecated && Util.isDeprecated(packages[i]))) {
aoqi@0	145	continue;
aoqi@0	146	}
aoqi@0	147	DocPath link = pathString(packages[i], DocPaths.PACKAGE_TREE);
aoqi@0	148	Content li = HtmlTree.LI(getHyperLink(
aoqi@0	149	link, new StringContent(packages[i].name())));
aoqi@0	150	if (i < packages.length - 1) {
aoqi@0	151	li.addContent(", ");
aoqi@0	152	}
aoqi@0	153	ul.addContent(li);
aoqi@0	154	}
aoqi@0	155	contentTree.addContent(ul);
aoqi@0	156	}
aoqi@0	157	}
aoqi@0	158
aoqi@0	159	/**
aoqi@0	160	* Get the tree header.
aoqi@0	161	*
aoqi@0	162	* @return a content tree for the tree header
aoqi@0	163	*/
aoqi@0	164	protected Content getTreeHeader() {
aoqi@0	165	String title = configuration.getText("doclet.Window_Class_Hierarchy");
aoqi@0	166	Content bodyTree = getBody(true, getWindowTitle(title));
aoqi@0	167	addTop(bodyTree);
aoqi@0	168	addNavLinks(true, bodyTree);
aoqi@0	169	return bodyTree;
aoqi@0	170	}
aoqi@0	171	}