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

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

All Implemented Interfaces:

MemberSummaryWriter

public class NestedClassWriterImpl
extends AbstractMemberWriter
implements MemberSummaryWriter

Writes nested class 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

NestedClassWriterImpl(SubWriterHolderWriter writer)

NestedClassWriterImpl(SubWriterHolderWriter writer, ClassDoc classdoc)

Method Summary

void	close() Close the writer.
int	getMemberKind()
protected void	printBodyHtmlEnd(ClassDoc cd)
protected void	printHeader(ClassDoc cd)
void	printInheritedSummaryAnchor(ClassDoc cd)
void	printInheritedSummaryLabel(ClassDoc cd)
protected void	printMember(ProgramElementDoc member)
protected void	printMemberLink(ProgramElementDoc member)
protected void	printMembersSummaryLink(ClassDoc cd, ClassDoc icd, boolean link)
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	writeClassHeader(ClassDoc nestedClass, boolean isFirst) Write the nested class header for the given nested class.
protected void	writeDeprecatedLink(ProgramElementDoc member)
void	writeHeader(ClassDoc classDoc, java.lang.String header) Write the header for the nested class documentation.
void	writeInheritedMemberSummary(ClassDoc classDoc, ProgramElementDoc nestedClass, boolean isFirst, boolean isLast) Write the inherited member summary for the given class and member.
void	writeInheritedMemberSummaryFooter(ClassDoc classDoc) Write the inherited classes summary footer for the given class.
void	writeInheritedMemberSummaryHeader(ClassDoc classDoc) Write the inherited classes summary header for the given class.
protected void	writeInheritedSummaryLink(ClassDoc cd, ProgramElementDoc member)
void	writeMemberSummaryFooter(ClassDoc classDoc) Write the classes summary footer for the given class.
void	writeMemberSummaryHeader(ClassDoc classDoc) Write the classes summary header for the given class.
protected void	writeSummaryLink(int context, ClassDoc cd, ProgramElementDoc member)

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

NestedClassWriterImpl

public NestedClassWriterImpl(SubWriterHolderWriter writer,
                             ClassDoc classdoc)

NestedClassWriterImpl

public NestedClassWriterImpl(SubWriterHolderWriter writer)

Method Detail

writeMemberSummaryHeader

public void writeMemberSummaryHeader(ClassDoc classDoc)

Write the classes 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 classes 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 classes 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 nestedClass,
                                        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.

nestedClass - 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 classes 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 nested class documentation.

Parameters:

classDoc - the class that the classes belong to.

writeClassHeader

public void writeClassHeader(ClassDoc nestedClass,
                             boolean isFirst)

Write the nested class header for the given nested class.

Parameters:

nestedClass - the nested class being documented.

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

close

public void close()
           throws java.io.IOException

Close the writer.

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

printHeader

protected void printHeader(ClassDoc cd)

printBodyHtmlEnd

protected void printBodyHtmlEnd(ClassDoc cd)

printMember

protected void printMember(ProgramElementDoc member)

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

printMemberLink

protected void printMemberLink(ProgramElementDoc member)

printMembersSummaryLink

protected void printMembersSummaryLink(ClassDoc cd,
                                       ClassDoc icd,
                                       boolean link)