Class HiLiteSrcCodeFile


  • public class HiLiteSrcCodeFile
    extends java.lang.Object
    Process Java Doc Web-Page: Inserts link to a complete '.java' HiLited Source-File Page into a Java Doc Page.

    JD-Upgrader Internally Used Class, Methods are Package-Private

    There is largely no use for these methods outside of the Java Doc Upgrader Application. Little Java-Doc Style Documentation will be provided here. The code itself (and code comments) may be viewed using the HiLited Source Code Button in the Navigation-Bar, or the URL-Link that is lower on this page.

    To see how this Upgrader Application class works, click the HiLited Source Code Link above.

    This class' job is to call the HiLite Server and have the entire contents of one Java Source-Code File HiLited.

    1. Transmit the '.java' Source-Code to the HiLite.ME Server, and wait for the Code-HiLiting results
    2. Save this to the appropriate javadoc/ output directory
    3. Insert a link to this '.html' file in the CIET - Class, Interface or Enumerated-Type Java-Doc HTML page

    In any Upgraded Java-Doc HTML Web-Page, unless explicitly requested by the user to "avoid adding Source-Code File HiLite", two links to the HiLited Version of the Source-Code will be inserted into the Java-Doc Page.

    The HiLited Source Code File procedure is the one which creates links on your Java Doc Pages that look like:

    HiLited Source Code File Link

    A user may request to have "Extra Files" Hi-Lited, and their links added to any Java Doc Page. Here are examples of two files that have been added to provide more HiLited Source Examples.


    These two files were placed inside the following directories. When the Java Doc Upgrade Tool finds these files, it will automatically add all extra hiliting files onto their pages.

    • Torello/HTML/NodeSearch/upgrade-files/config-classes/ExtraHiLitedSrc.java
    • ../src/main/java/javax/json/upgrade-files/config-classes/ExtraHiLitedSrc.java

    NOTE:The files you may view in the links above are the actual files that were used in the most recent build of Java HTML - the one you are reading right now. Click on any of the search-classes in the package NodeSearch or any of the classes inside the external-import package java.json to see some classes which have had "extra source files" HiLited - with links inserted onto their pages.


Stateless Class: This class neither contains any program-state, nor can it be instantiated. The @StaticFunctional Annotation may also be called 'The Spaghetti Report'. Static-Functional classes are, essentially, C-Styled Files, without any constructors or non-static member field. It is very similar to the Java-Bean @Stateless Annotation.
  • 1 Constructor(s), 1 declared private, zero-argument constructor
  • 8 Method(s), 8 declared static
  • 20 Field(s), 20 declared static, 20 declared final


    • Field Detail

      • SRCCODE_ANCHOR

        🡇    
        protected static final java.util.Vector<HTMLNode> SRCCODE_ANCHOR
        This is the HTML Inserted into the Page.
        Code:
        Exact Field Declaration Expression:
        protected static final Vector<HTMLNode> SRCCODE_ANCHOR = HTMLPage.getPageTokens(
                "\n" +
                "<DIV ID=SRCCODELINK>\n" +
                "<SPAN CLASS=srcCodeLabel>Hi-Lited Source-Code:</SPAN>\n" +
                "<UL CLASS=JDUL>\n" +
                "<LI><SPAN STYLE='white-space: pre; font-family: monospace'>" +
                "View Here:              </SPAN><A>SRCCODE_FILE_NAME</A></LI>\n" +
                "<LI><SPAN STYLE='white-space: pre; font-family: monospace'>" +
                "Open New Browser-Tab:   </SPAN><A TARGET='_blank'>SRCCODE_FILE_NAME</A></LI>\n" +
                "</UL>\n" +
                "<SPAN STYLE='white-space: pre; font-family: monospace;'>" +
                "File Size:     FS Bytes\n" +
                "Line Count:    LC \'\\n\' Characters Found\n" +
                "</SPAN></DIV><BR /><BR />\n",
                false
            );
        
      • EXTRA_SRCCODE_ANCHOR

        🡅  🡇    
        protected static final java.util.Vector<HTMLNode> EXTRA_SRCCODE_ANCHOR
        Using a Lambda-Configuration with the Configuration-Class Upgrade, a user may request that additional HiLited Source Code Links be added to this section / area on Java Doc Class File Pages.

        This is the HTML that is added to the page, upon request.
        Code:
        Exact Field Declaration Expression:
        protected static final Vector<HTMLNode> EXTRA_SRCCODE_ANCHOR = HTMLPage.getPageTokens(
                "\n" +
                "<BR /><SPAN CLASS=SRCCODETITLE>DESCRIPTION</SPAN>\n" +
                "<BR />\n" +
                "<UL CLASS=JDUL>\n" +
                "<LI><SPAN STYLE='white-space: pre; font-family: monospace'>" +
                "View Here:              </SPAN><A>SRCCODE_FILE_NAME</A></LI>\n" +
                "<LI><SPAN STYLE='white-space: pre; font-family: monospace'>" +
                "Open New Browser-Tab:   </SPAN><A TARGET='_blank'>SRCCODE_FILE_NAME</A></LI>\n" +
                "</UL>\n" +
                "<SPAN STYLE='white-space: pre; font-family: monospace;'>" +
                "File Size:     FS Bytes\n" +
                "Line Count:    LC \'\\n\' Characters Found\n" +
                "</SPAN>\n",
                false
            );
        
    • Method Detail

      • retrieveHEADER

        🡅  🡇    
        public static java.util.Vector<HTMLNoderetrieveHEADER​
                    (java.lang.String cietName)
        
        Used in build library.
        Parameters:
        cietName - The name of the class, interface or enumerated-type whose source-code file is being hilited. This name will be placed in the title portion of the HTML <HEAD>...</HEAD> section.
        Returns:
        A clone of the Vector which is placed at the top of a HiLited Source Code '.html' File.
        Code:
        Exact Method Body:
         Vector<HTMLNode> header = (Vector<HTMLNode>) PAGE_HEADER.clone();
         header.setElementAt(new TextNode(cietName), titlePos);
         return header;
        
      • retrieveFOOTER

        🡅    
        public static java.util.Vector<HTMLNoderetrieveFOOTER()
        Used in build library. Must be declared public.
        Returns:
        a clone of the hilited source-code HTML-Vector page footer.
        Code:
        Exact Method Body:
         return (Vector<HTMLNode>) PAGE_FOOTER.clone();