jdk-sandbox: comparison langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDocletWriter.java

equal deleted inserted replaced

-:8c0d8d2c3519
+:96a1226aca18
 import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
 import jdk.javadoc.internal.doclets.toolkit.AnnotationTypeWriter;
 import jdk.javadoc.internal.doclets.toolkit.ClassWriter;
 import jdk.javadoc.internal.doclets.toolkit.Configuration;
 import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.Messages;
 import jdk.javadoc.internal.doclets.toolkit.PackageSummaryWriter;
+import jdk.javadoc.internal.doclets.toolkit.Resources;
 import jdk.javadoc.internal.doclets.toolkit.taglets.DocRootTaglet;
 import jdk.javadoc.internal.doclets.toolkit.taglets.TagletWriter;
 import jdk.javadoc.internal.doclets.toolkit.util.DocFile;
 import jdk.javadoc.internal.doclets.toolkit.util.DocLink;
 import jdk.javadoc.internal.doclets.toolkit.util.DocPath;
 */
 public final ConfigurationImpl configuration;
 protected final Utils utils;
+protected final Contents contents;
+protected final Messages messages;
+protected final Resources resources;
 /**
 * To check whether annotation heading is printed or not.
 */
 protected boolean printedAnnotationHeading = false;
 /**
 * Constructor to construct the HtmlStandardWriter object.
 *
 * @param path File to be generated.
 */
