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

java.lang.Object
  java.io.Writer
      java.io.PrintWriter
          com.sun.tools.doclets.formats.html.markup.HtmlWriter
              com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
                  com.sun.tools.doclets.formats.html.HtmlDocletWriter
                      com.sun.tools.doclets.formats.html.SubWriterHolderWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable

Direct Known Subclasses:

AnnotationTypeWriterImpl, ClassUseWriter, ClassWriterImpl, DeprecatedListWriter, PackageUseWriter, SerializedFormWriterImpl

public abstract class SubWriterHolderWriter
extends HtmlDocletWriter

This abstract class exists to provide functionality needed in the the formatting of member information. Since AbstractSubWriter and its subclasses control this, they would be the logical place to put this. However, because each member type has its own subclass, subclassing can not be used effectively to change formatting. The concrete class subclass of this class can be subclassed to change formatting.

See Also:

AbstractMemberWriter, ClassWriterImpl

Field Summary

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

configuration, displayLength, filename, path, relativePath, relativepathNoSlash

Fields inherited from class com.sun.tools.doclets.formats.html.markup.HtmlWriter

fileseparator, htmlFilename, winTitle

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

SubWriterHolderWriter(ConfigurationImpl configuration, java.lang.String filename)

SubWriterHolderWriter(ConfigurationImpl configuration, java.lang.String path, java.lang.String filename, java.lang.String relpath)

Method Summary

protected void	printIndexComment(Doc member)
protected void	printIndexComment(Doc member, Tag[] firstSentenceTags)
void	printInheritedSummaryFooter(AbstractMemberWriter mw, ClassDoc cd)
void	printInheritedSummaryHeader(AbstractMemberWriter mw, ClassDoc cd)
void	printInheritedSummaryMember(AbstractMemberWriter mw, ClassDoc cd, ProgramElementDoc member, boolean isFirst)
void	printMemberFooter()
void	printMemberHeader()
void	printSummaryFooter(AbstractMemberWriter mw, ClassDoc cd)
void	printSummaryHeader(AbstractMemberWriter mw, ClassDoc cd)
void	printSummaryLinkComment(AbstractMemberWriter mw, ProgramElementDoc member)
void	printSummaryLinkComment(AbstractMemberWriter mw, ProgramElementDoc member, Tag[] firstSentenceTags)
void	printSummaryLinkType(AbstractMemberWriter mw, ProgramElementDoc member)
void	printTableHeadingBackground(java.lang.String str)
void	printTypeSummaryFooter()
void	printTypeSummaryHeader()

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

anchor, commentTagsToString, configuration, frame, frameEnd, frameSet, frameSetEnd, getAnchor, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getLink, getPackageLink, getPackageLink, getPreQualifiedClassLink, getTagletWriterInstance, getTypeParameterLinks, isClassLinkable, isCoreClass, italicsClassName, navCellEnd, navCellRevStart, navCellStart, navDetail, navHideLists, navLinkClass, navLinkClassIndex, navLinkClassUse, navLinkContents, navLinkDeprecated, navLinkHelp, navLinkIndex, navLinkMainTree, navLinkNext, navLinkNext, navLinkPackage, navLinkPackage, navLinkPrevious, navLinkPrevious, navLinks, navLinkTree, navShowLists, navShowLists, navSummary, pathString, pathString, pathToClass, printBottom, printDocLink, printDocLink, printHtmlHeader, printIndexHeading, printInlineComment, printInlineComment, printInlineDeprecatedComment, printInlineDeprecatedComment, printLink, printNoFramesTargetHyperLink, printPackageLink, printPackageLink, printPreQualifiedClassLink, printPreQualifiedStrongClassLink, printQualifiedClassLink, printSrcLink, printStyleSheetProperties, printSummaryComment, printSummaryComment, printSummaryDeprecatedComment, printSummaryDeprecatedComment, printSummaryDetailLinks, printTags, printTagsInfoFooter, printTagsInfoHeader, printTargetPackageLink, printText, printText, printText, printTop, printUserHeaderFooter, removeNonInlineHtmlTags, replace, replaceDocRootDir, seeTagToString, strongText, strongText, strongText, summaryRow, summaryRowEnd, tableHeaderEnd, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableIndexDetail, tableIndexSummary, tableInheritedHeaderEnd, tableInheritedHeaderStart, tableUseInfoHeaderStart, tdIndex, writeAnnotationInfo, writeAnnotationInfo, writeAnnotationInfo

