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

Class sun.tools.javadoc.doclets.AbstractPackageWriter

sun.tools.javadoc.doclets.HtmlWriter
    |
    +----sun.tools.javadoc.doclets.HtmlDocWriter
            |
            +----sun.tools.javadoc.doclets.AbstractPackageWriter
Subclasses:
PackageFrameWriter, PackageWriter

public abstract class AbstractPackageWriter
extends HtmlDocWriter
Abstract class to generate file for each package contents. Sub-classed to generate specific formats for 1.1 compliant, Frame and Non-Frame Output.


Fields inherited from class sun.tools.javadoc.doclets.HtmlDocWriter
 configuration, htmlFilename
 

Constructor Summary
 AbstractPackageWriter(sun.tools.javadoc.doclets.String filename, sun.tools.javadoc.doclets.PackageDoc packagedoc)
          Constructor.
 

Method Summary
void  generateClassListing()
           
void  generatePackageFile()
          Generate Individual Package File with Class/Interface/Exceptions and Error Listing with the appropriate links.
void  navLinkPackage()
          Print this package link
void  navLinkTree()
          Print class/interface hierarchy link
void  printPackageDescription()
           
void  printPackageFooter()
           
void  printPackageHeader(sun.tools.javadoc.doclets.String head)
           
 
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
 

Constructor Detail

AbstractPackageWriter

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

generateClassListing

protected abstract void generateClassListing()

printPackageDescription

protected abstract void printPackageDescription() throws sun.tools.javadoc.doclets.IOException

printPackageHeader

protected abstract void printPackageHeader(sun.tools.javadoc.doclets.String head)

printPackageFooter

protected abstract void printPackageFooter()

generatePackageFile

protected void generatePackageFile() throws sun.tools.javadoc.doclets.IOException
          Generate Individual Package File with Class/Interface/Exceptions and Error Listing with the appropriate links. File names will be e.g. "package-java.io.applet.html". Calls the methods from the sub-classes.

navLinkTree

protected void navLinkTree()
          Print class/interface hierarchy link
Overrides:
navLinkTree in class HtmlDocWriter

navLinkPackage

protected void navLinkPackage()
          Print this package link
Overrides:
navLinkPackage in class HtmlDocWriter

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