jdk8-mips64-public/langtools: comparison src/share/classes/com/sun/tools/doclets/formats/html/ClassUseWriter.java

-:bcbc86cc5b31
+:90af8d87741f
 * questions.
 */
 package com.sun.tools.doclets.formats.html;
-import com.sun.tools.doclets.internal.toolkit.util.*;
-import com.sun.javadoc.*;
 import java.io.*;
 import java.util.*;
+import com.sun.javadoc.*;
+import com.sun.tools.doclets.internal.toolkit.util.*;
+import com.sun.tools.doclets.formats.html.markup.*;
+import com.sun.tools.doclets.internal.toolkit.*;
 /**
 * Generate class usage information.
 *
 * @author Robert G. Field
 throw new DocletAbortException();
 }
 }
 /**
-* Print the class use list.
+* Generate the class use list.
 */
 protected void generateClassUseFile() throws IOException {
+Content body = getClassUseHeader();
-printClassUseHeader();
+HtmlTree div = new HtmlTree(HtmlTag.DIV);
+div.addStyle(HtmlStyle.classUseContainer);
 if (pkgSet.size() > 0) {
-generateClassUse();
+addClassUse(div);
 } else {
-printText("doclet.ClassUse_No.usage.of.0",
+div.addContent(getResource("doclet.ClassUse_No.usage.of.0",
-classdoc.qualifiedName());
+classdoc.qualifiedName()));
-p();
+}
-}
+body.addContent(div);
+addNavLinks(false, body);
-printClassUseFooter();
+addBottom(body);
-}
+printHtmlDocument(null, true, body);
+}
-protected void generateClassUse() throws IOException {
+/**
+* Add the class use documentation.
+*
+* @param contentTree the content tree to which the class use information will be added
+*/
+protected void addClassUse(Content contentTree) throws IOException {
+HtmlTree ul = new HtmlTree(HtmlTag.UL);
+ul.addStyle(HtmlStyle.blockList);
 if (configuration.packages.length > 1) {
-generatePackageList();
+addPackageList(ul);
-generatePackageAnnotationList();
+addPackageAnnotationList(ul);
 }
-generateClassList();
+addClassList(ul);
-}
+contentTree.addContent(ul);
+}
-protected void generatePackageList() throws IOException {
-tableIndexSummary(useTableSummary);
+/**
-tableCaptionStart();
+* Add the packages list that use the given class.
-printText("doclet.ClassUse_Packages.that.use.0",
+*
-getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_CLASS_USE_HEADER, classdoc,
+* @param contentTree the content tree to which the packages list will be added
-false)));
+*/
-tableCaptionEnd();
+protected void addPackageList(Content contentTree) throws IOException {
-summaryTableHeader(packageTableHeader, "col");
+Content table = HtmlTree.TABLE(0, 3, 0, useTableSummary,
+getTableCaption(configuration().getText(
+"doclet.ClassUse_Packages.that.use.0",
+getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_CLASS_USE_HEADER, classdoc,
+false)))));
+table.addContent(getSummaryTableHeader(packageTableHeader, "col"));
+Content tbody = new HtmlTree(HtmlTag.TBODY);
+Iterator<PackageDoc> it = pkgSet.iterator();
+for (int i = 0; it.hasNext(); i++) {
+PackageDoc pkg = it.next();
+HtmlTree tr = new HtmlTree(HtmlTag.TR);
+if (i % 2 == 0) {
+tr.addStyle(HtmlStyle.altColor);
+} else {
+tr.addStyle(HtmlStyle.rowColor);
+}
+addPackageUse(pkg, tr);
+tbody.addContent(tr);
+}
+table.addContent(tbody);
+Content li = HtmlTree.LI(HtmlStyle.blockList, table);
+contentTree.addContent(li);
+}
+/**
+* Add the package annotation list.
+*
+* @param contentTree the content tree to which the package annotation list will be added
+*/
+protected void addPackageAnnotationList(Content contentTree) throws IOException {
+if ((!classdoc.isAnnotationType()) ||
+pkgToPackageAnnotations == null ||
+pkgToPackageAnnotations.size() == 0) {
+return;
+}
+Content table = HtmlTree.TABLE(0, 3, 0, useTableSummary,
+getTableCaption(configuration().getText(
+"doclet.ClassUse_PackageAnnotation",
+getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_CLASS_USE_HEADER, classdoc,
+false)))));
+table.addContent(getSummaryTableHeader(packageTableHeader, "col"));
+Content tbody = new HtmlTree(HtmlTag.TBODY);
+Iterator<PackageDoc> it = pkgToPackageAnnotations.iterator();
+for (int i = 0; it.hasNext(); i++) {
+PackageDoc pkg = it.next();
+HtmlTree tr = new HtmlTree(HtmlTag.TR);
+if (i % 2 == 0) {
+tr.addStyle(HtmlStyle.altColor);
+} else {
+tr.addStyle(HtmlStyle.rowColor);
+}
+Content tdFirst = HtmlTree.TD(HtmlStyle.colFirst,
+getPackageLink(pkg, new StringContent(pkg.name())));
+tr.addContent(tdFirst);
+HtmlTree tdLast = new HtmlTree(HtmlTag.TD);
+tdLast.addStyle(HtmlStyle.colLast);
+if (pkg != null) {
+addSummaryComment(pkg, tdLast);
+} else {
+tdLast.addContent(getSpace());
+}
+tr.addContent(tdLast);
+tbody.addContent(tr);
+}
+table.addContent(tbody);
+Content li = HtmlTree.LI(HtmlStyle.blockList, table);
+contentTree.addContent(li);
+}
+/**
+* Add the class list that use the given class.
+*
+* @param contentTree the content tree to which the class list will be added
+*/
+protected void addClassList(Content contentTree) throws IOException {
+HtmlTree ul = new HtmlTree(HtmlTag.UL);
+ul.addStyle(HtmlStyle.blockList);
 for (Iterator<PackageDoc> it = pkgSet.iterator(); it.hasNext();) {
 PackageDoc pkg = it.next();
-generatePackageUse(pkg);
+Content li = HtmlTree.LI(HtmlStyle.blockList, getMarkerAnchor(pkg.name()));
-}
+Content link = new RawHtml(
-tableEnd();
+configuration.getText("doclet.ClassUse_Uses.of.0.in.1",
-space();
+getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_CLASS_USE_HEADER,
-p();
-}
-protected void generatePackageAnnotationList() throws IOException {
-if ((! classdoc.isAnnotationType()) ||
-pkgToPackageAnnotations == null ||
-pkgToPackageAnnotations.size() == 0)
-return;
-tableIndexSummary(useTableSummary);
-tableCaptionStart();
-printText("doclet.ClassUse_PackageAnnotation",
-getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_CLASS_USE_HEADER, classdoc,
-false)));
-tableCaptionEnd();
-summaryTableHeader(packageTableHeader, "col");
-for (Iterator<PackageDoc> it = pkgToPackageAnnotations.iterator(); it.hasNext();) {
-PackageDoc pkg = it.next();
-trBgcolorStyle("white", "TableRowColor");
-summaryRow(0);
-//Just want an anchor here.
-printPackageLink(pkg, pkg.name(), true);
-summaryRowEnd();
-summaryRow(0);
-printSummaryComment(pkg);
-space();
-summaryRowEnd();
-trEnd();
-}
-tableEnd();
-space();
-p();
-}
-protected void generateClassList() throws IOException {
-for (Iterator<PackageDoc> it = pkgSet.iterator(); it.hasNext();) {
-PackageDoc pkg = it.next();
-anchor(pkg.name());
-tableIndexSummary();
-tableHeaderStart("#CCCCFF");
-printText("doclet.ClassUse_Uses.of.0.in.1",
-getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_CLASS_USE_HEADER,
 classdoc, false)),
-getPackageLink(pkg, Util.getPackageName(pkg), false));
+getPackageLinkString(pkg, Util.getPackageName(pkg), false)));
-tableHeaderEnd();
+Content heading = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING, link);
-tableEnd();
+li.addContent(heading);
-space();
+addClassUse(pkg, li);
-p();
+ul.addContent(li);
-generateClassUse(pkg);
+}
-}
+Content li = HtmlTree.LI(HtmlStyle.blockList, ul);
-}
+contentTree.addContent(li);
+}
-/**
-* Print the package use list.
+/**
-*/
+* Add the package use information.
-protected void generatePackageUse(PackageDoc pkg) throws IOException {
+*
-trBgcolorStyle("white", "TableRowColor");
+* @param pkg the package that uses the given class
-summaryRow(0);
+* @param contentTree the content tree to which the package use information will be added
-//Just want an anchor here.
+*/
-printHyperLink("", pkg.name(), Util.getPackageName(pkg), true);
+protected void addPackageUse(PackageDoc pkg, Content contentTree) throws IOException {
-summaryRowEnd();
+Content tdFirst = HtmlTree.TD(HtmlStyle.colFirst,
-summaryRow(0);
+getHyperLink("", pkg.name(), new StringContent(Util.getPackageName(pkg))));
-printSummaryComment(pkg);
+contentTree.addContent(tdFirst);
-space();
+HtmlTree tdLast = new HtmlTree(HtmlTag.TD);
-summaryRowEnd();
+tdLast.addStyle(HtmlStyle.colLast);
-trEnd();
+if (pkg != null)
-}
+addSummaryComment(pkg, tdLast);
+else
-/**
+tdLast.addContent(getSpace());
-* Print the class use list.
+contentTree.addContent(tdLast);
-*/
+}
-protected void generateClassUse(PackageDoc pkg) throws IOException {
+/**
+* Add the class use information.
+*
+* @param pkg the package that uses the given class
+* @param contentTree the content tree to which the class use information will be added
+*/
+protected void addClassUse(PackageDoc pkg, Content contentTree) throws IOException {
 String classLink = getLink(new LinkInfoImpl(
 LinkInfoImpl.CONTEXT_CLASS_USE_HEADER, classdoc, false));
-String pkgLink = getPackageLink(pkg, Util.getPackageName(pkg), false);
+String pkgLink = getPackageLinkString(pkg, Util.getPackageName(pkg), false);
-classSubWriter.printUseInfo(pkgToClassAnnotations.get(pkg.name()),
+classSubWriter.addUseInfo(pkgToClassAnnotations.get(pkg.name()),
 configuration.getText("doclet.ClassUse_Annotation", classLink,
-pkgLink), classUseTableSummary);
+pkgLink), classUseTableSummary, contentTree);
-classSubWriter.printUseInfo(pkgToClassTypeParameter.get(pkg.name()),
+classSubWriter.addUseInfo(pkgToClassTypeParameter.get(pkg.name()),
 configuration.getText("doclet.ClassUse_TypeParameter", classLink,
-pkgLink), classUseTableSummary);
+pkgLink), classUseTableSummary, contentTree);
-classSubWriter.printUseInfo(pkgToSubclass.get(pkg.name()),
+classSubWriter.addUseInfo(pkgToSubclass.get(pkg.name()),
 configuration.getText("doclet.ClassUse_Subclass", classLink,
-pkgLink), subclassUseTableSummary);
+pkgLink), subclassUseTableSummary, contentTree);
-classSubWriter.printUseInfo(pkgToSubinterface.get(pkg.name()),
+classSubWriter.addUseInfo(pkgToSubinterface.get(pkg.name()),
 configuration.getText("doclet.ClassUse_Subinterface", classLink,
-pkgLink), subinterfaceUseTableSummary);
+pkgLink), subinterfaceUseTableSummary, contentTree);
-classSubWriter.printUseInfo(pkgToImplementingClass.get(pkg.name()),
+classSubWriter.addUseInfo(pkgToImplementingClass.get(pkg.name()),
 configuration.getText("doclet.ClassUse_ImplementingClass", classLink,
-pkgLink), classUseTableSummary);
+pkgLink), classUseTableSummary, contentTree);
-fieldSubWriter.printUseInfo(pkgToField.get(pkg.name()),
+fieldSubWriter.addUseInfo(pkgToField.get(pkg.name()),
 configuration.getText("doclet.ClassUse_Field", classLink,
-pkgLink), fieldUseTableSummary);
+pkgLink), fieldUseTableSummary, contentTree);
-fieldSubWriter.printUseInfo(pkgToFieldAnnotations.get(pkg.name()),
+fieldSubWriter.addUseInfo(pkgToFieldAnnotations.get(pkg.name()),
 configuration.getText("doclet.ClassUse_FieldAnnotations", classLink,
-pkgLink), fieldUseTableSummary);
+pkgLink), fieldUseTableSummary, contentTree);
-fieldSubWriter.printUseInfo(pkgToFieldTypeParameter.get(pkg.name()),
+fieldSubWriter.addUseInfo(pkgToFieldTypeParameter.get(pkg.name()),
 configuration.getText("doclet.ClassUse_FieldTypeParameter", classLink,
-pkgLink), fieldUseTableSummary);
+pkgLink), fieldUseTableSummary, contentTree);
-methodSubWriter.printUseInfo(pkgToMethodAnnotations.get(pkg.name()),
+methodSubWriter.addUseInfo(pkgToMethodAnnotations.get(pkg.name()),
 configuration.getText("doclet.ClassUse_MethodAnnotations", classLink,
-pkgLink), methodUseTableSummary);
+pkgLink), methodUseTableSummary, contentTree);
-methodSubWriter.printUseInfo(pkgToMethodParameterAnnotations.get(pkg.name()),
+methodSubWriter.addUseInfo(pkgToMethodParameterAnnotations.get(pkg.name()),
 configuration.getText("doclet.ClassUse_MethodParameterAnnotations", classLink,
-pkgLink), methodUseTableSummary);
+pkgLink), methodUseTableSummary, contentTree);
-methodSubWriter.printUseInfo(pkgToMethodTypeParameter.get(pkg.name()),
+methodSubWriter.addUseInfo(pkgToMethodTypeParameter.get(pkg.name()),
 configuration.getText("doclet.ClassUse_MethodTypeParameter", classLink,
-pkgLink), methodUseTableSummary);
+pkgLink), methodUseTableSummary, contentTree);
-methodSubWriter.printUseInfo(pkgToMethodReturn.get(pkg.name()),
+methodSubWriter.addUseInfo(pkgToMethodReturn.get(pkg.name()),
 configuration.getText("doclet.ClassUse_MethodReturn", classLink,
-pkgLink), methodUseTableSummary);
+pkgLink), methodUseTableSummary, contentTree);
-methodSubWriter.printUseInfo(pkgToMethodReturnTypeParameter.get(pkg.name()),
+methodSubWriter.addUseInfo(pkgToMethodReturnTypeParameter.get(pkg.name()),
 configuration.getText("doclet.ClassUse_MethodReturnTypeParameter", classLink,
-pkgLink), methodUseTableSummary);
+pkgLink), methodUseTableSummary, contentTree);
-methodSubWriter.printUseInfo(pkgToMethodArgs.get(pkg.name()),
+methodSubWriter.addUseInfo(pkgToMethodArgs.get(pkg.name()),
 configuration.getText("doclet.ClassUse_MethodArgs", classLink,
-pkgLink), methodUseTableSummary);
+pkgLink), methodUseTableSummary, contentTree);
-methodSubWriter.printUseInfo(pkgToMethodArgTypeParameter.get(pkg.name()),
+methodSubWriter.addUseInfo(pkgToMethodArgTypeParameter.get(pkg.name()),
 configuration.getText("doclet.ClassUse_MethodArgsTypeParameters", classLink,
-pkgLink), methodUseTableSummary);
+pkgLink), methodUseTableSummary, contentTree);
-methodSubWriter.printUseInfo(pkgToMethodThrows.get(pkg.name()),
+methodSubWriter.addUseInfo(pkgToMethodThrows.get(pkg.name()),
 configuration.getText("doclet.ClassUse_MethodThrows", classLink,
-pkgLink), methodUseTableSummary);
+pkgLink), methodUseTableSummary, contentTree);
-constrSubWriter.printUseInfo(pkgToConstructorAnnotations.get(pkg.name()),
+constrSubWriter.addUseInfo(pkgToConstructorAnnotations.get(pkg.name()),
 configuration.getText("doclet.ClassUse_ConstructorAnnotations", classLink,
-pkgLink), constructorUseTableSummary);
+pkgLink), constructorUseTableSummary, contentTree);
-constrSubWriter.printUseInfo(pkgToConstructorParameterAnnotations.get(pkg.name()),
+constrSubWriter.addUseInfo(pkgToConstructorParameterAnnotations.get(pkg.name()),
 configuration.getText("doclet.ClassUse_ConstructorParameterAnnotations", classLink,
-pkgLink), constructorUseTableSummary);
+pkgLink), constructorUseTableSummary, contentTree);
-constrSubWriter.printUseInfo(pkgToConstructorArgs.get(pkg.name()),
+constrSubWriter.addUseInfo(pkgToConstructorArgs.get(pkg.name()),
 configuration.getText("doclet.ClassUse_ConstructorArgs", classLink,
-pkgLink), constructorUseTableSummary);
+pkgLink), constructorUseTableSummary, contentTree);
-constrSubWriter.printUseInfo(pkgToConstructorArgTypeParameter.get(pkg.name()),
+constrSubWriter.addUseInfo(pkgToConstructorArgTypeParameter.get(pkg.name()),
 configuration.getText("doclet.ClassUse_ConstructorArgsTypeParameters", classLink,
-pkgLink), constructorUseTableSummary);
+pkgLink), constructorUseTableSummary, contentTree);
-constrSubWriter.printUseInfo(pkgToConstructorThrows.get(pkg.name()),
+constrSubWriter.addUseInfo(pkgToConstructorThrows.get(pkg.name()),
 configuration.getText("doclet.ClassUse_ConstructorThrows", classLink,
-pkgLink), constructorUseTableSummary);
+pkgLink), constructorUseTableSummary, contentTree);
 }
 /**
-* Print the header for the class use Listing.
+* Get the header for the class use Listing.
-*/
+*
-protected void printClassUseHeader() {
+* @return a content tree representing the class use header
+*/
+protected Content getClassUseHeader() {
 String cltype = configuration.getText(classdoc.isInterface()?
-"doclet.Interface":
+"doclet.Interface":"doclet.Class");
-"doclet.Class");
 String clname = classdoc.qualifiedName();
-printHtmlHeader(configuration.getText("doclet.Window_ClassUse_Header",
+String title = configuration.getText("doclet.Window_ClassUse_Header",
-cltype, clname), null, true);
+cltype, clname);
-printTop();
+Content bodyTree = getBody(true, getWindowTitle(title));
-navLinks(true);
+addTop(bodyTree);
-hr();
+addNavLinks(true, bodyTree);
-center();
+Content headContent = getResource("doclet.ClassUse_Title", cltype, clname);
-h2();
+Content heading = HtmlTree.HEADING(HtmlConstants.CLASS_PAGE_HEADING,
-strongText("doclet.ClassUse_Title", cltype, clname);
+true, HtmlStyle.title, headContent);
-h2End();
+Content div = HtmlTree.DIV(HtmlStyle.header, heading);
-centerEnd();
+bodyTree.addContent(div);
-}
+return bodyTree;
+}
-/**
-* Print the footer for the class use Listing.
+/**
-*/
+* Get this package link.
-protected void printClassUseFooter() {
+*
-hr();
+* @return a content tree for the package link
-navLinks(false);
+*/
-printBottom();
+protected Content getNavLinkPackage() {
-printBodyHtmlEnd();
+Content linkContent = getHyperLink("../package-summary.html", "",
-}
+packageLabel);
+Content li = HtmlTree.LI(linkContent);
+return li;
-/**
+}
-* Print this package link
-*/
+/**
-protected void navLinkPackage() {
+* Get class page link.
-navCellStart();
+*
-printHyperLink("../package-summary.html", "",
+* @return a content tree for the class page link
-configuration.getText("doclet.Package"), true, "NavBarFont1");
+*/
-navCellEnd();
+protected Content getNavLinkClass() {
-}
+Content linkContent = new RawHtml(getLink(new LinkInfoImpl(
+LinkInfoImpl.CONTEXT_CLASS_USE_HEADER, classdoc, "",
-/**
+configuration.getText("doclet.Class"), false)));
-* Print class page indicator
+Content li = HtmlTree.LI(linkContent);
-*/
+return li;
-protected void navLinkClass() {
+}
-navCellStart();
-printLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_CLASS_USE_HEADER, classdoc, "",
+/**
-configuration.getText("doclet.Class"), true, "NavBarFont1"));
+* Get the use link.
-navCellEnd();
+*
-}
+* @return a content tree for the use link
+*/
-/**
+protected Content getNavLinkClassUse() {
-* Print class use link
+Content li = HtmlTree.LI(HtmlStyle.navBarCell1Rev, useLabel);
-*/
+return li;
-protected void navLinkClassUse() {
+}
-navCellRevStart();
-fontStyle("NavBarFont1Rev");
+/**
-strongText("doclet.navClassUse");
+* Get the tree link.
-fontEnd();
+*
-navCellEnd();
+* @return a content tree for the tree link
-}
+*/
+protected Content getNavLinkTree() {
-protected void navLinkTree() {
+Content linkContent = classdoc.containingPackage().isIncluded() ?
-navCellStart();
+getHyperLink("../package-tree.html", "", treeLabel) :
-if (classdoc.containingPackage().isIncluded()) {
+getHyperLink(relativePath + "overview-tree.html", "", treeLabel);
-printHyperLink("../package-tree.html", "",
+Content li = HtmlTree.LI(linkContent);
-configuration.getText("doclet.Tree"), true, "NavBarFont1");
+return li;
-} else {
+}
-printHyperLink(relativePath + "overview-tree.html", "",
-configuration.getText("doclet.Tree"), true, "NavBarFont1");
-}
-navCellEnd();
-}
 }

Mercurial > jdk8-mips64-public > langtools / file comparison

comparison: src/share/classes/com/sun/tools/doclets/formats/html/ClassUseWriter.java

src/share/classes/com/sun/tools/doclets/formats/html/ClassUseWriter.java