Package gw.gosudoc.com.sun.tools.doclets.formats.html

Class AbstractPackageIndexWriter

  • Direct Known Subclasses:
    PackageIndexFrameWriter, PackageIndexWriter
    @Deprecated
public abstract class AbstractPackageIndexWriter
extends HtmlDocletWriter
    Deprecated.
    Abstract class to generate the overview files in Frame and Non-Frame format. This will be sub-classed by to generate overview-frame.html as well as overview-summary.html.

    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, Bhavesh Patel (Modified)

    • Field Detail

      • packages

        protected SortedSet<PackageDoc> packages
        Deprecated.
        A Set of Packages to be documented.

    • Constructor Detail

      • AbstractPackageIndexWriter

        public AbstractPackageIndexWriter​(ConfigurationImpl configuration,
                                  DocPath filename)
                           throws IOException
        Deprecated.
        Constructor. Also initializes the packages variable.
        Parameters:
        configuration - The current configuration
        filename - Name of the package index file to be generated.
        Throws:
        IOException

    • Method Detail

      • addNavigationBarHeader

        protected abstract void addNavigationBarHeader​(Content body)
        Deprecated.
        Adds the navigation bar header to the documentation tree.
        Parameters:
        body - the document tree to which the navigation bar header will be added

      • addNavigationBarFooter

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

      • addOverviewHeader

        protected abstract void addOverviewHeader​(Content body)
        Deprecated.
        Adds the overview header to the documentation tree.
        Parameters:
        body - the document tree to which the overview header will be added

      • addPackagesList

        protected abstract void addPackagesList​(Collection<PackageDoc> packages,
                                        String text,
                                        String tableSummary,
                                        Content body)
        Deprecated.
        Adds the packages list to the documentation tree.
        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

      • buildPackageIndexFile

        protected void buildPackageIndexFile​(String title,
                                     boolean includeScript)
                              throws IOException
        Deprecated.
        Generate and prints the contents in the package index file. Call appropriate methods from the sub-class in order to generate Frame or Non Frame format.
        Parameters:
        title - the title of the window.
        includeScript - boolean set true if windowtitle script is to be included
        Throws:
        IOException

      • addOverview

        protected void addOverview​(Content body)
                    throws IOException
        Deprecated.
        Default to no overview, override to add overview.
        Parameters:
        body - the document tree to which the overview will be added
        Throws:
        IOException

      • addIndex

        protected void addIndex​(Content body)
        Deprecated.
        Adds the frame or non-frame package index to the documentation tree.
        Parameters:
        body - the document tree to which the index will be added

      • addIndexContents

        protected void addIndexContents​(Collection<PackageDoc> packages,
                                String text,
                                String tableSummary,
                                Content body)
        Deprecated.
        Adds package index contents. Call appropriate methods from the sub-classes. Adds it to the body HtmlTree
        Parameters:
        packages - a collection of packages to be documented
        text - string which will be used as the heading
        tableSummary - summary for the table
        body - the document tree to which the index contents will be added

      • addConfigurationTitle

        protected void addConfigurationTitle​(Content body)
        Deprecated.
        Adds the doctitle to the documentation tree, if it is specified on the command line.
        Parameters:
        body - the document tree to which the title will be added

      • getNavLinkContents

        protected Content getNavLinkContents()
        Deprecated.
        Returns highlighted "Overview", in the navigation bar as this is the overview page.
        Overrides:
        getNavLinkContents in class HtmlDocletWriter
        Returns:
        a Content object to be added to the documentation tree

      • addAllClassesLink

        protected void addAllClassesLink​(Content div)
        Deprecated.
        Do nothing. This will be overridden.
        Parameters:
        div - the document tree to which the all classes link will be added