org.freehep.tools.doclet
Class SubWriterHolderWriter

java.lang.Object
  java.io.Writer
      java.io.PrintWriter
          com.sun.tools.doclets.HtmlWriter
              com.sun.tools.doclets.HtmlDocWriter
                  org.freehep.tools.doclet.HtmlStandardWriter
                      org.freehep.tools.doclet.SubWriterHolderWriter

Direct Known Subclasses:

ClassUseWriter, ClassWriter, ConstantsSummaryWriter, DeprecatedListWriter, PackageUseWriter, SerializedFormWriter

public abstract class SubWriterHolderWriter

extends HtmlStandardWriter

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.

Author:

Robert Field, Atul M Dambalkar

See Also:

AbstractSubWriter, ClassWriter

Source Code:

SubWriterHolderWriter.java

Field Summary

Fields inherited from class org.freehep.tools.doclet.HtmlStandardWriter

backpath, configuration, displayLength, DOC_FILES_DIR_NAME, filename, path, relativepath, relativepathNoSlash

Fields inherited from class com.sun.tools.doclets.HtmlWriter

fileseparator, htmlFilename, winTitle

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

SubWriterHolderWriter(ConfigurationStandard configuration, String filename)

SubWriterHolderWriter(ConfigurationStandard configuration, String path, String filename, String relpath)

Method Summary

protected void	printCommentDef(com.sun.javadoc.Doc member)
protected void	printIndexComment(com.sun.javadoc.Doc member)
void	printInheritedSummaryFooter(AbstractSubWriter mw, com.sun.javadoc.ClassDoc cd)
void	printInheritedSummaryHeader(AbstractSubWriter mw, com.sun.javadoc.ClassDoc cd)
void	printInheritedSummaryMember(AbstractSubWriter mw, com.sun.javadoc.ClassDoc cd, com.sun.javadoc.ProgramElementDoc member)
void	printMemberFooter()
void	printMemberHeader()
void	printSummaryFooter(AbstractSubWriter mw, com.sun.javadoc.ClassDoc cd)
void	printSummaryHeader(AbstractSubWriter mw, com.sun.javadoc.ClassDoc cd)
void	printSummaryLinkComment(AbstractSubWriter mw, com.sun.javadoc.ProgramElementDoc member)
void	printSummaryLinkType(AbstractSubWriter mw, com.sun.javadoc.ProgramElementDoc member)
void	printSummaryMember(AbstractSubWriter mw, com.sun.javadoc.ClassDoc cd, com.sun.javadoc.ProgramElementDoc member)
void	printTableHeadingBackground(String str)
void	printTypeSummaryFooter()
void	printTypeSummaryHeader()

Methods inherited from class org.freehep.tools.doclet.HtmlStandardWriter

boldText, boldText, boldText, commentTagsToString, configuration, copyDocFiles, error, error, frame, frameEnd, frameSet, frameSetEnd, generateTagInfo, generateTagInfo, getClassLink, getClassLink, getClassLink, getClassLink, getClassLink, getClassLink, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getPackageLink, getPackageLink, getPackageLink, getPackageLink, getPreQualifiedClassLink, getPreQualifiedClassLink, getQualifiedClassLink, getSourcePath, getText, getText, getText, getText, isCoreClass, isCrossClassIncluded, isGeneratedDoc, italicsClassName, msg, navCellEnd, navCellRevStart, navCellStart, navDetail, navHideLists, navHideLists, navLinkClass, navLinkClassIndex, navLinkClassUse, navLinkContents, navLinkDeprecated, navLinkHelp, navLinkIndex, navLinkMainTree, navLinkNext, navLinkNext, navLinkPackage, navLinkPackage, navLinkPrevious, navLinkPrevious, navLinks, navLinkTree, navShowLists, navShowLists, navSummary, notice, notice, pathString, pathString, pathToClass, printBoldTargetHyperLink, printBottom, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printDocLink, printDocLink, printHtmlHeader, printHtmlHeader, printHtmlHeader, printIndexHeading, printInlineComment, printInlineComment, printInlineDeprecatedComment, printInlineDeprecatedComment, printNoFramesBoldTargetHyperLink, printNoFramesTargetHyperLink, printPackageLink, printPackageLink, printPackageLink, printPreQualifiedBoldClassLink, printPreQualifiedClassLink, printQualifiedClassLink, printSinceTag, printSrcLink, printStyleSheetProperties, printSummaryComment, printSummaryDeprecatedComment, printSummaryDeprecatedComment, printSummaryDetailLinks, printTargetClassLink, printTargetHyperLink, printTargetHyperLink, printTargetHyperLink, printTargetPackageLink, printText, printText, printText, printUserHeaderFooter, removeNonInlineHtmlTags, replace, replaceDocRootDir, replaceInheritDoc, seeTagToString, serialClassInclude, serialDocInclude, serialInclude, summaryRow, summaryRowEnd, tableHeaderEnd, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableIndexDetail, tableIndexSummary, tableInheritedHeaderEnd, tableInheritedHeaderStart, tableUseInfoHeaderStart, tdIndex, warning, warning, warning

