8223378: CSS solution for navbar problem with <a> elements is not ideal
Reviewed-by: jjg
/*
* Copyright (c) 2003, 2019, 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 4131628 4664607 7025314 8023700 7198273 8025633 8026567 8081854 8150188 8151743 8196027 8182765
* 8196200 8196202 8223378
* @summary Make sure the Next/Prev Class links iterate through all types.
* Make sure the navagation is 2 columns, not 3.
* @author jamieh
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build toolbox.ToolBox javadoc.tester.*
* @run main TestNavigation
*/
import java.io.IOException;
import java.nio.file.Path;
import java.nio.file.Paths;
import javadoc.tester.JavadocTester;
import toolbox.ToolBox;
public class TestNavigation extends JavadocTester {
public final ToolBox tb;
public static void main(String... args) throws Exception {
TestNavigation tester = new TestNavigation();
tester.runTests(m -> new Object[] { Paths.get(m.getName()) });
}
public TestNavigation() {
tb = new ToolBox();
}
@Test
public void test(Path ignore) {
javadoc("-d", "out",
"-overview", testSrc("overview.html"),
"-sourcepath", testSrc,
"pkg");
checkExit(Exit.OK);
checkSubNav();
checkOutput("pkg/A.html", true,
"<ul class=\"navList\" title=\"Navigation\">\n" +
"<li><a href=\"../index.html\">Overview</a></li>");
checkOutput("pkg/C.html", true,
"<ul class=\"navList\" title=\"Navigation\">\n" +
"<li><a href=\"../index.html\">Overview</a></li>");
checkOutput("pkg/E.html", true,
"<ul class=\"navList\" title=\"Navigation\">\n" +
"<li><a href=\"../index.html\">Overview</a></li>");
checkOutput("pkg/I.html", true,
// Test for 4664607
"<div class=\"skipNav\"><a href=\"#skip.navbar.top\" title=\"Skip navigation links\">Skip navigation links</a></div>\n"
+ "<a id=\"navbar.top.firstrow\">\n"
+ "<!-- -->\n"
+ "</a>",
"<li><a href=\"../index.html\">Overview</a></li>");
// Remaining tests check for additional padding to offset the fixed navigation bar.
checkOutput("pkg/A.html", true,
"<!-- ========= END OF TOP NAVBAR ========= -->\n"
+ "<div class=\"skipNav\"><a id=\"skip.navbar.top\">\n"
+ "<!-- -->\n"
+ "</a></div>\n"
+ "</nav>\n"
+ "</header>\n"
+ "<div class=\"flexContent\">\n"
+ "<main role=\"main\">\n"
+ "<!-- ======== START OF CLASS DATA ======== -->");
checkOutput("pkg/package-summary.html", true,
"<!-- ========= END OF TOP NAVBAR ========= -->\n"
+ "<div class=\"skipNav\"><a id=\"skip.navbar.top\">\n"
+ "<!-- -->\n"
+ "</a></div>\n"
+ "</nav>\n"
+ "</header>\n"
+ "<div class=\"flexContent\">\n"
+ "<main role=\"main\">\n"
+ "<div class=\"header\">");
}
// Test for checking additional padding to offset the fixed navigation bar in HTML5.
@Test
public void test1(Path ignore) {
javadoc("-d", "out-1",
"-html5",
"-sourcepath", testSrc,
"pkg");
checkExit(Exit.OK);
checkSubNav();
checkOutput("pkg/A.html", true,
"<!-- ========= END OF TOP NAVBAR ========= -->\n"
+ "<div class=\"skipNav\"><a id=\"skip.navbar.top\">\n"
+ "<!-- -->\n"
+ "</a></div>\n"
+ "</nav>\n"
+ "</header>\n"
+ "<div class=\"flexContent\">\n"
+ "<main role=\"main\">\n"
+ "<!-- ======== START OF CLASS DATA ======== -->");
checkOutput("pkg/package-summary.html", true,
"<!-- ========= END OF TOP NAVBAR ========= -->\n"
+ "<div class=\"skipNav\"><a id=\"skip.navbar.top\">\n"
+ "<!-- -->\n"
+ "</a></div>\n"
+ "</nav>");
}
// Test to make sure that no extra padding for nav bar gets generated if -nonavbar is specified.
@Test
public void test2(Path ignore) {
javadoc("-d", "out-2",
"-nonavbar",
"-sourcepath", testSrc,
"pkg");
checkExit(Exit.OK);
checkSubNav();
checkOutput("pkg/A.html", false,
"<!-- ========= END OF TOP NAVBAR ========= -->\n"
+ "</div>\n"
+ "<div class=\"skipNav\"><a id=\"skip.navbar.top\">\n"
+ "<!-- -->\n"
+ "</a></div>\n"
+ "</nav>\n"
+ "</header>\n"
+ "<!-- ======== START OF CLASS DATA ======== -->");
checkOutput("pkg/package-summary.html", false,
"<!-- ========= END OF TOP NAVBAR ========= -->\n"
+ "</div>\n"
+ "<div class=\"skipNav\"><a id=\"skip.navbar.top\">\n"
+ "<!-- -->\n"
+ "</a></div>\n"
+ "</nav>");
}
@Test
public void test3(Path base) throws IOException {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"package pkg1; public class A {\n"
+ " /**\n"
+ " * Class with members.\n"
+ " */\n"
+ " public static class X {\n"
+ " /**\n"
+ " * A ctor\n"
+ " */\n"
+ " public X() {\n"
+ " }\n"
+ " /**\n"
+ " * A field\n"
+ " */\n"
+ " public int field;\n"
+ " /**\n"
+ " * A method\n"
+ " */\n"
+ " public void method() {\n"
+ " }\n"
+ " /**\n"
+ " * An inner class\n"
+ " */\n"
+ " public static class IC {\n"
+ " }\n"
+ " }\n"
+ " /**\n"
+ " * Class with all inherited members.\n"
+ " */\n"
+ " public static class Y extends X {\n"
+ " }\n"
+ "}");
tb.writeJavaFiles(src,
"package pkg1; public class C {\n"
+ "}");
tb.writeJavaFiles(src,
"package pkg1; public interface InterfaceWithNoMembers {\n"
+ "}");
javadoc("-d", "out-3",
"-sourcepath", src.toString(),
"pkg1");
checkExit(Exit.OK);
checkOrder("pkg1/A.X.html",
"Summary",
"<li><a href=\"#nested.class.summary\">Nested</a> | </li>",
"<li><a href=\"#field.summary\">Field</a> | </li>",
"<li><a href=\"#constructor.summary\">Constr</a> | </li>",
"<li><a href=\"#method.summary\">Method</a></li>");
checkOrder("pkg1/A.Y.html",
"Summary",
"<li><a href=\"#nested.class.summary\">Nested</a> | </li>",
"<li><a href=\"#field.summary\">Field</a> | </li>",
"<li><a href=\"#constructor.summary\">Constr</a> | </li>",
"<li><a href=\"#method.summary\">Method</a></li>");
checkOrder("pkg1/A.X.IC.html",
"Summary",
"<li>Nested | </li>",
"<li>Field | </li>",
"<li><a href=\"#constructor.summary\">Constr</a> | </li>",
"<li><a href=\"#method.summary\">Method</a></li>");
checkOrder("pkg1/C.html",
"Summary",
"<li>Nested | </li>",
"<li>Field | </li>",
"<li><a href=\"#constructor.summary\">Constr</a> | </li>",
"<li><a href=\"#method.summary\">Method</a></li>");
checkOrder("pkg1/InterfaceWithNoMembers.html",
"Summary",
"<li>Nested | </li>",
"<li>Field | </li>",
"<li>Constr | </li>",
"<li>Method</li>");
}
private void checkSubNav() {
checkOutput("pkg/A.html", false,
"All Classes",
"<script type=\"text/javascript\"><!--\n"
+ " allClassesLink = document.getElementById(\"allclasses_navbar_top\");",
"<script type=\"text/javascript\"><!--\n"
+ " allClassesLink = document.getElementById(\"allclasses_navbar_bottom\");");
checkOutput("pkg/C.html", false,
"All Classes",
"<script type=\"text/javascript\"><!--\n"
+ " allClassesLink = document.getElementById(\"allclasses_navbar_top\");",
"<script type=\"text/javascript\"><!--\n"
+ " allClassesLink = document.getElementById(\"allclasses_navbar_bottom\");");
checkOutput("pkg/E.html", false,
"All Classes",
"<script type=\"text/javascript\"><!--\n"
+ " allClassesLink = document.getElementById(\"allclasses_navbar_top\");",
"<script type=\"text/javascript\"><!--\n"
+ " allClassesLink = document.getElementById(\"allclasses_navbar_bottom\");");
checkOutput("pkg/I.html", false,
"All Classes",
"<script type=\"text/javascript\"><!--\n"
+ " allClassesLink = document.getElementById(\"allclasses_navbar_top\");",
"<script type=\"text/javascript\"><!--\n"
+ " allClassesLink = document.getElementById(\"allclasses_navbar_bottom\");");
checkOutput("pkg/package-summary.html", false,
"All Classes",
"<script type=\"text/javascript\"><!--\n"
+ " allClassesLink = document.getElementById(\"allclasses_navbar_top\");",
"<script type=\"text/javascript\"><!--\n"
+ " allClassesLink = document.getElementById(\"allclasses_navbar_bottom\");");
}
}