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

src/share/classes/com/sun/tools/doclets/formats/html/AllClassesFrameWriter.java@2eb010b6cb22 (annotated)

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

Thu, 31 Aug 2017 15:17:03 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:17:03 +0800

changeset 2525

2eb010b6cb22

parent 1985

0e6577980181

parent 0

959103a6100f

permissions

-rw-r--r--

merge

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	import java.util.*;
aoqi@0	30
aoqi@0	31	import com.sun.javadoc.*;
aoqi@0	32	import com.sun.tools.doclets.formats.html.markup.*;
aoqi@0	33	import com.sun.tools.doclets.internal.toolkit.*;
aoqi@0	34	import com.sun.tools.doclets.internal.toolkit.util.*;
aoqi@0	35
aoqi@0	36	/**
aoqi@0	37	* Generate the file with list of all the classes in this run. This page will be
aoqi@0	38	* used in the left-hand bottom frame, when "All Classes" link is clicked in
aoqi@0	39	* the left-hand top frame. The name of the generated file is
aoqi@0	40	* "allclasses-frame.html".
aoqi@0	41	*
aoqi@0	42	* <p><b>This is NOT part of any supported API.
aoqi@0	43	* If you write code that depends on this, you do so at your own risk.
aoqi@0	44	* This code and its internal interfaces are subject to change or
aoqi@0	45	* deletion without notice.</b>
aoqi@0	46	*
aoqi@0	47	* @author Atul M Dambalkar
aoqi@0	48	* @author Doug Kramer
aoqi@0	49	* @author Bhavesh Patel (Modified)
aoqi@0	50	*/
aoqi@0	51	public class AllClassesFrameWriter extends HtmlDocletWriter {
aoqi@0	52
aoqi@0	53	/**
aoqi@0	54	* Index of all the classes.
aoqi@0	55	*/
aoqi@0	56	protected IndexBuilder indexbuilder;
aoqi@0	57
aoqi@0	58	/**
aoqi@0	59	* BR tag to be used within a document tree.
aoqi@0	60	*/
aoqi@0	61	final HtmlTree BR = new HtmlTree(HtmlTag.BR);
aoqi@0	62
aoqi@0	63	/**
aoqi@0	64	* Construct AllClassesFrameWriter object. Also initializes the indexbuilder
aoqi@0	65	* variable in this class.
aoqi@0	66	* @param configuration The current configuration
aoqi@0	67	* @param filename Path to the file which is getting generated.
aoqi@0	68	* @param indexbuilder Unicode based Index from {@link IndexBuilder}
aoqi@0	69	* @throws IOException
aoqi@0	70	* @throws DocletAbortException
aoqi@0	71	*/
aoqi@0	72	public AllClassesFrameWriter(ConfigurationImpl configuration,
aoqi@0	73	DocPath filename, IndexBuilder indexbuilder)
aoqi@0	74	throws IOException {
aoqi@0	75	super(configuration, filename);
aoqi@0	76	this.indexbuilder = indexbuilder;
aoqi@0	77	}
aoqi@0	78
aoqi@0	79	/**
aoqi@0	80	* Create AllClassesFrameWriter object. Then use it to generate the
aoqi@0	81	* "allclasses-frame.html" file. Generate the file in the current or the
aoqi@0	82	* destination directory.
aoqi@0	83	*
aoqi@0	84	* @param indexbuilder IndexBuilder object for all classes index.
aoqi@0	85	* @throws DocletAbortException
aoqi@0	86	*/
aoqi@0	87	public static void generate(ConfigurationImpl configuration,
aoqi@0	88	IndexBuilder indexbuilder) {
aoqi@0	89	AllClassesFrameWriter allclassgen;
aoqi@0	90	DocPath filename = DocPaths.ALLCLASSES_FRAME;
aoqi@0	91	try {
aoqi@0	92	allclassgen = new AllClassesFrameWriter(configuration,
aoqi@0	93	filename, indexbuilder);
aoqi@0	94	allclassgen.buildAllClassesFile(true);
aoqi@0	95	allclassgen.close();
aoqi@0	96	filename = DocPaths.ALLCLASSES_NOFRAME;
aoqi@0	97	allclassgen = new AllClassesFrameWriter(configuration,
aoqi@0	98	filename, indexbuilder);
aoqi@0	99	allclassgen.buildAllClassesFile(false);
aoqi@0	100	allclassgen.close();
aoqi@0	101	} catch (IOException exc) {
aoqi@0	102	configuration.standardmessage.
aoqi@0	103	error("doclet.exception_encountered",
aoqi@0	104	exc.toString(), filename);
aoqi@0	105	throw new DocletAbortException(exc);
aoqi@0	106	}
aoqi@0	107	}
aoqi@0	108
aoqi@0	109	/**
aoqi@0	110	* Print all the classes in the file.
aoqi@0	111	* @param wantFrames True if we want frames.
aoqi@0	112	*/
aoqi@0	113	protected void buildAllClassesFile(boolean wantFrames) throws IOException {
aoqi@0	114	String label = configuration.getText("doclet.All_Classes");
aoqi@0	115	Content body = getBody(false, getWindowTitle(label));
aoqi@0	116	Content heading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING,
aoqi@0	117	HtmlStyle.bar, allclassesLabel);
aoqi@0	118	body.addContent(heading);
aoqi@0	119	Content ul = new HtmlTree(HtmlTag.UL);
aoqi@0	120	// Generate the class links and add it to the tdFont tree.
aoqi@0	121	addAllClasses(ul, wantFrames);
aoqi@0	122	Content div = HtmlTree.DIV(HtmlStyle.indexContainer, ul);
aoqi@0	123	body.addContent(div);
aoqi@0	124	printHtmlDocument(null, false, body);
aoqi@0	125	}
aoqi@0	126
aoqi@0	127	/**
aoqi@0	128	* Use the sorted index of all the classes and add all the classes to the
aoqi@0	129	* content list.
aoqi@0	130	*
aoqi@0	131	* @param content HtmlTree content to which all classes information will be added
aoqi@0	132	* @param wantFrames True if we want frames.
aoqi@0	133	*/
aoqi@0	134	protected void addAllClasses(Content content, boolean wantFrames) {
aoqi@0	135	for (int i = 0; i < indexbuilder.elements().length; i++) {
aoqi@0	136	Character unicode = (Character)((indexbuilder.elements())[i]);
aoqi@0	137	addContents(indexbuilder.getMemberList(unicode), wantFrames, content);
aoqi@0	138	}
aoqi@0	139	}
aoqi@0	140
aoqi@0	141	/**
aoqi@0	142	* Given a list of classes, generate links for each class or interface.
aoqi@0	143	* If the class kind is interface, print it in the italics font. Also all
aoqi@0	144	* links should target the right-hand frame. If clicked on any class name
aoqi@0	145	* in this page, appropriate class page should get opened in the right-hand
aoqi@0	146	* frame.
aoqi@0	147	*
aoqi@0	148	* @param classlist Sorted list of classes.
aoqi@0	149	* @param wantFrames True if we want frames.
aoqi@0	150	* @param content HtmlTree content to which the links will be added
aoqi@0	151	*/
aoqi@0	152	protected void addContents(List<Doc> classlist, boolean wantFrames,
aoqi@0	153	Content content) {
aoqi@0	154	for (int i = 0; i < classlist.size(); i++) {
aoqi@0	155	ClassDoc cd = (ClassDoc)classlist.get(i);
aoqi@0	156	if (!Util.isCoreClass(cd)) {
aoqi@0	157	continue;
aoqi@0	158	}
aoqi@0	159	Content label = italicsClassName(cd, false);
aoqi@0	160	Content linkContent;
aoqi@0	161	if (wantFrames) {
aoqi@0	162	linkContent = getLink(new LinkInfoImpl(configuration,
aoqi@0	163	LinkInfoImpl.Kind.ALL_CLASSES_FRAME, cd).label(label).target("classFrame"));
aoqi@0	164	} else {
aoqi@0	165	linkContent = getLink(new LinkInfoImpl(configuration, LinkInfoImpl.Kind.DEFAULT, cd).label(label));
aoqi@0	166	}
aoqi@0	167	Content li = HtmlTree.LI(linkContent);
aoqi@0	168	content.addContent(li);
aoqi@0	169	}
aoqi@0	170	}
aoqi@0	171	}