duke@1: /*
duke@1:  * Copyright 2003-2004 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.taglets.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1: import com.sun.javadoc.*;
duke@1: 
duke@1: import java.io.*;
duke@1: 
duke@1: /**
duke@1:  * Writes enum constant documentation in HTML format.
duke@1:  *
duke@1:  * @author Jamie Ho
duke@1:  */
duke@1: public class EnumConstantWriterImpl extends AbstractMemberWriter
duke@1:     implements EnumConstantWriter, MemberSummaryWriter {
duke@1: 
duke@1:     private boolean printedSummaryHeader = false;
duke@1: 
duke@1:     public EnumConstantWriterImpl(SubWriterHolderWriter writer,
duke@1:         ClassDoc classdoc) {
duke@1:         super(writer, classdoc);
duke@1:     }
duke@1: 
duke@1:     public EnumConstantWriterImpl(SubWriterHolderWriter writer) {
duke@1:         super(writer);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the enum constant summary header for the given class.
duke@1:      *
duke@1:      * @param classDoc the class the summary belongs to.
duke@1:      */
duke@1:     public void writeMemberSummaryHeader(ClassDoc classDoc) {
duke@1:         printedSummaryHeader = true;
duke@1:         writer.println("<!-- =========== ENUM CONSTANT SUMMARY =========== -->");
duke@1:         writer.println();
duke@1:         writer.printSummaryHeader(this, classDoc);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the enum constant summary footer for the given class.
duke@1:      *
duke@1:      * @param classDoc the class the summary belongs to.
duke@1:      */
duke@1:     public void writeMemberSummaryFooter(ClassDoc classDoc) {
duke@1:         writer.printSummaryFooter(this, classDoc);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the inherited enum constant summary header for the given class.
duke@1:      *
duke@1:      * @param classDoc the class the summary belongs to.
duke@1:      */
duke@1:     public void writeInheritedMemberSummaryHeader(ClassDoc classDoc) {
duke@1:         if(! printedSummaryHeader){
duke@1:             //We don't want inherited summary to not be under heading.
duke@1:             writeMemberSummaryHeader(classDoc);
duke@1:             writeMemberSummaryFooter(classDoc);
duke@1:             printedSummaryHeader = true;
duke@1:         }
duke@1:         writer.printInheritedSummaryHeader(this, classDoc);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeInheritedMemberSummary(ClassDoc classDoc,
duke@1:         ProgramElementDoc enumConstant, boolean isFirst, boolean isLast) {
duke@1:         writer.printInheritedSummaryMember(this, classDoc, enumConstant, isFirst);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the inherited enum constant summary footer for the given class.
duke@1:      *
duke@1:      * @param classDoc the class the summary belongs to.
duke@1:      */
duke@1:     public void writeInheritedMemberSummaryFooter(ClassDoc classDoc) {
duke@1:         writer.printInheritedSummaryFooter(this, classDoc);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeHeader(ClassDoc classDoc, String header) {
duke@1:         writer.println();
duke@1:         writer.println("<!-- ============ ENUM CONSTANT DETAIL =========== -->");
duke@1:         writer.println();
duke@1:         writer.anchor("enum_constant_detail");
duke@1:         writer.printTableHeadingBackground(header);
duke@1:         writer.println();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeEnumConstantHeader(FieldDoc enumConstant, boolean isFirst) {
duke@1:         if (! isFirst) {
duke@1:             writer.printMemberHeader();
duke@1:             writer.println("");
duke@1:         }
duke@1:         writer.anchor(enumConstant.name());
duke@1:         writer.h3();
duke@1:         writer.print(enumConstant.name());
duke@1:         writer.h3End();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeSignature(FieldDoc enumConstant) {
duke@1:         writer.pre();
duke@1:         writer.writeAnnotationInfo(enumConstant);
duke@1:         printModifiers(enumConstant);
duke@1:         writer.printLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_MEMBER,
duke@1:             enumConstant.type()));
duke@1:         print(' ');
duke@1:         if (configuration().linksource) {
duke@1:             writer.printSrcLink(enumConstant, enumConstant.name());
duke@1:         } else {
duke@1:             bold(enumConstant.name());
duke@1:         }
duke@1:         writer.preEnd();
duke@1:         writer.dl();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeDeprecated(FieldDoc enumConstant) {
duke@1:         print(((TagletOutputImpl)
duke@1:             (new DeprecatedTaglet()).getTagletOutput(enumConstant,
duke@1:             writer.getTagletWriterInstance(false))).toString());
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeComments(FieldDoc enumConstant) {
duke@1:         if (enumConstant.inlineTags().length > 0) {
duke@1:             writer.dd();
duke@1:             writer.printInlineComment(enumConstant);
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeTags(FieldDoc enumConstant) {
duke@1:         writer.printTags(enumConstant);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeEnumConstantFooter() {
duke@1:         writer.dlEnd();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeFooter(ClassDoc classDoc) {
duke@1:         //No footer to write for enum constant documentation
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void close() throws IOException {
duke@1:         writer.close();
duke@1:     }
duke@1: 
duke@1:     public int getMemberKind() {
duke@1:         return VisibleMemberMap.ENUM_CONSTANTS;
duke@1:     }
duke@1: 
duke@1:     public void printSummaryLabel(ClassDoc cd) {
duke@1:         writer.boldText("doclet.Enum_Constant_Summary");
duke@1:     }
duke@1: 
duke@1:     public void printSummaryAnchor(ClassDoc cd) {
duke@1:         writer.anchor("enum_constant_summary");
duke@1:     }
duke@1: 
duke@1:     public void printInheritedSummaryAnchor(ClassDoc cd) {
duke@1:     }   // no such
duke@1: 
duke@1:     public void printInheritedSummaryLabel(ClassDoc cd) {
duke@1:         // no such
duke@1:     }
duke@1: 
duke@1:     protected void writeSummaryLink(int context, ClassDoc cd, ProgramElementDoc member) {
duke@1:         writer.bold();
duke@1:         writer.printDocLink(context, (MemberDoc) member, member.name(), false);
duke@1:         writer.boldEnd();
duke@1:     }
duke@1: 
duke@1:     protected void writeInheritedSummaryLink(ClassDoc cd,
duke@1:             ProgramElementDoc member) {
duke@1:         writer.printDocLink(LinkInfoImpl.CONTEXT_MEMBER, (MemberDoc)member,
duke@1:             member.name(), false);
duke@1:     }
duke@1: 
duke@1:     protected void printSummaryType(ProgramElementDoc member) {
duke@1:         //Not applicable.
duke@1:     }
duke@1: 
duke@1:     protected void writeDeprecatedLink(ProgramElementDoc member) {
duke@1:         writer.printDocLink(LinkInfoImpl.CONTEXT_MEMBER,
duke@1:             (MemberDoc) member, ((FieldDoc)member).qualifiedName(), false);
duke@1:     }
duke@1: 
duke@1:     protected void printNavSummaryLink(ClassDoc cd, boolean link) {
duke@1:         if (link) {
duke@1:             writer.printHyperLink("", (cd == null)?
duke@1:                         "enum_constant_summary":
duke@1:                         "enum_constants_inherited_from_class_" +
duke@1:                         configuration().getClassName(cd),
duke@1:                     configuration().getText("doclet.navEnum"));
duke@1:         } else {
duke@1:             writer.printText("doclet.navEnum");
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     protected void printNavDetailLink(boolean link) {
duke@1:         if (link) {
duke@1:             writer.printHyperLink("", "enum_constant_detail",
duke@1:                 configuration().getText("doclet.navEnum"));
duke@1:         } else {
duke@1:             writer.printText("doclet.navEnum");
duke@1:         }
duke@1:     }
duke@1: }