duke@1: /*
xdono@117:  * Copyright 2001-2008 Sun Microsystems, Inc.  All Rights Reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
duke@1:  * published by the Free Software Foundation.  Sun designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
duke@1:  * by Sun in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
duke@1:  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1:  * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1:  * have any questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.doclets.formats.html;
duke@1: 
duke@1: import com.sun.tools.doclets.internal.toolkit.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1: import com.sun.javadoc.*;
duke@1: import java.io.*;
duke@1: import java.util.*;
duke@1: 
duke@1: /**
duke@1:  * Write the Constants Summary Page in HTML format.
duke@1:  *
duke@1:  * @author Jamie Ho
duke@1:  * @since 1.4
duke@1:  */
duke@1: public class ConstantsSummaryWriterImpl extends HtmlDocletWriter
duke@1:         implements ConstantsSummaryWriter {
duke@1: 
duke@1:     /**
duke@1:      * The configuration used in this run of the standard doclet.
duke@1:      */
duke@1:     ConfigurationImpl configuration;
duke@1: 
duke@1:     /**
duke@1:      * The current class being documented.
duke@1:      */
duke@1:     private ClassDoc currentClassDoc;
duke@1: 
duke@1:     /**
duke@1:      * Construct a ConstantsSummaryWriter.
duke@1:      * @param configuration the configuration used in this run
duke@1:      *        of the standard doclet.
duke@1:      */
duke@1:     public ConstantsSummaryWriterImpl(ConfigurationImpl configuration)
duke@1:             throws IOException {
duke@1:         super(configuration, ConfigurationImpl.CONSTANTS_FILE_NAME);
duke@1:         this.configuration = configuration;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeHeader() {
duke@1:         printHtmlHeader(configuration.getText("doclet.Constants_Summary"),
duke@1:             null, true);
duke@1:         printTop();
duke@1:         navLinks(true);
duke@1:         hr();
duke@1: 
duke@1:         center();
duke@1:         h1(); printText("doclet.Constants_Summary"); h1End();
duke@1:         centerEnd();
duke@1: 
duke@1:         hr(4, "noshade");
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeFooter() {
duke@1:         hr();
duke@1:         navLinks(false);
duke@1:         printBottom();
duke@1:         printBodyHtmlEnd();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeContentsHeader() {
bpatel@182:         strong(configuration.getText("doclet.Contents"));
duke@1:         ul();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeContentsFooter() {
duke@1:         ulEnd();
duke@1:         println();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
jjg@74:     public void writeLinkToPackageContent(PackageDoc pkg, String parsedPackageName, Set<String> printedPackageHeaders) {
duke@1:         String packageName = pkg.name();
duke@1:         //add link to summary
duke@1:         li();
duke@1:         if (packageName.length() == 0) {
duke@1:             printHyperLink("#" + DocletConstants.UNNAMED_PACKAGE_ANCHOR,
duke@1:                            DocletConstants.DEFAULT_PACKAGE_NAME);
duke@1:         } else {
duke@1:             printHyperLink("#" + parsedPackageName, parsedPackageName + ".*");
duke@1:             printedPackageHeaders.add(parsedPackageName);
duke@1:         }
duke@1:         println();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeConstantMembersHeader(ClassDoc cd) {
duke@1:         //generate links backward only to public classes.
duke@1:         String classlink = (cd.isPublic() || cd.isProtected())?
duke@1:             getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_CONSTANT_SUMMARY, cd,
duke@1:                 false)) :
duke@1:             cd.qualifiedName();
duke@1:         String name = cd.containingPackage().name();
duke@1:         if (name.length() > 0) {
duke@1:             writeClassName(name + "." + classlink);
duke@1:         } else {
duke@1:             writeClassName(classlink);
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeConstantMembersFooter(ClassDoc cd) {
duke@1:         tableFooter(false);
duke@1:         p();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Print the class name in the table heading.
duke@1:      * @param classStr the heading to print.
duke@1:      */
duke@1:     protected void writeClassName(String classStr) {
duke@1:         table(1, 3, 0);
duke@1:         trBgcolorStyle("#EEEEFF", "TableSubHeadingColor");
duke@1:         thAlignColspan("left", 3);
duke@1:         write(classStr);
duke@1:         thEnd();
duke@1:         trEnd();
duke@1:     }
duke@1: 
duke@1:     private void tableFooter(boolean isHeader) {
duke@1:         fontEnd();
duke@1:         if (isHeader) {
duke@1:             thEnd();
duke@1:         } else {
duke@1:             tdEnd();
duke@1:         }
duke@1:         trEnd();
duke@1:         tableEnd();
duke@1:         p();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writePackageName(PackageDoc pkg, String parsedPackageName) {
duke@1:         String pkgname;
duke@1:         if (parsedPackageName.length() == 0) {
duke@1:             anchor(DocletConstants.UNNAMED_PACKAGE_ANCHOR);
duke@1:             pkgname = DocletConstants.DEFAULT_PACKAGE_NAME;
duke@1:         } else {
duke@1:             anchor(parsedPackageName);
duke@1:             pkgname = parsedPackageName;
duke@1:         }
duke@1:         table(1, "100%", 3, 0);
duke@1:         trBgcolorStyle("#CCCCFF", "TableHeadingColor");
duke@1:         thAlign("left");
duke@1:         font("+2");
duke@1:         write(pkgname + ".*");
duke@1:         tableFooter(true);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
mcimadamore@184:     public void writeConstantMembers(ClassDoc cd, List<FieldDoc> fields) {
duke@1:         currentClassDoc = cd;
duke@1:         for (int i = 0; i < fields.size(); ++i) {
mcimadamore@184:             writeConstantMember(fields.get(i));
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     private void writeConstantMember(FieldDoc member) {
duke@1:         trBgcolorStyle("white", "TableRowColor");
duke@1:         anchor(currentClassDoc.qualifiedName() + "." + member.name());
duke@1:         writeTypeColumn(member);
duke@1:         writeNameColumn(member);
duke@1:         writeValue(member);
duke@1:         trEnd();
duke@1:     }
duke@1: 
duke@1:     private void writeTypeColumn(FieldDoc member) {
duke@1:         tdAlign("right");
duke@1:         font("-1");
duke@1:         code();
duke@1:         StringTokenizer mods = new StringTokenizer(member.modifiers());
duke@1:         while(mods.hasMoreTokens()) {
duke@1:             print(mods.nextToken() + "&nbsp;");
duke@1:         }
duke@1:         printLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_CONSTANT_SUMMARY,
duke@1:             member.type()));
duke@1:         codeEnd();
duke@1:         fontEnd();
duke@1:         tdEnd();
duke@1:     }
duke@1: 
duke@1:     private void writeNameColumn(FieldDoc member) {
duke@1:         tdAlign("left");
duke@1:         code();
duke@1:         printDocLink(LinkInfoImpl.CONTEXT_CONSTANT_SUMMARY, member,
duke@1:             member.name(), false);
duke@1:         codeEnd();
duke@1:         tdEnd();
duke@1:     }
duke@1: 
duke@1:     private void writeValue(FieldDoc member) {
duke@1:         tdAlign("right");
duke@1:         code();
duke@1:         print(Util.escapeHtmlChars(member.constantValueExpression()));
duke@1:         codeEnd();
duke@1:         tdEnd();
duke@1:     }
duke@1: }