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

Class PackageWriterImpl

java.lang.Object
gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter
gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
gw.gosudoc.com.sun.tools.doclets.formats.html.PackageWriterImpl
All Implemented Interfaces:
PackageSummaryWriter
@Deprecated public class PackageWriterImpl extends HtmlDocletWriter implements PackageSummaryWriter
Deprecated.
Class to generate file for each package contents in the right-hand frame. This will list all the Class Kinds in the package. A click on any class-kind will update the frame with the clicked class-kind page.

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

    • prev

      protected PackageDoc prev
      Deprecated.
      The prev package name in the alpha-order list.

    • next

      protected PackageDoc next
      Deprecated.
      The next package name in the alpha-order list.

    • packageDoc

      protected PackageDoc packageDoc
      Deprecated.
      The package being documented.

    • mainTree

      protected HtmlTree mainTree
      Deprecated.
      The HTML tree for main tag.

    • sectionTree

      protected HtmlTree sectionTree
      Deprecated.
      The HTML tree for section tag.

  • Constructor Details

    • PackageWriterImpl

      public PackageWriterImpl(ConfigurationImpl configuration, PackageDoc packageDoc, PackageDoc prev, PackageDoc next) throws IOException
      Deprecated.
      Constructor to construct PackageWriter object and to generate "package-summary.html" file in the respective package directory. For example for package "java.lang" this will generate file "package-summary.html" file in the "java/lang" directory. It will also create "java/lang" directory in the current or the destination directory if it doesn't exist.
      Parameters:
      configuration - the configuration of the doclet.
      packageDoc - PackageDoc under consideration.
      prev - Previous package in the sorted array.
      next - Next package in the sorted array.
      Throws:
      IOException

  • Method Details

    • getPackageHeader

      public Content getPackageHeader(String heading)
      Deprecated.
      Get the header for the summary.
      Specified by:
      getPackageHeader in interface PackageSummaryWriter
      Parameters:
      heading - Package name.
      Returns:
      the header to be added to the content tree

    • getContentHeader

      public Content getContentHeader()
      Deprecated.
      Get the header for the package content.
      Specified by:
      getContentHeader in interface PackageSummaryWriter
      Returns:
      a content tree for the package content header

    • addDeprecationInfo

      public void addDeprecationInfo(Content div)
      Deprecated.
      Add the package deprecation information to the documentation tree.
      Parameters:
      div - the content tree to which the deprecation information will be added

    • getSummaryHeader

      public Content getSummaryHeader()
      Deprecated.
      Get the header for the package summary.
      Specified by:
      getSummaryHeader in interface PackageSummaryWriter
      Returns:
      a content tree with the package summary header

    • addClassesSummary

      public void addClassesSummary(ClassDoc[] classes, String label, String tableSummary, String[] tableHeader, Content summaryContentTree)
      Deprecated.
      Adds the table of classes to the documentation tree.
      Specified by:
      addClassesSummary in interface PackageSummaryWriter
      Parameters:
      classes - the array of classes to document.
      label - the label for this table.
      tableSummary - the summary string for the table
      tableHeader - array of table headers
      summaryContentTree - the content tree to which the summaries will be added

    • addPackageDescription

      public void addPackageDescription(Content packageContentTree)
      Deprecated.
      Adds the package description from the "packages.html" file to the documentation tree.
      Specified by:
      addPackageDescription in interface PackageSummaryWriter
      Parameters:
      packageContentTree - the content tree to which the package description will be added

    • addPackageTags

      public void addPackageTags(Content packageContentTree)
      Deprecated.
      Adds the tag information from the "packages.html" file to the documentation tree.
      Specified by:
      addPackageTags in interface PackageSummaryWriter
      Parameters:
      packageContentTree - the content tree to which the package tags will be added

    • addPackageContent

      public void addPackageContent(Content contentTree, Content packageContentTree)
      Deprecated.
      Adds the tag information from the "packages.html" or "package-info.java" file to the documentation tree.
      Specified by:
      addPackageContent in interface PackageSummaryWriter
      Parameters:
      contentTree - the content tree to which the package content tree will be added
      packageContentTree - the package content tree to be added

    • addPackageFooter

      public void addPackageFooter(Content contentTree)
      Deprecated.
      Adds the footer to the documentation tree.
      Specified by:
      addPackageFooter in interface PackageSummaryWriter
      Parameters:
      contentTree - the tree to which the footer will be added

    • printDocument

      public void printDocument(Content contentTree) throws IOException
      Deprecated.
      Print the package summary document.
      Specified by:
      printDocument in interface PackageSummaryWriter
      Parameters:
      contentTree - the content tree that will be printed
      Throws:
      IOException

    • getNavLinkClassUse

      protected Content getNavLinkClassUse()
      Deprecated.
      Get "Use" link for this pacakge in the navigation bar.
      Overrides:
      getNavLinkClassUse in class HtmlDocletWriter
      Returns:
      a content tree for the class use link

    • getNavLinkPrevious

      public Content getNavLinkPrevious()
      Deprecated.
      Get "PREV PACKAGE" link in the navigation bar.
      Overrides:
      getNavLinkPrevious in class HtmlDocletWriter
      Returns:
      a content tree for the previous link

    • getNavLinkNext

      public Content getNavLinkNext()
      Deprecated.
      Get "NEXT PACKAGE" link in the navigation bar.
      Overrides:
      getNavLinkNext in class HtmlDocletWriter
      Returns:
      a content tree for the next link

    • getNavLinkTree

      protected Content getNavLinkTree()
      Deprecated.
      Get "Tree" link in the navigation bar. This will be link to the package tree file.
      Overrides:
      getNavLinkTree in class HtmlDocletWriter
      Returns:
      a content tree for the tree link

    • getNavLinkPackage

      protected Content getNavLinkPackage()
      Deprecated.
      Highlight "Package" in the navigation bar, as this is the package page.
      Overrides:
      getNavLinkPackage in class HtmlDocletWriter
      Returns:
      a content tree for the package link