Package Torello.JavaDoc
Annotation Type JDHeaderBackgroundImg
-
@Target(TYPE) @Retention(SOURCE) public @interface JDHeaderBackgroundImg
JavaDoc Upgrader Annotations:@StaticFunctional(Excuses={...}, Excused={...})
Both of the Elements -Excuses
andExcused
- are optional.Excuses
accepts the enum'Excuse'
, or anExcuse[]
-Array.Excused
will accept aString
or aString[]
-Array
@JDHeaderBackgroundImg(CSSClass={...}, EmbedTagFileID={...})
Both of the Elements (CSSClass
andEmbedTagFileID
are optional). Both of them accept either aString
, or aString[]
-Array.
Genuine Java Annotation:
This is the actual annotation that a user may place in a'.java'
file. This annotation may only be placed on a type - and only on aclass
orinterface
.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.
Hi-Lited Source-Code:This File's Source Code:
- View Here: Torello/JavaDoc/JDHeaderBackgroundImg.java
- Open New Browser-Tab: Torello/JavaDoc/JDHeaderBackgroundImg.java
Annotation Processor Class:
- View Here: Torello/JavaDoc/Annotations/JDHBImgProcessor.java
- Open New Browser-Tab: Torello/JavaDoc/Annotations/JDHBImgProcessor.java
Annotation Mirror Class:
- View Here: Torello/JavaDoc/Annotations/AnnotationsMirror.java
- Open New Browser-Tab: Torello/JavaDoc/Annotations/AnnotationsMirror.java
-
-
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 thedefault
value for this element is, indeed, an EmptyString[]
-Array. The JavaDoc Upgrader will interpret this as a request to use the defaultCSS CLASS
, which is"JDWoodBoardDark"
. ClickDEFAULT_CSS_CLASS
to view (or retrieve} thisString
IMPORTANT:
It is advisable not to change the default value for thisCSS 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 thatCSS-Class
and inserting it into yourJavaDoc.css
style-definitions page.
MultipleCSS-Classes
This Annotation-Element is, indeed, aString[]
-Array, rather than just a simple-String
. You may choose to provide mltipleCSS-Classes
to this Annotation, and if you do - the HTML-<DIV>
will have a'CLASS'
attribute with multipleCSS CLASS's
assigned.
This example shows assigning the default-background to a Javaclass
. Since there is noEmbedTagFileID
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 validFILE-ID
that is listed in either thePackage-Local
, or theGlobal
Embed-Tags Map. ThisFILE-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 theexternal-html-ids.properties
file which contained the definition.- Default:
- {}
-
-