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

src/share/classes/com/sun/tools/doclets/formats/html/HelpWriter.java@959103a6100f (annotated)

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

Wed, 27 Apr 2016 01:34:52 +0800

author

aoqi

date

Wed, 27 Apr 2016 01:34:52 +0800

changeset 0

959103a6100f

child 2525

2eb010b6cb22

permissions

-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17

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 the Help File for the generated API documentation. The help file
aoqi@0	36	* contents are helpful for browsing the generated documentation.
aoqi@0	37	*
aoqi@0	38	* <p><b>This is NOT part of any supported API.
aoqi@0	39	* If you write code that depends on this, you do so at your own risk.
aoqi@0	40	* This code and its internal interfaces are subject to change or
aoqi@0	41	* deletion without notice.</b>
aoqi@0	42	*
aoqi@0	43	* @author Atul M Dambalkar
aoqi@0	44	*/
aoqi@0	45	public class HelpWriter extends HtmlDocletWriter {
aoqi@0	46
aoqi@0	47	/**
aoqi@0	48	* Constructor to construct HelpWriter object.
aoqi@0	49	* @param filename File to be generated.
aoqi@0	50	*/
aoqi@0	51	public HelpWriter(ConfigurationImpl configuration,
aoqi@0	52	DocPath filename) throws IOException {
aoqi@0	53	super(configuration, filename);
aoqi@0	54	}
aoqi@0	55
aoqi@0	56	/**
aoqi@0	57	* Construct the HelpWriter object and then use it to generate the help
aoqi@0	58	* file. The name of the generated file is "help-doc.html". The help file
aoqi@0	59	* will get generated if and only if "-helpfile" and "-nohelp" is not used
aoqi@0	60	* on the command line.
aoqi@0	61	* @throws DocletAbortException
aoqi@0	62	*/
aoqi@0	63	public static void generate(ConfigurationImpl configuration) {
aoqi@0	64	HelpWriter helpgen;
aoqi@0	65	DocPath filename = DocPath.empty;
aoqi@0	66	try {
aoqi@0	67	filename = DocPaths.HELP_DOC;
aoqi@0	68	helpgen = new HelpWriter(configuration, filename);
aoqi@0	69	helpgen.generateHelpFile();
aoqi@0	70	helpgen.close();
aoqi@0	71	} catch (IOException exc) {
aoqi@0	72	configuration.standardmessage.error(
aoqi@0	73	"doclet.exception_encountered",
aoqi@0	74	exc.toString(), filename);
aoqi@0	75	throw new DocletAbortException(exc);
aoqi@0	76	}
aoqi@0	77	}
aoqi@0	78
aoqi@0	79	/**
aoqi@0	80	* Generate the help file contents.
aoqi@0	81	*/
aoqi@0	82	protected void generateHelpFile() throws IOException {
aoqi@0	83	String title = configuration.getText("doclet.Window_Help_title");
aoqi@0	84	Content body = getBody(true, getWindowTitle(title));
aoqi@0	85	addTop(body);
aoqi@0	86	addNavLinks(true, body);
aoqi@0	87	addHelpFileContents(body);
aoqi@0	88	addNavLinks(false, body);
aoqi@0	89	addBottom(body);
aoqi@0	90	printHtmlDocument(null, true, body);
aoqi@0	91	}
aoqi@0	92
aoqi@0	93	/**
aoqi@0	94	* Add the help file contents from the resource file to the content tree. While adding the
aoqi@0	95	* help file contents it also keeps track of user options. If "-notree"
aoqi@0	96	* is used, then the "overview-tree.html" will not get added and hence
aoqi@0	97	* help information also will not get added.
aoqi@0	98	*
aoqi@0	99	* @param contentTree the content tree to which the help file contents will be added
aoqi@0	100	*/
aoqi@0	101	protected void addHelpFileContents(Content contentTree) {
aoqi@0	102	Content heading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, false, HtmlStyle.title,
aoqi@0	103	getResource("doclet.Help_line_1"));
aoqi@0	104	Content div = HtmlTree.DIV(HtmlStyle.header, heading);
aoqi@0	105	Content line2 = HtmlTree.DIV(HtmlStyle.subTitle,
aoqi@0	106	getResource("doclet.Help_line_2"));
aoqi@0	107	div.addContent(line2);
aoqi@0	108	contentTree.addContent(div);
aoqi@0	109	HtmlTree ul = new HtmlTree(HtmlTag.UL);
aoqi@0	110	ul.addStyle(HtmlStyle.blockList);
aoqi@0	111	if (configuration.createoverview) {
aoqi@0	112	Content overviewHeading = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
aoqi@0	113	getResource("doclet.Overview"));
aoqi@0	114	Content liOverview = HtmlTree.LI(HtmlStyle.blockList, overviewHeading);
aoqi@0	115	Content line3 = getResource("doclet.Help_line_3",
aoqi@0	116	getHyperLink(DocPaths.OVERVIEW_SUMMARY,
aoqi@0	117	configuration.getText("doclet.Overview")));
aoqi@0	118	Content overviewPara = HtmlTree.P(line3);
aoqi@0	119	liOverview.addContent(overviewPara);
aoqi@0	120	ul.addContent(liOverview);
aoqi@0	121	}
aoqi@0	122	Content packageHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
aoqi@0	123	getResource("doclet.Package"));
aoqi@0	124	Content liPackage = HtmlTree.LI(HtmlStyle.blockList, packageHead);
aoqi@0	125	Content line4 = getResource("doclet.Help_line_4");
aoqi@0	126	Content packagePara = HtmlTree.P(line4);
aoqi@0	127	liPackage.addContent(packagePara);
aoqi@0	128	HtmlTree ulPackage = new HtmlTree(HtmlTag.UL);
aoqi@0	129	ulPackage.addContent(HtmlTree.LI(
aoqi@0	130	getResource("doclet.Interfaces_Italic")));
aoqi@0	131	ulPackage.addContent(HtmlTree.LI(
aoqi@0	132	getResource("doclet.Classes")));
aoqi@0	133	ulPackage.addContent(HtmlTree.LI(
aoqi@0	134	getResource("doclet.Enums")));
aoqi@0	135	ulPackage.addContent(HtmlTree.LI(
aoqi@0	136	getResource("doclet.Exceptions")));
aoqi@0	137	ulPackage.addContent(HtmlTree.LI(
aoqi@0	138	getResource("doclet.Errors")));
aoqi@0	139	ulPackage.addContent(HtmlTree.LI(
aoqi@0	140	getResource("doclet.AnnotationTypes")));
aoqi@0	141	liPackage.addContent(ulPackage);
aoqi@0	142	ul.addContent(liPackage);
aoqi@0	143	Content classHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
aoqi@0	144	getResource("doclet.Help_line_5"));
aoqi@0	145	Content liClass = HtmlTree.LI(HtmlStyle.blockList, classHead);
aoqi@0	146	Content line6 = getResource("doclet.Help_line_6");
aoqi@0	147	Content classPara = HtmlTree.P(line6);
aoqi@0	148	liClass.addContent(classPara);
aoqi@0	149	HtmlTree ul1 = new HtmlTree(HtmlTag.UL);
aoqi@0	150	ul1.addContent(HtmlTree.LI(
aoqi@0	151	getResource("doclet.Help_line_7")));
aoqi@0	152	ul1.addContent(HtmlTree.LI(
aoqi@0	153	getResource("doclet.Help_line_8")));
aoqi@0	154	ul1.addContent(HtmlTree.LI(
aoqi@0	155	getResource("doclet.Help_line_9")));
aoqi@0	156	ul1.addContent(HtmlTree.LI(
aoqi@0	157	getResource("doclet.Help_line_10")));
aoqi@0	158	ul1.addContent(HtmlTree.LI(
aoqi@0	159	getResource("doclet.Help_line_11")));
aoqi@0	160	ul1.addContent(HtmlTree.LI(
aoqi@0	161	getResource("doclet.Help_line_12")));
aoqi@0	162	liClass.addContent(ul1);
aoqi@0	163	HtmlTree ul2 = new HtmlTree(HtmlTag.UL);
aoqi@0	164	ul2.addContent(HtmlTree.LI(
aoqi@0	165	getResource("doclet.Nested_Class_Summary")));
aoqi@0	166	ul2.addContent(HtmlTree.LI(
aoqi@0	167	getResource("doclet.Field_Summary")));
aoqi@0	168	ul2.addContent(HtmlTree.LI(
aoqi@0	169	getResource("doclet.Constructor_Summary")));
aoqi@0	170	ul2.addContent(HtmlTree.LI(
aoqi@0	171	getResource("doclet.Method_Summary")));
aoqi@0	172	liClass.addContent(ul2);
aoqi@0	173	HtmlTree ul3 = new HtmlTree(HtmlTag.UL);
aoqi@0	174	ul3.addContent(HtmlTree.LI(
aoqi@0	175	getResource("doclet.Field_Detail")));
aoqi@0	176	ul3.addContent(HtmlTree.LI(
aoqi@0	177	getResource("doclet.Constructor_Detail")));
aoqi@0	178	ul3.addContent(HtmlTree.LI(
aoqi@0	179	getResource("doclet.Method_Detail")));
aoqi@0	180	liClass.addContent(ul3);
aoqi@0	181	Content line13 = getResource("doclet.Help_line_13");
aoqi@0	182	Content para = HtmlTree.P(line13);
aoqi@0	183	liClass.addContent(para);
aoqi@0	184	ul.addContent(liClass);
aoqi@0	185	//Annotation Types
aoqi@0	186	Content aHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
aoqi@0	187	getResource("doclet.AnnotationType"));
aoqi@0	188	Content liAnnotation = HtmlTree.LI(HtmlStyle.blockList, aHead);
aoqi@0	189	Content aline1 = getResource("doclet.Help_annotation_type_line_1");
aoqi@0	190	Content aPara = HtmlTree.P(aline1);
aoqi@0	191	liAnnotation.addContent(aPara);
aoqi@0	192	HtmlTree aul = new HtmlTree(HtmlTag.UL);
aoqi@0	193	aul.addContent(HtmlTree.LI(
aoqi@0	194	getResource("doclet.Help_annotation_type_line_2")));
aoqi@0	195	aul.addContent(HtmlTree.LI(
aoqi@0	196	getResource("doclet.Help_annotation_type_line_3")));
aoqi@0	197	aul.addContent(HtmlTree.LI(
aoqi@0	198	getResource("doclet.Annotation_Type_Required_Member_Summary")));
aoqi@0	199	aul.addContent(HtmlTree.LI(
aoqi@0	200	getResource("doclet.Annotation_Type_Optional_Member_Summary")));
aoqi@0	201	aul.addContent(HtmlTree.LI(
aoqi@0	202	getResource("doclet.Annotation_Type_Member_Detail")));
aoqi@0	203	liAnnotation.addContent(aul);
aoqi@0	204	ul.addContent(liAnnotation);
aoqi@0	205	//Enums
aoqi@0	206	Content enumHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
aoqi@0	207	getResource("doclet.Enum"));
aoqi@0	208	Content liEnum = HtmlTree.LI(HtmlStyle.blockList, enumHead);
aoqi@0	209	Content eline1 = getResource("doclet.Help_enum_line_1");
aoqi@0	210	Content enumPara = HtmlTree.P(eline1);
aoqi@0	211	liEnum.addContent(enumPara);
aoqi@0	212	HtmlTree eul = new HtmlTree(HtmlTag.UL);
aoqi@0	213	eul.addContent(HtmlTree.LI(
aoqi@0	214	getResource("doclet.Help_enum_line_2")));
aoqi@0	215	eul.addContent(HtmlTree.LI(
aoqi@0	216	getResource("doclet.Help_enum_line_3")));
aoqi@0	217	eul.addContent(HtmlTree.LI(
aoqi@0	218	getResource("doclet.Enum_Constant_Summary")));
aoqi@0	219	eul.addContent(HtmlTree.LI(
aoqi@0	220	getResource("doclet.Enum_Constant_Detail")));
aoqi@0	221	liEnum.addContent(eul);
aoqi@0	222	ul.addContent(liEnum);
aoqi@0	223	if (configuration.classuse) {
aoqi@0	224	Content useHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
aoqi@0	225	getResource("doclet.Help_line_14"));
aoqi@0	226	Content liUse = HtmlTree.LI(HtmlStyle.blockList, useHead);
aoqi@0	227	Content line15 = getResource("doclet.Help_line_15");
aoqi@0	228	Content usePara = HtmlTree.P(line15);
aoqi@0	229	liUse.addContent(usePara);
aoqi@0	230	ul.addContent(liUse);
aoqi@0	231	}
aoqi@0	232	if (configuration.createtree) {
aoqi@0	233	Content treeHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
aoqi@0	234	getResource("doclet.Help_line_16"));
aoqi@0	235	Content liTree = HtmlTree.LI(HtmlStyle.blockList, treeHead);
aoqi@0	236	Content line17 = getResource("doclet.Help_line_17_with_tree_link",
aoqi@0	237	getHyperLink(DocPaths.OVERVIEW_TREE,
aoqi@0	238	configuration.getText("doclet.Class_Hierarchy")),
aoqi@0	239	HtmlTree.CODE(new StringContent("java.lang.Object")));
aoqi@0	240	Content treePara = HtmlTree.P(line17);
aoqi@0	241	liTree.addContent(treePara);
aoqi@0	242	HtmlTree tul = new HtmlTree(HtmlTag.UL);
aoqi@0	243	tul.addContent(HtmlTree.LI(
aoqi@0	244	getResource("doclet.Help_line_18")));
aoqi@0	245	tul.addContent(HtmlTree.LI(
aoqi@0	246	getResource("doclet.Help_line_19")));
aoqi@0	247	liTree.addContent(tul);
aoqi@0	248	ul.addContent(liTree);
aoqi@0	249	}
aoqi@0	250	if (!(configuration.nodeprecatedlist ||
aoqi@0	251	configuration.nodeprecated)) {
aoqi@0	252	Content dHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
aoqi@0	253	getResource("doclet.Deprecated_API"));
aoqi@0	254	Content liDeprecated = HtmlTree.LI(HtmlStyle.blockList, dHead);
aoqi@0	255	Content line20 = getResource("doclet.Help_line_20_with_deprecated_api_link",
aoqi@0	256	getHyperLink(DocPaths.DEPRECATED_LIST,
aoqi@0	257	configuration.getText("doclet.Deprecated_API")));
aoqi@0	258	Content dPara = HtmlTree.P(line20);
aoqi@0	259	liDeprecated.addContent(dPara);
aoqi@0	260	ul.addContent(liDeprecated);
aoqi@0	261	}
aoqi@0	262	if (configuration.createindex) {
aoqi@0	263	Content indexlink;
aoqi@0	264	if (configuration.splitindex) {
aoqi@0	265	indexlink = getHyperLink(DocPaths.INDEX_FILES.resolve(DocPaths.indexN(1)),
aoqi@0	266	configuration.getText("doclet.Index"));
aoqi@0	267	} else {
aoqi@0	268	indexlink = getHyperLink(DocPaths.INDEX_ALL,
aoqi@0	269	configuration.getText("doclet.Index"));
aoqi@0	270	}
aoqi@0	271	Content indexHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
aoqi@0	272	getResource("doclet.Help_line_21"));
aoqi@0	273	Content liIndex = HtmlTree.LI(HtmlStyle.blockList, indexHead);
aoqi@0	274	Content line22 = getResource("doclet.Help_line_22", indexlink);
aoqi@0	275	Content indexPara = HtmlTree.P(line22);
aoqi@0	276	liIndex.addContent(indexPara);
aoqi@0	277	ul.addContent(liIndex);
aoqi@0	278	}
aoqi@0	279	Content prevHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
aoqi@0	280	getResource("doclet.Help_line_23"));
aoqi@0	281	Content liPrev = HtmlTree.LI(HtmlStyle.blockList, prevHead);
aoqi@0	282	Content line24 = getResource("doclet.Help_line_24");
aoqi@0	283	Content prevPara = HtmlTree.P(line24);
aoqi@0	284	liPrev.addContent(prevPara);
aoqi@0	285	ul.addContent(liPrev);
aoqi@0	286	Content frameHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
aoqi@0	287	getResource("doclet.Help_line_25"));
aoqi@0	288	Content liFrame = HtmlTree.LI(HtmlStyle.blockList, frameHead);
aoqi@0	289	Content line26 = getResource("doclet.Help_line_26");
aoqi@0	290	Content framePara = HtmlTree.P(line26);
aoqi@0	291	liFrame.addContent(framePara);
aoqi@0	292	ul.addContent(liFrame);
aoqi@0	293	Content allclassesHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
aoqi@0	294	getResource("doclet.All_Classes"));
aoqi@0	295	Content liAllClasses = HtmlTree.LI(HtmlStyle.blockList, allclassesHead);
aoqi@0	296	Content line27 = getResource("doclet.Help_line_27",
aoqi@0	297	getHyperLink(DocPaths.ALLCLASSES_NOFRAME,
aoqi@0	298	configuration.getText("doclet.All_Classes")));
aoqi@0	299	Content allclassesPara = HtmlTree.P(line27);
aoqi@0	300	liAllClasses.addContent(allclassesPara);
aoqi@0	301	ul.addContent(liAllClasses);
aoqi@0	302	Content sHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
aoqi@0	303	getResource("doclet.Serialized_Form"));
aoqi@0	304	Content liSerial = HtmlTree.LI(HtmlStyle.blockList, sHead);
aoqi@0	305	Content line28 = getResource("doclet.Help_line_28");
aoqi@0	306	Content serialPara = HtmlTree.P(line28);
aoqi@0	307	liSerial.addContent(serialPara);
aoqi@0	308	ul.addContent(liSerial);
aoqi@0	309	Content constHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING,
aoqi@0	310	getResource("doclet.Constants_Summary"));
aoqi@0	311	Content liConst = HtmlTree.LI(HtmlStyle.blockList, constHead);
aoqi@0	312	Content line29 = getResource("doclet.Help_line_29",
aoqi@0	313	getHyperLink(DocPaths.CONSTANT_VALUES,
aoqi@0	314	configuration.getText("doclet.Constants_Summary")));
aoqi@0	315	Content constPara = HtmlTree.P(line29);
aoqi@0	316	liConst.addContent(constPara);
aoqi@0	317	ul.addContent(liConst);
aoqi@0	318	Content divContent = HtmlTree.DIV(HtmlStyle.contentContainer, ul);
aoqi@0	319	Content line30 = HtmlTree.SPAN(HtmlStyle.emphasizedPhrase, getResource("doclet.Help_line_30"));
aoqi@0	320	divContent.addContent(line30);
aoqi@0	321	contentTree.addContent(divContent);
aoqi@0	322	}
aoqi@0	323
aoqi@0	324	/**
aoqi@0	325	* Get the help label.
aoqi@0	326	*
aoqi@0	327	* @return a content tree for the help label
aoqi@0	328	*/
aoqi@0	329	@Override
aoqi@0	330	protected Content getNavLinkHelp() {
aoqi@0	331	Content li = HtmlTree.LI(HtmlStyle.navBarCell1Rev, helpLabel);
aoqi@0	332	return li;
aoqi@0	333	}
aoqi@0	334	}