Class AllClassesFrameWriter


  • @Deprecated
    public class AllClassesFrameWriter
    extends HtmlDocletWriter
    Deprecated.
    Generate the file with list of all the classes in this run. This page will be used in the left-hand bottom frame, when "All Classes" link is clicked in the left-hand top frame. The name of the generated file is "allclasses-frame.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, Doug Kramer, Bhavesh Patel (Modified)
    • Field Detail

      • indexbuilder

        protected IndexBuilder indexbuilder
        Deprecated.
        Index of all the classes.
    • Constructor Detail

      • AllClassesFrameWriter

        public AllClassesFrameWriter​(ConfigurationImpl configuration,
                                     DocPath filename,
                                     IndexBuilder indexbuilder)
                              throws IOException
        Deprecated.
        Construct AllClassesFrameWriter object. Also initializes the indexbuilder variable in this class.
        Parameters:
        configuration - The current configuration
        filename - Path to the file which is getting generated.
        indexbuilder - Unicode based Index from IndexBuilder
        Throws:
        IOException
        DocletAbortException
    • Method Detail

      • generate

        public static void generate​(ConfigurationImpl configuration,
                                    IndexBuilder indexbuilder)
        Deprecated.
        Create AllClassesFrameWriter object. Then use it to generate the "allclasses-frame.html" file. Generate the file in the current or the destination directory.
        Parameters:
        indexbuilder - IndexBuilder object for all classes index.
        Throws:
        DocletAbortException
      • buildAllClassesFile

        protected void buildAllClassesFile​(boolean wantFrames)
                                    throws IOException
        Deprecated.
        Print all the classes in the file.
        Parameters:
        wantFrames - True if we want frames.
        Throws:
        IOException
      • addAllClasses

        protected void addAllClasses​(Content content,
                                     boolean wantFrames)
        Deprecated.
        Use the sorted index of all the classes and add all the classes to the content list.
        Parameters:
        content - HtmlTree content to which all classes information will be added
        wantFrames - True if we want frames.
      • addContents

        protected void addContents​(List<Doc> classlist,
                                   boolean wantFrames,
                                   Content content)
        Deprecated.
        Given a list of classes, generate links for each class or interface. If the class kind is interface, print it in the italics font. Also all links should target the right-hand frame. If clicked on any class name in this page, appropriate class page should get opened in the right-hand frame.
        Parameters:
        classlist - Sorted list of classes.
        wantFrames - True if we want frames.
        content - HtmlTree content to which the links will be added