org.freehep.tools.doclet
Class AbstractTreeWriter

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

Direct Known Subclasses:

PackageTreeWriter, TreeWriter

public abstract class AbstractTreeWriter

extends HtmlStandardWriter

Abstract class to print the class hierarchy page for all the Classes. This is sub-classed by PackageTreeWriter and TreeWriter to generate the Package Tree and global Tree(for all the classes and packages) pages.

Author:

Atul M Dambalkar

Source Code:

AbstractTreeWriter.java

Field Summary

protected com.sun.tools.doclets.ClassTree

classtree The class and interface tree built by using 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

protected	AbstractTreeWriter(ConfigurationStandard configuration, String filename, com.sun.tools.doclets.ClassTree classtree) Constructor initilises classtree variable.
protected	AbstractTreeWriter(ConfigurationStandard configuration, String path, String filename, com.sun.tools.doclets.ClassTree classtree, com.sun.javadoc.PackageDoc pkg) Create appropriate directory for the package and also initilise the relative path from this generated file to the current or the destination directory.

Method Summary

protected void	generateLevelInfo(com.sun.javadoc.ClassDoc parent, List list) Generate each level of the class tree.
protected void	generateTree(List list, String heading) Generate the heading for the tree depending upon tree type if it's a Class Tree or Interface tree and also print the tree.
protected void	navLinkTree() Highlight "Tree" word in the navigation bar, since this is the tree page.
protected void	printExtendsImplements(com.sun.javadoc.ClassDoc parent, com.sun.javadoc.ClassDoc cd) Print the information regarding the classes which this class extends or implements.
protected void	printPartialInfo(com.sun.javadoc.ClassDoc cd) Print information about the class kind, if it's a "class" or "interface".
protected void	printTreeHeading(String heading) Print the heading for the tree.

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

Field Detail

classtree

protected final com.sun.tools.doclets.ClassTree classtree

The class and interface tree built by using ClassTree

Constructor Detail

AbstractTreeWriter

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

Constructor initilises classtree variable. This constructor will be used while generating global tree file "overview-tree.html".

Parameters:

filename - File to be generated.

classtree - Tree built by ClassTree

Throws:

IOException

com.sun.tools.doclets.DocletAbortException

AbstractTreeWriter

protected AbstractTreeWriter(ConfigurationStandard configuration,
                             String path,
                             String filename,
                             com.sun.tools.doclets.ClassTree classtree,
                             com.sun.javadoc.PackageDoc pkg)
                      throws IOException

Create appropriate directory for the package and also initilise the relative path from this generated file to the current or the destination directory. This constructor will be used while generating "package tree" file.

Parameters:

path - Directories in this path will be created if they are not already there.

filename - Name of the package tree file to be generated.

classtree - The tree built using ClassTree for the package pkg.

pkg - PackageDoc for which tree file will be generated.

Throws:

IOException

com.sun.tools.doclets.DocletAbortException

Method Detail

generateLevelInfo

protected void generateLevelInfo(com.sun.javadoc.ClassDoc parent,
                                 List list)

Generate each level of the class tree. For each sub-class or sub-interface indents the next level information. Recurses itself to generate subclasses info. To iterate is human, to recurse is divine - L. Peter Deutsch.

Parameters:

parent - the superclass or superinterface of the list.

list - list of the sub-classes at this level.

generateTree

protected void generateTree(List list,
                            String heading)

Generate the heading for the tree depending upon tree type if it's a Class Tree or Interface tree and also print the tree.

Parameters:

list - List of classes which are at the most base level, all the other classes in this run will derive from these classes.

heading - Heading for the tree.

printExtendsImplements

protected void printExtendsImplements(com.sun.javadoc.ClassDoc parent,
                                      com.sun.javadoc.ClassDoc cd)

Print the information regarding the classes which this class extends or implements.

Parameters:

cd - The classdoc under consideration.

printPartialInfo

protected void printPartialInfo(com.sun.javadoc.ClassDoc cd)

Print information about the class kind, if it's a "class" or "interface".

Parameters:

cd - classdoc.

printTreeHeading

protected void printTreeHeading(String heading)

Print the heading for the tree.

Parameters:

heading - Heading for the tree.

navLinkTree

protected void navLinkTree()

Highlight "Tree" word in the navigation bar, since this is the tree page.

Overrides:

navLinkTree in class HtmlStandardWriter