diff -r 000000000000 -r 959103a6100f src/share/classes/com/sun/tools/doclets/formats/html/ConstantsSummaryWriterImpl.java
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/share/classes/com/sun/tools/doclets/formats/html/ConstantsSummaryWriterImpl.java Wed Apr 27 01:34:52 2016 +0800
@@ -0,0 +1,314 @@
+/*
+ * Copyright (c) 2001, 2013, 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 com.sun.tools.doclets.formats.html;
+
+import java.io.*;
+import java.util.*;
+
+import com.sun.javadoc.*;
+import com.sun.tools.doclets.formats.html.markup.*;
+import com.sun.tools.doclets.internal.toolkit.*;
+import com.sun.tools.doclets.internal.toolkit.util.*;
+
+/**
+ * Write the Constants Summary Page in HTML format.
+ *
+ *
This is NOT part of any supported API.
+ * If you write code that depends on this, you do so at your own risk.
+ * This code and its internal interfaces are subject to change or
+ * deletion without notice.
+ *
+ * @author Jamie Ho
+ * @author Bhavesh Patel (Modified)
+ * @since 1.4
+ */
+public class ConstantsSummaryWriterImpl extends HtmlDocletWriter
+ implements ConstantsSummaryWriter {
+
+ /**
+ * The configuration used in this run of the standard doclet.
+ */
+ ConfigurationImpl configuration;
+
+ /**
+ * The current class being documented.
+ */
+ private ClassDoc currentClassDoc;
+
+ private final String constantsTableSummary;
+
+ private final String[] constantsTableHeader;
+
+ /**
+ * Construct a ConstantsSummaryWriter.
+ * @param configuration the configuration used in this run
+ * of the standard doclet.
+ */
+ public ConstantsSummaryWriterImpl(ConfigurationImpl configuration)
+ throws IOException {
+ super(configuration, DocPaths.CONSTANT_VALUES);
+ this.configuration = configuration;
+ constantsTableSummary = configuration.getText("doclet.Constants_Table_Summary",
+ configuration.getText("doclet.Constants_Summary"));
+ constantsTableHeader = new String[] {
+ getModifierTypeHeader(),
+ configuration.getText("doclet.ConstantField"),
+ configuration.getText("doclet.Value")
+ };
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public Content getHeader() {
+ String label = configuration.getText("doclet.Constants_Summary");
+ Content bodyTree = getBody(true, getWindowTitle(label));
+ addTop(bodyTree);
+ addNavLinks(true, bodyTree);
+ return bodyTree;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public Content getContentsHeader() {
+ return new HtmlTree(HtmlTag.UL);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public void addLinkToPackageContent(PackageDoc pkg, String parsedPackageName,
+ Set printedPackageHeaders, Content contentListTree) {
+ String packageName = pkg.name();
+ //add link to summary
+ Content link;
+ if (packageName.length() == 0) {
+ link = getHyperLink(getDocLink(
+ SectionName.UNNAMED_PACKAGE_ANCHOR),
+ defaultPackageLabel, "", "");
+ } else {
+ Content packageNameContent = getPackageLabel(parsedPackageName);
+ packageNameContent.addContent(".*");
+ link = getHyperLink(DocLink.fragment(parsedPackageName),
+ packageNameContent, "", "");
+ printedPackageHeaders.add(parsedPackageName);
+ }
+ contentListTree.addContent(HtmlTree.LI(link));
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public Content getContentsList(Content contentListTree) {
+ Content titleContent = getResource(
+ "doclet.Constants_Summary");
+ Content pHeading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, true,
+ HtmlStyle.title, titleContent);
+ Content div = HtmlTree.DIV(HtmlStyle.header, pHeading);
+ Content headingContent = getResource(
+ "doclet.Contents");
+ div.addContent(HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, true,
+ headingContent));
+ div.addContent(contentListTree);
+ return div;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public Content getConstantSummaries() {
+ HtmlTree summariesDiv = new HtmlTree(HtmlTag.DIV);
+ summariesDiv.addStyle(HtmlStyle.constantValuesContainer);
+ return summariesDiv;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public void addPackageName(PackageDoc pkg, String parsedPackageName,
+ Content summariesTree) {
+ Content pkgNameContent;
+ if (parsedPackageName.length() == 0) {
+ summariesTree.addContent(getMarkerAnchor(
+ SectionName.UNNAMED_PACKAGE_ANCHOR));
+ pkgNameContent = defaultPackageLabel;
+ } else {
+ summariesTree.addContent(getMarkerAnchor(
+ parsedPackageName));
+ pkgNameContent = getPackageLabel(parsedPackageName);
+ }
+ Content headingContent = new StringContent(".*");
+ Content heading = HtmlTree.HEADING(HtmlConstants.PACKAGE_HEADING, true,
+ pkgNameContent);
+ heading.addContent(headingContent);
+ summariesTree.addContent(heading);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public Content getClassConstantHeader() {
+ HtmlTree ul = new HtmlTree(HtmlTag.UL);
+ ul.addStyle(HtmlStyle.blockList);
+ return ul;
+ }
+
+ /**
+ * Get the table caption and header for the constant summary table
+ *
+ * @param cd classdoc to be documented
+ * @return constant members header content
+ */
+ public Content getConstantMembersHeader(ClassDoc cd) {
+ //generate links backward only to public classes.
+ Content classlink = (cd.isPublic() || cd.isProtected()) ?
+ getLink(new LinkInfoImpl(configuration,
+ LinkInfoImpl.Kind.CONSTANT_SUMMARY, cd)) :
+ new StringContent(cd.qualifiedName());
+ String name = cd.containingPackage().name();
+ if (name.length() > 0) {
+ Content cb = new ContentBuilder();
+ cb.addContent(name);
+ cb.addContent(".");
+ cb.addContent(classlink);
+ return getClassName(cb);
+ } else {
+ return getClassName(classlink);
+ }
+ }
+
+ /**
+ * Get the class name in the table caption and the table header.
+ *
+ * @param classStr the class name to print.
+ * @return the table caption and header
+ */
+ protected Content getClassName(Content classStr) {
+ Content table = HtmlTree.TABLE(HtmlStyle.constantsSummary, 0, 3, 0, constantsTableSummary,
+ getTableCaption(classStr));
+ table.addContent(getSummaryTableHeader(constantsTableHeader, "col"));
+ return table;
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public void addConstantMembers(ClassDoc cd, List fields,
+ Content classConstantTree) {
+ currentClassDoc = cd;
+ Content tbody = new HtmlTree(HtmlTag.TBODY);
+ for (int i = 0; i < fields.size(); ++i) {
+ HtmlTree tr = new HtmlTree(HtmlTag.TR);
+ if (i%2 == 0)
+ tr.addStyle(HtmlStyle.altColor);
+ else
+ tr.addStyle(HtmlStyle.rowColor);
+ addConstantMember(fields.get(i), tr);
+ tbody.addContent(tr);
+ }
+ Content table = getConstantMembersHeader(cd);
+ table.addContent(tbody);
+ Content li = HtmlTree.LI(HtmlStyle.blockList, table);
+ classConstantTree.addContent(li);
+ }
+
+ /**
+ * Add the row for the constant summary table.
+ *
+ * @param member the field to be documented.
+ * @param trTree an htmltree object for the table row
+ */
+ private void addConstantMember(FieldDoc member, HtmlTree trTree) {
+ trTree.addContent(getTypeColumn(member));
+ trTree.addContent(getNameColumn(member));
+ trTree.addContent(getValue(member));
+ }
+
+ /**
+ * Get the type column for the constant summary table row.
+ *
+ * @param member the field to be documented.
+ * @return the type column of the constant table row
+ */
+ private Content getTypeColumn(FieldDoc member) {
+ Content anchor = getMarkerAnchor(currentClassDoc.qualifiedName() +
+ "." + member.name());
+ Content tdType = HtmlTree.TD(HtmlStyle.colFirst, anchor);
+ Content code = new HtmlTree(HtmlTag.CODE);
+ StringTokenizer mods = new StringTokenizer(member.modifiers());
+ while(mods.hasMoreTokens()) {
+ Content modifier = new StringContent(mods.nextToken());
+ code.addContent(modifier);
+ code.addContent(getSpace());
+ }
+ Content type = getLink(new LinkInfoImpl(configuration,
+ LinkInfoImpl.Kind.CONSTANT_SUMMARY, member.type()));
+ code.addContent(type);
+ tdType.addContent(code);
+ return tdType;
+ }
+
+ /**
+ * Get the name column for the constant summary table row.
+ *
+ * @param member the field to be documented.
+ * @return the name column of the constant table row
+ */
+ private Content getNameColumn(FieldDoc member) {
+ Content nameContent = getDocLink(
+ LinkInfoImpl.Kind.CONSTANT_SUMMARY, member, member.name(), false);
+ Content code = HtmlTree.CODE(nameContent);
+ return HtmlTree.TD(code);
+ }
+
+ /**
+ * Get the value column for the constant summary table row.
+ *
+ * @param member the field to be documented.
+ * @return the value column of the constant table row
+ */
+ private Content getValue(FieldDoc member) {
+ Content valueContent = new StringContent(member.constantValueExpression());
+ Content code = HtmlTree.CODE(valueContent);
+ return HtmlTree.TD(HtmlStyle.colLast, code);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public void addFooter(Content contentTree) {
+ addNavLinks(false, contentTree);
+ addBottom(contentTree);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public void printDocument(Content contentTree) throws IOException {
+ printHtmlDocument(null, true, contentTree);
+ }
+}