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

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

All Implemented Interfaces:

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

public class PackageWriterImpl
extends HtmlDocletWriter
implements PackageSummaryWriter

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

Field Summary

protected PackageDoc	next The next package name in the alpha-order list.
private static java.lang.String	OUTPUT_FILE_NAME The name of the output file.
protected PackageDoc	packageDoc The package being documented.
protected PackageDoc	prev The prev package name in the alpha-order list.

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

PackageWriterImpl(ConfigurationImpl configuration, PackageDoc packageDoc, PackageDoc prev, PackageDoc next)
Constructor to construct PackageWriter object and to generate "package-summary.html" file in the respective package directory.

Method Summary

java.lang.String	getOutputFileName() Return the name of the output file.
protected void	navLinkClassUse() Print "Use" link for this pacakge in the navigation bar.
protected void	navLinkNext() Print "NEXT PACKAGE" link in the navigation bar.
protected void	navLinkPackage() Highlight "Package" in the navigation bar, as this is the package page.
protected void	navLinkPrevious() Print "PREV PACKAGE" link in the navigation bar.
protected void	navLinkTree() Print "Tree" link in the navigation bar.
protected void	printFirstRow(java.lang.String label) Print the table heading for the class-listing.
void	writeClassesSummary(ClassDoc[] classes, java.lang.String label) Write the table of classes in this package.
void	writePackageDescription() Print the package description from the "packages.html" file.
void	writePackageFooter() Write the footer for the summary.
void	writePackageHeader(java.lang.String heading) Write the header for the summary.
void	writePackageTags() Print the tag information from the "packages.html" file.
void	writeSummaryFooter() Write the footer for the package summary.
void	writeSummaryHeader() Write the header for the package summary.

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

Methods inherited from interface com.sun.tools.doclets.internal.toolkit.PackageSummaryWriter

close

Field Detail

prev

protected PackageDoc prev

The prev package name in the alpha-order list.

next

protected PackageDoc next

The next package name in the alpha-order list.

packageDoc

protected PackageDoc packageDoc

The package being documented.

OUTPUT_FILE_NAME

private static final java.lang.String OUTPUT_FILE_NAME

The name of the output file.

See Also:

Constant Field Values

Constructor Detail

PackageWriterImpl

public PackageWriterImpl(ConfigurationImpl configuration,
                         PackageDoc packageDoc,
                         PackageDoc prev,
                         PackageDoc next)
                  throws java.io.IOException

Constructor to construct PackageWriter object and to generate "package-summary.html" file in the respective package directory. For example for package "java.lang" this will generate file "package-summary.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.

prev - Previous package in the sorted array.

next - Next package in the sorted array.

Throws:

java.io.IOException

Method Detail

getOutputFileName

public java.lang.String getOutputFileName()

Return the name of the output file.

Specified by:

getOutputFileName in interface PackageSummaryWriter

Returns:

the name of the output file.

writeSummaryHeader

public void writeSummaryHeader()

Write the header for the package summary.

Specified by:

writeSummaryHeader in interface PackageSummaryWriter

writeSummaryFooter

public void writeSummaryFooter()

Write the footer for the package summary.

Specified by:

writeSummaryFooter in interface PackageSummaryWriter

writeClassesSummary

public void writeClassesSummary(ClassDoc[] classes,
                                java.lang.String label)

Write the table of classes in this package.

Specified by:

writeClassesSummary in interface PackageSummaryWriter

Parameters:

classes - the array of classes to document.

label - the label for this table.

printFirstRow

protected void printFirstRow(java.lang.String label)

Print the table heading for the class-listing.

Parameters:

label - Label for the Class kind listing.

writePackageDescription

public void writePackageDescription()

Print the package description from the "packages.html" file.

Specified by:

writePackageDescription in interface PackageSummaryWriter

writePackageTags

public void writePackageTags()

Print the tag information from the "packages.html" file.

Specified by:

writePackageTags in interface PackageSummaryWriter

writePackageHeader

public void writePackageHeader(java.lang.String heading)

Write the header for the summary.

Specified by:

writePackageHeader in interface PackageSummaryWriter

Parameters:

heading - Package name.

writePackageFooter

public void writePackageFooter()

Write the footer for the summary.

Specified by:

writePackageFooter in interface PackageSummaryWriter

navLinkClassUse

protected void navLinkClassUse()

Print "Use" link for this pacakge in the navigation bar.

Overrides:

navLinkClassUse in class HtmlDocletWriter

navLinkPrevious

protected void navLinkPrevious()

Print "PREV PACKAGE" link in the navigation bar.

Overrides:

navLinkPrevious in class HtmlDocletWriter

navLinkNext

protected void navLinkNext()

Print "NEXT PACKAGE" link in the navigation bar.

Overrides:

navLinkNext in class HtmlDocletWriter

navLinkTree

protected void navLinkTree()

Print "Tree" link in the navigation bar. This will be link to the package tree file.

Overrides:

navLinkTree in class HtmlDocletWriter

navLinkPackage

protected void navLinkPackage()

Highlight "Package" in the navigation bar, as this is the package page.

Overrides:

navLinkPackage in class HtmlDocletWriter