1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
|
/*
* Copyright (c) 2003, 2025, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* @test
* @bug 7025314 8023700 7198273 8025633 8026567 8081854 8196027 8182765
* 8196200 8196202 8223378 8258659 8261976 8320458 8329537 8350638
* 8342705
* @summary Make sure the Next/Prev Class links iterate through all types.
* Make sure the navagation is 2 columns, not 3.
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build toolbox.ToolBox javadoc.tester.* builder.ClassBuilder
* @run main TestNavigation
*/
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import javadoc.tester.JavadocTester;
import builder.ClassBuilder;
import toolbox.ToolBox;
public class TestNavigation extends JavadocTester {
public final ToolBox tb;
public static void main(String... args) throws Exception {
var tester = new TestNavigation();
tester.runTests();
}
public TestNavigation() {
tb = new ToolBox();
}
@Test
public void testOverview(Path base) {
javadoc("-d", base.resolve("api").toString(),
"-overview", testSrc("overview.html"),
"-sourcepath", testSrc,
"pkg");
checkExit(Exit.OK);
checkSubNav();
checkOutput("index.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li class="nav-bar-cell1-rev">Overview</li>
<li><a href="pkg/package-tree.html">Tree</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="search.html">Search</a></li>
<li><a href="help-doc.html#overview">Help</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="re\
source-files/sun.svg" alt="Select Theme" class="theme-light"><img src="resource-files/moo\
n.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""");
checkOutput("pkg/package-summary.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li class="nav-bar-cell1-rev">Package</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../search.html">Search</a></li>
<li><a href="../help-doc.html#package">Help</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="..\
/resource-files/sun.svg" alt="Select Theme" class="theme-light"><img src="../resource-fil\
es/moon.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""");
checkOutput("pkg/A.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../search.html">Search</a></li>
<li><a href="../help-doc.html#class">Help</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="..\
/resource-files/sun.svg" alt="Select Theme" class="theme-light"><img src="../resource-fil\
es/moon.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""");
checkOutput("pkg/C.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../search.html">Search</a></li>
<li><a href="../help-doc.html#class">Help</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="..\
/resource-files/sun.svg" alt="Select Theme" class="theme-light"><img src="../resource-fil\
es/moon.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""");
checkOutput("pkg/E.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../search.html">Search</a></li>
<li><a href="../help-doc.html#class">Help</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="..\
/resource-files/sun.svg" alt="Select Theme" class="theme-light"><img src="../resource-fil\
es/moon.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""");
checkOutput("pkg/I.html", true,
// Test for 4664607
"""
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
""",
"""
<li><a href="../index.html">Overview</a></li>""");
}
@Test
public void testNavLinks(Path base) throws IOException {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package pkg1; public class A {
/**
* Class with members.
*/
public static class X {
/**
* A ctor
*/
public X() {
}
/**
* A field
*/
public int field;
/**
* A method
*/
public void method() {
}
/**
* An inner class
*/
public static class IC {
}
}
/**
* Class with all inherited members.
*/
public static class Y extends X {
}
}""");
tb.writeJavaFiles(src,
"package pkg1; public class C {\n"
+ "}");
tb.writeJavaFiles(src,
"""
package pkg1; public interface InterfaceWithNoMembers {
}""");
javadoc("-d", base.resolve("api").toString(),
"-sourcepath", src.toString(),
"pkg1");
checkExit(Exit.OK);
checkOrder("pkg1/A.X.html",
"""
<ol class="sub-nav-list">
<li><a href="package-summary.html">pkg1</a></li>
<li><a href="A.html">A</a></li>
<li><a href="A.X.html" class="current-selection">X</a></li>
</ol>""",
"""
<ol class="toc-list" tabindex="-1">
<li><a href="#" tabindex="0">Description</a></li>
<li><a href="#nested-class-summary" tabindex="0">Nested Class Summary</a></li>
<li><a href="#field-summary" tabindex="0">Field Summary</a></li>
<li><a href="#constructor-summary" tabindex="0">Constructor Summary</a></li>
<li><a href="#method-summary" tabindex="0">Method Summary</a></li>
<li><a href="#field-detail" tabindex="0">Field Details</a>
<ol class="toc-list">
<li><a href="#field" tabindex="0">field</a></li>
</ol>
</li>
<li><a href="#constructor-detail" tabindex="0">Constructor Details</a>
<ol class="toc-list">
<li><a href="#%3Cinit%3E()" tabindex="0">X()</a></li>
</ol>
</li>
<li><a href="#method-detail" tabindex="0">Method Details</a>
<ol class="toc-list">
<li><a href="#method()" tabindex="0">method()</a></li>
</ol>
</li>
</ol>""");
checkOrder("pkg1/A.Y.html",
"""
<ol class="sub-nav-list">
<li><a href="package-summary.html">pkg1</a></li>
<li><a href="A.html">A</a></li>
<li><a href="A.Y.html" class="current-selection">Y</a></li>
</ol>""",
"""
<ol class="toc-list" tabindex="-1">
<li><a href="#" tabindex="0">Description</a></li>
<li><a href="#nested-class-summary" tabindex="0">Nested Class Summary</a></li>
<li><a href="#field-summary" tabindex="0">Field Summary</a></li>
<li><a href="#constructor-summary" tabindex="0">Constructor Summary</a></li>
<li><a href="#method-summary" tabindex="0">Method Summary</a></li>
<li><a href="#constructor-detail" tabindex="0">Constructor Details</a>
<ol class="toc-list">
<li><a href="#%3Cinit%3E()" tabindex="0">Y()</a></li>
</ol>
</li>
</ol>""");
checkOrder("pkg1/A.X.IC.html",
"""
<ol class="sub-nav-list">
<li><a href="package-summary.html">pkg1</a></li>
<li><a href="A.html">A</a></li>
<li><a href="A.X.html">X</a></li>
<li><a href="A.X.IC.html" class="current-selection">IC</a></li>
</ol>""",
"""
<ol class="toc-list" tabindex="-1">
<li><a href="#" tabindex="0">Description</a></li>
<li><a href="#constructor-summary" tabindex="0">Constructor Summary</a></li>
<li><a href="#method-summary" tabindex="0">Method Summary</a></li>
<li><a href="#constructor-detail" tabindex="0">Constructor Details</a>
<ol class="toc-list">
<li><a href="#%3Cinit%3E()" tabindex="0">IC()</a></li>
</ol>
</li>
</ol>""");
checkOrder("pkg1/C.html",
"""
<ol class="toc-list" tabindex="-1">
<li><a href="#" tabindex="0">Description</a></li>
<li><a href="#constructor-summary" tabindex="0">Constructor Summary</a></li>
<li><a href="#method-summary" tabindex="0">Method Summary</a></li>
<li><a href="#constructor-detail" tabindex="0">Constructor Details</a>
<ol class="toc-list">
<li><a href="#%3Cinit%3E()" tabindex="0">C()</a></li>
</ol>
</li>
</ol>""");
checkOrder("pkg1/InterfaceWithNoMembers.html",
"""
<ol class="toc-list" tabindex="-1">
<li><a href="#" tabindex="0">Description</a></li>
</ol>""");
}
private void checkSubNav() {
checkOutput("pkg/A.html", false,
"All Classes",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");""",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");""");
checkOutput("pkg/C.html", false,
"All Classes",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");""",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");""");
checkOutput("pkg/E.html", false,
"All Classes",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");""",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");""");
checkOutput("pkg/I.html", false,
"All Classes",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");""",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");""");
checkOutput("pkg/package-summary.html", false,
"All Classes",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");""",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");""");
}
@Test
public void testSinglePackage(Path base) {
javadoc("-d", base.resolve("api").toString(),
"-sourcepath", testSrc,
"pkg");
checkExit(Exit.OK);
checkSubNav();
checkOutput("index.html", true,
"""
<meta http-equiv="Refresh" content="0;pkg/package-summary.html">""",
"""
<p><a href="pkg/package-summary.html">pkg/package-summary.html</a></p>""");
checkOutput("pkg/package-summary.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li class="nav-bar-cell1-rev">Package</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../search.html">Search</a></li>
<li><a href="../help-doc.html#package">Help</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="..\
/resource-files/sun.svg" alt="Select Theme" class="theme-light"><img src="../resource-fil\
es/moon.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""");
checkOutput("pkg/A.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../search.html">Search</a></li>
<li><a href="../help-doc.html#class">Help</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="..\
/resource-files/sun.svg" alt="Select Theme" class="theme-light"><img src="../resource-fil\
es/moon.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""");
checkOutput("pkg/C.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../search.html">Search</a></li>
<li><a href="../help-doc.html#class">Help</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="..\
/resource-files/sun.svg" alt="Select Theme" class="theme-light"><img src="../resource-fil\
es/moon.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""");
checkOutput("pkg/E.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../search.html">Search</a></li>
<li><a href="../help-doc.html#class">Help</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="..\
/resource-files/sun.svg" alt="Select Theme" class="theme-light"><img src="../resource-fil\
es/moon.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""");
checkOutput("pkg/I.html", true,
// Test for 4664607
"""
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
""",
"""
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>""");
}
@Test
public void testUnnamedPackage(Path base) throws Exception {
Path src = Files.createDirectories(base.resolve("src"));
new ClassBuilder(tb, "C")
.setModifiers("public", "class")
.write(src);
javadoc("-d", base.resolve("api").toString(),
src.resolve("C.java").toString());
checkExit(Exit.OK);
checkOutput("index.html", true,
"""
<script type="text/javascript">window.location.replace('package-summary.html')</script>
<noscript>
<meta http-equiv="Refresh" content="0;package-summary.html">
</noscript>""");
checkOutput("package-summary.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li class="nav-bar-cell1-rev">Package</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="search.html">Search</a></li>
<li><a href="help-doc.html#package">Help</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="re\
source-files/sun.svg" alt="Select Theme" class="theme-light"><img src="resource-files/moo\
n.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""",
"""
<ol class="sub-nav-list">
<li><a href="package-summary.html" class="current-selection">Unnamed Package</a></li>
</ol>""");
checkOutput("C.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="search.html">Search</a></li>
<li><a href="help-doc.html#class">Help</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="re\
source-files/sun.svg" alt="Select Theme" class="theme-light"><img src="resource-files/moo\
n.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""",
"""
<ol class="sub-nav-list">
<li><a href="package-summary.html">Unnamed Package</a></li>
<li><a href="C.html" class="current-selection">C</a></li>
</ol>""");
}
}
|
