org.freehep.tools.doclet
Class TreeWriter

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.AbstractTreeWriter
                          org.freehep.tools.doclet.TreeWriter

public class TreeWriter

extends AbstractTreeWriter

Generate Class Hierarchy page for all the Classes in this run. Use ClassTree for building the Tree. The name of the generated file is "overview-tree.html" and it is generated in the current or the destination directory.

Author:

Atul M Dambalkar

Source Code:

TreeWriter.java

Field Summary

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

classtree

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

TreeWriter(ConfigurationStandard configuration, String filename, com.sun.tools.doclets.ClassTree classtree)
Constructor to construct TreeWriter object.

Method Summary

static void	generate(ConfigurationStandard configuration, com.sun.tools.doclets.ClassTree classtree) Create a TreeWriter object and use it to generate the "overview-tree.html" file.
void	generateTreeFile() Print the interface hierarchy and class hierarchy in the file.
protected void	printPackageTreeLinks() Generate the links to all the package tree files.
protected void	printPageHeading() Print the page title "Hierarchy For All Packages" at the top of the tree page.
protected void	printTreeFooter() Print the navigation bar links at the bottom.
protected void	printTreeHeader() Print the navigation bar links at the top.

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

generateLevelInfo, generateTree, navLinkTree, printExtendsImplements, printPartialInfo, printTreeHeading

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, 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

TreeWriter

public TreeWriter(ConfigurationStandard configuration,
                  String filename,
                  com.sun.tools.doclets.ClassTree classtree)
           throws IOException

Constructor to construct TreeWriter object.

Parameters:

filename - String filename

classtree - Tree built using ClassTree.

Throws:

com.sun.tools.doclets.DocletAbortException

IOException

Method Detail

generate

public static void generate(ConfigurationStandard configuration,
                            com.sun.tools.doclets.ClassTree classtree)

Create a TreeWriter object and use it to generate the "overview-tree.html" file.

Parameters:

classtree - ClassTree.

Throws:

com.sun.tools.doclets.DocletAbortException

generateTreeFile

public void generateTreeFile()
                      throws IOException

Print the interface hierarchy and class hierarchy in the file.

Throws:

IOException

printPackageTreeLinks

protected void printPackageTreeLinks()

Generate the links to all the package tree files.

printTreeHeader

protected void printTreeHeader()

Print the navigation bar links at the top.

printTreeFooter

protected void printTreeFooter()

Print the navigation bar links at the bottom.

printPageHeading

protected void printPageHeading()

Print the page title "Hierarchy For All Packages" at the top of the tree page.