Annotation Type JDHeaderBackgroundImg

  • @Target(TYPE)
@Retention(SOURCE)
public @interface JDHeaderBackgroundImg
    Genuine Java Annotation:
    This is the actual annotation that a user may place in a '.java' file. This annotation generates a Wood-Plank Background Image for a small header containing useful information about the Source-Code.

    The comment you are looking at / reading right now was inserted into this JavaDoc Web-Page using this very Annotation. (A self-documenting annotation?)

    The @JDHeaderBackgroundImg annotation may only be placed on a type Definition (or inner Type-Definition) - for example: class, interface, enum, record or @interface (annotation).

    Target:
    Specifically: @Target(ElementType.TYPE)

    has been placed on this @interface definition!
    Java-Annotation: A Java-Annotation for inserting a Wooden-Plank Background Image at the top of a Java-Doc Page using External-HTML File's; the image used is configurable, and my be changed by assigning the Annotation-Element Values appropriately.


    • Field Summary

      Fields 
      Modifier and Type Fields Description
      static java.lang.String DEFAULT_CSS_CLASS
      This is the default CSS-Class used for the <DIV> that is inserted.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element
      String[] CSSClass
      String[] EmbedTagFileID

    • Field Detail

      • DEFAULT_CSS_CLASS

        static final java.lang.String DEFAULT_CSS_CLASS
        This is the default CSS-Class used for the <DIV> that is inserted.

    • Element Detail

      • CSSClass

        java.lang.String[] CSSClass
        This Annotation-Element is optional. It is intended to contain the CSS-Class the user would like associated with the Java-Doc Header-Background Image Divider (the '<DIV>' element).

        This Optional-Element has a default-value, and that is to use a CSS-Class which contains an image of a "Dark Wooden Board" for a background-image. This image will serve as the background for an HTML divider '<DIV>' element that is placed at the top of the Java-Doc HTML Page for the type/class being annotated.

        Note that the default value for this element is, indeed, an Empty String[]-Array. The JavaDoc Upgrader will interpret this as a request to use the default CSS CLASS, which is "JDWoodBoardDark". Click DEFAULT_CSS_CLASS to view (or retrieve} this String

        IMPORTANT:
        It is advisable not to change the default value for this CSS CLASS. Though there shouldn't be any problems in using an alternate image, it will require (and, hopefully this is obvious) ... it will require writing your own definition for that CSS-Class and inserting it into your JavaDoc.css style-definitions page.

        Multiple CSS-Classes
        This Annotation-Element is, indeed, a String[]-Array, rather than just a simple-String. You may choose to provide mltiple CSS-Classes to this Annotation, and if you do - the HTML-<DIV> will have a 'CLASS' attribute with multiple CSS CLASS's assigned.

        This example shows assigning the default-background to a Java class. Since there is no EmbedTagFileID assigned to that element, the default Dark Wooden Plank will be used as a background. The Ugrader will look for the external-HTML in the default-directory location, which is listed first (followed by the example)
        "SrcPackageDirectory/upgrade-files/external-html/JDHBI/MyClass.html"

        This example shows how to assign an alternate CSS-Class to the HTML <DIV> element that is inserted. In this example, two user-provided CSS classes are going to be applied to the <DIV>. Again, as in the previous example, the Ugrader will look for the External-HTML file in the default location:
        Default:
        {}

      • EmbedTagFileID

        java.lang.String[] EmbedTagFileID
        This Annotation-Element is also optional. If used, it must contain a valid FILE-ID that is listed in either the Package-Local, or the Global Embed-Tags Map. This FILE-ID maps to the external HTML File that contains the HTML which is to be inserted on top of the Header-Banner containing the background image.

        If the Empty-String ("") is passed to this Annotation-Element, or if the default value (which is the Empty-String) is passed, then the JavaDoc Upgrader will look for the HTML inside the 'upgrade-files/' directory:

        "PackageSrcDirectory/upgrade-files/external-html/JDHBI/"

        For a file-name that matches the name of the CIET / Type (The 'ClassName'), but ending with the suffix '.html'. For instance, in the following snippet:

        The Upgrader would reference the external-html-ids.properties file which contained the definition.
        Default:
        {}