jdk8-mips64-public/langtools: comparison src/share/classes/com/sun/tools/doclets/formats/html/FieldWriterImpl.java

-:bcbc86cc5b31
+:90af8d87741f
 package com.sun.tools.doclets.formats.html;
 import java.io.*;
 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.*;
 /**
 * Writes field documentation in HTML format.
 * @author Bhavesh Patel (Modified)
 */
 public class FieldWriterImpl extends AbstractMemberWriter
 implements FieldWriter, MemberSummaryWriter {
-private boolean printedSummaryHeader = false;
 public FieldWriterImpl(SubWriterHolderWriter writer, ClassDoc classdoc) {
 super(writer, classdoc);
 }
 public FieldWriterImpl(SubWriterHolderWriter writer) {
 super(writer);
 }
 /**
-* Write the fields summary header for the given class.
+* {@inheritDoc}
-*
+*/
-* @param classDoc the class the summary belongs to.
+public Content getMemberSummaryHeader(ClassDoc classDoc,
-*/
+Content memberSummaryTree) {
-public void writeMemberSummaryHeader(ClassDoc classDoc) {
+memberSummaryTree.addContent(HtmlConstants.START_OF_FIELD_SUMMARY);
-printedSummaryHeader = true;
+Content memberTree = writer.getMemberTreeHeader();
-writer.println("<!-- =========== FIELD SUMMARY =========== -->");
+writer.addSummaryHeader(this, classDoc, memberTree);
-writer.println();
+return memberTree;
-writer.printSummaryHeader(this, classDoc);
+}
-}
+/**
-/**
+* {@inheritDoc}
-* Write the fields summary footer for the given class.
+*/
-*
+public Content getFieldDetailsTreeHeader(ClassDoc classDoc,
-* @param classDoc the class the summary belongs to.
+Content memberDetailsTree) {
-*/
+memberDetailsTree.addContent(HtmlConstants.START_OF_FIELD_DETAILS);
-public void writeMemberSummaryFooter(ClassDoc classDoc) {
+Content fieldDetailsTree = writer.getMemberTreeHeader();
-writer.tableEnd();
+fieldDetailsTree.addContent(writer.getMarkerAnchor("field_detail"));
-writer.space();
+Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING,
-}
+writer.fieldDetailsLabel);
+fieldDetailsTree.addContent(heading);
-/**
+return fieldDetailsTree;
-* Write the inherited fields summary header for the given class.
+}
-*
-* @param classDoc the class the summary belongs to.
+/**
-*/
+* {@inheritDoc}
-public void writeInheritedMemberSummaryHeader(ClassDoc classDoc) {
+*/
-if(! printedSummaryHeader){
+public Content getFieldDocTreeHeader(FieldDoc field,
-//We don't want inherited summary to not be under heading.
+Content fieldDetailsTree) {
-writeMemberSummaryHeader(classDoc);
+fieldDetailsTree.addContent(
-writeMemberSummaryFooter(classDoc);
+writer.getMarkerAnchor(field.name()));
-printedSummaryHeader = true;
+Content fieldDocTree = writer.getMemberTreeHeader();
+Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING);
+heading.addContent(field.name());
+fieldDocTree.addContent(heading);
+return fieldDocTree;
+}
+/**
+* {@inheritDoc}
+*/
+public Content getSignature(FieldDoc field) {
+Content pre = new HtmlTree(HtmlTag.PRE);
+writer.addAnnotationInfo(field, pre);
+addModifiers(field, pre);
+Content fieldlink = new RawHtml(writer.getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_MEMBER,
+field.type())));
+pre.addContent(fieldlink);
+pre.addContent(" ");
+if (configuration().linksource) {
+Content fieldName = new StringContent(field.name());
+writer.addSrcLink(field, fieldName, pre);
+} else {
+addName(field.name(), pre);
 }
-writer.printInheritedSummaryHeader(this, classDoc);
+return pre;
 }
 /**
 * {@inheritDoc}
 */
