115 * help file contents it also keeps track of user options. If "-notree"
116 * is used, then the "overview-tree.html" will not get added and hence
117 * help information also will not get added.
118 *
119 * @param contentTree the content tree to which the help file contents will be added
120 */
121 protected void addHelpFileContents(Content contentTree) {
122 // Heading
123 Content heading = HtmlTree.HEADING(Headings.PAGE_TITLE_HEADING, false, HtmlStyle.title,
124 contents.getContent("doclet.help.main_heading"));
125 Content div = HtmlTree.DIV(HtmlStyle.header, heading);
126 Content intro = HtmlTree.DIV(HtmlStyle.subTitle,
127 contents.getContent("doclet.help.intro"));
128 div.add(intro);
129 contentTree.add(div);
130 HtmlTree htmlTree;
131 HtmlTree ul = new HtmlTree(HtmlTag.UL);
132 ul.setStyle(HtmlStyle.blockList);
133
134 // Overview
135 if (configuration.createoverview) {
136 Content overviewHeading = HtmlTree.HEADING(Headings.CONTENT_HEADING,
137 contents.overviewLabel);
138 htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, overviewHeading);
139 String overviewKey = configuration.showModules
140 ? "doclet.help.overview.modules.body"
141 : "doclet.help.overview.packages.body";
142 Content overviewLink = links.createLink(
143 DocPaths.INDEX, resources.getText("doclet.Overview"));
144 Content overviewBody = contents.getContent(overviewKey, overviewLink);
145 Content overviewPara = HtmlTree.P(overviewBody);
146 htmlTree.add(overviewPara);
147 ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
148 }
149
150 // Module
151 if (configuration.showModules) {
152 Content moduleHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
153 contents.moduleLabel);
154 htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, moduleHead);
155 Content moduleIntro = contents.getContent("doclet.help.module.intro");
229 aul.add(HtmlTree.LI(contents.annotateTypeOptionalMemberSummaryLabel));
230 aul.add(HtmlTree.LI(contents.annotationTypeMemberDetail));
231 htmlTree.add(aul);
232 ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
233
234 // Enums
235 Content enumHead = HtmlTree.HEADING(Headings.CONTENT_HEADING, contents.enum_);
236 htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, enumHead);
237 Content eIntro = contents.getContent("doclet.help.enum.intro");
238 Content enumPara = HtmlTree.P(eIntro);
239 htmlTree.add(enumPara);
240 HtmlTree eul = new HtmlTree(HtmlTag.UL);
241 eul.add(HtmlTree.LI(contents.getContent("doclet.help.enum.declaration")));
242 eul.add(HtmlTree.LI(contents.getContent("doclet.help.enum.definition")));
243 eul.add(HtmlTree.LI(contents.enumConstantSummary));
244 eul.add(HtmlTree.LI(contents.enumConstantDetailLabel));
245 htmlTree.add(eul);
246 ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
247
248 // Class Use
249 if (configuration.classuse) {
250 Content useHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
251 contents.getContent("doclet.help.use.head"));
252 htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, useHead);
253 Content useBody = contents.getContent("doclet.help.use.body");
254 Content usePara = HtmlTree.P(useBody);
255 htmlTree.add(usePara);
256 ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
257 }
258
259 // Tree
260 if (configuration.createtree) {
261 Content treeHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
262 contents.getContent("doclet.help.tree.head"));
263 htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, treeHead);
264 Content treeIntro = contents.getContent("doclet.help.tree.intro",
265 links.createLink(DocPaths.OVERVIEW_TREE,
266 resources.getText("doclet.Class_Hierarchy")),
267 HtmlTree.CODE(new StringContent("java.lang.Object")));
268 Content treePara = HtmlTree.P(treeIntro);
269 htmlTree.add(treePara);
270 HtmlTree tul = new HtmlTree(HtmlTag.UL);
271 tul.add(HtmlTree.LI(contents.getContent("doclet.help.tree.overview")));
272 tul.add(HtmlTree.LI(contents.getContent("doclet.help.tree.package")));
273 htmlTree.add(tul);
274 ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
275 }
276
277 // Deprecated
278 if (!(configuration.nodeprecatedlist || configuration.nodeprecated)) {
279 Content dHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
280 contents.deprecatedAPI);
281 htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, dHead);
282 Content deprBody = contents.getContent("doclet.help.deprecated.body",
283 links.createLink(DocPaths.DEPRECATED_LIST,
284 resources.getText("doclet.Deprecated_API")));
285 Content dPara = HtmlTree.P(deprBody);
286 htmlTree.add(dPara);
287 ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
288 }
289
290 // Index
291 if (configuration.createindex) {
292 Content indexlink;
293 if (configuration.splitindex) {
294 indexlink = links.createLink(DocPaths.INDEX_FILES.resolve(DocPaths.indexN(1)),
295 resources.getText("doclet.Index"));
296 } else {
297 indexlink = links.createLink(DocPaths.INDEX_ALL,
298 resources.getText("doclet.Index"));
299 }
300 Content indexHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
301 contents.getContent("doclet.help.index.head"));
302 htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, indexHead);
303 Content indexBody = contents.getContent("doclet.help.index.body", indexlink);
304 Content indexPara = HtmlTree.P(indexBody);
305 htmlTree.add(indexPara);
306 ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
307 }
308
309 // Serialized Form
310 Content sHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
311 contents.serializedForm);
312 htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, sHead);
313 Content serialBody = contents.getContent("doclet.help.serial_form.body");
|
115 * help file contents it also keeps track of user options. If "-notree"
116 * is used, then the "overview-tree.html" will not get added and hence
117 * help information also will not get added.
118 *
119 * @param contentTree the content tree to which the help file contents will be added
120 */
121 protected void addHelpFileContents(Content contentTree) {
122 // Heading
123 Content heading = HtmlTree.HEADING(Headings.PAGE_TITLE_HEADING, false, HtmlStyle.title,
124 contents.getContent("doclet.help.main_heading"));
125 Content div = HtmlTree.DIV(HtmlStyle.header, heading);
126 Content intro = HtmlTree.DIV(HtmlStyle.subTitle,
127 contents.getContent("doclet.help.intro"));
128 div.add(intro);
129 contentTree.add(div);
130 HtmlTree htmlTree;
131 HtmlTree ul = new HtmlTree(HtmlTag.UL);
132 ul.setStyle(HtmlStyle.blockList);
133
134 // Overview
135 if (options.createOverview) {
136 Content overviewHeading = HtmlTree.HEADING(Headings.CONTENT_HEADING,
137 contents.overviewLabel);
138 htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, overviewHeading);
139 String overviewKey = configuration.showModules
140 ? "doclet.help.overview.modules.body"
141 : "doclet.help.overview.packages.body";
142 Content overviewLink = links.createLink(
143 DocPaths.INDEX, resources.getText("doclet.Overview"));
144 Content overviewBody = contents.getContent(overviewKey, overviewLink);
145 Content overviewPara = HtmlTree.P(overviewBody);
146 htmlTree.add(overviewPara);
147 ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
148 }
149
150 // Module
151 if (configuration.showModules) {
152 Content moduleHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
153 contents.moduleLabel);
154 htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, moduleHead);
155 Content moduleIntro = contents.getContent("doclet.help.module.intro");
229 aul.add(HtmlTree.LI(contents.annotateTypeOptionalMemberSummaryLabel));
230 aul.add(HtmlTree.LI(contents.annotationTypeMemberDetail));
231 htmlTree.add(aul);
232 ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
233
234 // Enums
235 Content enumHead = HtmlTree.HEADING(Headings.CONTENT_HEADING, contents.enum_);
236 htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, enumHead);
237 Content eIntro = contents.getContent("doclet.help.enum.intro");
238 Content enumPara = HtmlTree.P(eIntro);
239 htmlTree.add(enumPara);
240 HtmlTree eul = new HtmlTree(HtmlTag.UL);
241 eul.add(HtmlTree.LI(contents.getContent("doclet.help.enum.declaration")));
242 eul.add(HtmlTree.LI(contents.getContent("doclet.help.enum.definition")));
243 eul.add(HtmlTree.LI(contents.enumConstantSummary));
244 eul.add(HtmlTree.LI(contents.enumConstantDetailLabel));
245 htmlTree.add(eul);
246 ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
247
248 // Class Use
249 if (options.classUse) {
250 Content useHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
251 contents.getContent("doclet.help.use.head"));
252 htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, useHead);
253 Content useBody = contents.getContent("doclet.help.use.body");
254 Content usePara = HtmlTree.P(useBody);
255 htmlTree.add(usePara);
256 ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
257 }
258
259 // Tree
260 if (options.createTree) {
261 Content treeHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
262 contents.getContent("doclet.help.tree.head"));
263 htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, treeHead);
264 Content treeIntro = contents.getContent("doclet.help.tree.intro",
265 links.createLink(DocPaths.OVERVIEW_TREE,
266 resources.getText("doclet.Class_Hierarchy")),
267 HtmlTree.CODE(new StringContent("java.lang.Object")));
268 Content treePara = HtmlTree.P(treeIntro);
269 htmlTree.add(treePara);
270 HtmlTree tul = new HtmlTree(HtmlTag.UL);
271 tul.add(HtmlTree.LI(contents.getContent("doclet.help.tree.overview")));
272 tul.add(HtmlTree.LI(contents.getContent("doclet.help.tree.package")));
273 htmlTree.add(tul);
274 ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
275 }
276
277 // Deprecated
278 if (!(options.noDeprecatedList || options.noDeprecated)) {
279 Content dHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
280 contents.deprecatedAPI);
281 htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, dHead);
282 Content deprBody = contents.getContent("doclet.help.deprecated.body",
283 links.createLink(DocPaths.DEPRECATED_LIST,
284 resources.getText("doclet.Deprecated_API")));
285 Content dPara = HtmlTree.P(deprBody);
286 htmlTree.add(dPara);
287 ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
288 }
289
290 // Index
291 if (options.createIndex) {
292 Content indexlink;
293 if (options.splitIndex) {
294 indexlink = links.createLink(DocPaths.INDEX_FILES.resolve(DocPaths.indexN(1)),
295 resources.getText("doclet.Index"));
296 } else {
297 indexlink = links.createLink(DocPaths.INDEX_ALL,
298 resources.getText("doclet.Index"));
299 }
300 Content indexHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
301 contents.getContent("doclet.help.index.head"));
302 htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, indexHead);
303 Content indexBody = contents.getContent("doclet.help.index.body", indexlink);
304 Content indexPara = HtmlTree.P(indexBody);
305 htmlTree.add(indexPara);
306 ul.add(HtmlTree.LI(HtmlStyle.blockList, htmlTree));
307 }
308
309 // Serialized Form
310 Content sHead = HtmlTree.HEADING(Headings.CONTENT_HEADING,
311 contents.serializedForm);
312 htmlTree = HtmlTree.SECTION(HtmlStyle.helpSection, sHead);
313 Content serialBody = contents.getContent("doclet.help.serial_form.body");
|