org.freehep.tools.doclet
Class PackageUseWriter

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
                                      |
                                      +--org.freehep.tools.doclet.PackageUseWriter

public class PackageUseWriter

extends SubWriterHolderWriter

Generate package usage information.

Author:

Robert G. Field

Field Summary

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

backpath, checkedSoucePath, configuration, displayLength, DOC_FILES_DIR_NAME, filename, path, relativepath, shouldCopyDocFiles

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

PackageUseWriter(ConfigurationStandard configuration, ClassUseMapper mapper, String filename, com.sun.javadoc.PackageDoc pkgdoc)
Constructor.

Method Summary

static void	generate(ConfigurationStandard configuration, ClassUseMapper mapper, com.sun.javadoc.PackageDoc pkgdoc) Generate a class page.
protected void	generateClassList()
protected void	generatePackageList()
protected void	generatePackageUse() Print the class use list.
protected void	generatePackageUse(com.sun.javadoc.PackageDoc pkg) Print the package use list.
protected void	generatePackageUseFile() Print the class use list.
protected void	navLinkClassUse() Print class use link
protected void	navLinkPackage() Print this package link
protected void	navLinkTree() Print "Tree" link in the navigation bar.
protected void	printClassRow(com.sun.javadoc.ClassDoc usedClass, com.sun.javadoc.PackageDoc usingPackage)
protected void	printPackageUseFooter() Print the footer for the class use Listing.
protected void	printPackageUseHeader() Print the header for the class use Listing.

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

printCommentDef, printIndexComment, printInheritedSummaryFooter, printInheritedSummaryHeader, printInheritedSummaryMember, printMemberFooter, printMemberHeader, printSummaryFooter, printSummaryHeader, printSummaryLinkComment, printSummaryLinkType, printSummaryMember, printTableHeadingBackground, printTypeSummaryFooter, printTypeSummaryHeader

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

boldText, boldText, boldText, commentTagsToString, configuration, copyDocFiles, error, error, frame, frameEnd, frameSet, frameSetEnd, generateTagInfo, getClassLink, getClassLink, getClassLink, getClassLink, getClassLink, getClassLink, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getNoFramesTargetHyperLink, getPackageLink, getPackageLink, getPackageLink, getPackageLink, getPreQualifiedClassLink, getPreQualifiedClassLink, getQualifiedClassLink, getSourcePath, getTargetHyperLink, getText, getText, getText, getText, isCoreClass, isCrossClassIncluded, isGeneratedDoc, italicsClassName, msg, navCellEnd, navCellRevStart, navCellStart, navDetail, navHideLists, navHideLists, navLinkClass, navLinkClassIndex, navLinkContents, navLinkDeprecated, navLinkHelp, navLinkIndex, navLinkMainTree, navLinkNext, navLinkNext, navLinkPackage, navLinkPrevious, navLinkPrevious, navLinks, navShowLists, navShowLists, navSummary, notice, notice, pathString, pathString, pathToClass, printBoldTargetHyperLink, printBottom, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printClassLinkForSameDir, printDocLink, printDocLink, printHeader, printIndexHeading, printInlineComment, printInlineComment, printInlineDeprecatedComment, printInlineDeprecatedComment, printNoFramesBoldTargetHyperLink, printPackageLink, printPackageLink, printPackageLink, printPreQualifiedBoldClassLink, printPreQualifiedClassLink, printQualifiedClassLink, printSinceTag, printSrcLink, printStyleSheetProperties, printSummaryComment, printSummaryDeprecatedComment, printSummaryDeprecatedComment, printSummaryDetailLinks, printTargetClassLink, printTargetHyperLink, printTargetHyperLink, printTargetHyperLink, printTargetPackageLink, printText, printText, printText, printUserHeaderFooter, removeNonInlineTags, 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, getPkgName, printBodyHtmlEnd, printFooter, printFrameFooter, printHyperLink, printHyperLink, printHyperLink, printHyperLink, printNbsps, printPartialHeader, printPkgName, spaces, today

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

address, addressEnd, aEnd, aName, anchor, anchor, blockquote, blockquoteEnd, body, 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, getScriptCode, 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, 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

PackageUseWriter

public PackageUseWriter(ConfigurationStandard configuration,
                        ClassUseMapper mapper,
                        String filename,
                        com.sun.javadoc.PackageDoc pkgdoc)
                 throws IOException

Constructor.

Parameters:

filename - the file to be generated.

Throws:

IOException

com.sun.tools.doclets.DocletAbortException

Method Detail

generate

public static void generate(ConfigurationStandard configuration,
                            ClassUseMapper mapper,
                            com.sun.javadoc.PackageDoc pkgdoc)

Generate a class page.

Throws:

com.sun.tools.doclets.DocletAbortException

generatePackageUseFile

protected void generatePackageUseFile()
                               throws IOException

Print the class use list.

IOException

generatePackageUse

protected void generatePackageUse()
                           throws IOException

Print the class use list.

IOException

generatePackageList

protected void generatePackageList()
                            throws IOException

IOException

generateClassList

protected void generateClassList()
                          throws IOException

IOException

printClassRow

protected void printClassRow(com.sun.javadoc.ClassDoc usedClass,
                             com.sun.javadoc.PackageDoc usingPackage)

generatePackageUse

protected void generatePackageUse(com.sun.javadoc.PackageDoc pkg)
                           throws IOException

Print the package use list.

IOException

printPackageUseHeader

protected void printPackageUseHeader()

Print the header for the class use Listing.

printPackageUseFooter

protected void printPackageUseFooter()

Print the footer for the class use Listing.

navLinkPackage

protected void navLinkPackage()

Print this package link

Overrides:

navLinkPackage in class HtmlStandardWriter

navLinkClassUse

protected void navLinkClassUse()

Print class use link

Overrides:

navLinkClassUse in class HtmlStandardWriter

navLinkTree

protected void navLinkTree()

Description copied from class: HtmlStandardWriter

Print "Tree" link in the navigation bar. If there is only one package specified on the command line, then the "Tree" link will be to the only "package-tree.html" file otherwise it will be to the "overview-tree.html" file.

Overrides:

navLinkTree in class HtmlStandardWriter