Class FrameOutputWriter


@Deprecated public class FrameOutputWriter extends HtmlDocletWriter
Deprecated.
Generate the documentation in the Html "frame" format in the browser. The generated documentation will have two or three frames depending upon the number of packages on the command line. In general there will be three frames in the output, a left-hand top frame will have a list of all packages with links to target left-hand bottom frame. The left-hand bottom frame will have the particular package contents or the all-classes list, where as the single right-hand frame will have overview or package summary or class file. Also take care of browsers which do not support Html frames.

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

    • noOfPackages

      int noOfPackages
      Deprecated.
      Number of packages specified on the command line.
  • Constructor Details

    • FrameOutputWriter

      public FrameOutputWriter(ConfigurationImpl configuration, DocPath filename) throws IOException
      Deprecated.
      Constructor to construct FrameOutputWriter object.
      Parameters:
      filename - File to be generated.
      Throws:
      IOException
  • Method Details

    • generate

      public static void generate(ConfigurationImpl configuration)
      Deprecated.
      Construct FrameOutputWriter object and then use it to generate the Html file which will have the description of all the frames in the documentation. The name of the generated file is "index.html" which is the default first file for Html documents.
      Throws:
      DocletAbortException
    • generateFrameFile

      protected void generateFrameFile() throws IOException
      Deprecated.
      Generate the constants in the "index.html" file. Print the frame details as well as warning if browser is not supporting the Html frames.
      Throws:
      IOException
    • getFrameDetails

      protected Content getFrameDetails()
      Deprecated.
      Get the frame sizes and their contents.
      Returns:
      a content tree for the frame details
    • addAllPackagesFrameTag

      private void addAllPackagesFrameTag(Content contentTree)
      Deprecated.
      Add the IFRAME tag for the frame that lists all packages.
      Parameters:
      contentTree - the content tree to which the information will be added
    • addAllClassesFrameTag

      private void addAllClassesFrameTag(Content contentTree)
      Deprecated.
      Add the IFRAME tag for the frame that lists all classes.
      Parameters:
      contentTree - the content tree to which the information will be added
    • addClassFrameTag

      private void addClassFrameTag(Content contentTree)
      Deprecated.
      Add the IFRAME tag for the frame that describes the class in detail.
      Parameters:
      contentTree - the content tree to which the information will be added