org.freehep.tools.doclet
Class AbstractPackageIndexWriter

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

Direct Known Subclasses:

PackageIndexFrameWriter, PackageIndexWriter

public abstract class AbstractPackageIndexWriter

extends HtmlStandardWriter

Abstract class to generate the overview files in Frame and Non-Frame format. This will be sub-classed by to generate overview-frame.html as well as overview-summary.html.

Author:

Atul M Dambalkar

Source Code:

AbstractPackageIndexWriter.java

Field Summary

protected com.sun.javadoc.PackageDoc[]

packages Array of Packages to be documented.

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

AbstractPackageIndexWriter(ConfigurationStandard configuration, String filename)
Constructor.

Method Summary

protected void	generateIndex() Generate the frame or non-frame package index.
protected void	generatePackageIndexFile(boolean includeScript) Generate the contants in the package index file.
protected void	navLinkContents() Highlight "Overview" in the bold format, in the navigation bar as this is the overview page.
protected void	printAllClassesPackagesLink() Do nothing.
protected void	printConfigurationTitle() Print the doctitle, if it is specified on the command line.
protected void	printIndexContents(com.sun.javadoc.PackageDoc[] packages, String text) Generate code for package index contents.
protected abstract void	printIndexFooter()
protected abstract void	printIndexHeader(String text)
protected abstract void	printIndexRow(com.sun.javadoc.PackageDoc pkg)
protected abstract void	printNavigationBarFooter()
protected abstract void	printNavigationBarHeader()
protected void	printOverview() Default to no overview, overwrite to add overview.
protected abstract void	printOverviewHeader()

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, navLinkDeprecated, navLinkHelp, navLinkIndex, navLinkMainTree, navLinkNext, navLinkNext, navLinkPackage, navLinkPackage, navLinkPrevious, navLinkPrevious, navLinks, navLinkTree, 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

packages

protected com.sun.javadoc.PackageDoc[] packages

Array of Packages to be documented.

Constructor Detail

AbstractPackageIndexWriter

public AbstractPackageIndexWriter(ConfigurationStandard configuration,
                                  String filename)
                           throws IOException

Constructor. Also initialises the packages variable.

Parameters:

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

Method Detail

printNavigationBarHeader

protected abstract void printNavigationBarHeader()

printNavigationBarFooter

protected abstract void printNavigationBarFooter()

printOverviewHeader

protected abstract void printOverviewHeader()

printIndexHeader

protected abstract void printIndexHeader(String text)

printIndexRow

protected abstract void printIndexRow(com.sun.javadoc.PackageDoc pkg)

printIndexFooter

protected abstract void printIndexFooter()

generatePackageIndexFile

protected void generatePackageIndexFile(boolean includeScript)
                                 throws IOException

Generate the contants in the package index file. Call appropriate methods from the sub-class in order to generate Frame or Non Frame format.

Parameters:

includeScript - boolean set true if windowtitle script is to be included

Throws:

IOException

printOverview

protected void printOverview()
                      throws IOException

Default to no overview, overwrite to add overview.

Throws:

IOException

generateIndex

protected void generateIndex()

Generate the frame or non-frame package index.

printIndexContents

protected void printIndexContents(com.sun.javadoc.PackageDoc[] packages,
                                  String text)

Generate code for package index contents. Call appropriate methods from the sub-classes.

Parameters:

packages - Array of packages to be documented.

text - String which will be used as the heading.

printConfigurationTitle

protected void printConfigurationTitle()

Print the doctitle, if it is specified on the command line.

navLinkContents

protected void navLinkContents()

Highlight "Overview" in the bold format, in the navigation bar as this is the overview page.

Overrides:

navLinkContents in class HtmlStandardWriter

printAllClassesPackagesLink

protected void printAllClassesPackagesLink()

Do nothing. This will be overridden in PackageIndexFrameWriter.