Contents | Package | Class | Tree | Index
PREV | NEXT SHOW LISTS | HIDE LISTS

Class sun.tools.javadoc.doclets.PackageWriter

sun.tools.javadoc.doclets.HtmlWriter
    |
    +----sun.tools.javadoc.doclets.HtmlDocWriter
            |
            +----sun.tools.javadoc.doclets.AbstractPackageWriter
                    |
                    +----sun.tools.javadoc.doclets.PackageWriter

public class PackageWriter
extends AbstractPackageWriter
Class to generate file for each package contents.

See Also:
sun.tools.javadoc.PackageDoc, HtmlDocWriter

Field Summary
sun.tools.javadoc.doclets.String  next
          The next package name in the alpha-ordr list.
sun.tools.javadoc.doclets.String  prev
          The prev package name in the alpha-ordr list.
 
Fields inherited from class sun.tools.javadoc.doclets.HtmlDocWriter
 configuration, htmlFilename
 

Constructor Summary
 PackageWriter(sun.tools.javadoc.doclets.String filename, sun.tools.javadoc.doclets.PackageDoc packagedoc, sun.tools.javadoc.doclets.String prev, sun.tools.javadoc.doclets.String next)
          Constructor.
 

Method Summary
static void  generate(sun.tools.javadoc.doclets.PackageDoc pkg, sun.tools.javadoc.doclets.String prev, sun.tools.javadoc.doclets.String next)
          Generate a package page.
void  generateClassKindListing(sun.tools.javadoc.doclets.ClassDoc[] arr, sun.tools.javadoc.doclets.String label)
          This method is used by genIndPackageFiles method to generate the Class/Interface...
void  generateClassListing()
          Generate class listing for all classes in this package.
void  navLinkNext()
          Print next package link
void  navLinkPrevious()
          Print previous package link
void  printFirstRow(sun.tools.javadoc.doclets.String label)
          Print the table heading for the class-listing.
void  printPackageComment()
          Print the package comment.
void  printPackageDescription()
          Print the package comment and the tag information.
void  printPackageFooter()
          Print the navigation bar links at the bottom.
void  printPackageHeader(sun.tools.javadoc.doclets.String heading)
          Print the navigation bar links at the top.
 
Methods inherited from class sun.tools.javadoc.doclets.AbstractPackageWriter
 generateClassListing, generatePackageFile, navLinkPackage, navLinkTree, printPackageDescription, printPackageFooter, printPackageHeader
 
Methods inherited from class sun.tools.javadoc.doclets.HtmlDocWriter
 boldText, error, error, error, error, firstSentence, frame, frameEnd, frameSet, frameSetEnd, generateTagInfo, getText, getText, getText, getText, navGap, navHideLists, navHideLists, navLinkClass, navLinkContents, navLinkDeprecated, navLinkHelp, navLinkIndex, navLinkMainTree, navLinkNext, navLinkNext, navLinkPackage, navLinkPackage, navLinkPrevious, navLinkPrevious, navLinks, navLinkTree, navLinkTree, navShowLists, navShowLists, notice, notice, notice, notice, printBottom, printClassLink, printClassLink, printClassLink, printFooter, printHeader, printHyperLink, printHyperLink, printImage, printIndexHeading, printMemberHyperLink, printNbsps, printPackageLink, printPackageLink, printPartialHeader, printPreQualifiedClassLink, printQualifiedClassLink, printSeeTags, printTargetClassLink, printTargetHyperLink, printText, printText, printUserHeaderFooter, spaces, summaryRow, summaryRowEnd, table, tableEnd, tableHeaderEnd, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableIndexDetail, tableIndexSummary, tableInheritedHeaderStart, tablePackageFrame, td, td, tdIndex, today, warning, warning, warning, warning
 
Methods inherited from class sun.tools.javadoc.doclets.HtmlWriter
 address, addressEnd, aEnd, aName, anchor, anchor, body, body, bodyEnd, bold, bold, boldEnd, br, center, centerEnd, code, codeEnd, dd, ddEnd, dl, dlEnd, dt, em, emEnd, font, fontColor, fontEnd, h1, h1, h1End, h2, h2, h2End, h3, h3, h3End, h4, h4, h4End, h5, h5End, head, headEnd, hr, hr, html, htmlEnd, img, italics, li, li, menu, menuEnd, p, pre, preEnd, space, sup, supEnd, td, tdAlign, tdAlignRowspan, tdColspan, tdEnd, title, titleEnd, tr, trBgcolor, trEnd, ul, ulEnd
 

Field Detail

prev

protected sun.tools.javadoc.doclets.String prev
          The prev package name in the alpha-ordr list.

next

protected sun.tools.javadoc.doclets.String next
          The next package name in the alpha-ordr list.
Constructor Detail

PackageWriter

public PackageWriter(sun.tools.javadoc.doclets.String filename,
                     sun.tools.javadoc.doclets.PackageDoc packagedoc,
                     sun.tools.javadoc.doclets.String prev,
                     sun.tools.javadoc.doclets.String next) throws sun.tools.javadoc.doclets.IOException
          Constructor.
Method Detail

generate

public static void generate(sun.tools.javadoc.doclets.PackageDoc pkg,
                            sun.tools.javadoc.doclets.String prev,
                            sun.tools.javadoc.doclets.String next) throws DocletAbortException
          Generate a package page.
Parameters:
package - the package to generate.

generateClassListing

protected void generateClassListing()
          Generate class listing for all classes in this package.
Overrides:
generateClassListing in class AbstractPackageWriter

generateClassKindListing

protected void generateClassKindListing(sun.tools.javadoc.doclets.ClassDoc[] arr,
                                        sun.tools.javadoc.doclets.String label)
          This method is used by genIndPackageFiles method to generate the Class/Interface... Listing.

printFirstRow

protected void printFirstRow(sun.tools.javadoc.doclets.String label)
          Print the table heading for the class-listing.

printPackageComment

protected void printPackageComment()
          Print the package comment.

printPackageDescription

protected void printPackageDescription() throws sun.tools.javadoc.doclets.IOException
          Print the package comment and the tag information.
Overrides:
printPackageDescription in class AbstractPackageWriter

printPackageHeader

protected void printPackageHeader(sun.tools.javadoc.doclets.String heading)
          Print the navigation bar links at the top.
Overrides:
printPackageHeader in class AbstractPackageWriter

printPackageFooter

protected void printPackageFooter()
          Print the navigation bar links at the bottom.
Overrides:
printPackageFooter in class AbstractPackageWriter

navLinkPrevious

protected void navLinkPrevious()
          Print previous package link
Overrides:
navLinkPrevious in class HtmlDocWriter

navLinkNext

protected void navLinkNext()
          Print next package link
Overrides:
navLinkNext in class HtmlDocWriter

Contents | Package | Class | Tree | Index
PREV | NEXT SHOW LISTS | HIDE LISTS