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

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.AbstractTreeWriter
                          com.sun.tools.doclets.formats.html.TreeWriter

All Implemented Interfaces:

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

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.

Field Summary

private boolean	classesonly True if there are no packages specified on the command line, False otherwise.
private PackageDoc[]	packages Packages in this run.

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

classtree

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

TreeWriter(ConfigurationImpl configuration, java.lang.String filename, ClassTree classtree)
Constructor to construct TreeWriter object.

Method Summary

static void	generate(ConfigurationImpl configuration, 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 and bottom text (from the -bottom option) at the bottom of page.
protected void	printTreeHeader() Print the top text (from the -top option) and navigation bar at the top of page.

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

generateLevelInfo, generateTree, navLinkTree, printExtendsImplements, printPartialInfo, printTreeHeading

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

Field Detail

packages

private PackageDoc[] packages

Packages in this run.

classesonly

private boolean classesonly

True if there are no packages specified on the command line, False otherwise.

Constructor Detail

TreeWriter

public TreeWriter(ConfigurationImpl configuration,
                  java.lang.String filename,
                  ClassTree classtree)
           throws java.io.IOException

Constructor to construct TreeWriter object.

Parameters:

configuration - the current configuration of the doclet.

filename - String filename

classtree - the tree being built.

Throws:

java.io.IOException

Method Detail

generate

public static void generate(ConfigurationImpl configuration,
                            ClassTree classtree)

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

Parameters:

classtree - the class tree being documented.

Throws:

DocletAbortException

generateTreeFile

public void generateTreeFile()
                      throws java.io.IOException

Print the interface hierarchy and class hierarchy in the file.

Throws:

java.io.IOException

printPackageTreeLinks

protected void printPackageTreeLinks()

Generate the links to all the package tree files.

printTreeHeader

protected void printTreeHeader()

Print the top text (from the -top option) and navigation bar at the top of page.

printTreeFooter

protected void printTreeFooter()

Print the navigation bar and bottom text (from the -bottom option) at the bottom of page.

printPageHeading

protected void printPageHeading()

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