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

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

src/share/classes/com/sun/tools/doclets/formats/html/PackageIndexFrameWriter.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) 1998, 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 the package index for the left-hand frame in the generated output.
aoqi@0	37	* A click on the package name in this frame will update the page in the bottom
aoqi@0	38	* left hand frame with the listing of contents of the clicked package.
aoqi@0	39	*
aoqi@0	40	* <p><b>This is NOT part of any supported API.
aoqi@0	41	* If you write code that depends on this, you do so at your own risk.
aoqi@0	42	* This code and its internal interfaces are subject to change or
aoqi@0	43	* deletion without notice.</b>
aoqi@0	44	*
aoqi@0	45	* @author Atul M Dambalkar
aoqi@0	46	*/
aoqi@0	47	public class PackageIndexFrameWriter extends AbstractPackageIndexWriter {
aoqi@0	48
aoqi@0	49	/**
aoqi@0	50	* Construct the PackageIndexFrameWriter object.
aoqi@0	51	*
aoqi@0	52	* @param filename Name of the package index file to be generated.
aoqi@0	53	*/
aoqi@0	54	public PackageIndexFrameWriter(ConfigurationImpl configuration,
aoqi@0	55	DocPath filename) throws IOException {
aoqi@0	56	super(configuration, filename);
aoqi@0	57	}
aoqi@0	58
aoqi@0	59	/**
aoqi@0	60	* Generate the package index file named "overview-frame.html".
aoqi@0	61	* @throws DocletAbortException
aoqi@0	62	*/
aoqi@0	63	public static void generate(ConfigurationImpl configuration) {
aoqi@0	64	PackageIndexFrameWriter packgen;
aoqi@0	65	DocPath filename = DocPaths.OVERVIEW_FRAME;
aoqi@0	66	try {
aoqi@0	67	packgen = new PackageIndexFrameWriter(configuration, filename);
aoqi@0	68	packgen.buildPackageIndexFile("doclet.Window_Overview", false);
aoqi@0	69	packgen.close();
aoqi@0	70	} catch (IOException exc) {
aoqi@0	71	configuration.standardmessage.error(
aoqi@0	72	"doclet.exception_encountered",
aoqi@0	73	exc.toString(), filename);
aoqi@0	74	throw new DocletAbortException(exc);
aoqi@0	75	}
aoqi@0	76	}
aoqi@0	77
aoqi@0	78	/**
aoqi@0	79	* {@inheritDoc}
aoqi@0	80	*/
aoqi@0	81	protected void addPackagesList(PackageDoc[] packages, String text,
aoqi@0	82	String tableSummary, Content body) {
aoqi@0	83	Content heading = HtmlTree.HEADING(HtmlConstants.PACKAGE_HEADING, true,
aoqi@0	84	packagesLabel);
aoqi@0	85	Content div = HtmlTree.DIV(HtmlStyle.indexContainer, heading);
aoqi@0	86	HtmlTree ul = new HtmlTree(HtmlTag.UL);
aoqi@0	87	ul.setTitle(packagesLabel);
aoqi@0	88	for(int i = 0; i < packages.length; i++) {
aoqi@0	89	// Do not list the package if -nodeprecated option is set and the
aoqi@0	90	// package is marked as deprecated.
aoqi@0	91	if (packages[i] != null &&
aoqi@0	92	(!(configuration.nodeprecated && Util.isDeprecated(packages[i])))) {
aoqi@0	93	ul.addContent(getPackage(packages[i]));
aoqi@0	94	}
aoqi@0	95	}
aoqi@0	96	div.addContent(ul);
aoqi@0	97	body.addContent(div);
aoqi@0	98	}
aoqi@0	99
aoqi@0	100	/**
aoqi@0	101	* Gets each package name as a separate link.
aoqi@0	102	*
aoqi@0	103	* @param pd PackageDoc
aoqi@0	104	* @return content for the package link
aoqi@0	105	*/
aoqi@0	106	protected Content getPackage(PackageDoc pd) {
aoqi@0	107	Content packageLinkContent;
aoqi@0	108	Content packageLabel;
aoqi@0	109	if (pd.name().length() > 0) {
aoqi@0	110	packageLabel = getPackageLabel(pd.name());
aoqi@0	111	packageLinkContent = getHyperLink(pathString(pd,
aoqi@0	112	DocPaths.PACKAGE_FRAME), packageLabel, "",
aoqi@0	113	"packageFrame");
aoqi@0	114	} else {
aoqi@0	115	packageLabel = new StringContent("<unnamed package>");
aoqi@0	116	packageLinkContent = getHyperLink(DocPaths.PACKAGE_FRAME,
aoqi@0	117	packageLabel, "", "packageFrame");
aoqi@0	118	}
aoqi@0	119	Content li = HtmlTree.LI(packageLinkContent);
aoqi@0	120	return li;
aoqi@0	121	}
aoqi@0	122
aoqi@0	123	/**
aoqi@0	124	* {@inheritDoc}
aoqi@0	125	*/
aoqi@0	126	protected void addNavigationBarHeader(Content body) {
aoqi@0	127	Content headerContent;
aoqi@0	128	if (configuration.packagesheader.length() > 0) {
aoqi@0	129	headerContent = new RawHtml(replaceDocRootDir(configuration.packagesheader));
aoqi@0	130	} else {
aoqi@0	131	headerContent = new RawHtml(replaceDocRootDir(configuration.header));
aoqi@0	132	}
aoqi@0	133	Content heading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, true,
aoqi@0	134	HtmlStyle.bar, headerContent);
aoqi@0	135	body.addContent(heading);
aoqi@0	136	}
aoqi@0	137
aoqi@0	138	/**
aoqi@0	139	* Do nothing as there is no overview information in this page.
aoqi@0	140	*/
aoqi@0	141	protected void addOverviewHeader(Content body) {
aoqi@0	142	}
aoqi@0	143
aoqi@0	144	/**
aoqi@0	145	* Adds "All Classes" link for the top of the left-hand frame page to the
aoqi@0	146	* documentation tree.
aoqi@0	147	*
aoqi@0	148	* @param div the Content object to which the all classes link should be added
aoqi@0	149	*/
aoqi@0	150	protected void addAllClassesLink(Content div) {
aoqi@0	151	Content linkContent = getHyperLink(DocPaths.ALLCLASSES_FRAME,
aoqi@0	152	allclassesLabel, "", "packageFrame");
aoqi@0	153	Content span = HtmlTree.SPAN(linkContent);
aoqi@0	154	div.addContent(span);
aoqi@0	155	}
aoqi@0	156
aoqi@0	157	/**
aoqi@0	158	* Adds "All Profiles" link for the top of the left-hand frame page to the
aoqi@0	159	* documentation tree.
aoqi@0	160	*
aoqi@0	161	* @param div the Content object to which the all profiles link should be added
aoqi@0	162	*/
aoqi@0	163	protected void addAllProfilesLink(Content div) {
aoqi@0	164	Content linkContent = getHyperLink(DocPaths.PROFILE_OVERVIEW_FRAME,
aoqi@0	165	allprofilesLabel, "", "packageListFrame");
aoqi@0	166	Content span = HtmlTree.SPAN(linkContent);
aoqi@0	167	div.addContent(span);
aoqi@0	168	}
aoqi@0	169
aoqi@0	170	/**
aoqi@0	171	* {@inheritDoc}
aoqi@0	172	*/
aoqi@0	173	protected void addNavigationBarFooter(Content body) {
aoqi@0	174	Content p = HtmlTree.P(getSpace());
aoqi@0	175	body.addContent(p);
aoqi@0	176	}
aoqi@0	177	}