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

Class sun.tools.javadoc.doclets.AbstractPackageIndexWriter

sun.tools.javadoc.doclets.HtmlWriter
    |
    +----sun.tools.javadoc.doclets.HtmlDocWriter
            |
            +----sun.tools.javadoc.doclets.AbstractPackageIndexWriter
Subclasses:
PackageIndexFrameWriter, PackageIndexWriter

public abstract class AbstractPackageIndexWriter
extends HtmlDocWriter
Abstract class to generate the package index. The package index needs to be generated in 1.1 compliant, Frame and Non-Frame format.


Field Summary
sun.tools.javadoc.doclets.PackageDoc[]  packages
          Array of Packages.
 
Fields inherited from class sun.tools.javadoc.doclets.HtmlDocWriter
 configuration, htmlFilename
 

Constructor Summary
 AbstractPackageIndexWriter(sun.tools.javadoc.doclets.String filename, sun.tools.javadoc.doclets.Root root)
          Constructor.
 

Method Summary
void  generatePackageIndexFile()
          Generate the contants in the package index file.
void  navLinkContents()
          Print packages contents link
void  printFirstRow(sun.tools.javadoc.doclets.String label)
          Print the first row of the index table.
void  printHeaderOrTitle()
          Print the header or title.
void  printIndex(boolean mustBeJava)
          Generate code for package index.
void  printIndexEnd()
          Print part of the index footer.
void  printIndexFooter()
          Print the footer for Non-Frame frmat output generation.
void  printIndexHeader()
          Print the header for Non-Frame frmat output generation.
void  printIndexRow(sun.tools.javadoc.doclets.PackageDoc packagedoc)
           
void  printIndexSpecificEnd()
          Print the specific index footer.
void  printOneOneHeader()
           
void  printOverview()
           
void  printTableMenuFirstRow(boolean mustBeJava)
           
 
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

packages

protected sun.tools.javadoc.doclets.PackageDoc[] packages
          Array of Packages.
Constructor Detail

AbstractPackageIndexWriter

public AbstractPackageIndexWriter(sun.tools.javadoc.doclets.String filename,
                                  sun.tools.javadoc.doclets.Root root) throws sun.tools.javadoc.doclets.IOException
          Constructor.
Method Detail

printTableMenuFirstRow

protected abstract void printTableMenuFirstRow(boolean mustBeJava)

printIndexRow

protected abstract void printIndexRow(sun.tools.javadoc.doclets.PackageDoc packagedoc)

printIndex

protected void printIndex(boolean mustBeJava)
          Generate code for package index. If parameter passed is true print only 'java.*' packages, else if parameter passed is false print everything but 'java.*' packages.
Parameters:
mustBeJava - boolean.

printOneOneHeader

protected void printOneOneHeader()

printOverview

protected void printOverview() throws sun.tools.javadoc.doclets.IOException

generatePackageIndexFile

protected void generatePackageIndexFile() throws sun.tools.javadoc.doclets.IOException
          Generate the contants in the package index file. Call appropriate methods from the sub-class in order to generate 1.1 or Frame or Non Frame format.

printIndexHeader

protected void printIndexHeader()
          Print the header for Non-Frame frmat output generation. Over-ridden in few sub-classes.

printIndexFooter

protected void printIndexFooter()
          Print the footer for Non-Frame frmat output generation. Over-ridden in few sub-classes.

printHeaderOrTitle

protected void printHeaderOrTitle()
          Print the header or title. Over-ridden in few sub-classes.

printIndexEnd

protected void printIndexEnd()
          Print part of the index footer.

printIndexSpecificEnd

protected void printIndexSpecificEnd()
          Print the specific index footer. The method is over-ridden in few sub-classes.

printFirstRow

protected void printFirstRow(sun.tools.javadoc.doclets.String label)
          Print the first row of the index table.

navLinkContents

protected void navLinkContents()
          Print packages contents link
Overrides:
navLinkContents in class HtmlDocWriter

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