duke@1: /*
ohair@798:  * Copyright (c) 1997, 2010, 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.*;
bpatel@766: import com.sun.tools.doclets.formats.html.markup.*;
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:     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:     /**
bpatel@766:      * {@inheritDoc}
duke@1:      */
bpatel@766:     public Content getMemberSummaryHeader(ClassDoc classDoc,
bpatel@766:             Content memberSummaryTree) {
bpatel@766:         memberSummaryTree.addContent(HtmlConstants.START_OF_FIELD_SUMMARY);
bpatel@766:         Content memberTree = writer.getMemberTreeHeader();
bpatel@766:         writer.addSummaryHeader(this, classDoc, memberTree);
bpatel@766:         return memberTree;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
bpatel@766:     public Content getFieldDetailsTreeHeader(ClassDoc classDoc,
bpatel@766:             Content memberDetailsTree) {
bpatel@766:         memberDetailsTree.addContent(HtmlConstants.START_OF_FIELD_DETAILS);
bpatel@766:         Content fieldDetailsTree = writer.getMemberTreeHeader();
bpatel@766:         fieldDetailsTree.addContent(writer.getMarkerAnchor("field_detail"));
bpatel@766:         Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING,
bpatel@766:                 writer.fieldDetailsLabel);
bpatel@766:         fieldDetailsTree.addContent(heading);
bpatel@766:         return fieldDetailsTree;
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * {@inheritDoc}
duke@1:      */
bpatel@766:     public Content getFieldDocTreeHeader(FieldDoc field,
bpatel@766:             Content fieldDetailsTree) {
bpatel@766:         fieldDetailsTree.addContent(
bpatel@766:                 writer.getMarkerAnchor(field.name()));
bpatel@766:         Content fieldDocTree = writer.getMemberTreeHeader();
bpatel@766:         Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING);
bpatel@766:         heading.addContent(field.name());
bpatel@766:         fieldDocTree.addContent(heading);
bpatel@766:         return fieldDocTree;
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * {@inheritDoc}
duke@1:      */
bpatel@766:     public Content getSignature(FieldDoc field) {
bpatel@766:         Content pre = new HtmlTree(HtmlTag.PRE);
bpatel@766:         writer.addAnnotationInfo(field, pre);
bpatel@766:         addModifiers(field, pre);
bpatel@766:         Content fieldlink = new RawHtml(writer.getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_MEMBER,
bpatel@766:                 field.type())));
bpatel@766:         pre.addContent(fieldlink);
bpatel@766:         pre.addContent(" ");
bpatel@766:         if (configuration().linksource) {
bpatel@766:             Content fieldName = new StringContent(field.name());
bpatel@766:             writer.addSrcLink(field, fieldName, pre);
bpatel@766:         } else {
bpatel@766:             addName(field.name(), pre);
bpatel@766:         }
bpatel@766:         return pre;
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * {@inheritDoc}
duke@1:      */
bpatel@766:     public void addDeprecated(FieldDoc field, Content fieldDocTree) {
bpatel@766:         addDeprecatedInfo(field, fieldDocTree);
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * {@inheritDoc}
duke@1:      */
bpatel@766:     public void addComments(FieldDoc field, Content fieldDocTree) {
duke@1:         ClassDoc holder = field.containingClass();
duke@1:         if (field.inlineTags().length > 0) {
duke@1:             if (holder.equals(classdoc) ||
bpatel@766:                     (! (holder.isPublic() || Util.isLinkable(holder, configuration())))) {
bpatel@766:                 writer.addInlineComment(field, fieldDocTree);
duke@1:             } else {
bpatel@766:                 Content link = new RawHtml(
bpatel@766:                         writer.getDocLink(LinkInfoImpl.CONTEXT_FIELD_DOC_COPY,
duke@1:                         holder, field,
duke@1:                         holder.isIncluded() ?
duke@1:                             holder.typeName() : holder.qualifiedTypeName(),
bpatel@766:                             false));
bpatel@766:                 Content codeLink = HtmlTree.CODE(link);
bpatel@766:                 Content strong = HtmlTree.STRONG(holder.isClass()?
bpatel@766:                    writer.descfrmClassLabel : writer.descfrmInterfaceLabel);
bpatel@766:                 strong.addContent(writer.getSpace());
bpatel@766:                 strong.addContent(codeLink);
bpatel@766:                 fieldDocTree.addContent(HtmlTree.DIV(HtmlStyle.block, strong));
bpatel@766:                 writer.addInlineComment(field, fieldDocTree);
duke@1:             }
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * {@inheritDoc}
duke@1:      */
bpatel@766:     public void addTags(FieldDoc field, Content fieldDocTree) {
bpatel@766:         writer.addTagsInfo(field, fieldDocTree);
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * {@inheritDoc}
duke@1:      */
bpatel@766:     public Content getFieldDetails(Content fieldDetailsTree) {
bpatel@766:         return getMemberTree(fieldDetailsTree);
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * {@inheritDoc}
duke@1:      */
bpatel@766:     public Content getFieldDoc(Content fieldDocTree,
bpatel@766:             boolean isLastContent) {
bpatel@766:         return getMemberTree(fieldDocTree, isLastContent);
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@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     public void addSummaryLabel(Content memberTree) {
bpatel@766:         Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING,
bpatel@766:                 writer.getResource("doclet.Field_Summary"));
bpatel@766:         memberTree.addContent(label);
bpatel@243:     }
bpatel@243: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     public String getTableSummary() {
bpatel@766:         return configuration().getText("doclet.Member_Table_Summary",
bpatel@243:                 configuration().getText("doclet.Field_Summary"),
bpatel@766:                 configuration().getText("doclet.fields"));
bpatel@243:     }
bpatel@243: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     public String getCaption() {
bpatel@766:         return configuration().getText("doclet.Fields");
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     public String[] getSummaryTableHeader(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@766:         return header;
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     public void addSummaryAnchor(ClassDoc cd, Content memberTree) {
bpatel@766:         memberTree.addContent(writer.getMarkerAnchor("field_summary"));
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree) {
bpatel@766:         inheritedTree.addContent(writer.getMarkerAnchor(
bpatel@766:                 "fields_inherited_from_class_" + configuration().getClassName(cd)));
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree) {
bpatel@766:         Content classLink = new RawHtml(writer.getPreQualifiedClassLink(
bpatel@766:                 LinkInfoImpl.CONTEXT_MEMBER, cd, false));
bpatel@766:         Content label = new StringContent(cd.isClass() ?
bpatel@766:             configuration().getText("doclet.Fields_Inherited_From_Class") :
bpatel@766:             configuration().getText("doclet.Fields_Inherited_From_Interface"));
bpatel@766:         Content labelHeading = HtmlTree.HEADING(HtmlConstants.INHERITED_SUMMARY_HEADING,
bpatel@766:                 label);
bpatel@766:         labelHeading.addContent(writer.getSpace());
bpatel@766:         labelHeading.addContent(classLink);
bpatel@766:         inheritedTree.addContent(labelHeading);
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     protected void addSummaryLink(int context, ClassDoc cd, ProgramElementDoc member,
bpatel@766:             Content tdSummary) {
bpatel@766:         Content strong = HtmlTree.STRONG(new RawHtml(
bpatel@766:                 writer.getDocLink(context, cd , (MemberDoc) member, member.name(), false)));
bpatel@766:         Content code = HtmlTree.CODE(strong);
bpatel@766:         tdSummary.addContent(code);
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     protected void addInheritedSummaryLink(ClassDoc cd,
bpatel@766:             ProgramElementDoc member, Content linksTree) {
bpatel@766:         linksTree.addContent(new RawHtml(
bpatel@766:                 writer.getDocLink(LinkInfoImpl.CONTEXT_MEMBER, cd, (MemberDoc)member,
bpatel@766:                 member.name(), false)));
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     protected void addSummaryType(ProgramElementDoc member, Content tdSummaryType) {
duke@1:         FieldDoc field = (FieldDoc)member;
bpatel@766:         addModifierAndType(field, field.type(), tdSummaryType);
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     protected Content getDeprecatedLink(ProgramElementDoc member) {
bpatel@766:         return writer.getDocLink(LinkInfoImpl.CONTEXT_MEMBER,
bpatel@766:                 (MemberDoc) member, ((FieldDoc)member).qualifiedName());
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     protected Content getNavSummaryLink(ClassDoc cd, boolean link) {
duke@1:         if (link) {
bpatel@766:             return writer.getHyperLink("", (cd == null)?
bpatel@766:                 "field_summary":
bpatel@766:                 "fields_inherited_from_class_" +
bpatel@766:                 configuration().getClassName(cd),
bpatel@766:                 writer.getResource("doclet.navField"));
duke@1:         } else {
bpatel@766:             return writer.getResource("doclet.navField");
duke@1:         }
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     protected void addNavDetailLink(boolean link, Content liNav) {
duke@1:         if (link) {
bpatel@766:             liNav.addContent(writer.getHyperLink("", "field_detail",
bpatel@766:                     writer.getResource("doclet.navField")));
duke@1:         } else {
bpatel@766:             liNav.addContent(writer.getResource("doclet.navField"));
duke@1:         }
duke@1:     }
duke@1: }