Class PackageFrameWriter


@Deprecated public class PackageFrameWriter extends HtmlDocletWriter
Deprecated.
Class to generate file for each package contents in the left-hand bottom frame. This will list all the Class Kinds in the package. A click on any class-kind will update the right-hand 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

    • packageDoc

      private PackageDoc packageDoc
      Deprecated.
      The package being documented.
    • documentedClasses

      private Set<ClassDoc> documentedClasses
      Deprecated.
      The classes to be documented. Use this to filter out classes that will not be documented.
  • Constructor Details

    • PackageFrameWriter

      public PackageFrameWriter(ConfigurationImpl configuration, PackageDoc packageDoc) throws IOException
      Deprecated.
      Constructor to construct PackageFrameWriter object and to generate "package-frame.html" file in the respective package directory. For example for package "java.lang" this will generate file "package-frame.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.
      Throws:
      IOException
  • Method Details

    • generate

      public static void generate(ConfigurationImpl configuration, PackageDoc packageDoc)
      Deprecated.
      Generate a package summary page for the left-hand bottom frame. Construct the PackageFrameWriter object and then uses it generate the file.
      Parameters:
      configuration - the current configuration of the doclet.
      packageDoc - The package for which "pacakge-frame.html" is to be generated.
    • addClassListing

      protected void addClassListing(HtmlTree contentTree)
      Deprecated.
      Add class listing for all the classes in this package. Divide class listing as per the class kind and generate separate listing for Classes, Interfaces, Exceptions and Errors.
      Parameters:
      contentTree - the content tree to which the listing will be added
    • addClassKindListing

      protected void addClassKindListing(ClassDoc[] arr, Content labelContent, HtmlTree contentTree)
      Deprecated.
      Add specific class kind listing. Also add label to the listing.
      Parameters:
      arr - Array of specific class kinds, namely Class or Interface or Exception or Error
      labelContent - content tree of the label to be added
      contentTree - the content tree to which the class kind listing will be added