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

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

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

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

author

aoqi

date

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

changeset 2525

2eb010b6cb22

parent 2101

933ba3f81a87

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
aoqi@0	30	import com.sun.tools.doclets.formats.html.markup.*;
aoqi@0	31	import com.sun.tools.doclets.internal.toolkit.*;
aoqi@0	32	import com.sun.tools.doclets.internal.toolkit.util.*;
aoqi@0	33
aoqi@0	34	/**
aoqi@0	35	* Generate only one index file for all the Member Names with Indexing in
aoqi@0	36	* Unicode Order. The name of the generated file is "index-all.html" and it is
aoqi@0	37	* generated in current or the destination directory.
aoqi@0	38	*
aoqi@0	39	* <p><b>This is NOT part of any supported API.
aoqi@0	40	* If you write code that depends on this, you do so at your own risk.
aoqi@0	41	* This code and its internal interfaces are subject to change or
aoqi@0	42	* deletion without notice.</b>
aoqi@0	43	*
aoqi@0	44	* @see java.lang.Character
aoqi@0	45	* @author Atul M Dambalkar
aoqi@0	46	* @author Bhavesh Patel (Modified)
aoqi@0	47	*/
aoqi@0	48	public class SingleIndexWriter extends AbstractIndexWriter {
aoqi@0	49
aoqi@0	50	/**
aoqi@0	51	* Construct the SingleIndexWriter with filename "index-all.html" and the
aoqi@0	52	* {@link IndexBuilder}
aoqi@0	53	*
aoqi@0	54	* @param filename Name of the index file to be generated.
aoqi@0	55	* @param indexbuilder Unicode based Index from {@link IndexBuilder}
aoqi@0	56	*/
aoqi@0	57	public SingleIndexWriter(ConfigurationImpl configuration,
aoqi@0	58	DocPath filename,
aoqi@0	59	IndexBuilder indexbuilder) throws IOException {
aoqi@0	60	super(configuration, filename, indexbuilder);
aoqi@0	61	}
aoqi@0	62
aoqi@0	63	/**
aoqi@0	64	* Generate single index file, for all Unicode characters.
aoqi@0	65	*
aoqi@0	66	* @param indexbuilder IndexBuilder built by {@link IndexBuilder}
aoqi@0	67	* @throws DocletAbortException
aoqi@0	68	*/
aoqi@0	69	public static void generate(ConfigurationImpl configuration,
aoqi@0	70	IndexBuilder indexbuilder) {
aoqi@0	71	SingleIndexWriter indexgen;
aoqi@0	72	DocPath filename = DocPaths.INDEX_ALL;
aoqi@0	73	try {
aoqi@0	74	indexgen = new SingleIndexWriter(configuration,
aoqi@0	75	filename, indexbuilder);
aoqi@0	76	indexgen.generateIndexFile();
aoqi@0	77	indexgen.close();
aoqi@0	78	} catch (IOException exc) {
aoqi@0	79	configuration.standardmessage.error(
aoqi@0	80	"doclet.exception_encountered",
aoqi@0	81	exc.toString(), filename);
aoqi@0	82	throw new DocletAbortException(exc);
aoqi@0	83	}
aoqi@0	84	}
aoqi@0	85
aoqi@0	86	/**
aoqi@0	87	* Generate the contents of each index file, with Header, Footer,
aoqi@0	88	* Member Field, Method and Constructor Description.
aoqi@0	89	*/
aoqi@0	90	protected void generateIndexFile() throws IOException {
aoqi@0	91	String title = configuration.getText("doclet.Window_Single_Index");
aoqi@0	92	Content body = getBody(true, getWindowTitle(title));
aoqi@0	93	addTop(body);
aoqi@0	94	addNavLinks(true, body);
aoqi@0	95	HtmlTree divTree = new HtmlTree(HtmlTag.DIV);
aoqi@0	96	divTree.addStyle(HtmlStyle.contentContainer);
aoqi@0	97	addLinksForIndexes(divTree);
aoqi@0	98	for (int i = 0; i < indexbuilder.elements().length; i++) {
aoqi@0	99	Character unicode = (Character)((indexbuilder.elements())[i]);
aoqi@0	100	addContents(unicode, indexbuilder.getMemberList(unicode), divTree);
aoqi@0	101	}
aoqi@0	102	addLinksForIndexes(divTree);
aoqi@0	103	body.addContent(divTree);
aoqi@0	104	addNavLinks(false, body);
aoqi@0	105	addBottom(body);
aoqi@0	106	printHtmlDocument(null, true, body);
aoqi@0	107	}
aoqi@0	108
aoqi@0	109	/**
aoqi@0	110	* Add links for all the Index Files per unicode character.
aoqi@0	111	*
aoqi@0	112	* @param contentTree the content tree to which the links for indexes will be added
aoqi@0	113	*/
aoqi@0	114	protected void addLinksForIndexes(Content contentTree) {
aoqi@0	115	for (int i = 0; i < indexbuilder.elements().length; i++) {
aoqi@0	116	String unicode = (indexbuilder.elements())[i].toString();
aoqi@0	117	contentTree.addContent(
aoqi@0	118	getHyperLink(getNameForIndex(unicode),
aoqi@0	119	new StringContent(unicode)));
aoqi@0	120	contentTree.addContent(getSpace());
aoqi@0	121	}
aoqi@0	122	}
aoqi@0	123	}