FileDocCategorySizeDatePackage
PackageIndexFrameWriter.javaAPI DocExample3985Wed Apr 19 11:17:12 BST 2000com.sun.tools.doclets.standard

PackageIndexFrameWriter

public class PackageIndexFrameWriter extends AbstractPackageIndexWriter
Generate the package index for the left-hand frame in the generated output. A click on the package name in this frame will update the page in the bottom left hand frame with the listing of contents of the clicked package.
author
Atul M Dambalkar

Fields Summary
Constructors Summary
public PackageIndexFrameWriter(String filename)
Construct the PackageIndexFrameWriter object.

param
filename Name of the package index file to be generated.

        super(filename);
Methods Summary
public static voidgenerate()
Generate the package index file named "overview-frame.html".

        PackageIndexFrameWriter packgen;
        String filename = "overview-frame.html";
        try {
            packgen = new PackageIndexFrameWriter(filename);
            packgen.generatePackageIndexFile();
            packgen.close();
        } catch (IOException exc) {
 Standard.configuration().standardmessage.error("doclet.exception_encountered", 
                                                 exc.toString(), filename);
            throw new DocletAbortException();
        }
protected voidprintAllClassesPackagesLink()
Print "All Classes" link at the top of the left-hand frame page.

        fontStyle("FrameItemFont");
        printTargetHyperLink("allclasses-frame.html", "packageFrame", 
                              getText("doclet.All_Classes"));
        fontEnd();
        p();
        fontSizeStyle("+1", "FrameHeadingFont");
        printText("doclet.Packages");
        fontEnd();
        br();
protected voidprintIndexFooter()
Print Html closing "table" tag at the end of the package index.

        printTableFooter();
protected voidprintIndexHeader(java.lang.String text)
Print Html "table" tag for the package index format.

param
text Text string will not be used in this method.

        printTableHeader();
protected voidprintIndexRow(com.sun.javadoc.PackageDoc pd)
Print each package name on separate rows.

param
pd PackageDoc

        fontStyle("FrameItemFont");
        printTargetHyperLink(pathString(pd, "package-frame.html"), 
                             "packageFrame", pd.name());
        fontEnd();
        br();
protected voidprintNavigationBarFooter()
Just print some space, since there is no navigation bar for this page.

        p();
        space();
protected voidprintNavigationBarHeader()
Print the "-header" in bold format, at top of the page. There is actually no navigation bar for this page.

        if (Standard.configuration().header != null) {
            printTableHeader();
            fontSizeStyle("+1", "FrameTitleFont");
            bold(Standard.configuration().header);
            fontEnd();
            printTableFooter();
        }
protected voidprintOverviewHeader()
Do nothing as there is no overview information in this page.
protected voidprintTableFooter()
Print Html closing tags for the table for package index.

        tdEnd();
        trEnd();
        tableEnd();
protected voidprintTableHeader()
Print Html tags for the table for package index.

        table();
        tr();
        tdNowrap();