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

Class sun.tools.javadoc.doclets.PackageTreeWriter

sun.tools.javadoc.doclets.HtmlWriter
    |
    +----sun.tools.javadoc.doclets.HtmlDocWriter
            |
            +----sun.tools.javadoc.doclets.AbstractTreeWriter
                    |
                    +----sun.tools.javadoc.doclets.PackageTreeWriter

public class PackageTreeWriter
extends AbstractTreeWriter
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-order list.
sun.tools.javadoc.doclets.PackageDoc  packagedoc
          Package for which tree is to be generated.
sun.tools.javadoc.doclets.String  prev
          The previous package name in the alpha-order list.
 
Fields inherited from class sun.tools.javadoc.doclets.AbstractTreeWriter
 classtree
 
Fields inherited from class sun.tools.javadoc.doclets.HtmlDocWriter
 configuration, htmlFilename
 

Constructor Summary
 PackageTreeWriter(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  generatePackageTreeFile()
          Generate a separate tree file for each package.
void  navLinkNext()
          Link for the next package tree file.
void  navLinkPackage()
          Print this package link
void  navLinkPrevious()
          Link for the previous package tree file.
void  printLinkToMainTree()
          Generate a link to the tree for all the packages.
void  printPackageTreeFooter()
          Print the navigation bar footer for the package tree file.
void  printPackageTreeHeader()
          Print the navigation bar header for the package tree file.
 
Methods inherited from class sun.tools.javadoc.doclets.AbstractTreeWriter
 equalNames, generateLevelInfo, generateTree, navLinkTree, printExtendsImplements, printPartialInfo, printTreeHeading
 
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

packagedoc

protected sun.tools.javadoc.doclets.PackageDoc packagedoc
          Package for which tree is to be generated.

prev

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

next

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

PackageTreeWriter

public PackageTreeWriter(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.

generatePackageTreeFile

protected void generatePackageTreeFile() throws sun.tools.javadoc.doclets.IOException
          Generate a separate tree file for each package.

printPackageTreeHeader

protected void printPackageTreeHeader()
          Print the navigation bar header for the package tree file.

printLinkToMainTree

protected void printLinkToMainTree()
          Generate a link to the tree for all the packages.

printPackageTreeFooter

protected void printPackageTreeFooter()
          Print the navigation bar footer for the package tree file.

navLinkPackage

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

navLinkPrevious

protected void navLinkPrevious()
          Link for the previous package tree file.
Overrides:
navLinkPrevious in class HtmlDocWriter

navLinkNext

protected void navLinkNext()
          Link for the next package tree file.
Overrides:
navLinkNext in class HtmlDocWriter

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