author | bpatel |
Thu, 17 May 2018 12:59:53 -0700 | |
changeset 50167 | cc705c956798 |
parent 49879 | 601277b1d582 |
child 50895 | 83ed34655f59 |
permissions | -rw-r--r-- |
49551 | 1 |
/* |
2 |
* Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved. |
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
7 |
* published by the Free Software Foundation. Oracle designates this |
|
8 |
* particular file as subject to the "Classpath" exception as provided |
|
9 |
* by Oracle in the LICENSE file that accompanied this code. |
|
10 |
* |
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
24 |
*/ |
|
25 |
package jdk.javadoc.internal.doclets.formats.html.markup; |
|
26 |
||
27 |
import java.util.ArrayDeque; |
|
28 |
import java.util.ArrayList; |
|
29 |
import java.util.Deque; |
|
30 |
import java.util.HashMap; |
|
31 |
import java.util.List; |
|
32 |
import java.util.Map; |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
33 |
import java.util.Set; |
49551 | 34 |
import java.util.SortedSet; |
35 |
||
36 |
import javax.lang.model.element.Element; |
|
37 |
import javax.lang.model.element.ElementKind; |
|
38 |
import javax.lang.model.element.ModuleElement; |
|
39 |
import javax.lang.model.element.PackageElement; |
|
40 |
import javax.lang.model.element.TypeElement; |
|
41 |
||
42 |
import jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter; |
|
43 |
import jdk.javadoc.internal.doclets.formats.html.Contents; |
|
44 |
import jdk.javadoc.internal.doclets.formats.html.HtmlConfiguration; |
|
45 |
import jdk.javadoc.internal.doclets.formats.html.SectionName; |
|
46 |
import jdk.javadoc.internal.doclets.toolkit.Content; |
|
47 |
import jdk.javadoc.internal.doclets.toolkit.builders.MemberSummaryBuilder; |
|
48 |
import jdk.javadoc.internal.doclets.toolkit.util.DocFile; |
|
49 |
import jdk.javadoc.internal.doclets.toolkit.util.DocLink; |
|
50 |
import jdk.javadoc.internal.doclets.toolkit.util.DocPath; |
|
51 |
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths; |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
52 |
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable; |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
53 |
|
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
54 |
import static jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind.*; |
49551 | 55 |
|
56 |
/** |
|
57 |
* Factory for navigation bar. |
|
58 |
* |
|
59 |
* <p> |
|
60 |
* <b>This is NOT part of any supported API. If you write code that depends on this, you do so at |
|
61 |
* your own risk. This code and its internal interfaces are subject to change or deletion without |
|
62 |
* notice.</b> |
|
63 |
*/ |
|
64 |
public class Navigation { |
|
65 |
||
66 |
private final HtmlConfiguration configuration; |
|
67 |
private final Element element; |
|
68 |
private final Contents contents; |
|
69 |
private final DocPath path; |
|
70 |
private final DocPath pathToRoot; |
|
71 |
private final Links links; |
|
72 |
private final HtmlTree fixedNavDiv; |
|
73 |
private final PageMode documentedPage; |
|
74 |
private Content navLinkModule; |
|
75 |
private Content navLinkPackage; |
|
76 |
private Content navLinkClass; |
|
77 |
private MemberSummaryBuilder memberSummaryBuilder; |
|
78 |
private boolean displaySummaryModuleDescLink; |
|
79 |
private boolean displaySummaryModulesLink; |
|
80 |
private boolean displaySummaryPackagesLink; |
|
81 |
private boolean displaySummaryServicesLink; |
|
82 |
private final Map<Position, Deque<Content>> topBottomNavContents; |
|
83 |
private Content userHeader; |
|
84 |
private Content userFooter; |
|
85 |
private final String rowListTitle; |
|
86 |
private final Content searchLabel; |
|
87 |
private static final Script FIXED_NAV_SCRIPT = new Script("<!--\n" |
|
88 |
+ "$('.navPadding').css('padding-top', $('.fixedNav').css(\"height\"));\n" |
|
89 |
+ "//-->\n"); |
|
90 |
||
91 |
public enum PageMode { |
|
50167
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
49879
diff
changeset
|
92 |
ALLCLASSES, |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
49879
diff
changeset
|
93 |
ALLPACKAGES, |
49551 | 94 |
CLASS, |
95 |
CONSTANTVALUES, |
|
96 |
DEPRECATED, |
|
97 |
DOCFILE, |
|
98 |
HELP, |
|
99 |
INDEX, |
|
100 |
MODULE, |
|
101 |
OVERVIEW, |
|
102 |
PACKAGE, |
|
103 |
SERIALIZEDFORM, |
|
104 |
TREE, |
|
105 |
USE; |
|
106 |
} |
|
107 |
||
108 |
enum Position { |
|
109 |
BOTTOM("allclasses_navbar_bottom", HtmlConstants.START_OF_BOTTOM_NAVBAR, HtmlConstants.END_OF_BOTTOM_NAVBAR), |
|
110 |
TOP("allclasses_navbar_top", HtmlConstants.START_OF_TOP_NAVBAR, HtmlConstants.END_OF_TOP_NAVBAR); |
|
111 |
||
112 |
final String allClassesLinkId; |
|
113 |
final Content startOfNav; |
|
114 |
final Content endOfNav; |
|
115 |
||
116 |
Position(String allClassesLinkId, Content startOfNav, Content endOfNav) { |
|
117 |
this.allClassesLinkId = allClassesLinkId; |
|
118 |
this.startOfNav = startOfNav; |
|
119 |
this.endOfNav = endOfNav; |
|
120 |
} |
|
121 |
||
122 |
String allClassesLinkId() { |
|
123 |
return allClassesLinkId; |
|
124 |
} |
|
125 |
||
126 |
Content startOfNav() { |
|
127 |
return startOfNav; |
|
128 |
} |
|
129 |
||
130 |
Content endOfNav() { |
|
131 |
return endOfNav; |
|
132 |
} |
|
133 |
||
134 |
Script allClassesLinkScript() { |
|
135 |
return new Script("<!--\n" |
|
136 |
+ " allClassesLink = document.getElementById(") |
|
137 |
.appendStringLiteral(allClassesLinkId) |
|
138 |
.append(");\n" |
|
139 |
+ " if(window==top) {\n" |
|
140 |
+ " allClassesLink.style.display = \"block\";\n" |
|
141 |
+ " }\n" |
|
142 |
+ " else {\n" |
|
143 |
+ " allClassesLink.style.display = \"none\";\n" |
|
144 |
+ " }\n" |
|
145 |
+ " //-->\n"); |
|
146 |
} |
|
147 |
} |
|
148 |
||
149 |
/** |
|
150 |
* Creates a {@code Navigation} object for a specific file, to be written in a specific HTML |
|
151 |
* version. |
|
152 |
* |
|
153 |
* @param element element being documented. null if its not an element documentation page |
|
154 |
* @param configuration the configuration object |
|
155 |
* @param fixedNavDiv the fixed navigation for the header navigation |
|
156 |
* @param page the kind of page being documented |
|
157 |
* @param path the DocPath object |
|
158 |
*/ |
|
159 |
public Navigation(Element element, HtmlConfiguration configuration, HtmlTree fixedNavDiv, |
|
160 |
PageMode page, DocPath path) { |
|
161 |
this.configuration = configuration; |
|
162 |
this.element = element; |
|
163 |
this.fixedNavDiv = fixedNavDiv; |
|
164 |
this.contents = configuration.contents; |
|
165 |
this.documentedPage = page; |
|
166 |
this.path = path; |
|
167 |
this.pathToRoot = path.parent().invert(); |
|
168 |
this.links = new Links(path, configuration.htmlVersion); |
|
169 |
this.topBottomNavContents = new HashMap<>(); |
|
170 |
this.rowListTitle = configuration.getText("doclet.Navigation"); |
|
171 |
this.searchLabel = configuration.getContent("doclet.search"); |
|
172 |
populateNavContents(Position.TOP); |
|
173 |
populateNavContents(Position.BOTTOM); |
|
174 |
} |
|
175 |
||
176 |
/** |
|
177 |
* Populate the navigation contents for top and bottom navigation |
|
178 |
* |
|
179 |
* @param position the position of the navigation bar on the page |
|
180 |
*/ |
|
181 |
private void populateNavContents(Position position) { |
|
182 |
Deque<Content> queue = new ArrayDeque<>(); |
|
183 |
Content skipNavLinks = configuration.getContent("doclet.Skip_navigation_links"); |
|
184 |
switch (position) { |
|
185 |
case TOP: |
|
186 |
queue.addLast(links.createAnchor(SectionName.NAVBAR_TOP)); |
|
187 |
queue.addLast(links.createLink(SectionName.SKIP_NAVBAR_TOP, skipNavLinks, |
|
188 |
skipNavLinks.toString(), "")); |
|
189 |
queue.addLast(links.createAnchor(SectionName.NAVBAR_TOP_FIRSTROW)); |
|
190 |
queue.addLast(links.createAnchor(SectionName.SKIP_NAVBAR_TOP)); |
|
191 |
topBottomNavContents.put(position, queue); |
|
192 |
break; |
|
193 |
case BOTTOM: |
|
194 |
queue.addLast(links.createAnchor(SectionName.NAVBAR_BOTTOM)); |
|
195 |
queue.addLast(links.createLink(SectionName.SKIP_NAVBAR_BOTTOM, skipNavLinks, |
|
196 |
skipNavLinks.toString(), "")); |
|
197 |
queue.addLast(links.createAnchor(SectionName.NAVBAR_BOTTOM_FIRSTROW)); |
|
198 |
queue.addLast(links.createAnchor(SectionName.SKIP_NAVBAR_BOTTOM)); |
|
199 |
topBottomNavContents.put(position, queue); |
|
200 |
break; |
|
201 |
default: |
|
202 |
break; |
|
203 |
} |
|
204 |
} |
|
205 |
||
206 |
public Navigation setNavLinkModule(Content navLinkModule) { |
|
207 |
this.navLinkModule = navLinkModule; |
|
208 |
return this; |
|
209 |
} |
|
210 |
||
211 |
public Navigation setNavLinkPackage(Content navLinkPackage) { |
|
212 |
this.navLinkPackage = navLinkPackage; |
|
213 |
return this; |
|
214 |
} |
|
215 |
||
216 |
public Navigation setNavLinkClass(Content navLinkClass) { |
|
217 |
this.navLinkClass = navLinkClass; |
|
218 |
return this; |
|
219 |
} |
|
220 |
||
221 |
public Navigation setMemberSummaryBuilder(MemberSummaryBuilder memberSummaryBuilder) { |
|
222 |
this.memberSummaryBuilder = memberSummaryBuilder; |
|
223 |
return this; |
|
224 |
} |
|
225 |
||
226 |
public Navigation setDisplaySummaryModuleDescLink(boolean displaySummaryModuleDescLink) { |
|
227 |
this.displaySummaryModuleDescLink = displaySummaryModuleDescLink; |
|
228 |
return this; |
|
229 |
} |
|
230 |
||
231 |
public Navigation setDisplaySummaryModulesLink(boolean displaySummaryModulesLink) { |
|
232 |
this.displaySummaryModulesLink = displaySummaryModulesLink; |
|
233 |
return this; |
|
234 |
} |
|
235 |
||
236 |
public Navigation setDisplaySummaryPackagesLink(boolean displaySummaryPackagesLink) { |
|
237 |
this.displaySummaryPackagesLink = displaySummaryPackagesLink; |
|
238 |
return this; |
|
239 |
} |
|
240 |
||
241 |
public Navigation setDisplaySummaryServicesLink(boolean displaySummaryServicesLink) { |
|
242 |
this.displaySummaryServicesLink = displaySummaryServicesLink; |
|
243 |
return this; |
|
244 |
} |
|
245 |
||
246 |
public Navigation setUserHeader(Content userHeader) { |
|
247 |
this.userHeader = userHeader; |
|
248 |
return this; |
|
249 |
} |
|
250 |
||
251 |
public Navigation setUserFooter(Content userFooter) { |
|
252 |
this.userFooter = userFooter; |
|
253 |
return this; |
|
254 |
} |
|
255 |
||
256 |
/** |
|
257 |
* Add the links for the main navigation. |
|
258 |
* |
|
259 |
* @param tree the content tree to which the main navigation will added |
|
260 |
*/ |
|
261 |
private void addMainNavLinks(Content tree) { |
|
262 |
switch (documentedPage) { |
|
263 |
case OVERVIEW: |
|
264 |
addActivePageLink(tree, contents.overviewLabel, configuration.createoverview); |
|
265 |
addModuleLink(tree); |
|
266 |
addPackageLink(tree); |
|
267 |
addPageLabel(tree, contents.classLabel, true); |
|
268 |
addPageLabel(tree, contents.useLabel, configuration.classuse); |
|
269 |
addTreeLink(tree); |
|
270 |
addDeprecatedLink(tree); |
|
271 |
addIndexLink(tree); |
|
272 |
addHelpLink(tree); |
|
273 |
break; |
|
274 |
case MODULE: |
|
275 |
addOverviewLink(tree); |
|
276 |
addActivePageLink(tree, contents.moduleLabel, configuration.showModules); |
|
277 |
addPackageLink(tree); |
|
278 |
addPageLabel(tree, contents.classLabel, true); |
|
279 |
addPageLabel(tree, contents.useLabel, configuration.classuse); |
|
280 |
addTreeLink(tree); |
|
281 |
addDeprecatedLink(tree); |
|
282 |
addIndexLink(tree); |
|
283 |
addHelpLink(tree); |
|
284 |
break; |
|
285 |
case PACKAGE: |
|
286 |
addOverviewLink(tree); |
|
287 |
addModuleOfElementLink(tree); |
|
288 |
addActivePageLink(tree, contents.packageLabel, true); |
|
289 |
addPageLabel(tree, contents.classLabel, true); |
|
290 |
if (configuration.classuse) { |
|
291 |
addContentToTree(tree, links.createLink(DocPaths.PACKAGE_USE, |
|
292 |
contents.useLabel, "", "")); |
|
293 |
} |
|
294 |
if (configuration.createtree) { |
|
295 |
addContentToTree(tree, links.createLink(DocPaths.PACKAGE_TREE, |
|
296 |
contents.treeLabel, "", "")); |
|
297 |
} |
|
298 |
addDeprecatedLink(tree); |
|
299 |
addIndexLink(tree); |
|
300 |
addHelpLink(tree); |
|
301 |
break; |
|
302 |
case CLASS: |
|
303 |
addOverviewLink(tree); |
|
304 |
addModuleOfElementLink(tree); |
|
305 |
addPackageSummaryLink(tree); |
|
306 |
addActivePageLink(tree, contents.classLabel, true); |
|
307 |
if (configuration.classuse) { |
|
308 |
addContentToTree(tree, links.createLink(DocPaths.CLASS_USE.resolve(path.basename()), |
|
309 |
contents.useLabel)); |
|
310 |
} |
|
311 |
if (configuration.createtree) { |
|
312 |
addContentToTree(tree, links.createLink(DocPaths.PACKAGE_TREE, |
|
313 |
contents.treeLabel, "", "")); |
|
314 |
} |
|
315 |
addDeprecatedLink(tree); |
|
316 |
addIndexLink(tree); |
|
317 |
addHelpLink(tree); |
|
318 |
break; |
|
319 |
case USE: |
|
320 |
addOverviewLink(tree); |
|
321 |
addModuleOfElementLink(tree); |
|
322 |
if (element instanceof PackageElement) { |
|
323 |
addPackageSummaryLink(tree); |
|
324 |
addPageLabel(tree, contents.classLabel, true); |
|
325 |
} else { |
|
326 |
addPackageOfElementLink(tree); |
|
327 |
addContentToTree(tree, navLinkClass); |
|
328 |
} |
|
329 |
addActivePageLink(tree, contents.useLabel, configuration.classuse); |
|
330 |
if (element instanceof PackageElement) { |
|
331 |
addContentToTree(tree, links.createLink(DocPaths.PACKAGE_TREE, contents.treeLabel)); |
|
332 |
} else { |
|
333 |
addContentToTree(tree, configuration.utils.isEnclosingPackageIncluded((TypeElement) element) |
|
334 |
? links.createLink(DocPath.parent.resolve(DocPaths.PACKAGE_TREE), contents.treeLabel) |
|
335 |
: links.createLink(pathToRoot.resolve(DocPaths.OVERVIEW_TREE), contents.treeLabel)); |
|
336 |
} |
|
337 |
addDeprecatedLink(tree); |
|
338 |
addIndexLink(tree); |
|
339 |
addHelpLink(tree); |
|
340 |
break; |
|
341 |
case TREE: |
|
342 |
addOverviewLink(tree); |
|
343 |
if (element == null) { |
|
344 |
addPageLabel(tree, contents.moduleLabel, configuration.showModules); |
|
345 |
addPageLabel(tree, contents.packageLabel, true); |
|
346 |
} else { |
|
347 |
addModuleOfElementLink(tree); |
|
348 |
addPackageSummaryLink(tree); |
|
349 |
} |
|
350 |
addPageLabel(tree, contents.classLabel, true); |
|
351 |
addPageLabel(tree, contents.useLabel, configuration.classuse); |
|
352 |
addActivePageLink(tree, contents.treeLabel, configuration.createtree); |
|
353 |
addDeprecatedLink(tree); |
|
354 |
addIndexLink(tree); |
|
355 |
addHelpLink(tree); |
|
356 |
break; |
|
357 |
case DEPRECATED: |
|
358 |
case INDEX: |
|
359 |
case HELP: |
|
360 |
addOverviewLink(tree); |
|
361 |
addModuleLink(tree); |
|
362 |
addPackageLink(tree); |
|
363 |
addPageLabel(tree, contents.classLabel, true); |
|
364 |
addPageLabel(tree, contents.useLabel, configuration.classuse); |
|
365 |
addTreeLink(tree); |
|
366 |
if (documentedPage == PageMode.DEPRECATED) { |
|
367 |
addActivePageLink(tree, contents.deprecatedLabel, !(configuration.nodeprecated |
|
368 |
|| configuration.nodeprecatedlist)); |
|
369 |
} else { |
|
370 |
addDeprecatedLink(tree); |
|
371 |
} |
|
372 |
if (documentedPage == PageMode.INDEX) { |
|
373 |
addActivePageLink(tree, contents.indexLabel, configuration.createindex); |
|
374 |
} else { |
|
375 |
addIndexLink(tree); |
|
376 |
} |
|
377 |
if (documentedPage == PageMode.HELP) { |
|
378 |
addActivePageLink(tree, contents.helpLabel, !configuration.nohelp); |
|
379 |
} else { |
|
380 |
addHelpLink(tree); |
|
381 |
} |
|
382 |
break; |
|
50167
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
49879
diff
changeset
|
383 |
case ALLCLASSES: |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
49879
diff
changeset
|
384 |
case ALLPACKAGES: |
49551 | 385 |
case CONSTANTVALUES: |
386 |
case SERIALIZEDFORM: |
|
387 |
addOverviewLink(tree); |
|
388 |
addModuleLink(tree); |
|
389 |
addPackageLink(tree); |
|
390 |
addPageLabel(tree, contents.classLabel, true); |
|
391 |
addPageLabel(tree, contents.useLabel, configuration.classuse); |
|
392 |
addTreeLink(tree); |
|
393 |
addDeprecatedLink(tree); |
|
394 |
addIndexLink(tree); |
|
395 |
addHelpLink(tree); |
|
396 |
break; |
|
397 |
case DOCFILE: |
|
398 |
addOverviewLink(tree); |
|
399 |
addModuleOfElementLink(tree); |
|
400 |
addContentToTree(tree, navLinkPackage); |
|
401 |
addPageLabel(tree, contents.classLabel, true); |
|
402 |
addPageLabel(tree, contents.useLabel, configuration.classuse); |
|
403 |
addTreeLink(tree); |
|
404 |
addDeprecatedLink(tree); |
|
405 |
addIndexLink(tree); |
|
406 |
addHelpLink(tree); |
|
407 |
break; |
|
408 |
default: |
|
409 |
break; |
|
410 |
} |
|
411 |
} |
|
412 |
||
413 |
/** |
|
414 |
* Add the summary links to the sub-navigation. |
|
415 |
* |
|
416 |
* @param tree the content tree to which the sub-navigation will added |
|
417 |
*/ |
|
418 |
private void addSummaryLinks(Content tree) { |
|
419 |
List<Content> listContents = new ArrayList<>(); |
|
420 |
switch (documentedPage) { |
|
421 |
case CLASS: |
|
422 |
if (element.getKind() == ElementKind.ANNOTATION_TYPE) { |
|
423 |
addAnnotationTypeSummaryLink("doclet.navField", |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
424 |
ANNOTATION_TYPE_FIELDS, listContents); |
49551 | 425 |
addAnnotationTypeSummaryLink("doclet.navAnnotationTypeRequiredMember", |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
426 |
ANNOTATION_TYPE_MEMBER_REQUIRED, listContents); |
49551 | 427 |
addAnnotationTypeSummaryLink("doclet.navAnnotationTypeOptionalMember", |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
428 |
ANNOTATION_TYPE_MEMBER_OPTIONAL, listContents); |
49551 | 429 |
} else { |
430 |
TypeElement typeElement = (TypeElement) element; |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
431 |
for (VisibleMemberTable.Kind kind : summarySet) { |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
432 |
if (kind == ENUM_CONSTANTS && !configuration.utils.isEnum(typeElement)) { |
49551 | 433 |
continue; |
434 |
} |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
435 |
if (kind == CONSTRUCTORS && configuration.utils.isEnum(typeElement)) { |
49551 | 436 |
continue; |
437 |
} |
|
438 |
AbstractMemberWriter writer |
|
439 |
= ((AbstractMemberWriter) memberSummaryBuilder.getMemberSummaryWriter(kind)); |
|
440 |
if (writer == null) { |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
441 |
addContentToList(listContents, contents.getNavLinkLabelContent(kind)); |
49551 | 442 |
} else { |
443 |
addTypeSummaryLink(memberSummaryBuilder.members(kind), |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
444 |
memberSummaryBuilder.getVisibleMemberTable(), |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
445 |
kind, listContents); |
49551 | 446 |
} |
447 |
} |
|
448 |
} |
|
449 |
if (!listContents.isEmpty()) { |
|
450 |
Content li = HtmlTree.LI(contents.summaryLabel); |
|
451 |
li.addContent(Contents.SPACE); |
|
452 |
tree.addContent(li); |
|
453 |
addListToNav(listContents, tree); |
|
454 |
} |
|
455 |
break; |
|
456 |
case MODULE: |
|
457 |
if (displaySummaryModuleDescLink) { |
|
458 |
addContentToList(listContents, |
|
459 |
links.createLink(SectionName.MODULE_DESCRIPTION, contents.navModuleDescription)); |
|
460 |
} else { |
|
461 |
addContentToList(listContents, contents.navModuleDescription); |
|
462 |
} |
|
463 |
if (displaySummaryModulesLink) { |
|
464 |
addContentToList(listContents, |
|
465 |
links.createLink(SectionName.MODULES, contents.navModules)); |
|
466 |
} else { |
|
467 |
addContentToList(listContents, contents.navModules); |
|
468 |
} |
|
469 |
if (displaySummaryPackagesLink) { |
|
470 |
addContentToList(listContents, |
|
471 |
links.createLink(SectionName.PACKAGES, contents.navPackages)); |
|
472 |
} else { |
|
473 |
addContentToList(listContents, contents.navPackages); |
|
474 |
} |
|
475 |
if (displaySummaryServicesLink) { |
|
476 |
addContentToList(listContents, |
|
477 |
links.createLink(SectionName.SERVICES, contents.navServices)); |
|
478 |
} else { |
|
479 |
addContentToList(listContents, contents.navServices); |
|
480 |
} |
|
481 |
if (!listContents.isEmpty()) { |
|
482 |
Content li = HtmlTree.LI(contents.moduleSubNavLabel); |
|
483 |
li.addContent(Contents.SPACE); |
|
484 |
tree.addContent(li); |
|
485 |
addListToNav(listContents, tree); |
|
486 |
} |
|
487 |
break; |
|
488 |
default: |
|
489 |
break; |
|
490 |
} |
|
491 |
} |
|
492 |
||
493 |
/** |
|
494 |
* Add the navigation summary link. |
|
495 |
* |
|
496 |
* @param members members to be linked |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
497 |
* @param vmt the visible member table |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
498 |
* @param kind the visible member kind |
49551 | 499 |
* @param listContents the list of contents |
500 |
*/ |
|
501 |
private void addTypeSummaryLink(SortedSet<? extends Element> members, |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
502 |
VisibleMemberTable vmt, |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
503 |
VisibleMemberTable.Kind kind, List<Content> listContents) { |
49551 | 504 |
if (!members.isEmpty()) { |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
505 |
addTypeSummaryLink(null, kind, true, listContents); |
49551 | 506 |
return; |
507 |
} |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
508 |
Set<TypeElement> visibleClasses = vmt.getVisibleTypeElements(); |
49551 | 509 |
for (TypeElement t : visibleClasses) { |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
510 |
if (configuration.getVisibleMemberTable(t).hasVisibleMembers(kind)) { |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
511 |
addTypeSummaryLink(null, kind, true, listContents); |
49551 | 512 |
return; |
513 |
} |
|
514 |
} |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
515 |
addTypeSummaryLink(null, kind, false, listContents); |
49551 | 516 |
} |
517 |
||
518 |
/** |
|
519 |
* Add the navigation Type summary link. |
|
520 |
* |
|
521 |
* @param typeElement the Type being documented |
|
522 |
* @param kind the kind of member being documented |
|
523 |
* @param link true if the members are listed and need to be linked |
|
524 |
* @param listContents the list of contents to which the summary will be added |
|
525 |
*/ |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
526 |
private void addTypeSummaryLink(TypeElement typeElement, VisibleMemberTable.Kind kind, boolean link, |
49551 | 527 |
List<Content> listContents) { |
528 |
switch (kind) { |
|
529 |
case CONSTRUCTORS: |
|
530 |
if (link) { |
|
531 |
addContentToList(listContents, links.createLink(SectionName.CONSTRUCTOR_SUMMARY, |
|
532 |
contents.navConstructor)); |
|
533 |
} else { |
|
534 |
addContentToList(listContents, contents.navConstructor); |
|
535 |
} |
|
536 |
break; |
|
537 |
case ENUM_CONSTANTS: |
|
538 |
if (link) { |
|
539 |
if (typeElement == null) { |
|
540 |
addContentToList(listContents, links.createLink(SectionName.ENUM_CONSTANT_SUMMARY, |
|
541 |
contents.navEnum)); |
|
542 |
} else { |
|
543 |
addContentToList(listContents, links.createLink( |
|
544 |
SectionName.ENUM_CONSTANTS_INHERITANCE, |
|
545 |
configuration.getClassName(typeElement), contents.navEnum)); |
|
546 |
} |
|
547 |
} else { |
|
548 |
addContentToList(listContents, contents.navEnum); |
|
549 |
} |
|
550 |
break; |
|
551 |
case FIELDS: |
|
552 |
if (link) { |
|
553 |
if (typeElement == null) { |
|
554 |
addContentToList(listContents, |
|
555 |
links.createLink(SectionName.FIELD_SUMMARY, contents.navField)); |
|
556 |
} else { |
|
557 |
addContentToList(listContents, links.createLink(SectionName.FIELDS_INHERITANCE, |
|
558 |
configuration.getClassName(typeElement), contents.navField)); |
|
559 |
} |
|
560 |
} else { |
|
561 |
addContentToList(listContents, contents.navField); |
|
562 |
} |
|
563 |
break; |
|
564 |
case METHODS: |
|
565 |
if (link) { |
|
566 |
if (typeElement == null) { |
|
567 |
addContentToList(listContents, |
|
568 |
links.createLink(SectionName.METHOD_SUMMARY, contents.navMethod)); |
|
569 |
} else { |
|
570 |
addContentToList(listContents, links.createLink(SectionName.METHODS_INHERITANCE, |
|
571 |
configuration.getClassName(typeElement), contents.navMethod)); |
|
572 |
} |
|
573 |
} else { |
|
574 |
addContentToList(listContents, contents.navMethod); |
|
575 |
} |
|
576 |
break; |
|
577 |
case INNER_CLASSES: |
|
578 |
if (link) { |
|
579 |
if (typeElement == null) { |
|
580 |
addContentToList(listContents, |
|
581 |
links.createLink(SectionName.NESTED_CLASS_SUMMARY, contents.navNested)); |
|
582 |
} else { |
|
583 |
addContentToList(listContents, links.createLink(SectionName.NESTED_CLASSES_INHERITANCE, |
|
584 |
configuration.utils.getFullyQualifiedName(typeElement), contents.navNested)); |
|
585 |
} |
|
586 |
} else { |
|
587 |
addContentToList(listContents, contents.navNested); |
|
588 |
} |
|
589 |
break; |
|
590 |
case PROPERTIES: |
|
591 |
if (link) { |
|
592 |
if (typeElement == null) { |
|
593 |
addContentToList(listContents, |
|
594 |
links.createLink(SectionName.PROPERTY_SUMMARY, contents.navProperty)); |
|
595 |
} else { |
|
596 |
addContentToList(listContents, links.createLink(SectionName.PROPERTIES_INHERITANCE, |
|
597 |
configuration.getClassName(typeElement), contents.navProperty)); |
|
598 |
} |
|
599 |
} else { |
|
600 |
addContentToList(listContents, contents.navProperty); |
|
601 |
} |
|
602 |
break; |
|
603 |
default: |
|
604 |
break; |
|
605 |
} |
|
606 |
} |
|
607 |
||
608 |
/** |
|
609 |
* Add the navigation Type summary link. |
|
610 |
* |
|
611 |
* @param label the label to be added |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
612 |
* @param kind the kind of member being documented |
49551 | 613 |
* @param listContents the list of contents to which the summary will be added |
614 |
*/ |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
615 |
private void addAnnotationTypeSummaryLink(String label, VisibleMemberTable.Kind kind, List<Content> listContents) { |
49551 | 616 |
AbstractMemberWriter writer = ((AbstractMemberWriter) memberSummaryBuilder. |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
617 |
getMemberSummaryWriter(kind)); |
49551 | 618 |
if (writer == null) { |
619 |
addContentToList(listContents, contents.getContent(label)); |
|
620 |
} else { |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
621 |
boolean link = memberSummaryBuilder.getVisibleMemberTable().hasVisibleMembers(kind); |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
622 |
switch (kind) { |
49551 | 623 |
case ANNOTATION_TYPE_FIELDS: |
624 |
if (link) { |
|
625 |
addContentToList(listContents, links.createLink(SectionName.ANNOTATION_TYPE_FIELD_SUMMARY, |
|
626 |
contents.navField)); |
|
627 |
} else { |
|
628 |
addContentToList(listContents, contents.navField); |
|
629 |
} |
|
630 |
break; |
|
631 |
case ANNOTATION_TYPE_MEMBER_REQUIRED: |
|
632 |
if (link) { |
|
633 |
addContentToList(listContents, links.createLink( |
|
634 |
SectionName.ANNOTATION_TYPE_REQUIRED_ELEMENT_SUMMARY, |
|
635 |
contents.navAnnotationTypeRequiredMember)); |
|
636 |
} else { |
|
637 |
addContentToList(listContents, contents.navAnnotationTypeRequiredMember); |
|
638 |
} |
|
639 |
break; |
|
640 |
case ANNOTATION_TYPE_MEMBER_OPTIONAL: |
|
641 |
if (link) { |
|
642 |
addContentToList(listContents, links.createLink( |
|
643 |
SectionName.ANNOTATION_TYPE_OPTIONAL_ELEMENT_SUMMARY, |
|
644 |
contents.navAnnotationTypeOptionalMember)); |
|
645 |
} else { |
|
646 |
addContentToList(listContents, contents.navAnnotationTypeOptionalMember); |
|
647 |
} |
|
648 |
break; |
|
649 |
default: |
|
650 |
break; |
|
651 |
} |
|
652 |
} |
|
653 |
} |
|
654 |
||
655 |
/** |
|
656 |
* Add the detail links to sub-navigation. |
|
657 |
* |
|
658 |
* @param tree the content tree to which the links will be added |
|
659 |
*/ |
|
660 |
private void addDetailLinks(Content tree) { |
|
661 |
switch (documentedPage) { |
|
662 |
case CLASS: |
|
663 |
List<Content> listContents = new ArrayList<>(); |
|
664 |
if (element.getKind() == ElementKind.ANNOTATION_TYPE) { |
|
665 |
addAnnotationTypeDetailLink(listContents); |
|
666 |
} else { |
|
667 |
TypeElement typeElement = (TypeElement) element; |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
668 |
for (VisibleMemberTable.Kind kind : detailSet) { |
49551 | 669 |
AbstractMemberWriter writer |
670 |
= ((AbstractMemberWriter) memberSummaryBuilder. |
|
671 |
getMemberSummaryWriter(kind)); |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
672 |
if (kind == ENUM_CONSTANTS && !configuration.utils.isEnum(typeElement)) { |
49551 | 673 |
continue; |
674 |
} |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
675 |
if (kind == CONSTRUCTORS && configuration.utils.isEnum(typeElement)) { |
49551 | 676 |
continue; |
677 |
} |
|
678 |
if (writer == null) { |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
679 |
addContentToList(listContents, contents.getNavLinkLabelContent(kind)); |
49551 | 680 |
} else { |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
681 |
addTypeDetailLink(kind, memberSummaryBuilder.hasMembers(kind), listContents); |
49551 | 682 |
} |
683 |
} |
|
684 |
} |
|
685 |
if (!listContents.isEmpty()) { |
|
686 |
Content li = HtmlTree.LI(contents.detailLabel); |
|
687 |
li.addContent(Contents.SPACE); |
|
688 |
tree.addContent(li); |
|
689 |
addListToNav(listContents, tree); |
|
690 |
} |
|
691 |
break; |
|
692 |
default: |
|
693 |
break; |
|
694 |
} |
|
695 |
} |
|
696 |
||
697 |
/** |
|
698 |
* Add the navigation Type detail link. |
|
699 |
* |
|
700 |
* @param kind the kind of member being documented |
|
701 |
* @param link true if the members are listed and need to be linked |
|
702 |
* @param listContents the list of contents to which the detail will be added. |
|
703 |
*/ |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
704 |
protected void addTypeDetailLink(VisibleMemberTable.Kind kind, boolean link, List<Content> listContents) { |
49551 | 705 |
switch (kind) { |
706 |
case CONSTRUCTORS: |
|
707 |
if (link) { |
|
708 |
addContentToList(listContents, links.createLink(SectionName.CONSTRUCTOR_DETAIL, contents.navConstructor)); |
|
709 |
} else { |
|
710 |
addContentToList(listContents, contents.navConstructor); |
|
711 |
} |
|
712 |
break; |
|
713 |
case ENUM_CONSTANTS: |
|
714 |
if (link) { |
|
715 |
addContentToList(listContents, links.createLink(SectionName.ENUM_CONSTANT_DETAIL, contents.navEnum)); |
|
716 |
} else { |
|
717 |
addContentToList(listContents, contents.navEnum); |
|
718 |
} |
|
719 |
break; |
|
720 |
case FIELDS: |
|
721 |
if (link) { |
|
722 |
addContentToList(listContents, links.createLink(SectionName.FIELD_DETAIL, contents.navField)); |
|
723 |
} else { |
|
724 |
addContentToList(listContents, contents.navField); |
|
725 |
} |
|
726 |
break; |
|
727 |
case METHODS: |
|
728 |
if (link) { |
|
729 |
addContentToList(listContents, links.createLink(SectionName.METHOD_DETAIL, contents.navMethod)); |
|
730 |
} else { |
|
731 |
addContentToList(listContents, contents.navMethod); |
|
732 |
} |
|
733 |
break; |
|
734 |
case PROPERTIES: |
|
735 |
if (link) { |
|
736 |
addContentToList(listContents, links.createLink(SectionName.PROPERTY_DETAIL, contents.navProperty)); |
|
737 |
} else { |
|
738 |
addContentToList(listContents, contents.navProperty); |
|
739 |
} |
|
740 |
break; |
|
741 |
default: |
|
742 |
break; |
|
743 |
} |
|
744 |
} |
|
745 |
||
746 |
/** |
|
747 |
* Add the navigation Annotation Type detail link. |
|
748 |
* |
|
749 |
* @param listContents the list of contents to which the annotation detail will be added. |
|
750 |
*/ |
|
751 |
protected void addAnnotationTypeDetailLink(List<Content> listContents) { |
|
752 |
TypeElement annotationType = (TypeElement) element; |
|
753 |
AbstractMemberWriter writerField |
|
754 |
= ((AbstractMemberWriter) memberSummaryBuilder. |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
755 |
getMemberSummaryWriter(ANNOTATION_TYPE_FIELDS)); |
49551 | 756 |
AbstractMemberWriter writerOptional |
757 |
= ((AbstractMemberWriter) memberSummaryBuilder. |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
758 |
getMemberSummaryWriter(ANNOTATION_TYPE_MEMBER_OPTIONAL)); |
49551 | 759 |
AbstractMemberWriter writerRequired |
760 |
= ((AbstractMemberWriter) memberSummaryBuilder. |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
761 |
getMemberSummaryWriter(ANNOTATION_TYPE_MEMBER_REQUIRED)); |
49551 | 762 |
if (writerField != null) { |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
763 |
addAnnotationTypeDetailLink(ANNOTATION_TYPE_FIELDS, |
49551 | 764 |
!configuration.utils.getAnnotationFields(annotationType).isEmpty(), |
765 |
listContents); |
|
766 |
} else { |
|
767 |
addContentToList(listContents, contents.navField); |
|
768 |
} |
|
769 |
if (writerOptional != null) { |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
770 |
addAnnotationTypeDetailLink(ANNOTATION_TYPE_MEMBER_OPTIONAL, |
49551 | 771 |
!annotationType.getAnnotationMirrors().isEmpty(), listContents); |
772 |
} else if (writerRequired != null) { |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
773 |
addAnnotationTypeDetailLink(ANNOTATION_TYPE_MEMBER_REQUIRED, |
49551 | 774 |
!annotationType.getAnnotationMirrors().isEmpty(), listContents); |
775 |
} else { |
|
776 |
addContentToList(listContents, contents.navAnnotationTypeMember); |
|
777 |
} |
|
778 |
} |
|
779 |
||
780 |
/** |
|
781 |
* Add the navigation Annotation Type detail link. |
|
782 |
* |
|
783 |
* @param type the kind of member being documented |
|
784 |
* @param link true if the member details need to be linked |
|
785 |
* @param listContents the list of contents to which the annotation detail will be added. |
|
786 |
*/ |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
49551
diff
changeset
|
787 |
protected void addAnnotationTypeDetailLink(VisibleMemberTable.Kind type, boolean link, List<Content> listContents) { |
49551 | 788 |
switch (type) { |
789 |
case ANNOTATION_TYPE_FIELDS: |
|
790 |
if (link) { |
|
791 |
addContentToList(listContents, links.createLink(SectionName.ANNOTATION_TYPE_FIELD_DETAIL, |
|
792 |
contents.navField)); |
|
793 |
} else { |
|
794 |
addContentToList(listContents, contents.navField); |
|
795 |
} |
|
796 |
break; |
|
797 |
case ANNOTATION_TYPE_MEMBER_REQUIRED: |
|
798 |
case ANNOTATION_TYPE_MEMBER_OPTIONAL: |
|
799 |
if (link) { |
|
800 |
addContentToList(listContents, links.createLink(SectionName.ANNOTATION_TYPE_ELEMENT_DETAIL, |
|
801 |
contents.navAnnotationTypeMember)); |
|
802 |
} else { |
|
803 |
addContentToList(listContents, contents.navAnnotationTypeMember); |
|
804 |
} |
|
805 |
break; |
|
806 |
default: |
|
807 |
break; |
|
808 |
} |
|
809 |
} |
|
810 |
||
811 |
private void addContentToList(List<Content> listContents, Content tree) { |
|
812 |
listContents.add(HtmlTree.LI(tree)); |
|
813 |
} |
|
814 |
||
815 |
private void addContentToTree(Content tree, Content content) { |
|
816 |
tree.addContent(HtmlTree.LI(content)); |
|
817 |
} |
|
818 |
||
819 |
private void addListToNav(List<Content> listContents, Content tree) { |
|
820 |
int count = 0; |
|
821 |
for (Content liContent : listContents) { |
|
822 |
if (count < listContents.size() - 1) { |
|
823 |
liContent.addContent(Contents.SPACE); |
|
824 |
liContent.addContent("|"); |
|
825 |
liContent.addContent(Contents.SPACE); |
|
826 |
} |
|
827 |
tree.addContent(liContent); |
|
828 |
count++; |
|
829 |
} |
|
830 |
} |
|
831 |
||
832 |
private void addActivePageLink(Content tree, Content label, boolean display) { |
|
833 |
if (display) { |
|
834 |
tree.addContent(HtmlTree.LI(HtmlStyle.navBarCell1Rev, label)); |
|
835 |
} |
|
836 |
} |
|
837 |
||
838 |
private void addPageLabel(Content tree, Content label, boolean display) { |
|
839 |
if (display) { |
|
840 |
tree.addContent(HtmlTree.LI(label)); |
|
841 |
} |
|
842 |
} |
|
843 |
||
844 |
private void addOverviewLink(Content tree) { |
|
845 |
if (configuration.createoverview) { |
|
846 |
tree.addContent(HtmlTree.LI(links.createLink(pathToRoot.resolve(DocPaths.overviewSummary(configuration.frames)), |
|
847 |
contents.overviewLabel, "", ""))); |
|
848 |
} |
|
849 |
} |
|
850 |
||
851 |
private void addModuleLink(Content tree) { |
|
852 |
if (configuration.showModules) { |
|
853 |
if (configuration.modules.size() == 1) { |
|
854 |
ModuleElement mdle = configuration.modules.first(); |
|
855 |
boolean included = configuration.utils.isIncluded(mdle); |
|
856 |
tree.addContent(HtmlTree.LI((included) |
|
857 |
? links.createLink(pathToRoot.resolve(configuration.docPaths.moduleSummary(mdle)), contents.moduleLabel, "", "") |
|
858 |
: contents.moduleLabel)); |
|
859 |
} else if (!configuration.modules.isEmpty()) { |
|
860 |
addPageLabel(tree, contents.moduleLabel, true); |
|
861 |
} |
|
862 |
} |
|
863 |
} |
|
864 |
||
865 |
private void addModuleOfElementLink(Content tree) { |
|
866 |
if (configuration.showModules) { |
|
867 |
tree.addContent(HtmlTree.LI(navLinkModule)); |
|
868 |
} |
|
869 |
} |
|
870 |
||
871 |
private void addPackageLink(Content tree) { |
|
872 |
if (configuration.packages.size() == 1) { |
|
873 |
PackageElement packageElement = configuration.packages.first(); |
|
874 |
boolean included = packageElement != null && configuration.utils.isIncluded(packageElement); |
|
875 |
if (!included) { |
|
876 |
for (PackageElement p : configuration.packages) { |
|
877 |
if (p.equals(packageElement)) { |
|
878 |
included = true; |
|
879 |
break; |
|
880 |
} |
|
881 |
} |
|
882 |
} |
|
883 |
if (included || packageElement == null) { |
|
884 |
tree.addContent(HtmlTree.LI(links.createLink( |
|
885 |
pathToRoot.resolve(configuration.docPaths.forPackage(packageElement).resolve(DocPaths.PACKAGE_SUMMARY)), |
|
886 |
contents.packageLabel))); |
|
887 |
} else { |
|
888 |
DocLink crossPkgLink = configuration.extern.getExternalLink( |
|
889 |
configuration.utils.getPackageName(packageElement), pathToRoot, |
|
890 |
DocPaths.PACKAGE_SUMMARY.getPath()); |
|
891 |
if (crossPkgLink != null) { |
|
892 |
tree.addContent(HtmlTree.LI(links.createLink(crossPkgLink, contents.packageLabel))); |
|
893 |
} else { |
|
894 |
tree.addContent(HtmlTree.LI(contents.packageLabel)); |
|
895 |
} |
|
896 |
} |
|
897 |
} else if (!configuration.packages.isEmpty()) { |
|
898 |
addPageLabel(tree, contents.packageLabel, true); |
|
899 |
} |
|
900 |
} |
|
901 |
||
902 |
private void addPackageOfElementLink(Content tree) { |
|
903 |
tree.addContent(HtmlTree.LI(links.createLink(DocPath.parent.resolve(DocPaths.PACKAGE_SUMMARY), |
|
904 |
contents.packageLabel))); |
|
905 |
} |
|
906 |
||
907 |
private void addPackageSummaryLink(Content tree) { |
|
908 |
tree.addContent(HtmlTree.LI(links.createLink(DocPaths.PACKAGE_SUMMARY, contents.packageLabel))); |
|
909 |
} |
|
910 |
||
911 |
private void addTreeLink(Content tree) { |
|
912 |
if (configuration.createtree) { |
|
913 |
List<PackageElement> packages = new ArrayList<>(configuration.getSpecifiedPackageElements()); |
|
914 |
DocPath docPath = packages.size() == 1 && configuration.getSpecifiedTypeElements().isEmpty() |
|
915 |
? pathToRoot.resolve(configuration.docPaths.forPackage(packages.get(0)).resolve(DocPaths.PACKAGE_TREE)) |
|
916 |
: pathToRoot.resolve(DocPaths.OVERVIEW_TREE); |
|
917 |
tree.addContent(HtmlTree.LI(links.createLink(docPath, contents.treeLabel, "", ""))); |
|
918 |
} |
|
919 |
} |
|
920 |
||
921 |
private void addDeprecatedLink(Content tree) { |
|
922 |
if (!(configuration.nodeprecated || configuration.nodeprecatedlist)) { |
|
923 |
tree.addContent(HtmlTree.LI(links.createLink(pathToRoot.resolve(DocPaths.DEPRECATED_LIST), |
|
924 |
contents.deprecatedLabel, "", ""))); |
|
925 |
} |
|
926 |
} |
|
927 |
||
928 |
private void addIndexLink(Content tree) { |
|
929 |
if (configuration.createindex) { |
|
930 |
tree.addContent(HtmlTree.LI(links.createLink(pathToRoot.resolve( |
|
931 |
(configuration.splitindex |
|
932 |
? DocPaths.INDEX_FILES.resolve(DocPaths.indexN(1)) |
|
933 |
: DocPaths.INDEX_ALL)), |
|
934 |
contents.indexLabel, "", ""))); |
|
935 |
} |
|
936 |
} |
|
937 |
||
938 |
private void addHelpLink(Content tree) { |
|
939 |
if (!configuration.nohelp) { |
|
940 |
String helpfile = configuration.helpfile; |
|
941 |
DocPath helpfilenm; |
|
942 |
if (helpfile.isEmpty()) { |
|
943 |
helpfilenm = DocPaths.HELP_DOC; |
|
944 |
} else { |
|
945 |
DocFile file = DocFile.createFileForInput(configuration, helpfile); |
|
946 |
helpfilenm = DocPath.create(file.getName()); |
|
947 |
} |
|
948 |
tree.addContent(HtmlTree.LI(links.createLink(pathToRoot.resolve(helpfilenm), |
|
949 |
contents.helpLabel, "", ""))); |
|
950 |
} |
|
951 |
} |
|
952 |
||
953 |
/** |
|
954 |
* Add "FRAMES" link, to switch to the frame version of the output. |
|
955 |
* |
|
956 |
* @param tree the content tree to which the link will be added |
|
957 |
*/ |
|
958 |
private void addNavShowLists(Content tree) { |
|
959 |
DocLink dl = new DocLink(pathToRoot.resolve(DocPaths.INDEX), path.getPath(), null); |
|
960 |
Content framesContent = links.createLink(dl, contents.framesLabel, "", "_top"); |
|
961 |
tree.addContent(HtmlTree.LI(framesContent)); |
|
962 |
} |
|
963 |
||
964 |
/** |
|
965 |
* Add "NO FRAMES" link, to switch to the non-frame version of the output. |
|
966 |
* |
|
967 |
* @param tree the content tree to which the link will be added |
|
968 |
*/ |
|
969 |
private void addNavHideLists(Content tree) { |
|
970 |
Content noFramesContent = links.createLink(path.basename(), contents.noFramesLabel, "", "_top"); |
|
971 |
tree.addContent(HtmlTree.LI(noFramesContent)); |
|
972 |
} |
|
973 |
||
974 |
private void addNavLinkClassIndex(Content tree) { |
|
975 |
Content allClassesContent = links.createLink(pathToRoot.resolve( |
|
976 |
DocPaths.AllClasses(configuration.frames)), |
|
977 |
contents.allClassesLabel, "", ""); |
|
978 |
tree.addContent(HtmlTree.LI(allClassesContent)); |
|
979 |
} |
|
980 |
||
981 |
private void addSearch(Content tree) { |
|
982 |
String searchValueId = "search"; |
|
983 |
String reset = "reset"; |
|
984 |
HtmlTree inputText = HtmlTree.INPUT("text", searchValueId, searchValueId); |
|
985 |
HtmlTree inputReset = HtmlTree.INPUT(reset, reset, reset); |
|
986 |
HtmlTree liInput = HtmlTree.LI(HtmlTree.LABEL(searchValueId, searchLabel)); |
|
987 |
liInput.addContent(inputText); |
|
988 |
liInput.addContent(inputReset); |
|
989 |
HtmlTree ulSearch = HtmlTree.UL(HtmlStyle.navListSearch, liInput); |
|
990 |
tree.addContent(ulSearch); |
|
991 |
} |
|
992 |
||
993 |
private void addAllClassesLinkScript(Content tree, boolean top) { |
|
994 |
Content div = HtmlTree.DIV(top |
|
995 |
? Position.TOP.allClassesLinkScript().asContent() |
|
996 |
: Position.BOTTOM.allClassesLinkScript().asContent()); |
|
997 |
Content div_noscript = HtmlTree.DIV(contents.noScriptMessage); |
|
998 |
Content noScript = HtmlTree.NOSCRIPT(div_noscript); |
|
999 |
div.addContent(noScript); |
|
1000 |
tree.addContent(div); |
|
1001 |
} |
|
1002 |
||
1003 |
private void addFixedNavScript(Content tree) { |
|
1004 |
tree.addContent(FIXED_NAV_SCRIPT.asContent()); |
|
1005 |
} |
|
1006 |
||
1007 |
/** |
|
1008 |
* Get the navigation content. |
|
1009 |
* |
|
1010 |
* @param top true if the top navigation bar is to be printed |
|
1011 |
* @return the navigation contents |
|
1012 |
*/ |
|
1013 |
public Content getContent(boolean top) { |
|
1014 |
Content contentTree = new ContentBuilder(); |
|
1015 |
if (!configuration.nonavbar) { |
|
1016 |
Deque<Content> queue; |
|
1017 |
Content tree = (configuration.htmlVersion == HtmlVersion.HTML5) |
|
1018 |
? HtmlTree.NAV() |
|
1019 |
: contentTree; |
|
1020 |
HtmlTree navDiv = new HtmlTree(HtmlTag.DIV); |
|
1021 |
if (top) { |
|
1022 |
queue = topBottomNavContents.get(Position.TOP); |
|
1023 |
fixedNavDiv.addContent(Position.TOP.startOfNav()); |
|
1024 |
navDiv.setStyle(HtmlStyle.topNav); |
|
1025 |
} else { |
|
1026 |
queue = topBottomNavContents.get(Position.BOTTOM); |
|
1027 |
tree.addContent(Position.BOTTOM.startOfNav()); |
|
1028 |
navDiv.setStyle(HtmlStyle.bottomNav); |
|
1029 |
} |
|
1030 |
navDiv.addContent(queue.poll()); |
|
1031 |
HtmlTree skipLinkDiv = HtmlTree.DIV(HtmlStyle.skipNav, queue.poll()); |
|
1032 |
navDiv.addContent(skipLinkDiv); |
|
1033 |
navDiv.addContent(queue.poll()); |
|
1034 |
HtmlTree navList = new HtmlTree(HtmlTag.UL); |
|
1035 |
navList.setStyle(HtmlStyle.navList); |
|
1036 |
navList.addAttr(HtmlAttr.TITLE, rowListTitle); |
|
1037 |
fixedNavDiv.setStyle(HtmlStyle.fixedNav); |
|
1038 |
addMainNavLinks(navList); |
|
1039 |
navDiv.addContent(navList); |
|
1040 |
Content aboutDiv = HtmlTree.DIV(HtmlStyle.aboutLanguage, top ? userHeader : userFooter); |
|
1041 |
navDiv.addContent(aboutDiv); |
|
1042 |
if (top) { |
|
1043 |
fixedNavDiv.addContent(navDiv); |
|
1044 |
} else { |
|
1045 |
tree.addContent(navDiv); |
|
1046 |
} |
|
1047 |
HtmlTree subDiv = new HtmlTree(HtmlTag.DIV); |
|
1048 |
subDiv.setStyle(HtmlStyle.subNav); |
|
1049 |
HtmlTree ulFrames = new HtmlTree(HtmlTag.UL); |
|
1050 |
ulFrames.setStyle(HtmlStyle.navList); |
|
1051 |
if (!configuration.nonavbar) { |
|
1052 |
if (configuration.frames) { |
|
1053 |
addNavShowLists(ulFrames); |
|
1054 |
addNavHideLists(ulFrames); |
|
1055 |
} |
|
1056 |
} |
|
1057 |
subDiv.addContent(ulFrames); |
|
1058 |
HtmlTree ulAllClasses = new HtmlTree(HtmlTag.UL); |
|
1059 |
ulAllClasses.setStyle(HtmlStyle.navList); |
|
1060 |
ulAllClasses.addAttr(HtmlAttr.ID, top |
|
1061 |
? Position.TOP.allClassesLinkId() |
|
1062 |
: Position.BOTTOM.allClassesLinkId()); |
|
1063 |
addNavLinkClassIndex(ulAllClasses); |
|
1064 |
subDiv.addContent(ulAllClasses); |
|
1065 |
if (top && configuration.createindex) { |
|
1066 |
addSearch(subDiv); |
|
1067 |
} |
|
1068 |
addAllClassesLinkScript(subDiv, top); |
|
1069 |
HtmlTree div = new HtmlTree(HtmlTag.DIV); |
|
1070 |
// Add the summary links if present. |
|
1071 |
HtmlTree ulNavSummary = new HtmlTree(HtmlTag.UL); |
|
1072 |
ulNavSummary.setStyle(HtmlStyle.subNavList); |
|
1073 |
addSummaryLinks(ulNavSummary); |
|
1074 |
div.addContent(ulNavSummary); |
|
1075 |
// Add the detail links if present. |
|
1076 |
HtmlTree ulNavDetail = new HtmlTree(HtmlTag.UL); |
|
1077 |
ulNavDetail.setStyle(HtmlStyle.subNavList); |
|
1078 |
addDetailLinks(ulNavDetail); |
|
1079 |
div.addContent(ulNavDetail); |
|
1080 |
subDiv.addContent(div); |
|
1081 |
subDiv.addContent(queue.poll()); |
|
1082 |
if (top) { |
|
1083 |
fixedNavDiv.addContent(subDiv); |
|
1084 |
fixedNavDiv.addContent(Position.TOP.endOfNav()); |
|
1085 |
tree.addContent(fixedNavDiv); |
|
1086 |
HtmlTree paddingDiv = HtmlTree.DIV(HtmlStyle.navPadding, Contents.SPACE); |
|
1087 |
tree.addContent(paddingDiv); |
|
1088 |
addFixedNavScript(tree); |
|
1089 |
} else { |
|
1090 |
tree.addContent(subDiv); |
|
1091 |
tree.addContent(Position.BOTTOM.endOfNav()); |
|
1092 |
} |
|
1093 |
return tree; |
|
1094 |
} |
|
1095 |
return contentTree; |
|
1096 |
} |
|
1097 |
} |