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

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.AbstractPackageIndexWriter
                          com.sun.tools.doclets.formats.html.PackageIndexWriter

All Implemented Interfaces:

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

public class PackageIndexWriter
extends AbstractPackageIndexWriter

Generate the package index page "overview-summary.html" for the right-hand frame. A click on the package name on this page will update the same frame with the "pacakge-summary.html" file for the clicked package.

Field Summary

private java.util.List<java.lang.String>	groupList List to store the order groups as specified on the command line.
private java.util.Map<java.lang.String,java.util.List<PackageDoc>>	groupPackageMap Map representing the group of packages as specified on the command line.
private RootDoc	root Root of the program structure.

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

packages

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

PackageIndexWriter(ConfigurationImpl configuration, java.lang.String filename)
Construct the PackageIndexWriter.

Method Summary

static void	generate(ConfigurationImpl configuration) Generate the package index page for the right-hand frame.
protected void	generateIndex() Depending upon the grouping information and their titles, generate separate table indices for each package group.
protected void	printIndexFooter() Print Html closing tags for the table for this package index.
protected void	printIndexHeader(java.lang.String text) Print Html tags for the table for this package index.
protected void	printIndexRow(PackageDoc pkg) Print each package in separate rows in the index table.
protected void	printNavigationBarFooter() Print the lower navigation bar and the bottom text (from the -bottom option) at the bottom of page.
protected void	printNavigationBarHeader() Print the top text (from the -top option), the upper navigation bar, and then the title (from the"-title" option), at the top of page.
protected void	printOverview() Call printOverviewComment() and then genrate the tag information as provided in the file specified by the "-overview" option on the command line.
protected void	printOverviewComment() Print the overview comment as provided in the file specified by the "-overview" option on the command line.
protected void	printOverviewHeader() Print the overview summary comment for this documentation.

Methods inherited from class com.sun.tools.doclets.formats.html.AbstractPackageIndexWriter

generatePackageIndexFile, navLinkContents, printAllClassesPackagesLink, printConfigurationTitle, printIndexContents

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

root

private RootDoc root

Root of the program structure. Used for "overview" documentation.

groupPackageMap

private java.util.Map<java.lang.String,java.util.List<PackageDoc>> groupPackageMap

Map representing the group of packages as specified on the command line.

See Also:

Group

groupList

private java.util.List<java.lang.String> groupList

List to store the order groups as specified on the command line.

Constructor Detail

PackageIndexWriter

public PackageIndexWriter(ConfigurationImpl configuration,
                          java.lang.String filename)
                   throws java.io.IOException

Construct the PackageIndexWriter. Also constructs the grouping information as provided on the command line by "-group" option. Stores the order of groups specified by the user.

Throws:

java.io.IOException

See Also:

Group

Method Detail

generate

public static void generate(ConfigurationImpl configuration)

Generate the package index page for the right-hand frame.

Parameters:

configuration - the current configuration of the doclet.

printIndexRow

protected void printIndexRow(PackageDoc pkg)

Print each package in separate rows in the index table. Generate link to each package.

Specified by:

printIndexRow in class AbstractPackageIndexWriter

Parameters:

pkg - Package to which link is to be generated.

generateIndex

protected void generateIndex()

Depending upon the grouping information and their titles, generate separate table indices for each package group.

Overrides:

generateIndex in class AbstractPackageIndexWriter

printOverviewHeader

protected void printOverviewHeader()

Print the overview summary comment for this documentation. Print one line summary at the top of the page and generate a link to the description, which is generated at the end of this page.

Specified by:

printOverviewHeader in class AbstractPackageIndexWriter

printIndexHeader

protected void printIndexHeader(java.lang.String text)

Print Html tags for the table for this package index.

Specified by:

printIndexHeader in class AbstractPackageIndexWriter

printIndexFooter

protected void printIndexFooter()

Print Html closing tags for the table for this package index.

Specified by:

printIndexFooter in class AbstractPackageIndexWriter

printOverviewComment

protected void printOverviewComment()

Print the overview comment as provided in the file specified by the "-overview" option on the command line.

printOverview

protected void printOverview()
                      throws java.io.IOException

Call printOverviewComment() and then genrate the tag information as provided in the file specified by the "-overview" option on the command line.

Overrides:

printOverview in class AbstractPackageIndexWriter

Throws:

java.io.IOException

printNavigationBarHeader

protected void printNavigationBarHeader()

Print the top text (from the -top option), the upper navigation bar, and then the title (from the"-title" option), at the top of page.

Specified by:

printNavigationBarHeader in class AbstractPackageIndexWriter

printNavigationBarFooter

protected void printNavigationBarFooter()

Print the lower navigation bar and the bottom text (from the -bottom option) at the bottom of page.

Specified by:

printNavigationBarFooter in class AbstractPackageIndexWriter