-public HtmlDocletWriter(ConfigurationImpl configuration, DocPath path)
+public HtmlDocletWriter(ConfigurationImpl configuration, DocPath path) {
-throws IOException {
 super(configuration, path);
 this.configuration = configuration;
+this.contents = configuration.contents;
+this.messages = configuration.messages;
+this.resources = configuration.resources;
 this.utils = configuration.utils;
 this.path = path;
 this.pathToRoot = path.parent().invert();
 this.filename = path.basename();
 }
 * @param id id of the element to show or hide
 * @return a content tree for the script
 */
 public Content getAllClassesLinkScript(String id) {
 HtmlTree script = HtmlTree.SCRIPT();
-String scriptCode = "<!--" + DocletConstants.NL +
+String scriptCode = "<!--\n" +
-"  allClassesLink = document.getElementById(\"" + id + "\");" + DocletConstants.NL +
+"  allClassesLink = document.getElementById(\"" + id + "\");\n" +
-"  if(window==top) {" + DocletConstants.NL +
+"  if(window==top) {\n" +
-"    allClassesLink.style.display = \"block\";" + DocletConstants.NL +
+"    allClassesLink.style.display = \"block\";\n" +
-"  }" + DocletConstants.NL +
+"  }\n" +
-"  else {" + DocletConstants.NL +
+"  else {\n" +
-"    allClassesLink.style.display = \"none\";" + DocletConstants.NL +
+"    allClassesLink.style.display = \"none\";\n" +
-"  }" + DocletConstants.NL +
+"  }\n" +
-"  //-->" + DocletConstants.NL;
+"  //-->\n";
-Content scriptContent = new RawHtml(scriptCode);
+Content scriptContent = new RawHtml(scriptCode.replace("\n", DocletConstants.NL));
 script.addContent(scriptContent);
 Content div = HtmlTree.DIV(script);
-Content div_noscript = HtmlTree.DIV(getResource("doclet.No_Script_Message"));
+Content div_noscript = HtmlTree.DIV(contents.noScriptMessage);
 Content noScript = HtmlTree.NOSCRIPT(div_noscript);
 div.addContent(noScript);
 return div;
 }
 tr.addStyle(altColor ? HtmlStyle.altColor : HtmlStyle.rowColor);
 altColor = !altColor;
 HtmlTree tdClassDescription = new HtmlTree(HtmlTag.TD);
 tdClassDescription.addStyle(HtmlStyle.colLast);
 if (utils.isDeprecated(te)) {
-tdClassDescription.addContent(deprecatedLabel);
+tdClassDescription.addContent(contents.deprecatedLabel);
 List<? extends DocTree> tags = utils.getDeprecatedTrees(te);
 if (!tags.isEmpty()) {
 addSummaryDeprecatedComment(te, tags.get(0), tdClassDescription);
 }
 } else {
 ? HtmlTree.NAV()
 : htmlTree;
 String allClassesId = "allclasses_";
 HtmlTree navDiv = new HtmlTree(HtmlTag.DIV);
 fixedNavDiv.addStyle(HtmlStyle.fixedNav);
-Content skipNavLinks = configuration.getResource("doclet.Skip_navigation_links");
+Content skipNavLinks = configuration.getContent("doclet.Skip_navigation_links");
 if (header) {
 fixedNavDiv.addContent(HtmlConstants.START_OF_TOP_NAVBAR);
 navDiv.addStyle(HtmlStyle.topNav);
 allClassesId += "navbar_top";
 Content a = getMarkerAnchor(SectionName.NAVBAR_TOP);
 ulAllClasses.addAttr(HtmlAttr.ID, allClassesId);
 subDiv.addContent(ulAllClasses);
 if (header && configuration.createindex) {
 HtmlTree inputText = HtmlTree.INPUT("text", "search");
 HtmlTree inputReset = HtmlTree.INPUT("reset", "reset");
-Content searchTxt = configuration.getResource("doclet.search");
+Content searchTxt = new ContentBuilder();
-searchTxt.addContent(getSpace());
+searchTxt.addContent(configuration.getContent("doclet.search"));
+searchTxt.addContent(Contents.SPACE);
 HtmlTree liInput = HtmlTree.LI(HtmlTree.SPAN(searchTxt));
 liInput.addContent(inputText);
 liInput.addContent(inputReset);
 HtmlTree ulSearch = HtmlTree.UL(HtmlStyle.navListSearch, liInput);
 subDiv.addContent(ulSearch);
 if (header) {
 subDiv.addContent(getMarkerAnchor(SectionName.SKIP_NAVBAR_TOP));
 fixedNavDiv.addContent(subDiv);
 fixedNavDiv.addContent(HtmlConstants.END_OF_TOP_NAVBAR);
 tree.addContent(fixedNavDiv);
-HtmlTree paddingDiv = HtmlTree.DIV(HtmlStyle.navPadding, getSpace());
+HtmlTree paddingDiv = HtmlTree.DIV(HtmlStyle.navPadding, Contents.SPACE);
 tree.addContent(paddingDiv);
 } else {
 subDiv.addContent(getMarkerAnchor(SectionName.SKIP_NAVBAR_BOTTOM));
 tree.addContent(subDiv);
 tree.addContent(HtmlConstants.END_OF_BOTTOM_NAVBAR);
 *
 * @return a content tree for the link
 */
 protected Content getNavLinkContents() {
 Content linkContent = getHyperLink(pathToRoot.resolve(DocPaths.OVERVIEW_SUMMARY),
-overviewLabel, "", "");
+contents.overviewLabel, "", "");
 Content li = HtmlTree.LI(linkContent);
 return li;
 }
 /**
 *
 * @param mdle Module to which link will be generated
 * @return a content tree for the link
 */
 protected Content getNavLinkModule(ModuleElement mdle) {
-Content linkContent = getModuleLink(mdle, moduleLabel);
+Content linkContent = getModuleLink(mdle, contents.moduleLabel);
 Content li = HtmlTree.LI(linkContent);
 return li;
 }
 /**
 * Get the word "Module", to indicate that link is not available here.
 *
 * @return a content tree for the link
 */
 protected Content getNavLinkModule() {
-Content li = HtmlTree.LI(moduleLabel);
+Content li = HtmlTree.LI(contents.moduleLabel);
 return li;
 }
 /**
 * Get link to the "package-summary.html" page for the package passed.
 *
 * @param pkg Package to which link will be generated
 * @return a content tree for the link
 */
 protected Content getNavLinkPackage(PackageElement pkg) {
-Content linkContent = getPackageLink(pkg, packageLabel);
+Content linkContent = getPackageLink(pkg, contents.packageLabel);
 Content li = HtmlTree.LI(linkContent);
 return li;
 }
 /**
 * Get the word "Package" , to indicate that link is not available here.
 *
 * @return a content tree for the link
 */
 protected Content getNavLinkPackage() {
-Content li = HtmlTree.LI(packageLabel);
+Content li = HtmlTree.LI(contents.packageLabel);
 return li;
 }
 /**
 * Get the word "Use", to indicate that link is not available.
 *
 * @return a content tree for the link
 */
 protected Content getNavLinkClassUse() {
-Content li = HtmlTree.LI(useLabel);
+Content li = HtmlTree.LI(contents.useLabel);
 return li;
 }
 /**
 * Get link for previous file.
 * @return a content tree for the link
 */
 public Content getNavLinkPrevious(DocPath prev) {
 Content li;
 if (prev != null) {
-li = HtmlTree.LI(getHyperLink(prev, prevLabel, "", ""));
+li = HtmlTree.LI(getHyperLink(prev, contents.prevLabel, "", ""));
 }
 else
-li = HtmlTree.LI(prevLabel);
+li = HtmlTree.LI(contents.prevLabel);
 return li;
 }
 /**
 * Get link for next file.  If next is null, just print the label
 * @return a content tree for the link
 */
 public Content getNavLinkNext(DocPath next) {
 Content li;
 if (next != null) {
-li = HtmlTree.LI(getHyperLink(next, nextLabel, "", ""));
+li = HtmlTree.LI(getHyperLink(next, contents.nextLabel, "", ""));
 }
 else
-li = HtmlTree.LI(nextLabel);
+li = HtmlTree.LI(contents.nextLabel);
 return li;
 }
 /**
 * Get "FRAMES" link, to switch to the frame version of the output.
 * @param link File to be linked, "index.html"
 * @return a content tree for the link
 */
 protected Content getNavShowLists(DocPath link) {
 DocLink dl = new DocLink(link, path.getPath(), null);
-Content framesContent = getHyperLink(dl, framesLabel, "", "_top");
+Content framesContent = getHyperLink(dl, contents.framesLabel, "", "_top");
 Content li = HtmlTree.LI(framesContent);
 return li;
 }
 /**
 *
 * @param link File to be linked
 * @return a content tree for the link
 */
 protected Content getNavHideLists(DocPath link) {
-Content noFramesContent = getHyperLink(link, noframesLabel, "", "_top");
+Content noFramesContent = getHyperLink(link, contents.noFramesLabel, "", "_top");
 Content li = HtmlTree.LI(noFramesContent);
 return li;
 }
 /**
 protected Content getNavLinkTree() {
 List<PackageElement> packages = new ArrayList<>(utils.getSpecifiedPackages());
 DocPath docPath = packages.size() == 1 && utils.getSpecifiedClasses().isEmpty()
 ? pathString(packages.get(0), DocPaths.PACKAGE_TREE)
 : pathToRoot.resolve(DocPaths.OVERVIEW_TREE);
-return HtmlTree.LI(getHyperLink(docPath, treeLabel, "", ""));
+return HtmlTree.LI(getHyperLink(docPath, contents.treeLabel, "", ""));
 }
 /**
 * Get the overview tree link for the main tree.
 *
 * Get the word "Class", to indicate that class link is not available.
 *
 * @return a content tree for the link
 */
 protected Content getNavLinkClass() {
-Content li = HtmlTree.LI(classLabel);
+Content li = HtmlTree.LI(contents.classLabel);
 return li;
 }
 /**
 * Get "Deprecated" API link in the navigation bar.
 *
 * @return a content tree for the link
 */
 protected Content getNavLinkDeprecated() {
 Content linkContent = getHyperLink(pathToRoot.resolve(DocPaths.DEPRECATED_LIST),
-deprecatedLabel, "", "");
+contents.deprecatedLabel, "", "");
 Content li = HtmlTree.LI(linkContent);
 return li;
 }
 /**
 * @return a content tree for the link
 */
 protected Content getNavLinkClassIndex() {
 Content allClassesContent = getHyperLink(pathToRoot.resolve(
 DocPaths.ALLCLASSES_NOFRAME),
-allclassesLabel, "", "");
+contents.allClassesLabel, "", "");
 Content li = HtmlTree.LI(allClassesContent);
 return li;
 }
 /**
 protected Content getNavLinkIndex() {
 Content linkContent = getHyperLink(pathToRoot.resolve(
 (configuration.splitindex
 ? DocPaths.INDEX_FILES.resolve(DocPaths.indexN(1))
 : DocPaths.INDEX_ALL)),
-indexLabel, "", "");
+contents.indexLabel, "", "");
 Content li = HtmlTree.LI(linkContent);
 return li;
 }
 /**
 } else {
 DocFile file = DocFile.createFileForInput(configuration, helpfile);
 helpfilenm = DocPath.create(file.getName());
 }
 Content linkContent = getHyperLink(pathToRoot.resolve(helpfilenm),
-helpLabel, "", "");
+contents.helpLabel, "", "");
 Content li = HtmlTree.LI(linkContent);
 return li;
 }
 /**
 * Add gap between navigation bar elements.
 *
 * @param liNav the content tree to which the gap will be added
 */
 protected void addNavGap(Content liNav) {
-liNav.addContent(getSpace());
+liNav.addContent(Contents.SPACE);
 liNav.addContent("|");
-liNav.addContent(getSpace());
+liNav.addContent(Contents.SPACE);
 }
 /**
 * Get summary table header.
 *
 * @param rawText the caption for the table which could be raw Html
 * @return a content tree for the caption
 */
 public Content getTableCaption(Content title) {
 Content captionSpan = HtmlTree.SPAN(title);
-Content space = getSpace();
+Content space = Contents.SPACE;
 Content tabSpan = HtmlTree.SPAN(HtmlStyle.tabEnd, space);
 Content caption = HtmlTree.CAPTION(captionSpan);
 caption.addContent(tabSpan);
 return caption;
 }
 * @param packageElement the package to check
 * @return package name content
 */
 public Content getPackageName(PackageElement packageElement) {
 return packageElement == null || packageElement.isUnnamed()
-? defaultPackageLabel
+? contents.defaultPackageLabel
 : getPackageLabel(packageElement.getQualifiedName());
 }
 /**
 * Returns a package name label.
 * @param contentTree the content tree to which the deprecated package table will be added
 */
 protected void addPackageDeprecatedAPI(SortedSet<Element> deprPkgs, String headingKey,
 String tableSummary, List<String> tableHeader, Content contentTree) {
 if (deprPkgs.size() > 0) {
-Content caption = getTableCaption(configuration.getResource(headingKey));
+Content caption = getTableCaption(configuration.getContent(headingKey));
 Content table = (configuration.isOutputHtml5())
 ? HtmlTree.TABLE(HtmlStyle.deprecatedSummary, caption)
 : HtmlTree.TABLE(HtmlStyle.deprecatedSummary, tableSummary, caption);
 table.addContent(getSummaryTableHeader(tableHeader, "col"));
 Content tbody = new HtmlTree(HtmlTag.TBODY);
 refMemName, label, false, "", !isLinkPlain)) != null) {
 // Class cross link found (possibly to a member in the class)
 return classCrossLink;
 } else {
 // No cross link found so print warning
-configuration.getDocletSpecificMsg().warning(ch.getDocTreePath(see),
+messages.warning(ch.getDocTreePath(see),
 "doclet.see.class_or_package_not_found",
 "@" + tagName,
 seetext);
 return (label.isEmpty() ? text: label);
 }
 // The current class either overrides the referenced member or
 // inherits it automatically.
 if (this instanceof ClassWriterImpl) {
 containing = ((ClassWriterImpl) this).getTypeElement();
 } else if (!utils.isPublic(containing)) {
-configuration.getDocletSpecificMsg().warning(
+messages.warning(
 ch.getDocTreePath(see), "doclet.see.class_or_package_not_accessible",
 tagName, utils.getFullyQualifiedName(containing));
 } else {
-configuration.getDocletSpecificMsg().warning(
+messages.warning(
 ch.getDocTreePath(see), "doclet.see.class_or_package_not_found",
 tagName, seetext);
 }
 }
 if (configuration.currentTypeElement != containing) {
 else {
 div = HtmlTree.DIV(HtmlStyle.block, result);
 htmltree.addContent(div);
 }
 if (tags.isEmpty()) {
-htmltree.addContent(getSpace());
+htmltree.addContent(Contents.SPACE);
 }
 }
 boolean ignoreNonInlineTag(DocTree dtree) {
 Name name = null;
 return false;
 }
 @Override @DefinedBy(Api.COMPILER_TREE)
 public Boolean visitErroneous(ErroneousTree node, Content c) {
-configuration.getDocletSpecificMsg().warning(ch.getDocTreePath(node),
+messages.warning(ch.getDocTreePath(node),
 "doclet.tag.invalid_usage", node);
 result.addContent(new RawHtml(node.toString()));
 return false;
 }

changeset 40303	96a1226aca18
parent 39670	9d1eafbf29c6
child 40500	f293dbb81a53