org.freehep.tools.doclet
Class PackageIndexFrameWriter

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
                                      |
                                      +--org.freehep.tools.doclet.PackageIndexFrameWriter

public class PackageIndexFrameWriter

extends AbstractPackageIndexWriter

Generate the package index for the left-hand frame in the generated output. A click on the package name in this frame will update the page in the bottom left hand frame with the listing of contents of the clicked package.

Author:

Atul M Dambalkar

Field Summary

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

packages

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

backpath, checkedSoucePath, configuration, displayLength, DOC_FILES_DIR_NAME, filename, path, relativepath, shouldCopyDocFiles

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

PackageIndexFrameWriter(ConfigurationStandard configuration, String filename)
Construct the PackageIndexFrameWriter object.

Method Summary

static void	generate(ConfigurationStandard configuration) Generate the package index file named "overview-frame.html".
protected void	printAllClassesPackagesLink() Print "All Classes" link at the top of the left-hand frame page.
protected void	printIndexFooter() Print Html closing "table" tag at the end of the package index.
protected void	printIndexHeader(String text) Print Html "table" tag for the package index format.
protected void	printIndexRow(com.sun.javadoc.PackageDoc pd) Print each package name on separate rows.
protected void	printNavigationBarFooter() Just print some space, since there is no navigation bar for this page.
protected void	printNavigationBarHeader() Print the "-header" in bold format, at top of the page.
protected void	printOverviewHeader() Do nothing as there is no overview information in this page.
protected void	printTableFooter() Print Html closing tags for the table for package index.
protected void	printTableHeader() Print Html tags for the table for package index.

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

generateIndex, generatePackageIndexFile, navLinkContents, printConfigurationTitle, printIndexContents, printOverview

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

boldText, boldText, boldText, commentTagsToString, configuration, copyDocFiles, error, error, frame, frameEnd, frameSet, frameSetEnd, generateTagInfo, getClassLink, getClassLink, getClassLink, getClassLink, getClassLink, getClassLink, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getNoFramesTargetHyperLink, getPackageLink, getPackageLink, getPackageLink, getPackageLink, getPreQualifiedClassLink, getPreQualifiedClassLink, getQualifiedClassLink, getSourcePath, getTargetHyperLink, 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, printClassLinkForSameDir, printDocLink, printDocLink, printHeader, printIndexHeading, printInlineComment, printInlineComment, printInlineDeprecatedComment, printInlineDeprecatedComment, printNoFramesBoldTargetHyperLink, printPackageLink, printPackageLink, printPackageLink, printPreQualifiedBoldClassLink, printPreQualifiedClassLink, printQualifiedClassLink, printSinceTag, printSrcLink, printStyleSheetProperties, printSummaryComment, printSummaryDeprecatedComment, printSummaryDeprecatedComment, printSummaryDetailLinks, printTargetClassLink, printTargetHyperLink, printTargetHyperLink, printTargetHyperLink, printTargetPackageLink, printText, printText, printText, printUserHeaderFooter, removeNonInlineTags, 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, getPkgName, printBodyHtmlEnd, printFooter, printFrameFooter, printHyperLink, printHyperLink, printHyperLink, printHyperLink, printNbsps, printPartialHeader, printPkgName, spaces, today

Methods inherited from class com.sun.tools.doclets.HtmlWriter

address, addressEnd, aEnd, aName, anchor, anchor, blockquote, blockquoteEnd, body, 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, getScriptCode, 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, 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

PackageIndexFrameWriter

public PackageIndexFrameWriter(ConfigurationStandard configuration,
                               String filename)
                        throws IOException

Construct the PackageIndexFrameWriter object.

Parameters:

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

Method Detail

generate

public static void generate(ConfigurationStandard configuration)

Generate the package index file named "overview-frame.html".

Throws:

com.sun.tools.doclets.DocletAbortException

printIndexRow

protected void printIndexRow(com.sun.javadoc.PackageDoc pd)

Print each package name on separate rows.

Specified by:

printIndexRow in class AbstractPackageIndexWriter

Parameters:

pd - PackageDoc

printNavigationBarHeader

protected void printNavigationBarHeader()

Print the "-header" in bold format, at top of the page. There is actually no navigation bar for this page.

Specified by:

printNavigationBarHeader in class AbstractPackageIndexWriter

printOverviewHeader

protected void printOverviewHeader()

Do nothing as there is no overview information in this page.

Specified by:

printOverviewHeader in class AbstractPackageIndexWriter

printIndexHeader

protected void printIndexHeader(String text)

Print Html "table" tag for the package index format.

Specified by:

printIndexHeader in class AbstractPackageIndexWriter

Parameters:

text - Text string will not be used in this method.

printIndexFooter

protected void printIndexFooter()

Print Html closing "table" tag at the end of the package index.

Specified by:

printIndexFooter in class AbstractPackageIndexWriter

printAllClassesPackagesLink

protected void printAllClassesPackagesLink()

Print "All Classes" link at the top of the left-hand frame page.

Overrides:

printAllClassesPackagesLink in class AbstractPackageIndexWriter

printNavigationBarFooter

protected void printNavigationBarFooter()

Just print some space, since there is no navigation bar for this page.

Specified by:

printNavigationBarFooter in class AbstractPackageIndexWriter

printTableFooter

protected void printTableFooter()

Print Html closing tags for the table for package index.

printTableHeader

protected void printTableHeader()

Print Html tags for the table for package index.