org.freehep.tools.doclet
Class PackageFrameWriter

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.AbstractPackageWriter
                          org.freehep.tools.doclet.PackageFrameWriter

public class PackageFrameWriter

extends AbstractPackageWriter

Class to generate file for each package contents in the left-hand bottom frame. This will list all the Class Kinds in the package. A click on any class-kind will update the right-hand frame with the clicked class-kind page.

Author:

Atul M Dambalkar

Source Code:

PackageFrameWriter.java

Field Summary

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

documentedClasses

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

PackageFrameWriter(ConfigurationStandard configuration, String path, String filename, com.sun.javadoc.PackageDoc packagedoc)
Constructor to construct PackageFrameWriter object and to generate "package-frame.html" file in the respective package directory.

Method Summary

static void	generate(ConfigurationStandard configuration, com.sun.javadoc.PackageDoc pkg) Generate a package summary page for the left-hand bottom frame.
protected void	generateClassKindListing(com.sun.javadoc.ClassDoc[] arr, String label) Generate specific class kind listing.
protected void	generateClassListing() Generate class listing for all the classes in this package.
protected void	printPackageDescription() Do nothing.
protected void	printPackageFooter() Do nothing.
protected void	printPackageHeader(String heading) Print the package link at the top of the class kind listing.
protected void	printPackageTableFooter() Closing Html tags for table of class kind listing.
protected void	printPackageTableHeader() The table for the class kind listing.

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

generatePackageFile, navLinkPackage

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

Constructor Detail

PackageFrameWriter

public PackageFrameWriter(ConfigurationStandard configuration,
                          String path,
                          String filename,
                          com.sun.javadoc.PackageDoc packagedoc)
                   throws IOException

Constructor to construct PackageFrameWriter object and to generate "package-frame.html" file in the respective package directory. For example for package "java.lang" this will generate file "package-frame.html" file in the "java/lang" directory. It will also create "java/lang" directory in the current or the destination directory if it doesen't exist.

Parameters:

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

filename - Name of the package summary file to be generated, "package-frame.html".

packagedoc - PackageDoc under consideration.

Throws:

IOException

com.sun.tools.doclets.DocletAbortException

Method Detail

generate

public static void generate(ConfigurationStandard configuration,
                            com.sun.javadoc.PackageDoc pkg)

Generate a package summary page for the left-hand bottom frame. Construct the PackageFrameWriter object and then uses it generate the file.

Parameters:

pkg - The package for which "pacakge-frame.html" is to be generated.

Throws:

com.sun.tools.doclets.DocletAbortException

generateClassListing

protected void generateClassListing()

Generate class listing for all the classes in this package. Divide class listing as per the class kind and generate separate listing for Classes, Interfaces, Exceptions and Errors.

Specified by:

generateClassListing in class AbstractPackageWriter

generateClassKindListing

protected void generateClassKindListing(com.sun.javadoc.ClassDoc[] arr,
                                        String label)

Generate specific class kind listing. Also add label to the listing.

Parameters:

arr - Array of specific class kinds, namely Class or Interface or Exception or Error.

label - Label for the listing

printPackageHeader

protected void printPackageHeader(String heading)

Print the package link at the top of the class kind listing. Clicking this link, package-summary page will appear in the right hand frame.

Specified by:

printPackageHeader in class AbstractPackageWriter

Parameters:

heading - Top Heading to be used for the class kind listing.

printPackageTableHeader

protected void printPackageTableHeader()

The table for the class kind listing.

printPackageTableFooter

protected void printPackageTableFooter()

Closing Html tags for table of class kind listing.

printPackageFooter

protected void printPackageFooter()

Do nothing. No footer is generated for this page.

Specified by:

printPackageFooter in class AbstractPackageWriter

printPackageDescription

protected void printPackageDescription()
                                throws IOException

Do nothing. Package Description is not generted in this page.

Specified by:

printPackageDescription in class AbstractPackageWriter

Throws:

IOException