Class HtmlWriter

  • Direct Known Subclasses:
    HtmlDocWriter

    @Deprecated
    public class HtmlWriter
    extends Object
    Deprecated.
    Class for the Html format code generation. Initializes PrintWriter with FileWriter, to enable print related methods to generate the code to the named File through FileWriter.

    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, Bhavesh Patel (Modified)
    • Field Detail

      • winTitle

        protected String winTitle
        Deprecated.
        The window title of this file
      • configuration

        protected Configuration configuration
        Deprecated.
        The configuration
      • memberDetailsListPrinted

        protected boolean memberDetailsListPrinted
        Deprecated.
        The flag to indicate whether a member details list is printed or not.
      • packageTableHeader

        protected final String[] packageTableHeader
        Deprecated.
        Header for tables displaying packages and description..
      • useTableSummary

        protected final String useTableSummary
        Deprecated.
        Summary for use tables displaying class and package use.
      • modifierTypeHeader

        protected final String modifierTypeHeader
        Deprecated.
        Column header for class docs displaying Modifier and Type header.
      • overviewLabel

        public final Content overviewLabel
        Deprecated.
      • defaultPackageLabel

        public final Content defaultPackageLabel
        Deprecated.
      • packageLabel

        public final Content packageLabel
        Deprecated.
      • useLabel

        public final Content useLabel
        Deprecated.
      • prevLabel

        public final Content prevLabel
        Deprecated.
      • nextLabel

        public final Content nextLabel
        Deprecated.
      • prevclassLabel

        public final Content prevclassLabel
        Deprecated.
      • nextclassLabel

        public final Content nextclassLabel
        Deprecated.
      • summaryLabel

        public final Content summaryLabel
        Deprecated.
      • detailLabel

        public final Content detailLabel
        Deprecated.
      • framesLabel

        public final Content framesLabel
        Deprecated.
      • noframesLabel

        public final Content noframesLabel
        Deprecated.
      • treeLabel

        public final Content treeLabel
        Deprecated.
      • classLabel

        public final Content classLabel
        Deprecated.
      • deprecatedLabel

        public final Content deprecatedLabel
        Deprecated.
      • deprecatedPhrase

        public final Content deprecatedPhrase
        Deprecated.
      • allclassesLabel

        public final Content allclassesLabel
        Deprecated.
      • allpackagesLabel

        public final Content allpackagesLabel
        Deprecated.
      • indexLabel

        public final Content indexLabel
        Deprecated.
      • helpLabel

        public final Content helpLabel
        Deprecated.
      • seeLabel

        public final Content seeLabel
        Deprecated.
      • descriptionLabel

        public final Content descriptionLabel
        Deprecated.
      • prevpackageLabel

        public final Content prevpackageLabel
        Deprecated.
      • nextpackageLabel

        public final Content nextpackageLabel
        Deprecated.
      • packagesLabel

        public final Content packagesLabel
        Deprecated.
      • methodDetailsLabel

        public final Content methodDetailsLabel
        Deprecated.
      • annotationTypeDetailsLabel

        public final Content annotationTypeDetailsLabel
        Deprecated.
      • fieldDetailsLabel

        public final Content fieldDetailsLabel
        Deprecated.
      • propertyDetailsLabel

        public final Content propertyDetailsLabel
        Deprecated.
      • constructorDetailsLabel

        public final Content constructorDetailsLabel
        Deprecated.
      • enumConstantsDetailsLabel

        public final Content enumConstantsDetailsLabel
        Deprecated.
      • specifiedByLabel

        public final Content specifiedByLabel
        Deprecated.
      • overridesLabel

        public final Content overridesLabel
        Deprecated.
      • descfrmClassLabel

        public final Content descfrmClassLabel
        Deprecated.
      • descfrmInterfaceLabel

        public final Content descfrmInterfaceLabel
        Deprecated.
      • script

        protected Content script
        Deprecated.
    • Method Detail

      • getResource

        public Content getResource​(String key)
        Deprecated.
        Get the configuration string as a content.
        Parameters:
        key - the key to look for in the configuration file
        Returns:
        a content tree for the text
      • getNonBreakResource

        public Content getNonBreakResource​(String key)
        Deprecated.
        Get the configuration string as a content, replacing spaces with non-breaking spaces.
        Parameters:
        key - the key to look for in the configuration file
        Returns:
        a content tree for the text
      • getResource

        public Content getResource​(String key,
                                   Object o)
        Deprecated.
        Get the configuration string as a content.
        Parameters:
        key - the key to look for in the configuration file
        o - string or content argument added to configuration text
        Returns:
        a content tree for the text
      • getResource

        public Content getResource​(String key,
                                   Object o0,
                                   Object o1)
        Deprecated.
        Get the configuration string as a content.
        Parameters:
        key - the key to look for in the configuration file
        o1 - string or content argument added to configuration text
        o2 - string or content argument added to configuration text
        Returns:
        a content tree for the text
      • getWinTitleScript

        protected HtmlTree getWinTitleScript()
        Deprecated.
        Returns an HtmlTree for the SCRIPT tag.
        Returns:
        an HtmlTree for the SCRIPT tag
      • getFramesJavaScript

        protected Content getFramesJavaScript()
        Deprecated.
        Returns a content tree for the SCRIPT tag for the main page(index.html).
        Returns:
        a content for the SCRIPT tag
      • getBody

        public HtmlTree getBody​(boolean includeScript,
                                String title)
        Deprecated.
        Returns an HtmlTree for the BODY tag.
        Parameters:
        includeScript - set true if printing windowtitle script
        title - title for the window
        Returns:
        an HtmlTree for the BODY tag
      • generateMethodTypesScript

        public void generateMethodTypesScript​(Map<String,​Integer> typeMap,
                                              Set<MethodTypes> methodTypes)
        Deprecated.
        Generated javascript variables for the document.
        Parameters:
        typeMap - map comprising of method and type relationship
        methodTypes - set comprising of all methods types for this class
      • addStyles

        public void addStyles​(HtmlStyle style,
                              StringBuilder vars)
        Deprecated.
        Adds javascript style variables to the document.
        Parameters:
        style - style to be added as a javascript variable
        vars - variable string to which the style variable will be added
      • getTitle

        public HtmlTree getTitle()
        Deprecated.
        Returns an HtmlTree for the TITLE tag.
        Returns:
        an HtmlTree for the TITLE tag
      • codeText

        public String codeText​(String text)
        Deprecated.
      • getSpace

        public Content getSpace()
        Deprecated.
        Return "&nbsp;", non-breaking space.
      • getModifierTypeHeader

        public String getModifierTypeHeader()
        Deprecated.