com.sun.tools.doclets.formats.html
Class PackageFrameWriter

java.lang.Object
  java.io.Writer
      java.io.PrintWriter
          com.sun.tools.doclets.formats.html.markup.HtmlWriter
              com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
                  com.sun.tools.doclets.formats.html.HtmlDocletWriter
                      com.sun.tools.doclets.formats.html.PackageFrameWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable

public class PackageFrameWriter
extends HtmlDocletWriter

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.

Field Summary

private java.util.Set<ClassDoc>	documentedClasses The classes to be documented.
static java.lang.String	OUTPUT_FILE_NAME The name of the output file.
private PackageDoc	packageDoc The package being documented.

Fields inherited from class com.sun.tools.doclets.formats.html.HtmlDocletWriter

configuration, displayLength, filename, path, relativePath, relativepathNoSlash

Fields inherited from class com.sun.tools.doclets.formats.html.markup.HtmlWriter

fileseparator, htmlFilename, winTitle

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

PackageFrameWriter(ConfigurationImpl configuration, PackageDoc packageDoc)
Constructor to construct PackageFrameWriter object and to generate "package-frame.html" file in the respective package directory.

Method Summary

static void	generate(ConfigurationImpl configuration, PackageDoc packageDoc) Generate a package summary page for the left-hand bottom frame.
protected void	generateClassKindListing(ClassDoc[] arr, java.lang.String label) Generate specific class kind listing.
protected void	generateClassListing() Generate class listing for all the classes in this package.
protected void	printPackageHeader(java.lang.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 com.sun.tools.doclets.formats.html.HtmlDocletWriter

anchor, commentTagsToString, configuration, frame, frameEnd, frameSet, frameSetEnd, getAnchor, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getLink, getPackageLink, getPackageLink, getPreQualifiedClassLink, getTagletWriterInstance, getTypeParameterLinks, isClassLinkable, isCoreClass, italicsClassName, navCellEnd, navCellRevStart, navCellStart, navDetail, navHideLists, navLinkClass, navLinkClassIndex, navLinkClassUse, navLinkContents, navLinkDeprecated, navLinkHelp, navLinkIndex, navLinkMainTree, navLinkNext, navLinkNext, navLinkPackage, navLinkPackage, navLinkPrevious, navLinkPrevious, navLinks, navLinkTree, navShowLists, navShowLists, navSummary, pathString, pathString, pathToClass, printBottom, printDocLink, printDocLink, printHtmlHeader, printIndexHeading, printInlineComment, printInlineComment, printInlineDeprecatedComment, printInlineDeprecatedComment, printLink, printNoFramesTargetHyperLink, printPackageLink, printPackageLink, printPreQualifiedClassLink, printPreQualifiedStrongClassLink, printQualifiedClassLink, printSrcLink, printStyleSheetProperties, printSummaryComment, printSummaryComment, printSummaryDeprecatedComment, printSummaryDeprecatedComment, printSummaryDetailLinks, printTags, printTagsInfoFooter, printTagsInfoHeader, printTargetPackageLink, printText, printText, printText, printTop, printUserHeaderFooter, removeNonInlineHtmlTags, replace, replaceDocRootDir, seeTagToString, strongText, strongText, strongText, summaryRow, summaryRowEnd, tableHeaderEnd, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableIndexDetail, tableIndexSummary, tableInheritedHeaderEnd, tableInheritedHeaderStart, tableUseInfoHeaderStart, tdIndex, writeAnnotationInfo, writeAnnotationInfo, writeAnnotationInfo

Methods inherited from class com.sun.tools.doclets.formats.html.markup.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.formats.html.markup.HtmlWriter

address, addressEnd, aEnd, aName, anchor, anchor, blockquote, blockquoteEnd, body, bodyEnd, br, center, centerEnd, code, codeEnd, codeText, commentEnd, commentStart, dd, ddEnd, dl, dlEnd, dt, em, emEnd, font, fontEnd, fontNoNewLine, fontSizeStyle, fontStyle, getCode, getCodeEnd, getFontColor, getFontEnd, getStrong, getStrongEnd, 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, noScript, noScriptEnd, p, pEnd, pre, preEnd, preNoNewLine, printWinTitleScript, script, scriptEnd, space, strong, strong, strongEnd, sup, supEnd, table, table, table, table, tableEnd, td, tdAlign, tdAlignRowspan, tdAlignVAlign, tdAlignVAlignRowspan, tdBgcolorStyle, tdColspan, tdColspanBgcolorStyle, tdEnd, tdNowrap, tdVAlign, tdVAlignClass, tdWidth, thAlign, thAlignColspan, thAlignNowrap, thEnd, title, title, titleEnd, tr, trAlignVAlign, trBgcolor, trBgcolorStyle, trEnd, ul, ulEnd

Methods inherited from class java.io.PrintWriter

append, append, append, checkError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, 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

private PackageDoc packageDoc

The package being documented.

documentedClasses

private java.util.Set<ClassDoc> documentedClasses

The classes to be documented. Use this to filter out classes that will not be documented.

OUTPUT_FILE_NAME

public static final java.lang.String OUTPUT_FILE_NAME

The name of the output file.

See Also:

Constant Field Values

Constructor Detail

PackageFrameWriter

public PackageFrameWriter(ConfigurationImpl configuration,
                          PackageDoc packageDoc)
                   throws java.io.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:

configuration - the configuration of the doclet.

packageDoc - PackageDoc under consideration.

Throws:

java.io.IOException

Method Detail

generate

public static void generate(ConfigurationImpl configuration,
                            PackageDoc packageDoc)

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

Parameters:

configuration - the current configuration of the doclet.

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

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.

generateClassKindListing

protected void generateClassKindListing(ClassDoc[] arr,
                                        java.lang.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(java.lang.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.

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.