Methods inherited from class com.sun.tools.doclets.formats.html.markup.HtmlDocWriter

getHyperLink, getHyperLink, getHyperLink, getHyperLink, getPkgName, printBodyHtmlEnd, printFooter, printFrameFooter, printFramesetHeader, printFramesetHeader, printHyperLink, printHyperLink, printHyperLink, printHyperLink, printNbsps, printPkgName, spaces, today

Methods inherited from class com.sun.tools.doclets.formats.html.markup.HtmlWriter

address, addressEnd, aEnd, aName, anchor, anchor, blockquote, blockquoteEnd, body, bodyEnd, br, center, centerEnd, code, codeEnd, codeText, commentEnd, commentStart, dd, ddEnd, dl, dlEnd, dt, em, emEnd, font, fontEnd, fontNoNewLine, fontSizeStyle, fontStyle, getCode, getCodeEnd, getFontColor, getFontEnd, getStrong, getStrongEnd, getWindowTitleOnload, h1, h1, h1End, h2, h2, h2End, h3, h3, h3End, h4, h4, h4End, h5, h5End, head, headEnd, hr, hr, hr, html, htmlEnd, img, italic, italicEnd, italics, italicsText, li, li, link, menu, menuEnd, noFrames, noFramesEnd, noScript, noScriptEnd, p, pEnd, pre, preEnd, preNoNewLine, printWinTitleScript, script, scriptEnd, space, strong, strong, strongEnd, sup, supEnd, table, table, table, table, tableEnd, td, tdAlign, tdAlignRowspan, tdAlignVAlign, tdAlignVAlignRowspan, tdBgcolorStyle, tdColspan, tdColspanBgcolorStyle, tdEnd, tdNowrap, tdVAlign, tdVAlignClass, tdWidth, thAlign, thAlignColspan, thAlignNowrap, thEnd, title, title, titleEnd, tr, trAlignVAlign, trBgcolor, trBgcolorStyle, trEnd, ul, ulEnd

Methods inherited from class java.io.PrintWriter

append, append, append, checkError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

SubWriterHolderWriter

public SubWriterHolderWriter(ConfigurationImpl configuration,
                             java.lang.String filename)
                      throws java.io.IOException

Throws:

java.io.IOException

SubWriterHolderWriter

public SubWriterHolderWriter(ConfigurationImpl configuration,
                             java.lang.String path,
                             java.lang.String filename,
                             java.lang.String relpath)
                      throws java.io.IOException

Throws:

java.io.IOException

Method Detail

printTypeSummaryHeader

public void printTypeSummaryHeader()

printTypeSummaryFooter

public void printTypeSummaryFooter()

printSummaryHeader

public void printSummaryHeader(AbstractMemberWriter mw,
                               ClassDoc cd)

printTableHeadingBackground

public void printTableHeadingBackground(java.lang.String str)

printInheritedSummaryHeader

public void printInheritedSummaryHeader(AbstractMemberWriter mw,
                                        ClassDoc cd)

printSummaryFooter

public void printSummaryFooter(AbstractMemberWriter mw,
                               ClassDoc cd)

printInheritedSummaryFooter

public void printInheritedSummaryFooter(AbstractMemberWriter mw,
                                        ClassDoc cd)

printIndexComment

protected void printIndexComment(Doc member)

printIndexComment

protected void printIndexComment(Doc member,
                                 Tag[] firstSentenceTags)

printSummaryLinkType

public void printSummaryLinkType(AbstractMemberWriter mw,
                                 ProgramElementDoc member)

printSummaryLinkComment

public void printSummaryLinkComment(AbstractMemberWriter mw,
                                    ProgramElementDoc member)

printSummaryLinkComment

public void printSummaryLinkComment(AbstractMemberWriter mw,
                                    ProgramElementDoc member,
                                    Tag[] firstSentenceTags)

printInheritedSummaryMember

public void printInheritedSummaryMember(AbstractMemberWriter mw,
                                        ClassDoc cd,
                                        ProgramElementDoc member,
                                        boolean isFirst)

printMemberHeader

public void printMemberHeader()

printMemberFooter

public void printMemberFooter()