Class HtmlDocWriter

  • Direct Known Subclasses:
    HtmlDocletWriter

    @Deprecated
    public abstract class HtmlDocWriter
    extends HtmlWriter
    Deprecated.
    Class for the Html Format Code Generation specific to JavaDoc. This Class contains methods related to the Html Code Generation which are used by the Sub-Classes in the package com.sun.tools.doclets.standard and com.sun.tools.doclets.oneone.

    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.

    Since:
    1.2
    Author:
    Atul M Dambalkar, Robert Field
    • Constructor Detail

      • HtmlDocWriter

        public HtmlDocWriter​(Configuration configuration,
                             DocPath filename)
                      throws IOException
        Deprecated.
        Constructor. Initializes the destination file name through the super class HtmlWriter.
        Parameters:
        filename - String file name.
        Throws:
        IOException
    • Method Detail

      • configuration

        public abstract Configuration configuration()
        Deprecated.
        Accessor for configuration.
      • getHyperLink

        public Content getHyperLink​(String where,
                                    Content label)
        Deprecated.
        Get Html Hyper Link Content.
        Parameters:
        where - Position of the link in the file. Character '#' is not needed.
        label - Tag for the link.
        Returns:
        a content tree for the hyper link
      • getHyperLink

        public Content getHyperLink​(SectionName sectionName,
                                    Content label)
        Deprecated.
        Get Html Hyper Link Content.
        Parameters:
        sectionName - The section name to which the link will be created.
        label - Tag for the link.
        Returns:
        a content tree for the hyper link
      • getHyperLink

        public Content getHyperLink​(SectionName sectionName,
                                    String where,
                                    Content label)
        Deprecated.
        Get Html Hyper Link Content.
        Parameters:
        sectionName - The section name combined with where to which the link will be created.
        where - The fragment combined with sectionName to which the link will be created.
        label - Tag for the link.
        Returns:
        a content tree for the hyper link
      • getDocLink

        public DocLink getDocLink​(String where)
        Deprecated.
        Get the link.
        Parameters:
        where - Position of the link in the file.
        Returns:
        a DocLink object for the hyper link
      • getDocLink

        public DocLink getDocLink​(SectionName sectionName)
        Deprecated.
        Get the link.
        Parameters:
        sectionName - The section name to which the link will be created.
        Returns:
        a DocLink object for the hyper link
      • getDocLink

        public DocLink getDocLink​(SectionName sectionName,
                                  String where)
        Deprecated.
        Get the link.
        Parameters:
        sectionName - The section name combined with where to which the link will be created.
        where - The fragment combined with sectionName to which the link will be created.
        Returns:
        a DocLink object for the hyper link
      • getName

        public String getName​(String name)
        Deprecated.
        Convert the name to a valid HTML name.
        Parameters:
        name - the name that needs to be converted to valid HTML name.
        Returns:
        a valid HTML name string.
      • getHyperLink

        public Content getHyperLink​(DocPath link,
                                    Content label)
        Deprecated.
        Get Html hyperlink.
        Parameters:
        link - path of the file.
        label - Tag for the link.
        Returns:
        a content tree for the hyper link
      • getHyperLink

        public Content getHyperLink​(DocPath link,
                                    Content label,
                                    String title,
                                    String target)
        Deprecated.
        Get Html Hyper Link.
        Parameters:
        link - String name of the file.
        label - Tag for the link.
        title - String that describes the link's content for accessibility.
        target - Target frame.
        Returns:
        a content tree for the hyper link.
      • getPkgName

        public String getPkgName​(ClassDoc cd)
        Deprecated.
        Get the name of the package, this class is in.
        Parameters:
        cd - ClassDoc.
      • getMemberDetailsListPrinted

        public boolean getMemberDetailsListPrinted()
        Deprecated.
      • printFramesDocument

        public void printFramesDocument​(String title,
                                        ConfigurationImpl configuration,
                                        HtmlTree body)
                                 throws IOException
        Deprecated.
        Print the frames version of the Html file header. Called only when generating an HTML frames file.
        Parameters:
        title - Title of this HTML document
        configuration - the configuration object
        body - the body content tree to be added to the HTML document
        Throws:
        IOException
      • getStyleSheetProperties

        public HtmlTree getStyleSheetProperties​(ConfigurationImpl configuration)
        Deprecated.
        Returns a link to the stylesheet file.
        Returns:
        an HtmlTree for the lINK tag which provides the stylesheet location
      • getGeneratedBy

        protected Comment getGeneratedBy​(boolean timestamp)
        Deprecated.