FileDocCategorySizeDatePackage
AbstractPackageWriter.javaAPI DocExample2812Wed Apr 19 11:17:10 BST 2000com.sun.tools.doclets.standard

AbstractPackageWriter

public abstract class AbstractPackageWriter extends HtmlStandardWriter
Abstract class to generate file for each package contents. Sub-classed to generate specific formats Frame and Non-Frame Output by {@link PackageIndexFrameWriter} and {@link PackageIndexFrameWriter} respectively.
author
Atul M Dambalkar

Fields Summary
PackageDoc
packagedoc
The package under consideration.
Constructors Summary
public AbstractPackageWriter(String path, String filename, PackageDoc packagedoc)
Create appropriate directory for the package and also initilise the relative path from this generated file to the current or the destination directory.

param
path Directories in this path will be created if they are not already there.
param
filename Name of the package summary file to be generated.
param
packagedoc PackageDoc under consideration.

        super(path, filename,
              DirectoryManager.getRelativePath(packagedoc.name()));
        this.packagedoc = packagedoc;
Methods Summary
protected abstract voidgenerateClassListing()

protected voidgeneratePackageFile()
Generate Individual Package File with Class/Interface/Exceptions and
Error Listing with the appropriate links. Calls the methods from the
sub-classes to generate the file contents.
        String pkgName = packagedoc.name();
        String heading = getText("doclet.Window_Package", 
                                  Standard.configuration().windowtitle,
            		          pkgName);
        printHeader(heading);
        printPackageHeader(pkgName);

        generateClassListing();
        printPackageDescription();

        printPackageFooter();
        printBodyHtmlEnd();
    
protected voidnavLinkPackage()
Highlight "Package" in the navigation bar, as this is the package page.
        navCellRevStart();
        fontStyle("NavBarFont1Rev");
        boldText("doclet.Package");
        fontEnd();
        navCellEnd();
    
protected abstract voidprintPackageDescription()
protected abstract voidprintPackageFooter()
protected abstract voidprintPackageHeader(java.lang.String head)