duke@1: /*
ohair@554:  * Copyright (c) 1997, 2004, Oracle and/or its affiliates. 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
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle 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:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.doclets.formats.html;
duke@1: 
bpatel@233: import java.io.*;
bpatel@233: 
bpatel@233: import com.sun.javadoc.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1: 
duke@1: /**
duke@1:  * Writes field documentation in HTML format.
duke@1:  *
duke@1:  * @author Robert Field
duke@1:  * @author Atul M Dambalkar
duke@1:  * @author Jamie Ho (rewrite)
bpatel@243:  * @author Bhavesh Patel (Modified)
duke@1:  */
duke@1: public class FieldWriterImpl extends AbstractMemberWriter
duke@1:     implements FieldWriter, MemberSummaryWriter {
duke@1: 
duke@1:     private boolean printedSummaryHeader = false;
duke@1: 
duke@1:     public FieldWriterImpl(SubWriterHolderWriter writer, ClassDoc classdoc) {
duke@1:         super(writer, classdoc);
duke@1:     }
duke@1: 
duke@1:     public FieldWriterImpl(SubWriterHolderWriter writer) {
duke@1:         super(writer);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the fields 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("<!-- =========== FIELD SUMMARY =========== -->");
duke@1:         writer.println();
duke@1:         writer.printSummaryHeader(this, classDoc);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the fields 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.tableEnd();
duke@1:         writer.space();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the inherited fields 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 field, boolean isFirst, boolean isLast) {
duke@1:         writer.printInheritedSummaryMember(this, classDoc, field, isFirst);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the inherited fields 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:      * Write the header for the field documentation.
duke@1:      *
duke@1:      * @param classDoc the class that the fields belong to.
duke@1:      */
duke@1:     public void writeHeader(ClassDoc classDoc, String header) {
duke@1:         writer.println();
duke@1:         writer.println("<!-- ============ FIELD DETAIL =========== -->");
duke@1:         writer.println();
duke@1:         writer.anchor("field_detail");
duke@1:         writer.printTableHeadingBackground(header);
duke@1:         writer.println();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the field header for the given field.
duke@1:      *
duke@1:      * @param field the field being documented.
duke@1:      * @param isFirst the flag to indicate whether or not the field is the
duke@1:      *        first to be documented.
duke@1:      */
duke@1:     public void writeFieldHeader(FieldDoc field, boolean isFirst) {
duke@1:         if (! isFirst) {
duke@1:             writer.printMemberHeader();
duke@1:             writer.println("");
duke@1:         }
duke@1:         writer.anchor(field.name());
duke@1:         writer.h3();
duke@1:         writer.print(field.name());
duke@1:         writer.h3End();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the signature for the given field.
duke@1:      *
duke@1:      * @param field the field being documented.
duke@1:      */
duke@1:     public void writeSignature(FieldDoc field) {
duke@1:         writer.pre();
duke@1:         writer.writeAnnotationInfo(field);
duke@1:         printModifiers(field);
duke@1:         writer.printLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_MEMBER,
duke@1:             field.type()));
duke@1:         print(' ');
duke@1:         if (configuration().linksource) {
duke@1:             writer.printSrcLink(field, field.name());
duke@1:         } else {
bpatel@182:             strong(field.name());
duke@1:         }
duke@1:         writer.preEnd();
bpatel@233:         assert !writer.getMemberDetailsListPrinted();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the deprecated output for the given field.
duke@1:      *
duke@1:      * @param field the field being documented.
duke@1:      */
duke@1:     public void writeDeprecated(FieldDoc field) {
bpatel@233:         printDeprecated(field);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the comments for the given field.
duke@1:      *
duke@1:      * @param field the field being documented.
duke@1:      */
duke@1:     public void writeComments(FieldDoc field) {
duke@1:         ClassDoc holder = field.containingClass();
duke@1:         if (field.inlineTags().length > 0) {
bpatel@233:             writer.printMemberDetailsListStartTag();
duke@1:             if (holder.equals(classdoc) ||
duke@1:                 (! (holder.isPublic() || Util.isLinkable(holder, configuration())))) {
duke@1:                 writer.dd();
duke@1:                 writer.printInlineComment(field);
bpatel@233:                 writer.ddEnd();
duke@1:             } else {
duke@1:                 String classlink = writer.codeText(
duke@1:                     writer.getDocLink(LinkInfoImpl.CONTEXT_FIELD_DOC_COPY,
duke@1:                         holder, field,
duke@1:                         holder.isIncluded() ?
duke@1:                             holder.typeName() : holder.qualifiedTypeName(),
duke@1:                         false));
duke@1:                 writer.dd();
bpatel@182:                 writer.strong(configuration().getText(holder.isClass()?
duke@1:                    "doclet.Description_From_Class" :
duke@1:                     "doclet.Description_From_Interface", classlink));
duke@1:                 writer.ddEnd();
duke@1:                 writer.dd();
duke@1:                 writer.printInlineComment(field);
bpatel@233:                 writer.ddEnd();
duke@1:             }
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the tag output for the given field.
duke@1:      *
duke@1:      * @param field the field being documented.
duke@1:      */
duke@1:     public void writeTags(FieldDoc field) {
duke@1:         writer.printTags(field);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the field footer.
duke@1:      */
duke@1:     public void writeFieldFooter() {
bpatel@233:         printMemberFooter();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the footer for the field documentation.
duke@1:      *
duke@1:      * @param classDoc the class that the fields belong to.
duke@1:      */
duke@1:     public void writeFooter(ClassDoc classDoc) {
duke@1:         //No footer to write for field documentation
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Close the writer.
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.FIELDS;
duke@1:     }
duke@1: 
bpatel@243:     public void printSummaryLabel() {
bpatel@243:         writer.printText("doclet.Field_Summary");
bpatel@243:     }
bpatel@243: 
bpatel@243:     public void printTableSummary() {
bpatel@243:         writer.tableIndexSummary(configuration().getText("doclet.Member_Table_Summary",
bpatel@243:                 configuration().getText("doclet.Field_Summary"),
bpatel@243:                 configuration().getText("doclet.fields")));
bpatel@243:     }
bpatel@243: 
bpatel@243:     public void printSummaryTableHeader(ProgramElementDoc member) {
bpatel@243:         String[] header = new String[] {
bpatel@243:             writer.getModifierTypeHeader(),
bpatel@243:             configuration().getText("doclet.0_and_1",
bpatel@243:                     configuration().getText("doclet.Field"),
bpatel@243:                     configuration().getText("doclet.Description"))
bpatel@243:         };
bpatel@243:         writer.summaryTableHeader(header, "col");
duke@1:     }
duke@1: 
duke@1:     public void printSummaryAnchor(ClassDoc cd) {
duke@1:         writer.anchor("field_summary");
duke@1:     }
duke@1: 
duke@1:     public void printInheritedSummaryAnchor(ClassDoc cd) {
duke@1:         writer.anchor("fields_inherited_from_class_" + configuration().getClassName(cd));
duke@1:     }
duke@1: 
duke@1:     public void printInheritedSummaryLabel(ClassDoc cd) {
duke@1:         String classlink = writer.getPreQualifiedClassLink(
duke@1:             LinkInfoImpl.CONTEXT_MEMBER, cd, false);
bpatel@182:         writer.strong();
duke@1:         String key = cd.isClass()?
duke@1:             "doclet.Fields_Inherited_From_Class" :
duke@1:             "doclet.Fields_Inherited_From_Interface";
duke@1:         writer.printText(key, classlink);
bpatel@182:         writer.strongEnd();
duke@1:     }
duke@1: 
duke@1:     protected void writeSummaryLink(int context, ClassDoc cd, ProgramElementDoc member) {
bpatel@182:         writer.strong();
duke@1:         writer.printDocLink(context, cd , (MemberDoc) member, member.name(), false);
bpatel@182:         writer.strongEnd();
duke@1:     }
duke@1: 
duke@1:     protected void writeInheritedSummaryLink(ClassDoc cd,
duke@1:             ProgramElementDoc member) {
duke@1:         writer.printDocLink(LinkInfoImpl.CONTEXT_MEMBER, cd, (MemberDoc)member,
duke@1:             member.name(), false);
duke@1:     }
duke@1: 
duke@1:     protected void printSummaryType(ProgramElementDoc member) {
duke@1:         FieldDoc field = (FieldDoc)member;
duke@1:         printModifierAndType(field, field.type());
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:                         "field_summary":
duke@1:                         "fields_inherited_from_class_" +
duke@1:                         configuration().getClassName(cd),
duke@1:                     configuration().getText("doclet.navField"));
duke@1:         } else {
duke@1:             writer.printText("doclet.navField");
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     protected void printNavDetailLink(boolean link) {
duke@1:         if (link) {
duke@1:             writer.printHyperLink("", "field_detail",
duke@1:                 configuration().getText("doclet.navField"));
duke@1:         } else {
duke@1:             writer.printText("doclet.navField");
duke@1:         }
duke@1:     }
duke@1: }