-public void writeInheritedMemberSummary(ClassDoc classDoc,
+public void addDeprecated(FieldDoc field, Content fieldDocTree) {
-ProgramElementDoc field, boolean isFirst, boolean isLast) {
+addDeprecatedInfo(field, fieldDocTree);
-writer.printInheritedSummaryMember(this, classDoc, field, isFirst);
+}
-}
+/**
-/**
+* {@inheritDoc}
-* Write the inherited fields summary footer for the given class.
+*/
-*
+public void addComments(FieldDoc field, Content fieldDocTree) {
-* @param classDoc the class the summary belongs to.
-*/
-public void writeInheritedMemberSummaryFooter(ClassDoc classDoc) {
-writer.printInheritedSummaryFooter(this, classDoc);
-}
-/**
-* Write the header for the field documentation.
-*
-* @param classDoc the class that the fields belong to.
-*/
-public void writeHeader(ClassDoc classDoc, String header) {
-writer.println();
-writer.println("<!-- ============ FIELD DETAIL =========== -->");
-writer.println();
-writer.anchor("field_detail");
-writer.printTableHeadingBackground(header);
-writer.println();
-}
-/**
-* Write the field header for the given field.
-*
-* @param field the field being documented.
-* @param isFirst the flag to indicate whether or not the field is the
-*        first to be documented.
-*/
-public void writeFieldHeader(FieldDoc field, boolean isFirst) {
-if (! isFirst) {
-writer.printMemberHeader();
-writer.println("");
-}
-writer.anchor(field.name());
-writer.h3();
-writer.print(field.name());
-writer.h3End();
-}
-/**
-* Write the signature for the given field.
-*
-* @param field the field being documented.
-*/
-public void writeSignature(FieldDoc field) {
-writer.pre();
-writer.writeAnnotationInfo(field);
-printModifiers(field);
-writer.printLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_MEMBER,
-field.type()));
-print(' ');
-if (configuration().linksource) {
-writer.printSrcLink(field, field.name());
-} else {
-strong(field.name());
-}
-writer.preEnd();
-assert !writer.getMemberDetailsListPrinted();
-}
-/**
-* Write the deprecated output for the given field.
-*
-* @param field the field being documented.
-*/
-public void writeDeprecated(FieldDoc field) {
-printDeprecated(field);
-}
-/**
-* Write the comments for the given field.
-*
-* @param field the field being documented.
-*/
-public void writeComments(FieldDoc field) {
 ClassDoc holder = field.containingClass();
 if (field.inlineTags().length > 0) {
-writer.printMemberDetailsListStartTag();
 if (holder.equals(classdoc) ||
 (! (holder.isPublic() || Util.isLinkable(holder, configuration())))) {
-writer.dd();
+writer.addInlineComment(field, fieldDocTree);
-writer.printInlineComment(field);
-writer.ddEnd();
 } else {
-String classlink = writer.codeText(
+Content link = new RawHtml(
 writer.getDocLink(LinkInfoImpl.CONTEXT_FIELD_DOC_COPY,
 holder, field,
 holder.isIncluded() ?
 holder.typeName() : holder.qualifiedTypeName(),
 false));
-writer.dd();
+Content codeLink = HtmlTree.CODE(link);
-writer.strong(configuration().getText(holder.isClass()?
+Content strong = HtmlTree.STRONG(holder.isClass()?
-"doclet.Description_From_Class" :
+writer.descfrmClassLabel : writer.descfrmInterfaceLabel);
-"doclet.Description_From_Interface", classlink));
+strong.addContent(writer.getSpace());
-writer.ddEnd();
+strong.addContent(codeLink);
-writer.dd();
+fieldDocTree.addContent(HtmlTree.DIV(HtmlStyle.block, strong));
-writer.printInlineComment(field);
+writer.addInlineComment(field, fieldDocTree);
-writer.ddEnd();
 }
 }
 }
 /**
-* Write the tag output for the given field.
+* {@inheritDoc}
-*
+*/
-* @param field the field being documented.
+public void addTags(FieldDoc field, Content fieldDocTree) {
-*/
+writer.addTagsInfo(field, fieldDocTree);
-public void writeTags(FieldDoc field) {
+}
-writer.printTags(field);
-}
+/**
+* {@inheritDoc}
-/**
+*/
-* Write the field footer.
+public Content getFieldDetails(Content fieldDetailsTree) {
-*/
+return getMemberTree(fieldDetailsTree);
-public void writeFieldFooter() {
+}
-printMemberFooter();
-}
+/**
+* {@inheritDoc}
-/**
+*/
-* Write the footer for the field documentation.
+public Content getFieldDoc(Content fieldDocTree,
-*
+boolean isLastContent) {
-* @param classDoc the class that the fields belong to.
+return getMemberTree(fieldDocTree, isLastContent);
-*/
-public void writeFooter(ClassDoc classDoc) {
-//No footer to write for field documentation
 }
 /**
 * Close the writer.
 */
 public int getMemberKind() {
 return VisibleMemberMap.FIELDS;
 }
-public void printSummaryLabel() {
+/**
-writer.printText("doclet.Field_Summary");
+* {@inheritDoc}
-}
+*/
+public void addSummaryLabel(Content memberTree) {
-public void printTableSummary() {
+Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING,
-writer.tableIndexSummary(configuration().getText("doclet.Member_Table_Summary",
+writer.getResource("doclet.Field_Summary"));
+memberTree.addContent(label);
+}
+/**
+* {@inheritDoc}
+*/
+public String getTableSummary() {
+return configuration().getText("doclet.Member_Table_Summary",
 configuration().getText("doclet.Field_Summary"),
-configuration().getText("doclet.fields")));
+configuration().getText("doclet.fields"));
 }
-public void printSummaryTableHeader(ProgramElementDoc member) {
+/**
+* {@inheritDoc}
+*/
+public String getCaption() {
+return configuration().getText("doclet.Fields");
+}
+/**
+* {@inheritDoc}
+*/
+public String[] getSummaryTableHeader(ProgramElementDoc member) {
 String[] header = new String[] {
 writer.getModifierTypeHeader(),
 configuration().getText("doclet.0_and_1",
 configuration().getText("doclet.Field"),
 configuration().getText("doclet.Description"))
 };
-writer.summaryTableHeader(header, "col");
+return header;
 }
-public void printSummaryAnchor(ClassDoc cd) {
+/**
-writer.anchor("field_summary");
+* {@inheritDoc}
-}
+*/
+public void addSummaryAnchor(ClassDoc cd, Content memberTree) {
-public void printInheritedSummaryAnchor(ClassDoc cd) {
+memberTree.addContent(writer.getMarkerAnchor("field_summary"));
-writer.anchor("fields_inherited_from_class_" + configuration().getClassName(cd));
+}
-}
+/**
-public void printInheritedSummaryLabel(ClassDoc cd) {
+* {@inheritDoc}
-String classlink = writer.getPreQualifiedClassLink(
+*/
-LinkInfoImpl.CONTEXT_MEMBER, cd, false);
+public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree) {
-writer.strong();
+inheritedTree.addContent(writer.getMarkerAnchor(
-String key = cd.isClass()?
+"fields_inherited_from_class_" + configuration().getClassName(cd)));
-"doclet.Fields_Inherited_From_Class" :
+}
-"doclet.Fields_Inherited_From_Interface";
-writer.printText(key, classlink);
+/**
-writer.strongEnd();
+* {@inheritDoc}
-}
+*/
+public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree) {
-protected void writeSummaryLink(int context, ClassDoc cd, ProgramElementDoc member) {
+Content classLink = new RawHtml(writer.getPreQualifiedClassLink(
-writer.strong();
+LinkInfoImpl.CONTEXT_MEMBER, cd, false));
-writer.printDocLink(context, cd , (MemberDoc) member, member.name(), false);
+Content label = new StringContent(cd.isClass() ?
-writer.strongEnd();
+configuration().getText("doclet.Fields_Inherited_From_Class") :
-}
+configuration().getText("doclet.Fields_Inherited_From_Interface"));
+Content labelHeading = HtmlTree.HEADING(HtmlConstants.INHERITED_SUMMARY_HEADING,
-protected void writeInheritedSummaryLink(ClassDoc cd,
+label);
-ProgramElementDoc member) {
+labelHeading.addContent(writer.getSpace());
-writer.printDocLink(LinkInfoImpl.CONTEXT_MEMBER, cd, (MemberDoc)member,
+labelHeading.addContent(classLink);
-member.name(), false);
+inheritedTree.addContent(labelHeading);
 }
-protected void printSummaryType(ProgramElementDoc member) {
+/**
+* {@inheritDoc}
+*/
+protected void addSummaryLink(int context, ClassDoc cd, ProgramElementDoc member,
+Content tdSummary) {
+Content strong = HtmlTree.STRONG(new RawHtml(
+writer.getDocLink(context, cd , (MemberDoc) member, member.name(), false)));
+Content code = HtmlTree.CODE(strong);
+tdSummary.addContent(code);
+}
+/**
+* {@inheritDoc}
+*/
+protected void addInheritedSummaryLink(ClassDoc cd,
+ProgramElementDoc member, Content linksTree) {
+linksTree.addContent(new RawHtml(
+writer.getDocLink(LinkInfoImpl.CONTEXT_MEMBER, cd, (MemberDoc)member,
+member.name(), false)));
+}
+/**
+* {@inheritDoc}
+*/
+protected void addSummaryType(ProgramElementDoc member, Content tdSummaryType) {
 FieldDoc field = (FieldDoc)member;
-printModifierAndType(field, field.type());
+addModifierAndType(field, field.type(), tdSummaryType);
 }
-protected void writeDeprecatedLink(ProgramElementDoc member) {
+/**
-writer.printDocLink(LinkInfoImpl.CONTEXT_MEMBER,
+* {@inheritDoc}
-(MemberDoc) member, ((FieldDoc)member).qualifiedName(), false);
+*/
-}
+protected Content getDeprecatedLink(ProgramElementDoc member) {
+return writer.getDocLink(LinkInfoImpl.CONTEXT_MEMBER,
-protected void printNavSummaryLink(ClassDoc cd, boolean link) {
+(MemberDoc) member, ((FieldDoc)member).qualifiedName());
+}
+/**
+* {@inheritDoc}
+*/
+protected Content getNavSummaryLink(ClassDoc cd, boolean link) {
 if (link) {
-writer.printHyperLink("", (cd == null)?
+return writer.getHyperLink("", (cd == null)?
 "field_summary":
 "fields_inherited_from_class_" +
 configuration().getClassName(cd),
-configuration().getText("doclet.navField"));
+writer.getResource("doclet.navField"));
 } else {
-writer.printText("doclet.navField");
+return writer.getResource("doclet.navField");
 }
 }
-protected void printNavDetailLink(boolean link) {
+/**
+* {@inheritDoc}
+*/
+protected void addNavDetailLink(boolean link, Content liNav) {
 if (link) {
-writer.printHyperLink("", "field_detail",
+liNav.addContent(writer.getHyperLink("", "field_detail",
-configuration().getText("doclet.navField"));
+writer.getResource("doclet.navField")));
 } else {
-writer.printText("doclet.navField");
+liNav.addContent(writer.getResource("doclet.navField"));
 }
 }
 }

Mercurial > jdk8-mips64-public > langtools / file comparison

comparison: src/share/classes/com/sun/tools/doclets/formats/html/FieldWriterImpl.java

src/share/classes/com/sun/tools/doclets/formats/html/FieldWriterImpl.java