com.sun.tools.doclets.formats.html
Class FieldWriterImpl

java.lang.Object
  com.sun.tools.doclets.formats.html.AbstractMemberWriter
      com.sun.tools.doclets.formats.html.FieldWriterImpl

All Implemented Interfaces:

FieldWriter, MemberSummaryWriter

Direct Known Subclasses:

HtmlSerialFieldWriter

public class FieldWriterImpl
extends AbstractMemberWriter
implements FieldWriter, MemberSummaryWriter

Writes field documentation in HTML format.

Field Summary

private boolean

printedSummaryHeader

Fields inherited from class com.sun.tools.doclets.formats.html.AbstractMemberWriter

classdoc, nodepr, writer

Constructor Summary

FieldWriterImpl(SubWriterHolderWriter writer)

FieldWriterImpl(SubWriterHolderWriter writer, ClassDoc classdoc)

Method Summary

void	close() Close the writer.
int	getMemberKind()
void	printInheritedSummaryAnchor(ClassDoc cd)
void	printInheritedSummaryLabel(ClassDoc cd)
protected void	printNavDetailLink(boolean link)
protected void	printNavSummaryLink(ClassDoc cd, boolean link)
void	printSummaryAnchor(ClassDoc cd)
void	printSummaryLabel(ClassDoc cd) abstracts
protected void	printSummaryType(ProgramElementDoc member)
void	writeComments(FieldDoc field) Write the comments for the given field.
void	writeDeprecated(FieldDoc field) Write the deprecated output for the given field.
protected void	writeDeprecatedLink(ProgramElementDoc member)
void	writeFieldFooter() Write the field footer.
void	writeFieldHeader(FieldDoc field, boolean isFirst) Write the field header for the given field.
void	writeFooter(ClassDoc classDoc) Write the footer for the field documentation.
void	writeHeader(ClassDoc classDoc, java.lang.String header) Write the header for the field documentation.
void	writeInheritedMemberSummary(ClassDoc classDoc, ProgramElementDoc field, boolean isFirst, boolean isLast) Write the inherited member summary for the given class and member.
void	writeInheritedMemberSummaryFooter(ClassDoc classDoc) Write the inherited fields summary footer for the given class.
void	writeInheritedMemberSummaryHeader(ClassDoc classDoc) Write the inherited fields summary header for the given class.
protected void	writeInheritedSummaryLink(ClassDoc cd, ProgramElementDoc member)
void	writeMemberSummaryFooter(ClassDoc classDoc) Write the fields summary footer for the given class.
void	writeMemberSummaryHeader(ClassDoc classDoc) Write the fields summary header for the given class.
void	writeSignature(FieldDoc field) Write the signature for the given field.
protected void	writeSummaryLink(int context, ClassDoc cd, ProgramElementDoc member)
void	writeTags(FieldDoc field) Write the tag output for the given field.

Methods inherited from class com.sun.tools.doclets.formats.html.AbstractMemberWriter

configuration, eligibleMembers, isInherited, makeSpace, modifierString, name, navDetailLink, navSummaryLink, print, print, printComment, printCommentAndTags, printDeprecatedAPI, printFullComment, printHead, printInheritedSummaryFooter, printInheritedSummaryHeader, printModifierAndType, printModifiers, printStaticAndType, printSummaryFooter, printSummaryHeader, printUseInfo, serialWarning, strong, typeString, writeMemberSummary, writeSummaryLink

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sun.tools.doclets.internal.toolkit.MemberSummaryWriter

writeMemberSummary

Field Detail

printedSummaryHeader

private boolean printedSummaryHeader

Constructor Detail

FieldWriterImpl

public FieldWriterImpl(SubWriterHolderWriter writer,
                       ClassDoc classdoc)

FieldWriterImpl

public FieldWriterImpl(SubWriterHolderWriter writer)

Method Detail

writeMemberSummaryHeader

public void writeMemberSummaryHeader(ClassDoc classDoc)

Write the fields summary header for the given class.

Specified by:

writeMemberSummaryHeader in interface MemberSummaryWriter

Parameters:

classDoc - the class the summary belongs to.

writeMemberSummaryFooter

public void writeMemberSummaryFooter(ClassDoc classDoc)

Write the fields summary footer for the given class.

Specified by:

writeMemberSummaryFooter in interface MemberSummaryWriter

Parameters:

classDoc - the class the summary belongs to.

writeInheritedMemberSummaryHeader

public void writeInheritedMemberSummaryHeader(ClassDoc classDoc)

Write the inherited fields summary header for the given class.

