org.freehep.tools.doclet
Class PackageTreeWriter

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.PackageTreeWriter

public class PackageTreeWriter

extends AbstractTreeWriter

Class to generate Tree page for a package. The name of the file generated is "package-tree.html" and it is generated in the respective package directory.

Author:

Atul M Dambalkar

Source Code:

PackageTreeWriter.java

Field Summary

protected com.sun.javadoc.PackageDoc	next The next package name in the alpha-order list.
protected com.sun.javadoc.PackageDoc	packagedoc Package for which tree is to be generated.
protected com.sun.javadoc.PackageDoc	prev The previous package name in the alpha-order list.

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

PackageTreeWriter(ConfigurationStandard configuration, String path, String filename, com.sun.javadoc.PackageDoc packagedoc, com.sun.javadoc.PackageDoc prev, com.sun.javadoc.PackageDoc next, boolean noDeprecated)
Constructor.

Method Summary

static void	generate(ConfigurationStandard configuration, com.sun.javadoc.PackageDoc pkg, com.sun.javadoc.PackageDoc prev, com.sun.javadoc.PackageDoc next, boolean noDeprecated) Construct a PackageTreeWriter object and then use it to generate the package tree page.
protected void	generatePackageTreeFile() Generate a separate tree file for each package.
protected void	navLinkNext() Link for the next package tree file.
protected void	navLinkPackage() Link to the package summary page for the package of this tree.
protected void	navLinkPrevious() Link for the previous package tree file.
protected void	printLinkToMainTree() Generate a link to the tree for all the packages.
protected void	printPackageTreeFooter() Print the navigation bar footer for the package tree file.
protected void	printPackageTreeHeader() Print the navigation bar header for the package tree file.

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

packagedoc

protected com.sun.javadoc.PackageDoc packagedoc

Package for which tree is to be generated.

prev

protected com.sun.javadoc.PackageDoc prev

The previous package name in the alpha-order list.

next

protected com.sun.javadoc.PackageDoc next

The next package name in the alpha-order list.

Constructor Detail

PackageTreeWriter

public PackageTreeWriter(ConfigurationStandard configuration,
                         String path,
                         String filename,
                         com.sun.javadoc.PackageDoc packagedoc,
                         com.sun.javadoc.PackageDoc prev,
                         com.sun.javadoc.PackageDoc next,
                         boolean noDeprecated)
                  throws IOException

Constructor.

Throws:

IOException

com.sun.tools.doclets.DocletAbortException

Method Detail

generate

public static void generate(ConfigurationStandard configuration,
                            com.sun.javadoc.PackageDoc pkg,
                            com.sun.javadoc.PackageDoc prev,
                            com.sun.javadoc.PackageDoc next,
                            boolean noDeprecated)

Construct a PackageTreeWriter object and then use it to generate the package tree page.

Parameters:

pkg - Package for which tree file is to be generated.

prev - Previous package in the alpha-ordered list.

next - Next package in the alpha-ordered list.

noDeprecated - If true, do not generate any information for deprecated classe or interfaces.

Throws:

com.sun.tools.doclets.DocletAbortException

generatePackageTreeFile

protected void generatePackageTreeFile()
                                throws IOException

Generate a separate tree file for each package.

Throws:

IOException

printPackageTreeHeader

protected void printPackageTreeHeader()

Print the navigation bar header for the package tree file.

printLinkToMainTree

protected void printLinkToMainTree()

Generate a link to the tree for all the packages.

printPackageTreeFooter

protected void printPackageTreeFooter()

Print the navigation bar footer for the package tree file.

navLinkPrevious

protected void navLinkPrevious()

Link for the previous package tree file.

Overrides:

navLinkPrevious in class HtmlStandardWriter

navLinkNext

protected void navLinkNext()

Link for the next package tree file.

Overrides:

navLinkNext in class HtmlStandardWriter

navLinkPackage

protected void navLinkPackage()

Link to the package summary page for the package of this tree.

Overrides:

navLinkPackage in class HtmlStandardWriter