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

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

src/share/classes/com/sun/tools/doclets/formats/html/SplitIndexWriter.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
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 Separate Index Files for all the member names with Indexing in
aoqi@0	36	* Unicode Order. This will create "index-files" directory in the current or
aoqi@0	37	* destination directory and will generate separate file for each unicode index.
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 SplitIndexWriter extends AbstractIndexWriter {
aoqi@0	49
aoqi@0	50	/**
aoqi@0	51	* Previous unicode character index in the built index.
aoqi@0	52	*/
aoqi@0	53	protected int prev;
aoqi@0	54
aoqi@0	55	/**
aoqi@0	56	* Next unicode character in the built index.
aoqi@0	57	*/
aoqi@0	58	protected int next;
aoqi@0	59
aoqi@0	60	/**
aoqi@0	61	* Construct the SplitIndexWriter. Uses path to this file and relative path
aoqi@0	62	* from this file.
aoqi@0	63	*
aoqi@0	64	* @param path Path to the file which is getting generated.
aoqi@0	65	* @param indexbuilder Unicode based Index from {@link IndexBuilder}
aoqi@0	66	*/
aoqi@0	67	public SplitIndexWriter(ConfigurationImpl configuration,
aoqi@0	68	DocPath path,
aoqi@0	69	IndexBuilder indexbuilder,
aoqi@0	70	int prev, int next) throws IOException {
aoqi@0	71	super(configuration, path, indexbuilder);
aoqi@0	72	this.prev = prev;
aoqi@0	73	this.next = next;
aoqi@0	74	}
aoqi@0	75
aoqi@0	76	/**
aoqi@0	77	* Generate separate index files, for each Unicode character, listing all
aoqi@0	78	* the members starting with the particular unicode character.
aoqi@0	79	*
aoqi@0	80	* @param indexbuilder IndexBuilder built by {@link IndexBuilder}
aoqi@0	81	* @throws DocletAbortException
aoqi@0	82	*/
aoqi@0	83	public static void generate(ConfigurationImpl configuration,
aoqi@0	84	IndexBuilder indexbuilder) {
aoqi@0	85	SplitIndexWriter indexgen;
aoqi@0	86	DocPath filename = DocPath.empty;
aoqi@0	87	DocPath path = DocPaths.INDEX_FILES;
aoqi@0	88	try {
aoqi@0	89	for (int i = 0; i < indexbuilder.elements().length; i++) {
aoqi@0	90	int j = i + 1;
aoqi@0	91	int prev = (j == 1)? -1: i;
aoqi@0	92	int next = (j == indexbuilder.elements().length)? -1: j + 1;
aoqi@0	93	filename = DocPaths.indexN(j);
aoqi@0	94	indexgen = new SplitIndexWriter(configuration,
aoqi@0	95	path.resolve(filename),
aoqi@0	96	indexbuilder, prev, next);
aoqi@0	97	indexgen.generateIndexFile((Character)indexbuilder.
aoqi@0	98	elements()[i]);
aoqi@0	99	indexgen.close();
aoqi@0	100	}
aoqi@0	101	} catch (IOException exc) {
aoqi@0	102	configuration.standardmessage.error(
aoqi@0	103	"doclet.exception_encountered",
aoqi@0	104	exc.toString(), filename.getPath());
aoqi@0	105	throw new DocletAbortException(exc);
aoqi@0	106	}
aoqi@0	107	}
aoqi@0	108
aoqi@0	109	/**
aoqi@0	110	* Generate the contents of each index file, with Header, Footer,
aoqi@0	111	* Member Field, Method and Constructor Description.
aoqi@0	112	*
aoqi@0	113	* @param unicode Unicode character referring to the character for the
aoqi@0	114	* index.
aoqi@0	115	*/
aoqi@0	116	protected void generateIndexFile(Character unicode) throws IOException {
aoqi@0	117	String title = configuration.getText("doclet.Window_Split_Index",
aoqi@0	118	unicode.toString());
aoqi@0	119	Content body = getBody(true, getWindowTitle(title));
aoqi@0	120	addTop(body);
aoqi@0	121	addNavLinks(true, body);
aoqi@0	122	HtmlTree divTree = new HtmlTree(HtmlTag.DIV);
aoqi@0	123	divTree.addStyle(HtmlStyle.contentContainer);
aoqi@0	124	addLinksForIndexes(divTree);
aoqi@0	125	addContents(unicode, indexbuilder.getMemberList(unicode), divTree);
aoqi@0	126	addLinksForIndexes(divTree);
aoqi@0	127	body.addContent(divTree);
aoqi@0	128	addNavLinks(false, body);
aoqi@0	129	addBottom(body);
aoqi@0	130	printHtmlDocument(null, true, body);
aoqi@0	131	}
aoqi@0	132
aoqi@0	133	/**
aoqi@0	134	* Add links for all the Index Files per unicode character.
aoqi@0	135	*
aoqi@0	136	* @param contentTree the content tree to which the links for indexes will be added
aoqi@0	137	*/
aoqi@0	138	protected void addLinksForIndexes(Content contentTree) {
aoqi@0	139	Object[] unicodeChars = indexbuilder.elements();
aoqi@0	140	for (int i = 0; i < unicodeChars.length; i++) {
aoqi@0	141	int j = i + 1;
aoqi@0	142	contentTree.addContent(getHyperLink(DocPaths.indexN(j),
aoqi@0	143	new StringContent(unicodeChars[i].toString())));
aoqi@0	144	contentTree.addContent(getSpace());
aoqi@0	145	}
aoqi@0	146	}
aoqi@0	147
aoqi@0	148	/**
aoqi@0	149	* Get link to the previous unicode character.
aoqi@0	150	*
aoqi@0	151	* @return a content tree for the link
aoqi@0	152	*/
aoqi@0	153	public Content getNavLinkPrevious() {
aoqi@0	154	Content prevletterLabel = getResource("doclet.Prev_Letter");
aoqi@0	155	if (prev == -1) {
aoqi@0	156	return HtmlTree.LI(prevletterLabel);
aoqi@0	157	}
aoqi@0	158	else {
aoqi@0	159	Content prevLink = getHyperLink(DocPaths.indexN(prev),
aoqi@0	160	prevletterLabel);
aoqi@0	161	return HtmlTree.LI(prevLink);
aoqi@0	162	}
aoqi@0	163	}
aoqi@0	164
aoqi@0	165	/**
aoqi@0	166	* Get link to the next unicode character.
aoqi@0	167	*
aoqi@0	168	* @return a content tree for the link
aoqi@0	169	*/
aoqi@0	170	public Content getNavLinkNext() {
aoqi@0	171	Content nextletterLabel = getResource("doclet.Next_Letter");
aoqi@0	172	if (next == -1) {
aoqi@0	173	return HtmlTree.LI(nextletterLabel);
aoqi@0	174	}
aoqi@0	175	else {
aoqi@0	176	Content nextLink = getHyperLink(DocPaths.indexN(next),
aoqi@0	177	nextletterLabel);
aoqi@0	178	return HtmlTree.LI(nextLink);
aoqi@0	179	}
aoqi@0	180	}
aoqi@0	181	}