Class PackageIndexFrameWriter


  • @Deprecated
    public class PackageIndexFrameWriter
    extends AbstractPackageIndexWriter
    Deprecated.
    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.

    This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

    Author:
    Atul M Dambalkar
    • Constructor Detail

      • PackageIndexFrameWriter

        public PackageIndexFrameWriter​(ConfigurationImpl configuration,
                                       DocPath filename)
                                throws IOException
        Deprecated.
        Construct the PackageIndexFrameWriter object.
        Parameters:
        filename - Name of the package index file to be generated.
        Throws:
        IOException
    • Method Detail

      • addPackagesList

        protected void addPackagesList​(Collection<PackageDoc> packages,
                                       String text,
                                       String tableSummary,
                                       Content body)
        Deprecated.
        Adds the packages list to the documentation tree.
        Specified by:
        addPackagesList in class AbstractPackageIndexWriter
        Parameters:
        packages - a collection of packagedoc objects
        text - caption for the table
        tableSummary - summary for the table
        body - the document tree to which the packages list will be added
      • getPackage

        protected Content getPackage​(PackageDoc pd)
        Deprecated.
        Returns each package name as a separate link.
        Parameters:
        pd - PackageDoc
        Returns:
        content for the package link
      • addNavigationBarHeader

        protected void addNavigationBarHeader​(Content body)
        Deprecated.
        Adds the navigation bar header to the documentation tree.
        Specified by:
        addNavigationBarHeader in class AbstractPackageIndexWriter
        Parameters:
        body - the document tree to which the navigation bar header will be added
      • addOverviewHeader

        protected void addOverviewHeader​(Content body)
        Deprecated.
        Do nothing as there is no overview information in this page.
        Specified by:
        addOverviewHeader in class AbstractPackageIndexWriter
        Parameters:
        body - the document tree to which the overview header will be added
      • addAllClassesLink

        protected void addAllClassesLink​(Content ul)
        Deprecated.
        Adds "All Classes" link for the top of the left-hand frame page to the documentation tree.
        Overrides:
        addAllClassesLink in class AbstractPackageIndexWriter
        Parameters:
        ul - the Content object to which the "All Classes" link should be added
      • addNavigationBarFooter

        protected void addNavigationBarFooter​(Content body)
        Deprecated.
        Adds the navigation bar footer to the documentation tree.
        Specified by:
        addNavigationBarFooter in class AbstractPackageIndexWriter
        Parameters:
        body - the document tree to which the navigation bar footer will be added