Class PackageIndexWriter


@Deprecated public class PackageIndexWriter extends AbstractPackageIndexWriter
Deprecated.
Generate the package index page "overview-summary.html" for the right-hand frame. A click on the package name on this page will update the same frame with the "package-summary.html" file for 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.

  • Field Details

    • root

      private RootDoc root
      Deprecated.
      Root of the program structure. Used for "overview" documentation.
    • groupPackageMap

      private Map<String,List<PackageDoc>> groupPackageMap
      Deprecated.
      Map representing the group of packages as specified on the command line.
      See Also:
    • groupList

      private List<String> groupList
      Deprecated.
      List to store the order groups as specified on the command line.
    • htmlTree

      private HtmlTree htmlTree
      Deprecated.
      HTML tree for main tag.
  • Constructor Details

    • PackageIndexWriter

      public PackageIndexWriter(ConfigurationImpl configuration, DocPath filename) throws IOException
      Deprecated.
      Construct the PackageIndexWriter. Also constructs the grouping information as provided on the command line by "-group" option. Stores the order of groups specified by the user.
      Throws:
      IOException
      See Also:
  • Method Details

    • generate

      public static void generate(ConfigurationImpl configuration)
      Deprecated.
      Generate the package index page for the right-hand frame.
      Parameters:
      configuration - the current configuration of the doclet.
    • addIndex

      protected void addIndex(Content body)
      Deprecated.
      Depending upon the grouping information and their titles, add separate table indices for each package group.
      Overrides:
      addIndex in class AbstractPackageIndexWriter
      Parameters:
      body - the documentation tree to which the index will be added
    • 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
    • addPackagesList

      protected void addPackagesList(Collection<PackageDoc> packages, Content tbody)
      Deprecated.
      Adds list of packages in the index table. Generate link to each package.
      Parameters:
      packages - Packages to which link is to be generated
      tbody - the documentation tree to which the list will be added
    • addOverviewHeader

      protected void addOverviewHeader(Content body)
      Deprecated.
      Adds the overview summary comment for this documentation. Add one line summary at the top of the page and generate a link to the description, which is added at the end of this page.
      Specified by:
      addOverviewHeader in class AbstractPackageIndexWriter
      Parameters:
      body - the documentation tree to which the overview header will be added
    • addOverviewComment

      protected void addOverviewComment(Content htmltree)
      Deprecated.
      Adds the overview comment as provided in the file specified by the "-overview" option on the command line.
      Parameters:
      htmltree - the documentation tree to which the overview comment will be added
    • addOverview

      protected void addOverview(Content body) throws IOException
      Deprecated.
      Adds the tag information as provided in the file specified by the "-overview" option on the command line.
      Overrides:
      addOverview in class AbstractPackageIndexWriter
      Parameters:
      body - the documentation tree to which the overview will be added
      Throws:
      IOException
    • addNavigationBarHeader

      protected void addNavigationBarHeader(Content body)
      Deprecated.
      Adds the top text (from the -top option), the upper navigation bar, and then the title (from the"-title" option), at the top of page.
      Specified by:
      addNavigationBarHeader in class AbstractPackageIndexWriter
      Parameters:
      body - the documentation tree to which the navigation bar header will be added
    • addNavigationBarFooter

      protected void addNavigationBarFooter(Content body)
      Deprecated.
      Adds the lower navigation bar and the bottom text (from the -bottom option) at the bottom of page.
      Specified by:
      addNavigationBarFooter in class AbstractPackageIndexWriter
      Parameters:
      body - the documentation tree to which the navigation bar footer will be added