Methods inherited from class com.sun.tools.doclets.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.HtmlWriter

address, addressEnd, aEnd, aName, anchor, anchor, blockquote, blockquoteEnd, body, bodyEnd, bold, bold, boldEnd, br, center, centerEnd, code, codeEnd, codeText, commentEnd, commentStart, dd, ddEnd, dl, dlEnd, dt, em, emEnd, font, fontEnd, fontSizeStyle, fontStyle, genWriter, getBold, getBoldEnd, getCode, getCodeEnd, getFontColor, getFontEnd, 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, p, pEnd, pre, preEnd, printWinTitleScript, script, scriptEnd, space, sup, supEnd, table, table, table, table, tableEnd, td, tdAlign, tdAlignRowspan, tdAlignVAlign, tdAlignVAlignRowspan, tdBgcolorStyle, tdColspan, tdColspanBgcolorStyle, tdEnd, tdNowrap, tdVAlign, tdVAlignClass, tdWidth, title, title, titleEnd, tr, trAlignVAlign, trBgcolor, trBgcolorStyle, trEnd, ul, ulEnd

Methods inherited from class java.io.PrintWriter

checkError, close, flush, print, print, print, print, print, print, print, print, print, 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(ConfigurationStandard configuration,
                             String filename)
                      throws IOException

SubWriterHolderWriter

public SubWriterHolderWriter(ConfigurationStandard configuration,
                             String path,
                             String filename,
                             String relpath)
                      throws IOException

Method Detail

printTypeSummaryHeader

public void printTypeSummaryHeader()

printTypeSummaryFooter

public void printTypeSummaryFooter()

printSummaryHeader

public void printSummaryHeader(AbstractSubWriter mw,
                               com.sun.javadoc.ClassDoc cd)

printTableHeadingBackground

public void printTableHeadingBackground(String str)

printInheritedSummaryHeader

public void printInheritedSummaryHeader(AbstractSubWriter mw,
                                        com.sun.javadoc.ClassDoc cd)

printSummaryFooter

public void printSummaryFooter(AbstractSubWriter mw,
                               com.sun.javadoc.ClassDoc cd)

printInheritedSummaryFooter

public void printInheritedSummaryFooter(AbstractSubWriter mw,
                                        com.sun.javadoc.ClassDoc cd)

printCommentDef

protected void printCommentDef(com.sun.javadoc.Doc member)

printIndexComment

protected void printIndexComment(com.sun.javadoc.Doc member)

printSummaryMember

public void printSummaryMember(AbstractSubWriter mw,
                               com.sun.javadoc.ClassDoc cd,
                               com.sun.javadoc.ProgramElementDoc member)

printSummaryLinkType

public void printSummaryLinkType(AbstractSubWriter mw,
                                 com.sun.javadoc.ProgramElementDoc member)

printSummaryLinkComment

public void printSummaryLinkComment(AbstractSubWriter mw,
                                    com.sun.javadoc.ProgramElementDoc member)

printInheritedSummaryMember

public void printInheritedSummaryMember(AbstractSubWriter mw,
                                        com.sun.javadoc.ClassDoc cd,
                                        com.sun.javadoc.ProgramElementDoc member)

printMemberHeader

public void printMemberHeader()

printMemberFooter

public void printMemberFooter()