$$($1_SHORT_NAME) \
$$(DRAFT_MARKER_STR)
ifneq ($$($1_OTHER_VERSIONS), )
$1_JAVADOC_BOTTOM := $$(call JAVADOC_BOTTOM, Other versions.)
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java
index b6c56dd47b0..caeb6c35e6d 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2024, 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
@@ -220,6 +220,7 @@ public abstract class AbstractMemberWriter {
Content member = getMemberSummaryHeader(target);
summaryTreeList.forEach(member::add);
buildSummary(target, member);
+ writer.tableOfContents.addLink(HtmlIds.forMemberSummary(kind), getSummaryLabel());
}
}
@@ -306,6 +307,20 @@ public abstract class AbstractMemberWriter {
return out;
}
+ private Content getSummaryLabel() {
+ return switch (kind) {
+ case FIELDS -> contents.fieldSummaryLabel;
+ case METHODS -> contents.methodSummary;
+ case CONSTRUCTORS -> contents.constructorSummaryLabel;
+ case ENUM_CONSTANTS -> contents.enumConstantSummary;
+ case NESTED_CLASSES -> contents.nestedClassSummary;
+ case PROPERTIES -> contents.propertySummaryLabel;
+ case ANNOTATION_TYPE_MEMBER_OPTIONAL -> contents.annotateTypeOptionalMemberSummaryLabel;
+ case ANNOTATION_TYPE_MEMBER_REQUIRED -> contents.annotateTypeRequiredMemberSummaryLabel;
+ default -> throw new IllegalArgumentException(kind.toString());
+ };
+ }
+
/**
* Returns the member summary header for the given class.
*
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AnnotationTypeMemberWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AnnotationTypeMemberWriter.java
index d943a603958..6c0337513d0 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AnnotationTypeMemberWriter.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AnnotationTypeMemberWriter.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2003, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2024, 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
@@ -90,6 +90,8 @@ public class AnnotationTypeMemberWriter extends AbstractMemberWriter {
addAnnotationDetailsMarker(target);
Content annotationDetailsHeader = getAnnotationDetailsHeader();
Content memberList = getMemberList();
+ writer.tableOfContents.addLink(HtmlIds.ANNOTATION_TYPE_ELEMENT_DETAIL, contents.annotationTypeDetailsLabel);
+ writer.tableOfContents.pushNestedList();
for (Element member : members) {
currentMember = member;
@@ -98,9 +100,12 @@ public class AnnotationTypeMemberWriter extends AbstractMemberWriter {
buildAnnotationTypeMemberChildren(div);
annotationContent.add(div);
memberList.add(writer.getMemberListItem(annotationContent));
+ writer.tableOfContents.addLink(htmlIds.forMember(typeElement, (ExecutableElement) member),
+ Text.of(name(member)));
}
Content annotationDetails = getAnnotationDetails(annotationDetailsHeader, memberList);
target.add(annotationDetails);
+ writer.tableOfContents.popNestedList();
}
}
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ClassUseWriter.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ClassUseWriter.java
index 322659c6a46..e0b126dfacf 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ClassUseWriter.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ClassUseWriter.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1998, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2024, 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
@@ -34,6 +34,7 @@ import java.util.SortedSet;
import java.util.TreeSet;
import javax.lang.model.element.Element;
+import javax.lang.model.element.ModuleElement;
import javax.lang.model.element.PackageElement;
import javax.lang.model.element.TypeElement;
import javax.tools.Diagnostic;
@@ -42,6 +43,7 @@ import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.TagName;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
+import jdk.javadoc.internal.doclets.formats.html.markup.Text;
import jdk.javadoc.internal.doclets.formats.html.Navigation.PageMode;
import jdk.javadoc.internal.doclets.toolkit.DocletException;
import jdk.javadoc.internal.doclets.toolkit.util.ClassTree;
@@ -418,14 +420,19 @@ public class ClassUseWriter extends SubWriterHolderWriter {
@Override
protected Navigation getNavBar(PageMode pageMode, Element element) {
- Content mdleLinkContent = getModuleLink(utils.elementUtils.getModuleOf(typeElement),
- contents.moduleLabel);
- Content classLinkContent = getLink(new HtmlLinkInfo(
- configuration, HtmlLinkInfo.Kind.PLAIN, typeElement)
- .label(resources.getText("doclet.Class"))
- .skipPreview(true));
- return super.getNavBar(pageMode, element)
- .setNavLinkModule(mdleLinkContent)
- .setNavLinkClass(classLinkContent);
+ List} element that contains a
- * header that is always visible, and main content that
- * can be scrolled if necessary.
+ * header that is always visible, main content that
+ * can be scrolled if necessary, and optional side and footer
+ * contents that are only rendered if available.
*/
public class BodyContents extends Content {
private final List mainContents = new ArrayList<>();
+ private Content side = null;
private Content header = null;
private Content footer = null;
@@ -51,6 +53,11 @@ public class BodyContents extends Content {
return this;
}
+ public BodyContents setSideContent(Content side) {
+ this.side = Objects.requireNonNull(side);
+ return this;
+ }
+
public BodyContents setHeader(Content header) {
this.header = Objects.requireNonNull(header);
return this;
@@ -89,7 +96,10 @@ public class BodyContents extends Content {
return new ContentBuilder()
.add(header)
- .add(HtmlTree.MAIN().add(mainContents))
- .add(footer == null ? Text.EMPTY : footer);
+ .add(HtmlTree.DIV(HtmlStyle.mainGrid)
+ .add(side == null ? Text.EMPTY : side)
+ .add(HtmlTree.MAIN()
+ .add(mainContents)
+ .add(footer == null ? Text.EMPTY : footer)));
}
}
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Entity.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Entity.java
index 50ee53a2c75..c96063d703f 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Entity.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Entity.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2019, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2019, 2024, 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
@@ -38,6 +38,8 @@ public class Entity extends Content {
public static final Entity GREATER_THAN = new Entity(">");
public static final Entity AMPERSAND = new Entity("&");
public static final Entity NO_BREAK_SPACE = new Entity(" ");
+ public static final Entity LEFT_POINTING_ANGLE = new Entity("❮");
+ public static final Entity RIGHT_POINTING_ANGLE = new Entity("❯");
public final String text;
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Head.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Head.java
index 2935cbf8616..77d09c7226e 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Head.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Head.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2003, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2024, 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
@@ -351,7 +351,7 @@ public class Head extends Content {
if (index) {
if (pathToRoot != null && mainBodyScript != null) {
String ptrPath = pathToRoot.isEmpty() ? "." : pathToRoot.getPath();
- mainBodyScript.append("var pathtoroot = ")
+ mainBodyScript.append("const pathtoroot = ")
.appendStringLiteral(ptrPath + "/")
.append(";\n")
.append("loadScripts(document, 'script');");
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlAttr.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlAttr.java
index 0379d7ada61..8fe06640907 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlAttr.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlAttr.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2010, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2010, 2024, 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
@@ -38,6 +38,8 @@ public enum HtmlAttr {
ARIA_LABELLEDBY("aria-labelledby"),
ARIA_ORIENTATION("aria-orientation"),
ARIA_SELECTED("aria-selected"),
+ AUTOCOMPLETE,
+ AUTOCAPITALIZE,
CHECKED,
CLASS,
CLEAR,
@@ -91,6 +93,23 @@ public enum HtmlAttr {
}
}
+ public enum InputType {
+
+ CHECKBOX,
+ RESET,
+ TEXT;
+
+ private final String type;
+
+ InputType() {
+ type = Utils.toLowerCase(name());
+ }
+
+ public String toString() {
+ return type;
+ }
+ }
+
HtmlAttr() {
this.value = Utils.toLowerCase(name());
}
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java
index c6e1263d665..35a52b0c05d 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2010, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2010, 2024, 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
@@ -54,7 +54,13 @@ public enum HtmlStyle {
//
//
// The following constants are used for the main navigation bar that appears in the
- // {@code header} and {@code footer} elements on each page.
+ // {@code header} element on each page, as well as the side navigation bar that displays
+ // the table of contents on some pages.
+
+ /**
+ * The class for the link representing the current element in breadcrumb navigation and table of contents.
+ */
+ currentSelection,
/**
* The class for the overall {@code div} element containing the {@code header} element for the page.
@@ -67,6 +73,21 @@ public enum HtmlStyle {
*/
aboutLanguage,
+ /**
+ * The class for the {@code input} element to filter items in the table of contents.
+ */
+ filterInput,
+
+ /**
+ * The class for the {@code button} element to hide the sidebar.
+ */
+ hideSidebar,
+
+ /**
+ * The class for the {@code div} element containing the sidebar and main content.
+ */
+ mainGrid,
+
/**
* The class for the highlighted item in the list of navigation links, indicating
* the current page.
@@ -79,6 +100,16 @@ public enum HtmlStyle {
*/
navBarToggleIcon,
+ /**
+ * The class for the {@code div} element containing navigation elements.
+ */
+ navContent,
+
+ /**
+ * The class for the {@code div} element containing the button to show or hide the menu.
+ */
+ navMenuButton,
+
/**
* The class for the primary list of navigation links.
*/
@@ -89,6 +120,16 @@ public enum HtmlStyle {
*/
navListSearch,
+ /**
+ * The class for the reset button in the sidebar filter input element.
+ */
+ resetFilter,
+
+ /**
+ * The class for the {@code button} element to show the sidebar.
+ */
+ showSidebar,
+
/**
* The class for a {@code div} element containing a link to skip the navigation header.
* The element is typically invisible, but may be used when navigating the page
@@ -107,9 +148,19 @@ public enum HtmlStyle {
subNavList,
/**
- * The class for the list of subsidiary navigation links for smaller displays.
+ * The class for a {@code nav} element containing a table of contents.
*/
- subNavListSmall,
+ toc,
+
+ /**
+ * The class for the {@code div} element representing the header of the table of contents.
+ */
+ tocHeader,
+
+ /**
+ * The class used for list elements in the table of contents.
+ */
+ tocList,
//
@@ -124,21 +175,6 @@ public enum HtmlStyle {
*/
header,
- /**
- * The class for the "module" label in the heading for a package declaration.
- */
- moduleLabelInPackage,
-
- /**
- * The class for the "module" label in the heading for a type declaration.
- */
- moduleLabelInType,
-
- /**
- * The class for the "package" label in the heading for a type declaration.
- */
- packageLabelInType,
-
/**
* The class for the element containing the label and name for the module
* or package that precedes the main title for the declaration of a
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlTree.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlTree.java
index d296aa4c83b..0ec4033a929 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlTree.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlTree.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2010, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2010, 2024, 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
@@ -586,13 +586,26 @@ public class HtmlTree extends Content {
* @param id the id
* @return the element
*/
- public static HtmlTree INPUT(String type, HtmlId id) {
+ public static HtmlTree INPUT(HtmlAttr.InputType type, HtmlId id) {
return new HtmlTree(TagName.INPUT)
- .put(HtmlAttr.TYPE, type)
+ .put(HtmlAttr.TYPE, type.toString())
.setId(id)
.put(HtmlAttr.DISABLED, "");
}
+ /**
+ * Creates an HTML {@code INPUT} element with the given type
+ * and style. The element is marked as initially disabled.
+ * @param type the input type
+ * @param style the input style
+ * @return the element
+ */
+ public static HtmlTree INPUT(HtmlAttr.InputType type, HtmlStyle style) {
+ return new HtmlTree(TagName.INPUT)
+ .put(HtmlAttr.TYPE, type.toString())
+ .setStyle(style)
+ .put(HtmlAttr.DISABLED, "");
+ }
/**
* Creates an HTML {@code LABEL} element with the given content.
*
@@ -718,6 +731,17 @@ public class HtmlTree extends Content {
.add(body);
}
+ /**
+ * Creates an HTML {@code OL} element with the given style.
+ *
+ * @param style the style
+ * @return the element
+ */
+ public static HtmlTree OL(HtmlStyle style) {
+ return new HtmlTree(TagName.OL)
+ .setStyle(style);
+ }
+
/**
* Creates an HTML {@code P} element with some content.
*
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Links.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Links.java
index cfdc3cda5c6..a0bd0b3dd04 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Links.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Links.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1997, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1997, 2024, 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
@@ -53,7 +53,7 @@ public class Links {
* @param label the content for the link
* @return the link
*/
- public Content createLink(HtmlId id, Content label) {
+ public HtmlTree createLink(HtmlId id, Content label) {
DocLink l = DocLink.fragment(id.name());
return createLink(l, label, "");
}
@@ -67,7 +67,7 @@ public class Links {
* @param link whether to create a link or just return the label
* @return the link or just the label
*/
- public Content createLink(HtmlId id, Content label, boolean link) {
+ public Content createLinkOrLabel(HtmlId id, Content label, boolean link) {
return link ? createLink(id, label) : label;
}
@@ -80,7 +80,7 @@ public class Links {
*
* @return the link
*/
- public Content createLink(HtmlId id, Content label, String title) {
+ public HtmlTree createLink(HtmlId id, Content label, String title) {
DocLink l = DocLink.fragment(id.name());
return createLink(l, label, title);
}
@@ -92,7 +92,7 @@ public class Links {
* @param label the content for the link
* @return the link
*/
- public Content createLink(DocPath path, String label) {
+ public HtmlTree createLink(DocPath path, String label) {
return createLink(path, Text.of(label), null, "");
}
@@ -103,7 +103,7 @@ public class Links {
* @param label the content for the link
* @return the link
*/
- public Content createLink(DocPath path, Content label) {
+ public HtmlTree createLink(DocPath path, Content label) {
return createLink(path, label, "");
}
@@ -117,7 +117,7 @@ public class Links {
* @param title the title for the link
* @return the link
*/
- public Content createLink(DocPath path, Content label, HtmlStyle style, String title) {
+ public HtmlTree createLink(DocPath path, Content label, HtmlStyle style, String title) {
return createLink(new DocLink(path), label, style, title);
}
@@ -129,7 +129,7 @@ public class Links {
* @param title the title for the link
* @return the link
*/
- public Content createLink(DocPath path, Content label, String title) {
+ public HtmlTree createLink(DocPath path, Content label, String title) {
return createLink(new DocLink(path), label, title);
}
@@ -152,7 +152,7 @@ public class Links {
* @param title the title for the link
* @return the link
*/
- public Content createLink(DocLink link, Content label, String title) {
+ public HtmlTree createLink(DocLink link, Content label, String title) {
var anchor = HtmlTree.A(link.relativizeAgainst(file).toString(), label);
if (title != null && title.length() != 0) {
anchor.put(HtmlAttr.TITLE, title);
@@ -170,7 +170,7 @@ public class Links {
* @param title the title for the link
* @return the link
*/
- public Content createLink(DocLink link, Content label, HtmlStyle style,
+ public HtmlTree createLink(DocLink link, Content label, HtmlStyle style,
String title) {
return createLink(link, label, style, title, false);
}
@@ -186,7 +186,7 @@ public class Links {
* @param isExternal is the link external to the generated documentation
* @return the link
*/
- public Content createLink(DocLink link, Content label, HtmlStyle style,
+ public HtmlTree createLink(DocLink link, Content label, HtmlStyle style,
String title, boolean isExternal) {
var l = HtmlTree.A(link.relativizeAgainst(file).toString(), label);
if (style != null) {
@@ -209,7 +209,7 @@ public class Links {
* @param label the content for the link
* @return the link
*/
- public Content createExternalLink(DocLink link, Content label) {
+ public HtmlTree createExternalLink(DocLink link, Content label) {
return HtmlTree.A(link.relativizeAgainst(file).toString(), label)
.setStyle(HtmlStyle.externalLink);
}
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/ListBuilder.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/ListBuilder.java
new file mode 100644
index 00000000000..603e5717895
--- /dev/null
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/ListBuilder.java
@@ -0,0 +1,115 @@
+/*
+ * Copyright (c) 2024, 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. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * 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.
+ */
+
+package jdk.javadoc.internal.doclets.formats.html.markup;
+
+import java.io.IOException;
+import java.io.Writer;
+import java.util.ArrayDeque;
+import java.util.Deque;
+import java.util.NoSuchElementException;
+import java.util.Objects;
+
+import jdk.javadoc.internal.doclets.formats.html.Content;
+
+/**
+ * A utility class for building nested HTML lists. This class is implemented as a
+ * stack of nested list/item pairs where list items are added to the inner-most
+ * list and nested lists are added to the current list item of the inner-most list.
+ * Lists can be added to and removed from the stack using the {@link #pushNestedList}
+ * and {@link #popNestedList} methods.
+ */
+public class ListBuilder extends Content {
+
+ private final HtmlTree root;
+ private record Pair(HtmlTree list, HtmlTree item) {}
+ private final Deque stack = new ArrayDeque<>();
+ private HtmlTree currentList;
+ private HtmlTree currentItem;
+
+ /**
+ * Creates a new list builder.
+ *
+ * @param list the root list element
+ */
+ public ListBuilder(HtmlTree list) {
+ Objects.requireNonNull(list, "Root list element is required");
+ root = currentList = list;
+ }
+
+ /**
+ * Adds a new list item with the given content to the current list. The last added list item
+ * will also be used as container when pushing a new nested list.
+ *
+ * @param listItemContent the content for the new list item.
+ * @return this list builder
+ */
+ public ListBuilder add(Content listItemContent) {
+ currentItem = HtmlTree.LI(listItemContent);
+ currentList.addUnchecked(currentItem);
+ return this;
+ }
+
+ /**
+ * Adds a new nested list to the current list item and makes it the recipient for new list items.
+ * Note that the nested list is added even if empty; use {@code addNested} to avoid adding empty
+ * lists.
+ *
+ * @param list the nested list
+ * @return this list builder
+ */
+ public ListBuilder pushNestedList(HtmlTree list) {
+ Objects.requireNonNull(currentItem, "List item required for nested list");
+ stack.push(new Pair(currentList, currentItem));
+ currentList = list;
+ currentItem = null;
+ return this;
+ }
+
+ /**
+ * Pops the current list from the stack and returns to adding list items to the parent list.
+ *
+ * @return this list builder
+ * @throws NoSuchElementException if the stack is empty
+ */
+ public ListBuilder popNestedList() {
+ Pair pair = stack.pop();
+ // First restore currentItem and add nested list to it before restoring currentList to outer list.
+ currentItem = pair.item;
+ currentItem.add(currentList);
+ currentList = pair.list;
+ return this;
+ }
+
+ @Override
+ public boolean write(Writer writer, String newline, boolean atNewline) throws IOException {
+ return root.write(writer, newline, atNewline);
+ }
+
+ @Override
+ public boolean isEmpty() {
+ return root.isEmpty();
+ }
+}
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/TagName.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/TagName.java
index 18b4f71ad13..67635e18377 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/TagName.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/TagName.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2010, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2010, 2024, 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
@@ -35,6 +35,7 @@ import jdk.javadoc.internal.doclets.toolkit.util.Utils;
*/
public enum TagName {
A,
+ ASIDE,
BUTTON,
BLOCKQUOTE,
BODY,
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/script.js b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/script.js
deleted file mode 100644
index cd9ee635e04..00000000000
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/script.js
+++ /dev/null
@@ -1,236 +0,0 @@
-/*
- * Copyright (c) 2013, 2023, 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. Oracle designates this
- * particular file as subject to the "Classpath" exception as provided
- * by Oracle in the LICENSE file that accompanied this code.
- *
- * 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.
- */
-
-var moduleSearchIndex;
-var packageSearchIndex;
-var typeSearchIndex;
-var memberSearchIndex;
-var tagSearchIndex;
-
-var oddRowColor = "odd-row-color";
-var evenRowColor = "even-row-color";
-var sortAsc = "sort-asc";
-var sortDesc = "sort-desc";
-var tableTab = "table-tab";
-var activeTableTab = "active-table-tab";
-
-function loadScripts(doc, tag) {
- createElem(doc, tag, 'script-files/search.js');
-
- createElem(doc, tag, 'module-search-index.js');
- createElem(doc, tag, 'package-search-index.js');
- createElem(doc, tag, 'type-search-index.js');
- createElem(doc, tag, 'member-search-index.js');
- createElem(doc, tag, 'tag-search-index.js');
-}
-
-function createElem(doc, tag, path) {
- var script = doc.createElement(tag);
- var scriptElement = doc.getElementsByTagName(tag)[0];
- script.src = pathtoroot + path;
- scriptElement.parentNode.insertBefore(script, scriptElement);
-}
-
-// Helper for making content containing release names comparable lexicographically
-function makeComparable(s) {
- return s.toLowerCase().replace(/(\d+)/g,
- function(n, m) {
- return ("000" + m).slice(-4);
- });
-}
-
-// Switches between two styles depending on a condition
-function toggleStyle(classList, condition, trueStyle, falseStyle) {
- if (condition) {
- classList.remove(falseStyle);
- classList.add(trueStyle);
- } else {
- classList.remove(trueStyle);
- classList.add(falseStyle);
- }
-}
-
-// Sorts the rows in a table lexicographically by the content of a specific column
-function sortTable(header, columnIndex, columns) {
- var container = header.parentElement;
- var descending = header.classList.contains(sortAsc);
- container.querySelectorAll("div.table-header").forEach(
- function(header) {
- header.classList.remove(sortAsc);
- header.classList.remove(sortDesc);
- }
- )
- var cells = container.children;
- var rows = [];
- for (var i = columns; i < cells.length; i += columns) {
- rows.push(Array.prototype.slice.call(cells, i, i + columns));
- }
- var comparator = function(a, b) {
- var ka = makeComparable(a[columnIndex].textContent);
- var kb = makeComparable(b[columnIndex].textContent);
- if (ka < kb)
- return descending ? 1 : -1;
- if (ka > kb)
- return descending ? -1 : 1;
- return 0;
- };
- var sorted = rows.sort(comparator);
- var visible = 0;
- sorted.forEach(function(row) {
- if (row[0].style.display !== 'none') {
- var isEvenRow = visible++ % 2 === 0;
- }
- row.forEach(function(cell) {
- toggleStyle(cell.classList, isEvenRow, evenRowColor, oddRowColor);
- container.appendChild(cell);
- })
- });
- toggleStyle(header.classList, descending, sortDesc, sortAsc);
-}
-
-// Toggles the visibility of a table category in all tables in a page
-function toggleGlobal(checkbox, selected, columns) {
- var display = checkbox.checked ? '' : 'none';
- document.querySelectorAll("div.table-tabs").forEach(function(t) {
- var id = t.parentElement.getAttribute("id");
- var selectedClass = id + "-tab" + selected;
- // if selected is empty string it selects all uncategorized entries
- var selectUncategorized = !Boolean(selected);
- var visible = 0;
- document.querySelectorAll('div.' + id)
- .forEach(function(elem) {
- if (selectUncategorized) {
- if (elem.className.indexOf(selectedClass) === -1) {
- elem.style.display = display;
- }
- } else if (elem.classList.contains(selectedClass)) {
- elem.style.display = display;
- }
- if (elem.style.display === '') {
- var isEvenRow = visible++ % (columns * 2) < columns;
- toggleStyle(elem.classList, isEvenRow, evenRowColor, oddRowColor);
- }
- });
- var displaySection = visible === 0 ? 'none' : '';
- t.parentElement.style.display = displaySection;
- document.querySelector("li#contents-" + id).style.display = displaySection;
- })
-}
-
-// Shows the elements of a table belonging to a specific category
-function show(tableId, selected, columns) {
- if (tableId !== selected) {
- document.querySelectorAll('div.' + tableId + ':not(.' + selected + ')')
- .forEach(function(elem) {
- elem.style.display = 'none';
- });
- }
- document.querySelectorAll('div.' + selected)
- .forEach(function(elem, index) {
- elem.style.display = '';
- var isEvenRow = index % (columns * 2) < columns;
- toggleStyle(elem.classList, isEvenRow, evenRowColor, oddRowColor);
- });
- updateTabs(tableId, selected);
-}
-
-function updateTabs(tableId, selected) {
- document.querySelector('div#' + tableId +' .summary-table')
- .setAttribute('aria-labelledby', selected);
- document.querySelectorAll('button[id^="' + tableId + '"]')
- .forEach(function(tab, index) {
- if (selected === tab.id || (tableId === selected && index === 0)) {
- tab.className = activeTableTab;
- tab.setAttribute('aria-selected', true);
- tab.setAttribute('tabindex',0);
- } else {
- tab.className = tableTab;
- tab.setAttribute('aria-selected', false);
- tab.setAttribute('tabindex',-1);
- }
- });
-}
-
-function switchTab(e) {
- var selected = document.querySelector('[aria-selected=true]');
- if (selected) {
- if ((e.keyCode === 37 || e.keyCode === 38) && selected.previousSibling) {
- // left or up arrow key pressed: move focus to previous tab
- selected.previousSibling.click();
- selected.previousSibling.focus();
- e.preventDefault();
- } else if ((e.keyCode === 39 || e.keyCode === 40) && selected.nextSibling) {
- // right or down arrow key pressed: move focus to next tab
- selected.nextSibling.click();
- selected.nextSibling.focus();
- e.preventDefault();
- }
- }
-}
-
-var updateSearchResults = function() {};
-
-function indexFilesLoaded() {
- return moduleSearchIndex
- && packageSearchIndex
- && typeSearchIndex
- && memberSearchIndex
- && tagSearchIndex;
-}
-// Copy the contents of the local snippet to the clipboard
-function copySnippet(button) {
- copyToClipboard(button.nextElementSibling.innerText);
- switchCopyLabel(button, button.firstElementChild);
-}
-function copyToClipboard(content) {
- var textarea = document.createElement("textarea");
- textarea.style.height = 0;
- document.body.appendChild(textarea);
- textarea.value = content;
- textarea.select();
- document.execCommand("copy");
- document.body.removeChild(textarea);
-}
-function switchCopyLabel(button, span) {
- var copied = span.getAttribute("data-copied");
- button.classList.add("visible");
- var initialLabel = span.innerHTML;
- span.innerHTML = copied;
- setTimeout(function() {
- button.classList.remove("visible");
- setTimeout(function() {
- if (initialLabel !== copied) {
- span.innerHTML = initialLabel;
- }
- }, 100);
- }, 1900);
-}
-// Dynamically set scroll margin to accomodate for draft header
-document.addEventListener("DOMContentLoaded", function(e) {
- document.querySelectorAll(':not(input)[id]').forEach(
- function(c) {
- c.style["scroll-margin-top"] = Math.ceil(document.querySelector("header").offsetHeight) + "px"
- });
-});
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/script.js.template b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/script.js.template
new file mode 100644
index 00000000000..b0ba71ab71f
--- /dev/null
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/script.js.template
@@ -0,0 +1,481 @@
+/*
+ * Copyright (c) 2013, 2024, 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. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * 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.
+ */
+
+var moduleSearchIndex;
+var packageSearchIndex;
+var typeSearchIndex;
+var memberSearchIndex;
+var tagSearchIndex;
+
+var oddRowColor = "odd-row-color";
+var evenRowColor = "even-row-color";
+var sortAsc = "sort-asc";
+var sortDesc = "sort-desc";
+var tableTab = "table-tab";
+var activeTableTab = "active-table-tab";
+
+const linkIcon = "##REPLACE:doclet.Link_icon##";
+const linkToSection = "##REPLACE:doclet.Link_to_section##";
+
+function loadScripts(doc, tag) {
+ createElem(doc, tag, 'script-files/search.js');
+
+ createElem(doc, tag, 'module-search-index.js');
+ createElem(doc, tag, 'package-search-index.js');
+ createElem(doc, tag, 'type-search-index.js');
+ createElem(doc, tag, 'member-search-index.js');
+ createElem(doc, tag, 'tag-search-index.js');
+}
+
+function createElem(doc, tag, path) {
+ var script = doc.createElement(tag);
+ var scriptElement = doc.getElementsByTagName(tag)[0];
+ script.src = pathtoroot + path;
+ scriptElement.parentNode.insertBefore(script, scriptElement);
+}
+
+// Helper for making content containing release names comparable lexicographically
+function makeComparable(s) {
+ return s.toLowerCase().replace(/(\d+)/g,
+ function(n, m) {
+ return ("000" + m).slice(-4);
+ });
+}
+
+// Switches between two styles depending on a condition
+function toggleStyle(classList, condition, trueStyle, falseStyle) {
+ if (condition) {
+ classList.remove(falseStyle);
+ classList.add(trueStyle);
+ } else {
+ classList.remove(trueStyle);
+ classList.add(falseStyle);
+ }
+}
+
+// Sorts the rows in a table lexicographically by the content of a specific column
+function sortTable(header, columnIndex, columns) {
+ var container = header.parentElement;
+ var descending = header.classList.contains(sortAsc);
+ container.querySelectorAll("div.table-header").forEach(
+ function(header) {
+ header.classList.remove(sortAsc);
+ header.classList.remove(sortDesc);
+ }
+ )
+ var cells = container.children;
+ var rows = [];
+ for (var i = columns; i < cells.length; i += columns) {
+ rows.push(Array.prototype.slice.call(cells, i, i + columns));
+ }
+ var comparator = function(a, b) {
+ var ka = makeComparable(a[columnIndex].textContent);
+ var kb = makeComparable(b[columnIndex].textContent);
+ if (ka < kb)
+ return descending ? 1 : -1;
+ if (ka > kb)
+ return descending ? -1 : 1;
+ return 0;
+ };
+ var sorted = rows.sort(comparator);
+ var visible = 0;
+ sorted.forEach(function(row) {
+ if (row[0].style.display !== 'none') {
+ var isEvenRow = visible++ % 2 === 0;
+ }
+ row.forEach(function(cell) {
+ toggleStyle(cell.classList, isEvenRow, evenRowColor, oddRowColor);
+ container.appendChild(cell);
+ })
+ });
+ toggleStyle(header.classList, descending, sortDesc, sortAsc);
+}
+
+// Toggles the visibility of a table category in all tables in a page
+function toggleGlobal(checkbox, selected, columns) {
+ var display = checkbox.checked ? '' : 'none';
+ document.querySelectorAll("div.table-tabs").forEach(function(t) {
+ var id = t.parentElement.getAttribute("id");
+ var selectedClass = id + "-tab" + selected;
+ // if selected is empty string it selects all uncategorized entries
+ var selectUncategorized = !Boolean(selected);
+ var visible = 0;
+ document.querySelectorAll('div.' + id)
+ .forEach(function(elem) {
+ if (selectUncategorized) {
+ if (elem.className.indexOf(selectedClass) === -1) {
+ elem.style.display = display;
+ }
+ } else if (elem.classList.contains(selectedClass)) {
+ elem.style.display = display;
+ }
+ if (elem.style.display === '') {
+ var isEvenRow = visible++ % (columns * 2) < columns;
+ toggleStyle(elem.classList, isEvenRow, evenRowColor, oddRowColor);
+ }
+ });
+ var displaySection = visible === 0 ? 'none' : '';
+ t.parentElement.style.display = displaySection;
+ document.querySelector("li#contents-" + id).style.display = displaySection;
+ })
+}
+
+// Shows the elements of a table belonging to a specific category
+function show(tableId, selected, columns) {
+ if (tableId !== selected) {
+ document.querySelectorAll('div.' + tableId + ':not(.' + selected + ')')
+ .forEach(function(elem) {
+ elem.style.display = 'none';
+ });
+ }
+ document.querySelectorAll('div.' + selected)
+ .forEach(function(elem, index) {
+ elem.style.display = '';
+ var isEvenRow = index % (columns * 2) < columns;
+ toggleStyle(elem.classList, isEvenRow, evenRowColor, oddRowColor);
+ });
+ updateTabs(tableId, selected);
+}
+
+function updateTabs(tableId, selected) {
+ document.querySelector('div#' + tableId +' .summary-table')
+ .setAttribute('aria-labelledby', selected);
+ document.querySelectorAll('button[id^="' + tableId + '"]')
+ .forEach(function(tab, index) {
+ if (selected === tab.id || (tableId === selected && index === 0)) {
+ tab.className = activeTableTab;
+ tab.setAttribute('aria-selected', true);
+ tab.setAttribute('tabindex',0);
+ } else {
+ tab.className = tableTab;
+ tab.setAttribute('aria-selected', false);
+ tab.setAttribute('tabindex',-1);
+ }
+ });
+}
+
+function switchTab(e) {
+ var selected = document.querySelector('[aria-selected=true]');
+ if (selected) {
+ if ((e.keyCode === 37 || e.keyCode === 38) && selected.previousSibling) {
+ // left or up arrow key pressed: move focus to previous tab
+ selected.previousSibling.click();
+ selected.previousSibling.focus();
+ e.preventDefault();
+ } else if ((e.keyCode === 39 || e.keyCode === 40) && selected.nextSibling) {
+ // right or down arrow key pressed: move focus to next tab
+ selected.nextSibling.click();
+ selected.nextSibling.focus();
+ e.preventDefault();
+ }
+ }
+}
+
+var updateSearchResults = function() {};
+
+function indexFilesLoaded() {
+ return moduleSearchIndex
+ && packageSearchIndex
+ && typeSearchIndex
+ && memberSearchIndex
+ && tagSearchIndex;
+}
+// Copy the contents of the local snippet to the clipboard
+function copySnippet(button) {
+ copyToClipboard(button.nextElementSibling.innerText);
+ switchCopyLabel(button, button.firstElementChild);
+}
+function copyToClipboard(content) {
+ var textarea = document.createElement("textarea");
+ textarea.style.height = 0;
+ document.body.appendChild(textarea);
+ textarea.value = content;
+ textarea.select();
+ document.execCommand("copy");
+ document.body.removeChild(textarea);
+}
+function switchCopyLabel(button, span) {
+ var copied = span.getAttribute("data-copied");
+ button.classList.add("visible");
+ var initialLabel = span.innerHTML;
+ span.innerHTML = copied;
+ setTimeout(function() {
+ button.classList.remove("visible");
+ setTimeout(function() {
+ if (initialLabel !== copied) {
+ span.innerHTML = initialLabel;
+ }
+ }, 100);
+ }, 1900);
+}
+function setTopMargin() {
+ // Dynamically set scroll margin to accomodate for draft header
+ var headerHeight = Math.ceil(document.querySelector("header").offsetHeight);
+ document.querySelector(":root")
+ .style.setProperty("--nav-height", headerHeight + "px");
+}
+document.addEventListener("readystatechange", (e) => {
+ if (document.readyState === "interactive") {
+ setTopMargin();
+ }
+ if (sessionStorage.getItem("sidebar") === "hidden") {
+ const sidebar = document.querySelector(".main-grid nav.toc");
+ if (sidebar) sidebar.classList.add("hide-sidebar");
+ }
+});
+document.addEventListener("DOMContentLoaded", function(e) {
+ setTopMargin();
+ // Make sure current element is visible in breadcrumb navigation on small displays
+ const subnav = document.querySelector("ol.sub-nav-list");
+ if (subnav && subnav.lastElementChild) {
+ subnav.lastElementChild.scrollIntoView({ behavior: "instant", inline: "start", block: "nearest" });
+ }
+ // Clone TOC sidebar to header for mobile navigation
+ const navbar = document.querySelector("div#navbar-top");
+ const sidebar = document.querySelector(".main-grid nav.toc");
+ const main = document.querySelector(".main-grid main");
+ const mainnav = navbar.querySelector("ul.nav-list");
+ const toggleButton = document.querySelector("button#navbar-toggle-button");
+ const toc = sidebar ? sidebar.cloneNode(true) : null;
+ if (toc) {
+ navbar.appendChild(toc);
+ }
+ document.querySelectorAll("input.filter-input").forEach(function(input) {
+ input.removeAttribute("disabled");
+ input.value = "";
+ input.addEventListener("input", function(e) {
+ const pattern = input.value ? input.value.trim()
+ .replace(/[\[\]{}()*+?.\\^$|]/g, '\\$&')
+ .replace(/\s+/g, ".*") : "";
+ input.nextElementSibling.style.display = pattern ? "inline" : "none";
+ const filter = new RegExp(pattern, "i");
+ input.parentNode.parentNode.querySelectorAll("ol.toc-list li").forEach((li) => {
+ if (filter.test(li.innerText)) {
+ li.removeAttribute("style");
+ } else {
+ li.style.display = "none";
+ }
+ });
+ if (expanded) {
+ expand();
+ }
+ });
+ });
+ document.querySelectorAll("input.reset-filter").forEach((button) => {
+ button.removeAttribute("disabled");
+ button.addEventListener("click", (e) => {
+ const input = button.previousElementSibling;
+ input.value = "";
+ input.dispatchEvent(new InputEvent("input"));
+ input.focus();
+ if (expanded) {
+ expand();
+ } else {
+ prevHash = null;
+ handleScroll();
+ }
+ })
+ });
+ var expanded = false;
+ var windowWidth;
+ function collapse() {
+ if (expanded) {
+ mainnav.removeAttribute("style");
+ if (toc) {
+ toc.removeAttribute("style");
+ }
+ toggleButton.classList.remove("expanded")
+ toggleButton.setAttribute("aria-expanded", "false");
+ expanded = false;
+ }
+ }
+ function expand() {
+ expanded = true;
+ mainnav.style.display = "block";
+ mainnav.style.removeProperty("height");
+ var maxHeight = window.innerHeight - subnav.offsetTop + 4;
+ var expandedHeight = Math.min(maxHeight, mainnav.scrollHeight + 10);
+ if (toc) {
+ toc.style.display = "flex";
+ expandedHeight = Math.min(maxHeight,
+ Math.max(expandedHeight, toc.querySelector("div.toc-header").offsetHeight
+ + toc.querySelector("ol.toc-list").scrollHeight + 10));
+ toc.style.height = expandedHeight + "px";
+ }
+ mainnav.style.height = expandedHeight + "px";
+ toggleButton.classList.add("expanded");
+ toggleButton.setAttribute("aria-expanded", "true");
+ windowWidth = window.innerWidth;
+ }
+ toggleButton.addEventListener("click", (e) => {
+ if (expanded) {
+ collapse();
+ } else {
+ expand();
+ }
+ });
+ if (toc) {
+ toc.querySelectorAll("a").forEach((link) => {
+ link.addEventListener("click", collapse);
+ });
+ }
+ document.addEventListener('keydown', (e) => {
+ if (e.key === "Escape") collapse();
+ });
+ document.querySelector("main").addEventListener("click", collapse);
+ const searchInput = document.getElementById("search-input");
+ if (searchInput) searchInput.addEventListener("focus", collapse);
+ document.querySelectorAll("h1, h2, h3, h4, h5, h6")
+ .forEach((hdr, idx) => {
+ // Create anchor links for headers with an associated id attribute
+ var id = hdr.getAttribute("id") || hdr.parentElement.getAttribute("id")
+ || (hdr.querySelector("a") && hdr.querySelector("a").getAttribute("id"));
+ if (id) {
+ var template = document.createElement('template');
+ template.innerHTML =" ![" + linkIcon +"](" + pathtoroot + "resource-files/link.svg)
";
+ hdr.append(...template.content.childNodes);
+ }
+ });
+ var sections;
+ var scrollTimeout;
+ var scrollTimeoutNeeded;
+ var prevHash;
+ function initSectionData() {
+ sections = [{ id: "", top: 0 }].concat(Array.from(main.querySelectorAll("section[id], h2[id], h2 a[id], div[id]"))
+ .filter((e) => {
+ return sidebar.querySelector("a[href=\"#" + encodeURI(e.getAttribute("id")) + "\"]") !== null
+ }).map((e) => {
+ return {
+ id: e.getAttribute("id"),
+ top: e.offsetTop
+ };
+ }));
+ }
+ function setScrollTimeout() {
+ clearTimeout(scrollTimeout);
+ scrollTimeoutNeeded = false;
+ scrollTimeout = setTimeout(() => {
+ scrollTimeout = null;
+ handleScroll();
+ }, 50);
+ }
+ function handleScroll() {
+ if (!sidebar || !sidebar.offsetParent || sidebar.classList.contains("hide-sidebar")) {
+ return;
+ }
+ if (scrollTimeout || scrollTimeoutNeeded) {
+ setScrollTimeout();
+ return;
+ }
+ var scrollTop = document.documentElement.scrollTop;
+ var scrollHeight = document.documentElement.scrollHeight;
+ var currHash = null;
+ if (scrollHeight - scrollTop < window.innerHeight + 10) {
+ // Select last item if at bottom of the page
+ currHash = "#" + encodeURI(sections.at(-1).id);
+ } else {
+ for (var i = 0; i < sections.length; i++) {
+ var top = sections[i].top;
+ var bottom = sections[i + 1] ? sections[i + 1].top : scrollHeight;
+ if (top + ((bottom - top) / 2) > scrollTop || bottom > scrollTop + (window.innerHeight / 3)) {
+ currHash = "#" + encodeURI(sections[i].id);
+ break;
+ }
+ }
+ }
+ if (currHash !== prevHash) {
+ setSelected(currHash);
+ }
+ }
+ function setSelected(hash) {
+ var prev = sidebar.querySelector("a.current-selection");
+ if (prev)
+ prev.classList.remove("current-selection");
+ prevHash = hash;
+ if (hash) {
+ var curr = sidebar.querySelector("ol.toc-list a[href=\"" + hash + "\"]");
+ if (curr) {
+ curr.classList.add("current-selection");
+ curr.scrollIntoView({ behavior: "instant", block: "nearest" });
+ }
+ }
+ }
+ if (sidebar) {
+ initSectionData();
+ document.querySelectorAll("a[href^='#']").forEach((link) => {
+ link.addEventListener("click", (e) => {
+ scrollTimeoutNeeded = true;
+ setSelected(link.getAttribute("href"));
+ })
+ });
+ sidebar.querySelector("button.hide-sidebar").addEventListener("click", () => {
+ sidebar.classList.add("hide-sidebar");
+ sessionStorage.setItem("sidebar", "hidden");
+ });
+ sidebar.querySelector("button.show-sidebar").addEventListener("click", () => {
+ sidebar.classList.remove("hide-sidebar");
+ sessionStorage.removeItem("sidebar");
+ initSectionData();
+ handleScroll();
+ });
+ window.addEventListener("hashchange", (e) => {
+ scrollTimeoutNeeded = true;
+ });
+ if (document.location.hash) {
+ scrollTimeoutNeeded = true;
+ setSelected(document.location.hash);
+ } else {
+ handleScroll();
+ }
+ window.addEventListener("scroll", handleScroll);
+ window.addEventListener("scrollend", () => {
+ if (scrollTimeout) {
+ clearTimeout(scrollTimeout);
+ scrollTimeout = null;
+ handleScroll();
+ }
+ })
+ }
+ // Resize handler
+ function handleResize(e) {
+ if (expanded) {
+ if (windowWidth != window.innerWidth) {
+ collapse();
+ } else {
+ expand();
+ }
+ }
+ if (sections) {
+ initSectionData();
+ prevHash = null;
+ handleScroll();
+ }
+ setTopMargin();
+ }
+ window.addEventListener("orientationchange", handleResize);
+ window.addEventListener("resize", handleResize);
+});
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/search.js.template b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/search.js.template
index f98a2faf035..c864787bf2f 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/search.js.template
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/search.js.template
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2015, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2024, 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
@@ -31,8 +31,6 @@ const messages = {
loading: "##REPLACE:doclet.search.loading##",
searching: "##REPLACE:doclet.search.searching##",
redirecting: "##REPLACE:doclet.search.redirecting##",
- linkIcon: "##REPLACE:doclet.Link_icon##",
- linkToSection: "##REPLACE:doclet.Link_to_section##"
}
const categories = {
modules: "##REPLACE:doclet.search.modules##",
@@ -255,9 +253,6 @@ function rateNoise(str) {
function doSearch(request, response) {
var term = request.term.trim();
var maxResults = request.maxResults || MAX_RESULTS;
- if (term.length === 0) {
- return this.close();
- }
var matcher = {
plainMatcher: createMatcher(term, false),
camelCaseMatcher: createMatcher(term, true)
@@ -407,52 +402,18 @@ $.widget("custom.catcomplete", $.ui.autocomplete, {
}
});
$(function() {
- var expanded = false;
- var windowWidth;
- function collapse() {
- if (expanded) {
- $("div#navbar-top").removeAttr("style");
- $("button#navbar-toggle-button")
- .removeClass("expanded")
- .attr("aria-expanded", "false");
- expanded = false;
- }
- }
- $("button#navbar-toggle-button").click(function (e) {
- if (expanded) {
- collapse();
- } else {
- var navbar = $("div#navbar-top");
- navbar.height(navbar.prop("scrollHeight"));
- $("button#navbar-toggle-button")
- .addClass("expanded")
- .attr("aria-expanded", "true");
- expanded = true;
- windowWidth = window.innerWidth;
- }
- });
- $("ul.sub-nav-list-small li a").click(collapse);
- $("input#search-input").focus(collapse);
- $("main").click(collapse);
- $("section[id] > :header, :header[id], :header:has(a[id])").each(function(idx, el) {
- // Create anchor links for headers with an associated id attribute
- var hdr = $(el);
- var id = hdr.attr("id") || hdr.parent("section").attr("id") || hdr.children("a").attr("id");
- if (id) {
- hdr.append(" ");
- }
- });
- $(window).on("orientationchange", collapse).on("resize", function(e) {
- if (expanded && windowWidth !== window.innerWidth) collapse();
- });
var search = $("#search-input");
- var reset = $("#reset-button");
+ var reset = $("#reset-search");
search.catcomplete({
minLength: 1,
delay: 200,
- source: doSearch,
+ source: function(request, response) {
+ reset.css("display", "inline");
+ if (request.term.trim() === "") {
+ return this.close();
+ }
+ return doSearch(request, response);
+ },
response: function(event, ui) {
if (!ui.content.length) {
ui.content.push({ l: messages.noResult });
@@ -460,6 +421,12 @@ $(function() {
$("#search-input").empty();
}
},
+ close: function(event, ui) {
+ reset.css("display", search.val() ? "inline" : "none");
+ },
+ change: function(event, ui) {
+ reset.css("display", search.val() ? "inline" : "none");
+ },
autoFocus: true,
focus: function(event, ui) {
return false;
@@ -480,6 +447,7 @@ $(function() {
reset.prop("disabled", false);
reset.click(function() {
search.val('').focus();
+ reset.css("display", "none");
});
search.focus();
});
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/stylesheet.css b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/stylesheet.css
index 46c39a0918b..ab9201fbc86 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/stylesheet.css
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/stylesheet.css
@@ -15,7 +15,11 @@
--code-font-family: 'DejaVu Sans Mono', monospace;
/* Base font sizes for body and code elements */
--body-font-size: 14px;
+ --block-font-size: 14px;
--code-font-size: 14px;
+ --nav-font-size: 13.2px;
+ /* Line height for continuous text blocks */
+ --block-line-height: 1.4em;
/* Text colors for body and block elements */
--body-text-color: #353833;
--block-text-color: #474747;
@@ -59,6 +63,11 @@
/* Colors for invalid tag notifications */
--invalid-tag-background-color: #ffe6e6;
--invalid-tag-text-color: #000000;
+ /* Navigation bar dimensions */
+ --top-nav-height: 44px;
+ --sub-nav-height: 34px;
+ --nav-height: calc(var(--top-nav-height) + var(--sub-nav-height));
+ scroll-behavior: smooth;
}
/*
* Styles for individual HTML elements.
@@ -76,28 +85,20 @@ body {
height:100%;
width:100%;
}
-iframe {
- margin:0;
- padding:0;
- height:100%;
- width:100%;
- overflow-y:scroll;
- border:none;
-}
-:not(input)[id] {
- scroll-margin-top: 78px;
+main [id] {
+ scroll-margin-top: calc(var(--nav-height) + 6px);
}
a:link, a:visited {
text-decoration:none;
color:var(--link-color);
}
-a[href]:hover, a[href]:focus {
+a[href]:hover, a[href]:active {
text-decoration:none;
color:var(--link-color-active);
}
pre {
font-family:var(--code-font-family);
- font-size:1em;
+ font-size:var(--code-font-size);
}
h1 {
font-size:1.428em;
@@ -130,8 +131,6 @@ code, tt {
:not(h1, h2, h3, h4, h5, h6) > code,
:not(h1, h2, h3, h4, h5, h6) > tt {
font-size:var(--code-font-size);
- padding-top:4px;
- margin-top:8px;
line-height:1.4em;
}
dt code {
@@ -152,6 +151,9 @@ button {
font-family: var(--body-font-family);
font-size: 1em;
}
+hr {
+ border-color: #aaa;
+}
/*
* Styles for HTML generated by javadoc.
*
@@ -162,14 +164,14 @@ button {
* Styles for document title and copyright.
*/
.about-language {
- float:right;
- padding:0 21px 8px 8px;
+ flex: 0 0 auto;
+ padding:0 20px;
+ margin:0;
font-size:0.915em;
- margin-top:-9px;
- height:2.9em;
+ max-width: 50%;
+ white-space: nowrap;
}
.legal-copy {
- margin-left:.5em;
}
/*
* Styles for navigation bar.
@@ -178,83 +180,102 @@ button {
header {
position:sticky;
top:0;
- z-index:1;
+ z-index:2;
background: var(--body-background-color);
}
}
+.nav-content {
+ display:flex;
+ flex-direction: row;
+ align-items: center;
+ width: 100%;
+ height: 100%;
+}
.top-nav {
background-color:var(--navbar-background-color);
color:var(--navbar-text-color);
- float:left;
width:100%;
- clear:right;
- min-height:2.8em;
- padding:10px 0 0 0;
- overflow:hidden;
+ height:var(--top-nav-height);
+ overflow:visible;
font-size:0.857em;
+ position:relative;
+}
+.top-nav nav.toc {
+ display: none;
+ flex-direction: column;
+}
+.top-nav nav.toc button.show-sidebar,
+.top-nav nav.toc button.hide-sidebar {
+ display: none;
}
button#navbar-toggle-button {
display:none;
}
-ul.sub-nav-list-small {
- display: none;
-}
-.sub-nav {
- background-color:var(--subnav-background-color);
- float:left;
- width:100%;
- overflow:hidden;
- font-size:0.857em;
-}
-.sub-nav div {
- clear:left;
- float:left;
- padding:6px;
- text-transform:uppercase;
-}
-.sub-nav .sub-nav-list {
- padding-top:4px;
-}
ul.nav-list {
- display:block;
- margin:0 25px 0 0;
- padding:0;
-}
-ul.sub-nav-list {
- float:left;
- margin:0 25px 0 0;
- padding:0;
+ display:inline-flex;
+ margin:0;
+ padding-left:4px;
+ flex: 1 1 auto;
+ white-space: nowrap;
}
ul.nav-list li {
list-style:none;
- float:left;
padding: 5px 6px;
text-transform:uppercase;
+ height: 1.2em;
+}
+div.sub-nav {
+ background-color:var(--subnav-background-color);
+ width:100%;
+ overflow:hidden;
+ font-size:var(--nav-font-size);
+ height: var(--sub-nav-height);
+}
+ol.sub-nav-list {
+ flex: 1 1 90%;
+ line-height: 1.8em;
+ display: inline-flex;
+ overflow: auto;
+ scroll-snap-type: x mandatory;
+ scroll-padding-left: 13px;
+ scrollbar-width: none;
+ padding-left:6px;
+ white-space: nowrap;
+ margin:0;
+}
+ol.sub-nav-list::-webkit-scrollbar {
+ display: none;
+}
+ol.sub-nav-list li {
+ list-style:none;
+ scroll-snap-align: start;
+}
+ol.sub-nav-list a {
+ padding: 3px;
+}
+ol.sub-nav-list a.current-selection {
+ background-color: var(--section-background-color);
+ border-radius: 4px;
}
.sub-nav .nav-list-search {
- float:right;
+ flex: 1 1 10%;
margin:0;
padding:6px;
- clear:none;
- text-align:right;
position:relative;
+ white-space: nowrap;
}
-ul.sub-nav-list li {
- list-style:none;
- float:left;
-}
-.top-nav a:link, .top-nav a:active, .top-nav a:visited {
+.top-nav .nav-list a:link, .top-nav .nav-list a:active, .top-nav .nav-list a:visited {
color:var(--navbar-text-color);
text-decoration:none;
text-transform:uppercase;
}
-.top-nav a:hover {
+.top-nav .nav-list a:hover {
color:var(--link-color-active);
}
.nav-bar-cell1-rev {
background-color:var(--selected-background-color);
color:var(--selected-text-color);
- margin: auto 5px;
+ margin: 0 5px;
}
.skip-nav {
position:absolute;
@@ -298,6 +319,7 @@ body.module-declaration-page .block-list h2 {
font-style: italic;
padding:0;
margin:15px 0;
+ overflow-x:auto;
}
body.class-declaration-page .summary h3,
body.class-declaration-page .details h3 {
@@ -310,6 +332,18 @@ body.class-declaration-page .details h3 {
/*
* Styles for page layout containers.
*/
+.main-grid {
+ display: flex;
+ flex-direction: row;
+}
+.main-grid main {
+ flex: 2.6 1 0;
+ min-width: 240px
+}
+.main-grid nav.toc {
+ flex: 1 1 0;
+ min-width: 240px;
+}
main {
clear:both;
padding:10px 20px;
@@ -328,7 +362,7 @@ dl.notes > dt {
}
dl.notes > dd {
margin:5px 10px 10px 0;
- font-size:1em;
+ font-size:var(--block-font-size);
font-family:var(--block-font-family)
}
dl.name-value > dt {
@@ -342,6 +376,120 @@ dl.name-value > dd {
font-size:1.1em;
display:inline;
}
+/*
+ * Styles for table of contents.
+ */
+.main-grid nav.toc {
+ background-color: var(--section-background-color);
+ border-right: 1px solid var(--border-color);
+ position: sticky;
+ top: calc(var(--nav-height));
+ max-height: calc(100vh - var(--nav-height));
+ display: flex;
+ flex-direction: column;
+ font-family: var(--body-font-family);
+ z-index: 1;
+}
+.main-grid nav.toc div.toc-header {
+ background-color: var(--section-background-color);
+ border-right: 1px solid var(--border-color);
+ top: var(--nav-height);
+ z-index: 1;
+ padding: 15px 20px;
+}
+.main-grid nav.toc > ol.toc-list {
+ max-height: calc(100vh - var(--nav-height) - 100px);
+ padding-left: 12px;
+}
+.main-grid nav.toc button {
+ position: absolute;
+ bottom: 16px;
+ z-index: 3;
+ background-color: var(--section-background-color);
+ color: #666666;
+ font-size: 0.76rem;
+ border: none;
+ cursor: pointer;
+ padding: 6px 10px;
+ white-space: nowrap;
+}
+.main-grid nav.toc button.hide-sidebar {
+ right: 0;
+}
+.main-grid nav.toc button.show-sidebar {
+ left: 0;
+ display: none;
+}
+.main-grid nav.toc button span {
+ display: none;
+}
+.main-grid nav.toc button:hover {
+ color: var(--body-text-color);
+ border: 1px solid var(--subnav-background-color);
+}
+.main-grid nav.toc button:active {
+ background-color: var(--subnav-background-color);
+ color: var(--link-color-active);
+}
+.main-grid nav.toc button:hover span,
+.main-grid nav.toc button:active span {
+ display: inline;
+}
+.main-grid nav.toc button:hover {
+ box-shadow: 1px 1px 5px rgba(0,0,0,0.2);
+}
+.main-grid nav.toc.hide-sidebar {
+ min-width: revert;
+ max-width: 28px;
+}
+.main-grid nav.toc.hide-sidebar div.toc-header,
+.main-grid nav.toc.hide-sidebar ol.toc-list,
+.main-grid nav.toc.hide-sidebar button.hide-sidebar {
+ display: none;
+}
+.main-grid nav.toc.hide-sidebar button.show-sidebar {
+ display: inline;
+}
+nav.toc div.toc-header {
+ padding: 15px;
+ display: inline-flex;
+ align-items: center;
+ color: var(--body-text-color);
+ background-color: var(--body-background-color);
+ font-size: 0.856em;
+ font-weight: bold;
+ white-space: nowrap;
+ overflow-x: hidden;
+ position: sticky;
+ min-height: 20px;
+}
+nav.toc > ol.toc-list {
+ overflow: hidden auto;
+ overscroll-behavior: contain;
+}
+nav.toc ol.toc-list {
+ list-style: none;
+ padding-left: 8px;
+ margin: 0;
+}
+nav.toc ol.toc-list ol.toc-list {
+ margin-left: 8px;
+}
+nav.toc ol.toc-list li {
+ margin: 0;
+ font-size: var(--nav-font-size);
+ overflow-x: hidden;
+}
+a.current-selection {
+ font-weight: bold;
+}
+nav.toc a {
+ display: block;
+ padding: 8px;
+}
+nav.toc a.current-selection {
+ background-color: var(--subnav-background-color);
+}
/*
* Styles for lists.
*/
@@ -359,11 +507,14 @@ div.inheritance {
div.inheritance div.inheritance {
margin-left:2em;
}
+main > div.inheritance {
+ overflow-x:auto;
+}
ul.block-list,
ul.details-list,
ul.member-list,
ul.summary-list {
- margin:10px 0 10px 0;
+ margin:4px 0 10px 0;
padding:0;
}
ul.block-list > li,
@@ -599,8 +750,9 @@ div.checkboxes > label > input {
* Styles for contents.
*/
div.block {
- font-size:var(--body-font-size);
+ font-size:var(--block-font-size);
font-family:var(--block-font-family);
+ line-height:var(--block-line-height);
}
.col-last div {
padding-top:0;
@@ -646,7 +798,6 @@ div.block {
color:var(--block-text-color);
}
.deprecated-label, .description-from-type-label, .implementation-label, .member-name-link,
-.module-label-in-package, .module-label-in-type, .package-label-in-type,
.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label, .restricted-label {
font-weight:bold;
}
@@ -686,9 +837,6 @@ details summary {
main, nav, header, footer, section {
display:block;
}
-nav {
- overflow:hidden;
-}
/*
* Styles for javadoc search.
*/
@@ -712,15 +860,14 @@ nav {
.ui-autocomplete {
max-height:85%;
max-width:65%;
- overflow-y:auto;
- overflow-x:auto;
+ overflow:auto;
white-space:nowrap;
box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23);
overscroll-behavior: contain;
}
ul.ui-autocomplete {
position:fixed;
- z-index:1;
+ z-index:10;
background-color: var(--body-background-color);
}
ul.ui-autocomplete li {
@@ -738,7 +885,7 @@ ul.ui-autocomplete li.ui-static-link {
font-family: var(--body-font-family);
font-size: 0.93em;
font-weight: bolder;
- z-index: 2;
+ z-index: 10;
}
li.ui-static-link a, li.ui-static-link a:visited {
text-decoration:none;
@@ -756,7 +903,11 @@ li.ui-static-link a, li.ui-static-link a:visited {
padding-top: 0.4em;
padding-bottom: 0.4em;
}
-#search-input, #page-search-input {
+.ui-menu .ui-menu-item-wrapper {
+ padding-top: 5px;
+ padding-bottom: 5px;
+}
+input[type="text"] {
background-image:url('glass.png');
background-size:13px;
background-repeat:no-repeat;
@@ -764,14 +915,27 @@ li.ui-static-link a, li.ui-static-link a:visited {
background-color: var(--search-input-background-color);
color: var(--search-input-text-color);
border-color: var(--border-color);
+ border-radius: 4px;
padding-left:20px;
- width: 250px;
+ font-size: var(--nav-font-size);
+ height: 17px;
+}
+input#search-input, input#page-search-input {
+ width: calc(180px + 10vw);
margin: 0;
}
-#search-input {
- margin-left: 4px;
+input#search-input {
+ margin: 0 4px;
+ padding-right: 18px;
+ max-width: 340px;
}
-#reset-button {
+input.filter-input {
+ width: 40%;
+ max-width: 140px;
+ margin: 0 4px;
+ padding-right: 18px;
+}
+input#reset-search, input.reset-filter {
background-color: transparent;
background-image:url('x.png');
background-repeat:no-repeat;
@@ -780,12 +944,20 @@ li.ui-static-link a, li.ui-static-link a:visited {
border-radius:0;
width:12px;
height:12px;
- position:absolute;
- right:12px;
- top:10px;
font-size:0;
+ display:none;
}
-::placeholder {
+input#reset-search {
+ position:absolute;
+ right:15px;
+ top:11px;
+}
+input.reset-filter {
+ position: relative;
+ right: 20px;
+ top: 0;
+}
+input::placeholder {
color:var(--search-input-placeholder-color);
opacity: 1;
}
@@ -849,7 +1021,7 @@ span#page-search-link {
.module-graph:hover span, .sealed-graph:hover span {
display:block;
margin: -100px 0 0 100px;
- z-index: 1;
+ z-index: 5;
}
.inherited-list {
margin: 10px 0 10px 0;
@@ -874,6 +1046,10 @@ section.class-description {
.vertical-separator {
padding: 0 5px;
}
+.help-section {
+ font-size: var(--block-font-size);
+ line-height: var(--block-line-height);
+}
ul.help-section-list {
margin: 0;
}
@@ -1100,22 +1276,67 @@ table.striped > tbody > tr > th {
/**
* Tweak style for small screens.
*/
+@media screen and (max-width: 1050px) {
+ .summary section[class$="-summary"], .details section[class$="-details"],
+ .class-uses .detail, .serialized-class-details {
+ padding: 0 10px 5px 8px;
+ }
+ input#search-input {
+ width: 22vw;
+ }
+}
@media screen and (max-width: 920px) {
+ .main-grid nav.toc {
+ display: none;
+ }
+ .top-nav nav.toc {
+ display: none;
+ position: absolute;
+ top: var(--top-nav-height);
+ left: 40vw;
+ width: 60vw;
+ z-index: 7;
+ background-color: var(--section-background-color);
+ box-sizing: border-box;
+ }
+ .top-nav nav.toc div.toc-header {
+ padding: 6px 15px;
+ font-size: 0.94em;
+ background-color: var(--section-background-color);
+ top: calc(var(--top-nav-height) + 10px);
+ }
+ .top-nav nav.toc ol.toc-list li {
+ font-size: 1.04em;
+ }
+ nav.toc a:link, nav.toc a:visited {
+ text-decoration:none;
+ color:var(--link-color);
+ }
+ nav.toc a[href]:hover, nav.toc a[href]:focus {
+ text-decoration:none;
+ color:var(--link-color-active);
+ }
+ :root {
+ scroll-behavior: auto;
+ }
header {
max-height: 100vh;
- overflow-y: auto;
+ overflow-y: visible;
+ overscroll-behavior: contain;
}
- div#navbar-top {
- height: 2.8em;
- transition: height 0.35s ease;
+ nav {
+ overflow: visible;
}
ul.nav-list {
- display: block;
+ display: none;
+ position: absolute;
+ top: var(--top-nav-height);
+ overflow: auto;
+ z-index: 7;
+ background-color: var(--navbar-background-color);
width: 40%;
- float:left;
- clear: left;
- margin: 10px 0 0 0;
padding: 0;
+ box-sizing: border-box;
}
ul.nav-list li {
float: none;
@@ -1123,51 +1344,21 @@ table.striped > tbody > tr > th {
margin-left: 10px;
margin-top: 2px;
}
- ul.sub-nav-list-small {
- display:block;
- height: 100%;
- width: 50%;
- float: right;
- clear: right;
- background-color: var(--subnav-background-color);
- color: var(--body-text-color);
- margin: 6px 0 0 0;
- padding: 0;
- }
- ul.sub-nav-list-small ul {
- padding-left: 20px;
- }
- ul.sub-nav-list-small a:link, ul.sub-nav-list-small a:visited {
- color:var(--link-color);
- }
- ul.sub-nav-list-small a:hover {
- color:var(--link-color-active);
- }
- ul.sub-nav-list-small li {
- list-style:none;
- float:none;
- padding: 6px;
- margin-top: 1px;
- text-transform:uppercase;
- }
- ul.sub-nav-list-small > li {
- margin-left: 10px;
- }
- ul.sub-nav-list-small li p {
- margin: 5px 0;
- }
- div#navbar-sub-list {
- display: none;
- }
.top-nav a:link, .top-nav a:active, .top-nav a:visited {
display: block;
}
+ .top-nav div.nav-menu-button {
+ flex: 1 1 auto;
+ }
+ .sub-nav ol.sub-nav-list {
+ margin-left: 4px;
+ padding-left: 4px;
+ }
button#navbar-toggle-button {
width: 3.4em;
height: 2.8em;
background-color: transparent;
display: block;
- float: left;
border: 0;
margin: 0 10px;
cursor: pointer;
@@ -1177,9 +1368,8 @@ table.striped > tbody > tr > th {
display: block;
width: 24px;
height: 3px;
- margin: 1px 0 4px 0;
+ margin: 4px 0;
border-radius: 2px;
- transition: all 0.1s;
background-color: var(--navbar-text-color);
}
button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(1) {
@@ -1199,50 +1389,30 @@ table.striped > tbody > tr > th {
@media screen and (max-width: 800px) {
.about-language {
padding-right: 16px;
+ max-width: 90%;
}
ul.nav-list li {
margin-left: 5px;
}
- ul.sub-nav-list-small > li {
- margin-left: 5px;
- }
main {
- padding: 10px;
- }
- .summary section[class$="-summary"], .details section[class$="-details"],
- .class-uses .detail, .serialized-class-details {
- padding: 0 8px 5px 8px;
+ padding: 10px 12px;
}
body {
-webkit-text-size-adjust: none;
}
}
-@media screen and (max-width: 400px) {
- .about-language {
- font-size: 10px;
- padding-right: 12px;
- }
-}
-@media screen and (max-width: 400px) {
- .nav-list-search {
- width: 94%;
- }
- #search-input, #page-search-input {
- width: 70%;
- }
-}
-@media screen and (max-width: 320px) {
- .nav-list-search > label {
+@media screen and (max-width: 600px) {
+ .nav-list-search > a {
display: none;
}
- .nav-list-search {
- width: 90%;
+ input#search-input {
+ width: 18vw;
}
- #search-input, #page-search-input {
- width: 80%;
+ .summary section[class$="-summary"], .details section[class$="-details"],
+ .class-uses .detail, .serialized-class-details {
+ padding: 0;
}
}
-
pre.snippet {
background-color: var(--snippet-background-color);
color: var(--snippet-text-color);
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties
index 00da1793393..7c5b43d35df 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2010, 2023, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2010, 2024, 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
@@ -232,8 +232,9 @@ doclet.Modifier=Modifier
doclet.Type=Type
doclet.Modifier_and_Type=Modifier and Type
doclet.Implementation=Implementation(s):
-doclet.search=SEARCH
+doclet.search=Search
doclet.search_placeholder=Search
+doclet.search_in_documentation=Search in documentation
doclet.search_reset=Reset
doclet.Field=Field
doclet.Property=Property
@@ -247,6 +248,12 @@ doclet.Enum_Constant=Enum Constant
doclet.Description=Description
doclet.ConstantField=Constant Field
doclet.Value=Value
+doclet.table_of_contents=Table of contents
+doclet.hide_sidebar=Hide sidebar
+doclet.show_sidebar=Show sidebar
+doclet.filter_label=Filter
+doclet.filter_table_of_contents=Filter table of contents
+doclet.filter_reset=Reset
doclet.linkMismatch_PackagedLinkedtoModule=The code being documented uses packages in the unnamed module, \
but the packages defined in {0} are in named modules.
doclet.linkMismatch_ModuleLinkedtoPackage=The code being documented uses modules but the packages defined \
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocLink.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocLink.java
index 05119e25012..9764e9134b6 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocLink.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocLink.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2012, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2012, 2024, 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
@@ -90,7 +90,7 @@ public class DocLink {
DocPath newPath = base.relativize(path);
// avoid generating an empty link by using the basename of the path if necessary
- if (newPath.isEmpty() && isEmpty(fragment)) {
+ if (newPath.isEmpty() && fragment == null) {
newPath = path.basename();
}
return new DocLink(newPath, fragment);
@@ -121,18 +121,14 @@ public class DocLink {
@Override
public String toString() {
// common fast path
- if (path != null && isEmpty(fragment))
+ if (path != null && fragment == null)
return path.getPath();
StringBuilder sb = new StringBuilder();
if (path != null)
sb.append(path.getPath());
- if (!isEmpty(fragment))
+ if (fragment != null)
sb.append("#").append(fragment);
return sb.toString();
}
-
- private static boolean isEmpty(String s) {
- return (s == null) || s.isEmpty();
- }
}
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocPaths.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocPaths.java
index 4f3c10df887..0f329eebcd6 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocPaths.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocPaths.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1998, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2024, 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
@@ -94,6 +94,9 @@ public class DocPaths {
/** The name of the default javascript file. */
public static final DocPath SCRIPT_JS = DocPath.create("script.js");
+ /** The name of the template of the default javascript file. */
+ public static final DocPath SCRIPT_JS_TEMPLATE = DocPath.create("script.js.template");
+
/** The name of the copy-to-clipboard icon file. */
public static final DocPath CLIPBOARD_SVG = DocPath.create("copy.svg");
diff --git a/test/langtools/jdk/javadoc/doclet/testAnchorNames/TestAnchorNames.java b/test/langtools/jdk/javadoc/doclet/testAnchorNames/TestAnchorNames.java
index 524048e5069..84b5e96e547 100644
--- a/test/langtools/jdk/javadoc/doclet/testAnchorNames/TestAnchorNames.java
+++ b/test/langtools/jdk/javadoc/doclet/testAnchorNames/TestAnchorNames.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2013, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2013, 2024, 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
@@ -68,19 +68,19 @@ public class TestAnchorNames extends JavadocTester {
"""
Summary:
- Field | """,
+ Field Summary """,
"""
- Detail:
- Field | """,
+ Field Details
+
";
+ hdr.append(...template.content.childNodes);
+ }
+ });
+ var sections;
+ var scrollTimeout;
+ var scrollTimeoutNeeded;
+ var prevHash;
+ function initSectionData() {
+ sections = [{ id: "", top: 0 }].concat(Array.from(main.querySelectorAll("section[id], h2[id], h2 a[id], div[id]"))
+ .filter((e) => {
+ return sidebar.querySelector("a[href=\"#" + encodeURI(e.getAttribute("id")) + "\"]") !== null
+ }).map((e) => {
+ return {
+ id: e.getAttribute("id"),
+ top: e.offsetTop
+ };
+ }));
+ }
+ function setScrollTimeout() {
+ clearTimeout(scrollTimeout);
+ scrollTimeoutNeeded = false;
+ scrollTimeout = setTimeout(() => {
+ scrollTimeout = null;
+ handleScroll();
+ }, 50);
+ }
+ function handleScroll() {
+ if (!sidebar || !sidebar.offsetParent || sidebar.classList.contains("hide-sidebar")) {
+ return;
+ }
+ if (scrollTimeout || scrollTimeoutNeeded) {
+ setScrollTimeout();
+ return;
+ }
+ var scrollTop = document.documentElement.scrollTop;
+ var scrollHeight = document.documentElement.scrollHeight;
+ var currHash = null;
+ if (scrollHeight - scrollTop < window.innerHeight + 10) {
+ // Select last item if at bottom of the page
+ currHash = "#" + encodeURI(sections.at(-1).id);
+ } else {
+ for (var i = 0; i < sections.length; i++) {
+ var top = sections[i].top;
+ var bottom = sections[i + 1] ? sections[i + 1].top : scrollHeight;
+ if (top + ((bottom - top) / 2) > scrollTop || bottom > scrollTop + (window.innerHeight / 3)) {
+ currHash = "#" + encodeURI(sections[i].id);
+ break;
+ }
+ }
+ }
+ if (currHash !== prevHash) {
+ setSelected(currHash);
+ }
+ }
+ function setSelected(hash) {
+ var prev = sidebar.querySelector("a.current-selection");
+ if (prev)
+ prev.classList.remove("current-selection");
+ prevHash = hash;
+ if (hash) {
+ var curr = sidebar.querySelector("ol.toc-list a[href=\"" + hash + "\"]");
+ if (curr) {
+ curr.classList.add("current-selection");
+ curr.scrollIntoView({ behavior: "instant", block: "nearest" });
+ }
+ }
+ }
+ if (sidebar) {
+ initSectionData();
+ document.querySelectorAll("a[href^='#']").forEach((link) => {
+ link.addEventListener("click", (e) => {
+ scrollTimeoutNeeded = true;
+ setSelected(link.getAttribute("href"));
+ })
+ });
+ sidebar.querySelector("button.hide-sidebar").addEventListener("click", () => {
+ sidebar.classList.add("hide-sidebar");
+ sessionStorage.setItem("sidebar", "hidden");
+ });
+ sidebar.querySelector("button.show-sidebar").addEventListener("click", () => {
+ sidebar.classList.remove("hide-sidebar");
+ sessionStorage.removeItem("sidebar");
+ initSectionData();
+ handleScroll();
+ });
+ window.addEventListener("hashchange", (e) => {
+ scrollTimeoutNeeded = true;
+ });
+ if (document.location.hash) {
+ scrollTimeoutNeeded = true;
+ setSelected(document.location.hash);
+ } else {
+ handleScroll();
+ }
+ window.addEventListener("scroll", handleScroll);
+ window.addEventListener("scrollend", () => {
+ if (scrollTimeout) {
+ clearTimeout(scrollTimeout);
+ scrollTimeout = null;
+ handleScroll();
+ }
+ })
+ }
+ // Resize handler
+ function handleResize(e) {
+ if (expanded) {
+ if (windowWidth != window.innerWidth) {
+ collapse();
+ } else {
+ expand();
+ }
+ }
+ if (sections) {
+ initSectionData();
+ prevHash = null;
+ handleScroll();
+ }
+ setTopMargin();
+ }
+ window.addEventListener("orientationchange", handleResize);
+ window.addEventListener("resize", handleResize);
+});
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/search.js.template b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/search.js.template
index f98a2faf035..c864787bf2f 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/search.js.template
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/search.js.template
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2015, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2015, 2024, 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
@@ -31,8 +31,6 @@ const messages = {
loading: "##REPLACE:doclet.search.loading##",
searching: "##REPLACE:doclet.search.searching##",
redirecting: "##REPLACE:doclet.search.redirecting##",
- linkIcon: "##REPLACE:doclet.Link_icon##",
- linkToSection: "##REPLACE:doclet.Link_to_section##"
}
const categories = {
modules: "##REPLACE:doclet.search.modules##",
@@ -255,9 +253,6 @@ function rateNoise(str) {
function doSearch(request, response) {
var term = request.term.trim();
var maxResults = request.maxResults || MAX_RESULTS;
- if (term.length === 0) {
- return this.close();
- }
var matcher = {
plainMatcher: createMatcher(term, false),
camelCaseMatcher: createMatcher(term, true)
@@ -407,52 +402,18 @@ $.widget("custom.catcomplete", $.ui.autocomplete, {
}
});
$(function() {
- var expanded = false;
- var windowWidth;
- function collapse() {
- if (expanded) {
- $("div#navbar-top").removeAttr("style");
- $("button#navbar-toggle-button")
- .removeClass("expanded")
- .attr("aria-expanded", "false");
- expanded = false;
- }
- }
- $("button#navbar-toggle-button").click(function (e) {
- if (expanded) {
- collapse();
- } else {
- var navbar = $("div#navbar-top");
- navbar.height(navbar.prop("scrollHeight"));
- $("button#navbar-toggle-button")
- .addClass("expanded")
- .attr("aria-expanded", "true");
- expanded = true;
- windowWidth = window.innerWidth;
- }
- });
- $("ul.sub-nav-list-small li a").click(collapse);
- $("input#search-input").focus(collapse);
- $("main").click(collapse);
- $("section[id] > :header, :header[id], :header:has(a[id])").each(function(idx, el) {
- // Create anchor links for headers with an associated id attribute
- var hdr = $(el);
- var id = hdr.attr("id") || hdr.parent("section").attr("id") || hdr.children("a").attr("id");
- if (id) {
- hdr.append(" ");
- }
- });
- $(window).on("orientationchange", collapse).on("resize", function(e) {
- if (expanded && windowWidth !== window.innerWidth) collapse();
- });
var search = $("#search-input");
- var reset = $("#reset-button");
+ var reset = $("#reset-search");
search.catcomplete({
minLength: 1,
delay: 200,
- source: doSearch,
+ source: function(request, response) {
+ reset.css("display", "inline");
+ if (request.term.trim() === "") {
+ return this.close();
+ }
+ return doSearch(request, response);
+ },
response: function(event, ui) {
if (!ui.content.length) {
ui.content.push({ l: messages.noResult });
@@ -460,6 +421,12 @@ $(function() {
$("#search-input").empty();
}
},
+ close: function(event, ui) {
+ reset.css("display", search.val() ? "inline" : "none");
+ },
+ change: function(event, ui) {
+ reset.css("display", search.val() ? "inline" : "none");
+ },
autoFocus: true,
focus: function(event, ui) {
return false;
@@ -480,6 +447,7 @@ $(function() {
reset.prop("disabled", false);
reset.click(function() {
search.val('').focus();
+ reset.css("display", "none");
});
search.focus();
});
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/stylesheet.css b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/stylesheet.css
index 46c39a0918b..ab9201fbc86 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/stylesheet.css
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/stylesheet.css
@@ -15,7 +15,11 @@
--code-font-family: 'DejaVu Sans Mono', monospace;
/* Base font sizes for body and code elements */
--body-font-size: 14px;
+ --block-font-size: 14px;
--code-font-size: 14px;
+ --nav-font-size: 13.2px;
+ /* Line height for continuous text blocks */
+ --block-line-height: 1.4em;
/* Text colors for body and block elements */
--body-text-color: #353833;
--block-text-color: #474747;
@@ -59,6 +63,11 @@
/* Colors for invalid tag notifications */
--invalid-tag-background-color: #ffe6e6;
--invalid-tag-text-color: #000000;
+ /* Navigation bar dimensions */
+ --top-nav-height: 44px;
+ --sub-nav-height: 34px;
+ --nav-height: calc(var(--top-nav-height) + var(--sub-nav-height));
+ scroll-behavior: smooth;
}
/*
* Styles for individual HTML elements.
@@ -76,28 +85,20 @@ body {
height:100%;
width:100%;
}
-iframe {
- margin:0;
- padding:0;
- height:100%;
- width:100%;
- overflow-y:scroll;
- border:none;
-}
-:not(input)[id] {
- scroll-margin-top: 78px;
+main [id] {
+ scroll-margin-top: calc(var(--nav-height) + 6px);
}
a:link, a:visited {
text-decoration:none;
color:var(--link-color);
}
-a[href]:hover, a[href]:focus {
+a[href]:hover, a[href]:active {
text-decoration:none;
color:var(--link-color-active);
}
pre {
font-family:var(--code-font-family);
- font-size:1em;
+ font-size:var(--code-font-size);
}
h1 {
font-size:1.428em;
@@ -130,8 +131,6 @@ code, tt {
:not(h1, h2, h3, h4, h5, h6) > code,
:not(h1, h2, h3, h4, h5, h6) > tt {
font-size:var(--code-font-size);
- padding-top:4px;
- margin-top:8px;
line-height:1.4em;
}
dt code {
@@ -152,6 +151,9 @@ button {
font-family: var(--body-font-family);
font-size: 1em;
}
+hr {
+ border-color: #aaa;
+}
/*
* Styles for HTML generated by javadoc.
*
@@ -162,14 +164,14 @@ button {
* Styles for document title and copyright.
*/
.about-language {
- float:right;
- padding:0 21px 8px 8px;
+ flex: 0 0 auto;
+ padding:0 20px;
+ margin:0;
font-size:0.915em;
- margin-top:-9px;
- height:2.9em;
+ max-width: 50%;
+ white-space: nowrap;
}
.legal-copy {
- margin-left:.5em;
}
/*
* Styles for navigation bar.
@@ -178,83 +180,102 @@ button {
header {
position:sticky;
top:0;
- z-index:1;
+ z-index:2;
background: var(--body-background-color);
}
}
+.nav-content {
+ display:flex;
+ flex-direction: row;
+ align-items: center;
+ width: 100%;
+ height: 100%;
+}
.top-nav {
background-color:var(--navbar-background-color);
color:var(--navbar-text-color);
- float:left;
width:100%;
- clear:right;
- min-height:2.8em;
- padding:10px 0 0 0;
- overflow:hidden;
+ height:var(--top-nav-height);
+ overflow:visible;
font-size:0.857em;
+ position:relative;
+}
+.top-nav nav.toc {
+ display: none;
+ flex-direction: column;
+}
+.top-nav nav.toc button.show-sidebar,
+.top-nav nav.toc button.hide-sidebar {
+ display: none;
}
button#navbar-toggle-button {
display:none;
}
-ul.sub-nav-list-small {
- display: none;
-}
-.sub-nav {
- background-color:var(--subnav-background-color);
- float:left;
- width:100%;
- overflow:hidden;
- font-size:0.857em;
-}
-.sub-nav div {
- clear:left;
- float:left;
- padding:6px;
- text-transform:uppercase;
-}
-.sub-nav .sub-nav-list {
- padding-top:4px;
-}
ul.nav-list {
- display:block;
- margin:0 25px 0 0;
- padding:0;
-}
-ul.sub-nav-list {
- float:left;
- margin:0 25px 0 0;
- padding:0;
+ display:inline-flex;
+ margin:0;
+ padding-left:4px;
+ flex: 1 1 auto;
+ white-space: nowrap;
}
ul.nav-list li {
list-style:none;
- float:left;
padding: 5px 6px;
text-transform:uppercase;
+ height: 1.2em;
+}
+div.sub-nav {
+ background-color:var(--subnav-background-color);
+ width:100%;
+ overflow:hidden;
+ font-size:var(--nav-font-size);
+ height: var(--sub-nav-height);
+}
+ol.sub-nav-list {
+ flex: 1 1 90%;
+ line-height: 1.8em;
+ display: inline-flex;
+ overflow: auto;
+ scroll-snap-type: x mandatory;
+ scroll-padding-left: 13px;
+ scrollbar-width: none;
+ padding-left:6px;
+ white-space: nowrap;
+ margin:0;
+}
+ol.sub-nav-list::-webkit-scrollbar {
+ display: none;
+}
+ol.sub-nav-list li {
+ list-style:none;
+ scroll-snap-align: start;
+}
+ol.sub-nav-list a {
+ padding: 3px;
+}
+ol.sub-nav-list a.current-selection {
+ background-color: var(--section-background-color);
+ border-radius: 4px;
}
.sub-nav .nav-list-search {
- float:right;
+ flex: 1 1 10%;
margin:0;
padding:6px;
- clear:none;
- text-align:right;
position:relative;
+ white-space: nowrap;
}
-ul.sub-nav-list li {
- list-style:none;
- float:left;
-}
-.top-nav a:link, .top-nav a:active, .top-nav a:visited {
+.top-nav .nav-list a:link, .top-nav .nav-list a:active, .top-nav .nav-list a:visited {
color:var(--navbar-text-color);
text-decoration:none;
text-transform:uppercase;
}
-.top-nav a:hover {
+.top-nav .nav-list a:hover {
color:var(--link-color-active);
}
.nav-bar-cell1-rev {
background-color:var(--selected-background-color);
color:var(--selected-text-color);
- margin: auto 5px;
+ margin: 0 5px;
}
.skip-nav {
position:absolute;
@@ -298,6 +319,7 @@ body.module-declaration-page .block-list h2 {
font-style: italic;
padding:0;
margin:15px 0;
+ overflow-x:auto;
}
body.class-declaration-page .summary h3,
body.class-declaration-page .details h3 {
@@ -310,6 +332,18 @@ body.class-declaration-page .details h3 {
/*
* Styles for page layout containers.
*/
+.main-grid {
+ display: flex;
+ flex-direction: row;
+}
+.main-grid main {
+ flex: 2.6 1 0;
+ min-width: 240px
+}
+.main-grid nav.toc {
+ flex: 1 1 0;
+ min-width: 240px;
+}
main {
clear:both;
padding:10px 20px;
@@ -328,7 +362,7 @@ dl.notes > dt {
}
dl.notes > dd {
margin:5px 10px 10px 0;
- font-size:1em;
+ font-size:var(--block-font-size);
font-family:var(--block-font-family)
}
dl.name-value > dt {
@@ -342,6 +376,120 @@ dl.name-value > dd {
font-size:1.1em;
display:inline;
}
+/*
+ * Styles for table of contents.
+ */
+.main-grid nav.toc {
+ background-color: var(--section-background-color);
+ border-right: 1px solid var(--border-color);
+ position: sticky;
+ top: calc(var(--nav-height));
+ max-height: calc(100vh - var(--nav-height));
+ display: flex;
+ flex-direction: column;
+ font-family: var(--body-font-family);
+ z-index: 1;
+}
+.main-grid nav.toc div.toc-header {
+ background-color: var(--section-background-color);
+ border-right: 1px solid var(--border-color);
+ top: var(--nav-height);
+ z-index: 1;
+ padding: 15px 20px;
+}
+.main-grid nav.toc > ol.toc-list {
+ max-height: calc(100vh - var(--nav-height) - 100px);
+ padding-left: 12px;
+}
+.main-grid nav.toc button {
+ position: absolute;
+ bottom: 16px;
+ z-index: 3;
+ background-color: var(--section-background-color);
+ color: #666666;
+ font-size: 0.76rem;
+ border: none;
+ cursor: pointer;
+ padding: 6px 10px;
+ white-space: nowrap;
+}
+.main-grid nav.toc button.hide-sidebar {
+ right: 0;
+}
+.main-grid nav.toc button.show-sidebar {
+ left: 0;
+ display: none;
+}
+.main-grid nav.toc button span {
+ display: none;
+}
+.main-grid nav.toc button:hover {
+ color: var(--body-text-color);
+ border: 1px solid var(--subnav-background-color);
+}
+.main-grid nav.toc button:active {
+ background-color: var(--subnav-background-color);
+ color: var(--link-color-active);
+}
+.main-grid nav.toc button:hover span,
+.main-grid nav.toc button:active span {
+ display: inline;
+}
+.main-grid nav.toc button:hover {
+ box-shadow: 1px 1px 5px rgba(0,0,0,0.2);
+}
+.main-grid nav.toc.hide-sidebar {
+ min-width: revert;
+ max-width: 28px;
+}
+.main-grid nav.toc.hide-sidebar div.toc-header,
+.main-grid nav.toc.hide-sidebar ol.toc-list,
+.main-grid nav.toc.hide-sidebar button.hide-sidebar {
+ display: none;
+}
+.main-grid nav.toc.hide-sidebar button.show-sidebar {
+ display: inline;
+}
+nav.toc div.toc-header {
+ padding: 15px;
+ display: inline-flex;
+ align-items: center;
+ color: var(--body-text-color);
+ background-color: var(--body-background-color);
+ font-size: 0.856em;
+ font-weight: bold;
+ white-space: nowrap;
+ overflow-x: hidden;
+ position: sticky;
+ min-height: 20px;
+}
+nav.toc > ol.toc-list {
+ overflow: hidden auto;
+ overscroll-behavior: contain;
+}
+nav.toc ol.toc-list {
+ list-style: none;
+ padding-left: 8px;
+ margin: 0;
+}
+nav.toc ol.toc-list ol.toc-list {
+ margin-left: 8px;
+}
+nav.toc ol.toc-list li {
+ margin: 0;
+ font-size: var(--nav-font-size);
+ overflow-x: hidden;
+}
+a.current-selection {
+ font-weight: bold;
+}
+nav.toc a {
+ display: block;
+ padding: 8px;
+}
+nav.toc a.current-selection {
+ background-color: var(--subnav-background-color);
+}
/*
* Styles for lists.
*/
@@ -359,11 +507,14 @@ div.inheritance {
div.inheritance div.inheritance {
margin-left:2em;
}
+main > div.inheritance {
+ overflow-x:auto;
+}
ul.block-list,
ul.details-list,
ul.member-list,
ul.summary-list {
- margin:10px 0 10px 0;
+ margin:4px 0 10px 0;
padding:0;
}
ul.block-list > li,
@@ -599,8 +750,9 @@ div.checkboxes > label > input {
* Styles for contents.
*/
div.block {
- font-size:var(--body-font-size);
+ font-size:var(--block-font-size);
font-family:var(--block-font-family);
+ line-height:var(--block-line-height);
}
.col-last div {
padding-top:0;
@@ -646,7 +798,6 @@ div.block {
color:var(--block-text-color);
}
.deprecated-label, .description-from-type-label, .implementation-label, .member-name-link,
-.module-label-in-package, .module-label-in-type, .package-label-in-type,
.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label, .restricted-label {
font-weight:bold;
}
@@ -686,9 +837,6 @@ details summary {
main, nav, header, footer, section {
display:block;
}
-nav {
- overflow:hidden;
-}
/*
* Styles for javadoc search.
*/
@@ -712,15 +860,14 @@ nav {
.ui-autocomplete {
max-height:85%;
max-width:65%;
- overflow-y:auto;
- overflow-x:auto;
+ overflow:auto;
white-space:nowrap;
box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23);
overscroll-behavior: contain;
}
ul.ui-autocomplete {
position:fixed;
- z-index:1;
+ z-index:10;
background-color: var(--body-background-color);
}
ul.ui-autocomplete li {
@@ -738,7 +885,7 @@ ul.ui-autocomplete li.ui-static-link {
font-family: var(--body-font-family);
font-size: 0.93em;
font-weight: bolder;
- z-index: 2;
+ z-index: 10;
}
li.ui-static-link a, li.ui-static-link a:visited {
text-decoration:none;
@@ -756,7 +903,11 @@ li.ui-static-link a, li.ui-static-link a:visited {
padding-top: 0.4em;
padding-bottom: 0.4em;
}
-#search-input, #page-search-input {
+.ui-menu .ui-menu-item-wrapper {
+ padding-top: 5px;
+ padding-bottom: 5px;
+}
+input[type="text"] {
background-image:url('glass.png');
background-size:13px;
background-repeat:no-repeat;
@@ -764,14 +915,27 @@ li.ui-static-link a, li.ui-static-link a:visited {
background-color: var(--search-input-background-color);
color: var(--search-input-text-color);
border-color: var(--border-color);
+ border-radius: 4px;
padding-left:20px;
- width: 250px;
+ font-size: var(--nav-font-size);
+ height: 17px;
+}
+input#search-input, input#page-search-input {
+ width: calc(180px + 10vw);
margin: 0;
}
-#search-input {
- margin-left: 4px;
+input#search-input {
+ margin: 0 4px;
+ padding-right: 18px;
+ max-width: 340px;
}
-#reset-button {
+input.filter-input {
+ width: 40%;
+ max-width: 140px;
+ margin: 0 4px;
+ padding-right: 18px;
+}
+input#reset-search, input.reset-filter {
background-color: transparent;
background-image:url('x.png');
background-repeat:no-repeat;
@@ -780,12 +944,20 @@ li.ui-static-link a, li.ui-static-link a:visited {
border-radius:0;
width:12px;
height:12px;
- position:absolute;
- right:12px;
- top:10px;
font-size:0;
+ display:none;
}
-::placeholder {
+input#reset-search {
+ position:absolute;
+ right:15px;
+ top:11px;
+}
+input.reset-filter {
+ position: relative;
+ right: 20px;
+ top: 0;
+}
+input::placeholder {
color:var(--search-input-placeholder-color);
opacity: 1;
}
@@ -849,7 +1021,7 @@ span#page-search-link {
.module-graph:hover span, .sealed-graph:hover span {
display:block;
margin: -100px 0 0 100px;
- z-index: 1;
+ z-index: 5;
}
.inherited-list {
margin: 10px 0 10px 0;
@@ -874,6 +1046,10 @@ section.class-description {
.vertical-separator {
padding: 0 5px;
}
+.help-section {
+ font-size: var(--block-font-size);
+ line-height: var(--block-line-height);
+}
ul.help-section-list {
margin: 0;
}
@@ -1100,22 +1276,67 @@ table.striped > tbody > tr > th {
/**
* Tweak style for small screens.
*/
+@media screen and (max-width: 1050px) {
+ .summary section[class$="-summary"], .details section[class$="-details"],
+ .class-uses .detail, .serialized-class-details {
+ padding: 0 10px 5px 8px;
+ }
+ input#search-input {
+ width: 22vw;
+ }
+}
@media screen and (max-width: 920px) {
+ .main-grid nav.toc {
+ display: none;
+ }
+ .top-nav nav.toc {
+ display: none;
+ position: absolute;
+ top: var(--top-nav-height);
+ left: 40vw;
+ width: 60vw;
+ z-index: 7;
+ background-color: var(--section-background-color);
+ box-sizing: border-box;
+ }
+ .top-nav nav.toc div.toc-header {
+ padding: 6px 15px;
+ font-size: 0.94em;
+ background-color: var(--section-background-color);
+ top: calc(var(--top-nav-height) + 10px);
+ }
+ .top-nav nav.toc ol.toc-list li {
+ font-size: 1.04em;
+ }
+ nav.toc a:link, nav.toc a:visited {
+ text-decoration:none;
+ color:var(--link-color);
+ }
+ nav.toc a[href]:hover, nav.toc a[href]:focus {
+ text-decoration:none;
+ color:var(--link-color-active);
+ }
+ :root {
+ scroll-behavior: auto;
+ }
header {
max-height: 100vh;
- overflow-y: auto;
+ overflow-y: visible;
+ overscroll-behavior: contain;
}
- div#navbar-top {
- height: 2.8em;
- transition: height 0.35s ease;
+ nav {
+ overflow: visible;
}
ul.nav-list {
- display: block;
+ display: none;
+ position: absolute;
+ top: var(--top-nav-height);
+ overflow: auto;
+ z-index: 7;
+ background-color: var(--navbar-background-color);
width: 40%;
- float:left;
- clear: left;
- margin: 10px 0 0 0;
padding: 0;
+ box-sizing: border-box;
}
ul.nav-list li {
float: none;
@@ -1123,51 +1344,21 @@ table.striped > tbody > tr > th {
margin-left: 10px;
margin-top: 2px;
}
- ul.sub-nav-list-small {
- display:block;
- height: 100%;
- width: 50%;
- float: right;
- clear: right;
- background-color: var(--subnav-background-color);
- color: var(--body-text-color);
- margin: 6px 0 0 0;
- padding: 0;
- }
- ul.sub-nav-list-small ul {
- padding-left: 20px;
- }
- ul.sub-nav-list-small a:link, ul.sub-nav-list-small a:visited {
- color:var(--link-color);
- }
- ul.sub-nav-list-small a:hover {
- color:var(--link-color-active);
- }
- ul.sub-nav-list-small li {
- list-style:none;
- float:none;
- padding: 6px;
- margin-top: 1px;
- text-transform:uppercase;
- }
- ul.sub-nav-list-small > li {
- margin-left: 10px;
- }
- ul.sub-nav-list-small li p {
- margin: 5px 0;
- }
- div#navbar-sub-list {
- display: none;
- }
.top-nav a:link, .top-nav a:active, .top-nav a:visited {
display: block;
}
+ .top-nav div.nav-menu-button {
+ flex: 1 1 auto;
+ }
+ .sub-nav ol.sub-nav-list {
+ margin-left: 4px;
+ padding-left: 4px;
+ }
button#navbar-toggle-button {
width: 3.4em;
height: 2.8em;
background-color: transparent;
display: block;
- float: left;
border: 0;
margin: 0 10px;
cursor: pointer;
@@ -1177,9 +1368,8 @@ table.striped > tbody > tr > th {
display: block;
width: 24px;
height: 3px;
- margin: 1px 0 4px 0;
+ margin: 4px 0;
border-radius: 2px;
- transition: all 0.1s;
background-color: var(--navbar-text-color);
}
button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(1) {
@@ -1199,50 +1389,30 @@ table.striped > tbody > tr > th {
@media screen and (max-width: 800px) {
.about-language {
padding-right: 16px;
+ max-width: 90%;
}
ul.nav-list li {
margin-left: 5px;
}
- ul.sub-nav-list-small > li {
- margin-left: 5px;
- }
main {
- padding: 10px;
- }
- .summary section[class$="-summary"], .details section[class$="-details"],
- .class-uses .detail, .serialized-class-details {
- padding: 0 8px 5px 8px;
+ padding: 10px 12px;
}
body {
-webkit-text-size-adjust: none;
}
}
-@media screen and (max-width: 400px) {
- .about-language {
- font-size: 10px;
- padding-right: 12px;
- }
-}
-@media screen and (max-width: 400px) {
- .nav-list-search {
- width: 94%;
- }
- #search-input, #page-search-input {
- width: 70%;
- }
-}
-@media screen and (max-width: 320px) {
- .nav-list-search > label {
+@media screen and (max-width: 600px) {
+ .nav-list-search > a {
display: none;
}
- .nav-list-search {
- width: 90%;
+ input#search-input {
+ width: 18vw;
}
- #search-input, #page-search-input {
- width: 80%;
+ .summary section[class$="-summary"], .details section[class$="-details"],
+ .class-uses .detail, .serialized-class-details {
+ padding: 0;
}
}
-
pre.snippet {
background-color: var(--snippet-background-color);
color: var(--snippet-text-color);
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties
index 00da1793393..7c5b43d35df 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties
@@ -1,5 +1,5 @@
#
-# Copyright (c) 2010, 2023, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2010, 2024, 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
@@ -232,8 +232,9 @@ doclet.Modifier=Modifier
doclet.Type=Type
doclet.Modifier_and_Type=Modifier and Type
doclet.Implementation=Implementation(s):
-doclet.search=SEARCH
+doclet.search=Search
doclet.search_placeholder=Search
+doclet.search_in_documentation=Search in documentation
doclet.search_reset=Reset
doclet.Field=Field
doclet.Property=Property
@@ -247,6 +248,12 @@ doclet.Enum_Constant=Enum Constant
doclet.Description=Description
doclet.ConstantField=Constant Field
doclet.Value=Value
+doclet.table_of_contents=Table of contents
+doclet.hide_sidebar=Hide sidebar
+doclet.show_sidebar=Show sidebar
+doclet.filter_label=Filter
+doclet.filter_table_of_contents=Filter table of contents
+doclet.filter_reset=Reset
doclet.linkMismatch_PackagedLinkedtoModule=The code being documented uses packages in the unnamed module, \
but the packages defined in {0} are in named modules.
doclet.linkMismatch_ModuleLinkedtoPackage=The code being documented uses modules but the packages defined \
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocLink.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocLink.java
index 05119e25012..9764e9134b6 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocLink.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocLink.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2012, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2012, 2024, 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
@@ -90,7 +90,7 @@ public class DocLink {
DocPath newPath = base.relativize(path);
// avoid generating an empty link by using the basename of the path if necessary
- if (newPath.isEmpty() && isEmpty(fragment)) {
+ if (newPath.isEmpty() && fragment == null) {
newPath = path.basename();
}
return new DocLink(newPath, fragment);
@@ -121,18 +121,14 @@ public class DocLink {
@Override
public String toString() {
// common fast path
- if (path != null && isEmpty(fragment))
+ if (path != null && fragment == null)
return path.getPath();
StringBuilder sb = new StringBuilder();
if (path != null)
sb.append(path.getPath());
- if (!isEmpty(fragment))
+ if (fragment != null)
sb.append("#").append(fragment);
return sb.toString();
}
-
- private static boolean isEmpty(String s) {
- return (s == null) || s.isEmpty();
- }
}
diff --git a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocPaths.java b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocPaths.java
index 4f3c10df887..0f329eebcd6 100644
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocPaths.java
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/DocPaths.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1998, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2024, 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
@@ -94,6 +94,9 @@ public class DocPaths {
/** The name of the default javascript file. */
public static final DocPath SCRIPT_JS = DocPath.create("script.js");
+ /** The name of the template of the default javascript file. */
+ public static final DocPath SCRIPT_JS_TEMPLATE = DocPath.create("script.js.template");
+
/** The name of the copy-to-clipboard icon file. */
public static final DocPath CLIPBOARD_SVG = DocPath.create("copy.svg");
diff --git a/test/langtools/jdk/javadoc/doclet/testAnchorNames/TestAnchorNames.java b/test/langtools/jdk/javadoc/doclet/testAnchorNames/TestAnchorNames.java
index 524048e5069..84b5e96e547 100644
--- a/test/langtools/jdk/javadoc/doclet/testAnchorNames/TestAnchorNames.java
+++ b/test/langtools/jdk/javadoc/doclet/testAnchorNames/TestAnchorNames.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2013, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2013, 2024, 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
@@ -68,19 +68,19 @@ public class TestAnchorNames extends JavadocTester {
"""
Nested Class Summary
""", - "", + "", """Method Summary
""", - "", + "", """Field Details
""", - "", + "", """Constructor Details
""", - ""); + ""); // Test some members and link to these members checkOutput("pkg1/RegClass.html", true, diff --git a/test/langtools/jdk/javadoc/doclet/testAnnotationTypes/TestAnnotationTypes.java b/test/langtools/jdk/javadoc/doclet/testAnnotationTypes/TestAnnotationTypes.java index c53c3342bbc..9235fcd8215 100644 --- a/test/langtools/jdk/javadoc/doclet/testAnnotationTypes/TestAnnotationTypes.java +++ b/test/langtools/jdk/javadoc/doclet/testAnnotationTypes/TestAnnotationTypes.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2004, 2023, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2004, 2024, 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 @@ -52,11 +52,11 @@ public class TestAnnotationTypes extends JavadocTester { checkOutput("pkg/AnnotationTypeField.html", true, """ --
+
- DEFAULT_NAME """, "", "
- Detail: -
- Field | -
- Element -
Field Summary
", """ @@ -73,18 +73,17 @@ public class TestAnnotationTypes extends JavadocTester { checkOutput("pkg/AnnotationType.html", true, """ - """, - """ --
-