Specified by:

writeInheritedMemberSummaryHeader in interface MemberSummaryWriter

Parameters:

classDoc - the class the summary belongs to.

writeInheritedMemberSummary

public void writeInheritedMemberSummary(ClassDoc classDoc,
                                        ProgramElementDoc field,
                                        boolean isFirst,
                                        boolean isLast)

Write the inherited member summary for the given class and member.

Specified by:

writeInheritedMemberSummary in interface MemberSummaryWriter

Parameters:

classDoc - the class the inherited member belongs to.

field - the inherited member that I am summarizing.

isFirst - true if this is the first member in the list.

isLast - true if this is the last member in the list.

writeInheritedMemberSummaryFooter

public void writeInheritedMemberSummaryFooter(ClassDoc classDoc)

Write the inherited fields summary footer for the given class.

Specified by:

writeInheritedMemberSummaryFooter in interface MemberSummaryWriter

Parameters:

classDoc - the class the summary belongs to.

writeHeader

public void writeHeader(ClassDoc classDoc,
                        java.lang.String header)

Write the header for the field documentation.

Specified by:

writeHeader in interface FieldWriter

Parameters:

classDoc - the class that the fields belong to.

header - the header to write.

writeFieldHeader

public void writeFieldHeader(FieldDoc field,
                             boolean isFirst)

Write the field header for the given field.

Specified by:

writeFieldHeader in interface FieldWriter

Parameters:

field - the field being documented.

isFirst - the flag to indicate whether or not the field is the first to be documented.

writeSignature

public void writeSignature(FieldDoc field)

Write the signature for the given field.

Specified by:

writeSignature in interface FieldWriter

Parameters:

field - the field being documented.

writeDeprecated

public void writeDeprecated(FieldDoc field)

Write the deprecated output for the given field.

Specified by:

writeDeprecated in interface FieldWriter

Parameters:

field - the field being documented.

writeComments

public void writeComments(FieldDoc field)

Write the comments for the given field.

Specified by:

writeComments in interface FieldWriter

Parameters:

field - the field being documented.

writeTags

public void writeTags(FieldDoc field)

Write the tag output for the given field.

Specified by:

writeTags in interface FieldWriter

Parameters:

field - the field being documented.

writeFieldFooter

public void writeFieldFooter()

Write the field footer.

Specified by:

writeFieldFooter in interface FieldWriter

writeFooter

public void writeFooter(ClassDoc classDoc)

Write the footer for the field documentation.

Specified by:

writeFooter in interface FieldWriter

Parameters:

classDoc - the class that the fields belong to.

close

public void close()
           throws java.io.IOException

Close the writer.

Specified by:

close in interface FieldWriter

Specified by:

close in interface MemberSummaryWriter

Throws:

java.io.IOException

getMemberKind

public int getMemberKind()

printSummaryLabel

public void printSummaryLabel(ClassDoc cd)

Description copied from class: AbstractMemberWriter

abstracts

Specified by:

printSummaryLabel in class AbstractMemberWriter

printSummaryAnchor

public void printSummaryAnchor(ClassDoc cd)

Specified by:

printSummaryAnchor in class AbstractMemberWriter

printInheritedSummaryAnchor

public void printInheritedSummaryAnchor(ClassDoc cd)

Specified by:

printInheritedSummaryAnchor in class AbstractMemberWriter

printInheritedSummaryLabel

public void printInheritedSummaryLabel(ClassDoc cd)

Specified by:

printInheritedSummaryLabel in class AbstractMemberWriter

writeSummaryLink

protected void writeSummaryLink(int context,
                                ClassDoc cd,
                                ProgramElementDoc member)

Specified by:

writeSummaryLink in class AbstractMemberWriter

writeInheritedSummaryLink

protected void writeInheritedSummaryLink(ClassDoc cd,
                                         ProgramElementDoc member)

Specified by:

writeInheritedSummaryLink in class AbstractMemberWriter

printSummaryType

protected void printSummaryType(ProgramElementDoc member)

Specified by:

printSummaryType in class AbstractMemberWriter

writeDeprecatedLink

protected void writeDeprecatedLink(ProgramElementDoc member)

Specified by:

writeDeprecatedLink in class AbstractMemberWriter

printNavSummaryLink

protected void printNavSummaryLink(ClassDoc cd,
                                   boolean link)

Specified by:

printNavSummaryLink in class AbstractMemberWriter

printNavDetailLink

protected void printNavDetailLink(boolean link)

Specified by:

printNavDetailLink in class AbstractMemberWriter