Package Torello.JavaDoc
Annotation Type IntoHTMLTable
-
@Retention(SOURCE) @Target({FIELD,CONSTRUCTOR,METHOD}) public @interface IntoHTMLTable
Requests that the Java-Doc Upgrader convert the Description area of a Java-Doc Web-Page Detail-Section into an HTML<TABLE>
Element. The Description portion of the Detail Description MUST be initially loaded with a series lines which begin with HTML<BR />
elements.
The following documentation example should help elucidate how this annotation may be used. This example is copied from theIntoHTMLTable.Background
enum documentaion. To view all examples of using this annotation, please review the color selections which are offered in the Nested-Enum (again, named 'Background
') for this class.- See Also:
IntoHTMLTable.Background
Hi-Lited Source-Code:This File's Source Code:
- View Here: Torello/JavaDoc/IntoHTMLTable.java
- Open New Browser-Tab: Torello/JavaDoc/IntoHTMLTable.java
File Size: 9,019 Bytes Line Count: 206 '\n' Characters Found
Annotation Processor Class:
- View Here: ../EntityAnnotations/Processor/IntoHTMLTableProcessor.java
- Open New Browser-Tab: ../EntityAnnotations/Processor/IntoHTMLTableProcessor.java
File Size: 7,724 Bytes Line Count: 207 '\n' Characters Found
Annotation Mirror Class:
- View Here: ../EntityAnnotations/Mirror/IHTMirror.java
- Open New Browser-Tab: ../EntityAnnotations/Mirror/IHTMirror.java
File Size: 8,297 Bytes Line Count: 204 '\n' Characters Found
All Detail-Annotation Mirrors:
- View Here: ../EntityAnnotations/Mirror/EntityAnnotationMirrors.java
- Open New Browser-Tab: ../EntityAnnotations/Mirror/EntityAnnotationMirrors.java
File Size: 8,633 Bytes Line Count: 205 '\n' Characters Found
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element IntoHTMLTable.Background
background
String
divCSSClass
String
tableCSSClass
String
title
-
-
-
Element Detail
-
background
IntoHTMLTable.Background background
Allows a user to select the CSS-Class, and therefore the Colors, assigned to both the HTML-Table, and the Title-Background for the Description-Area of this Detail-Element.
This is the "default" color-assignment which is used whenever no value is provided to the background value. This is an example of how to use this Enum-Constant with the@IntoHTMLTable
Annotation:
Example:
/** * <BR>Row-1 Title: This is the First Table-Row of the Description-Table * <BR>Row-2 Title: This is the Second Table-Row of the Description-Table */ @IntoHTMLTable( title="This is a Description-Table with a Brown-Dithered Background", background=Standard ) public void methodStandardBackground() { return; }
This is the HTML-Output which is generated after applying the CSS which has been assigned to this Enum-Constant:
This is a Description-Table with a Brown-Dithered BackgroundRow-1 Title: This is the First Table-Row of the Description-Table Row-2 Title: This is the Second Table-Row of the Description-Table
The Backgound CSS-Colors which are assigned to this Enum-Constant, for the<DIV CLASS=IHTA>
(Description Divider) Tag:
Cascading Style Sheet (CSS):
--Convenience-Dithered-Start: lightyellow; --Convenience-Dithered-End: #bb7a2a; /* --JD-Brown */ DIV.IHTA.Standard { background: linear-gradient( 0.25turn, var(--Convenience-Dithered-Start), 75%, var(--Convenience-Dithered-End) ); }
The Title & Backgound CSS-Colors which are assigned to this Enum-Constant, for the<SPAN CLASS=IHTA>
(Description Title) Tag:
Cascading Style Sheet (CSS):
--Convenience-Detail-Label-Color: white; --Convenience-Detail-Label-Background: #bb7a2a; DIV.IHTA.Standard SPAN.IHTA, DIV.IHTA.Brown SPAN.IHTA { color: var(--Convenience-Detail-Label-Color); background: var(--Convenience-Detail-Label-Background); }
- Default:
- Torello.JavaDoc.IntoHTMLTable.Background.Standard
- Code:
- Exact Element Declaration:
public Background background() default
-
-
-
title
java.lang.String title
This is the Title-String
that is placed at the top of the HTML-Table. It will be placed onto a small background Text-Box that is mono-colored according to the settings which are assigned to theIntoHTMLTable.Background
passed to this Annotation (or the defaultBackground
, if no such color is passed or requeted to thebackground()
Annotation-Element.
Title-String
Rules:- This
String
may not contain the characters: '\t', '\n' or '\r' - May it be more than
300
Characters long.
- Default:
- ""
- Code:
- Exact Element Declaration:
public String title() default
- This
-
-
-
divCSSClass
java.lang.String divCSSClass
This is an Optional Annotation-Element that should only be used if they provided Color-Settings that are offered by theIntoHTMLTable.Background
'enum' do not contain a sufficient number of choices to properly render the HTML-Table which needs to be rendered.
It is expected that the value provided to thisString
be a valid CSS'Class-Name'
. The Error-Checking Logic for the processor of this annotation will, indeed check theString
that is provided.
This is, likely, a lesser used feature of theIntoHTMLTable
-Annotation. It provides for the ability to assign a self-designated CSS-Class to the Primary-<DIV>
element. It is usually much easier to either:- Provide a value to the
background()
Annotation-Element - Provided no value, and allow that the default
Background
-Value be assigned.
Multiple CSS Classes
It is permissible to pass multiple CSS-Classes to thisString
-Element. In order to apply multiple classes, simple separate them with white-space characters, in such a way no different than if they had been used or applied inside of an Inline-CSSSTYLE
-Attribute.- Default:
- ""
- Code:
- Exact Element Declaration:
public String divCSSClass() default
- Provide a value to the
-
-
-
tableCSSClass
java.lang.String tableCSSClass
This is another extra feature that may be used to provide User-Defined / Proprietary CSS-Color choices to be applied to the HTML-Tables generated by this annotation. Much as in the previous (optional) element, the only requirement for the value provided to this element is that be a valid CSS Class-Name.
Validity Checking:
Please review both of the CSS-Naming rules which are explained in the previous Annotation-Element description box,divCSSClass()
As in that element, multiple Class-Names may, indeed, be provided, just so long as each of the names provided are separated by white-space, and are valid CSS Class-Names.
Example Use:
The following is an example of BOTH of the following:tableCSSClass()
(this element)divCSSClass()
Example:
/** * <BR>Row-1 Title: This is the First Table-Row of the Description-Table * <BR>Row-2 Title: This is the Second Table-Row of the Description-Table * <BR>Row-3: Table-Row 3 * <BR>Row-4: Table-Row 4 */ @IntoHTMLTable( title="This is a Description-Table with User-Provided CSS Definitions", divCSSClass="highlightedTitle rainbow-candy-cane", tableCSSClass="tableClass" ) public void specializedCSSClassExample() { return; }
User-Supplied CSS:
The following is a CSS File that contains the User-Provided CSS Definitions for this example. 100% of these definitions, by the way, were generated by "Chat-GPT" on March 11th 2025. Chat-GPT is usually very good at making great color choices and answering questions regarding the look and feel at CSS. If you ever try to ask it about placement, margin, padding, flex and stuff that sort of feels like "spacing", it can sometimes make mistakes...
Note that the following is not intended to be a "serious" design Color-Choices for any kind of Source-Code Documentation, but rather just intended to show-case (in as 'pretentious' manner as possible), how the Custom-User CSS Design-Elements provided by this Annotation may actually be used.
As mentioned there, this Annotation (IntoHTMLTable
) has two Custom-User Annotation-Elements, both of which are demonstrated in the following example.
First, though, is the Syntax-HiLited CSS-File which has produced the following Java-Doc Upgrader HTML Description-Table:
IHTBackground.css
The following output is what is generated by the above application of the@IntoHTMLTable
Annotation.
This is a Description-Table with User-Provided CSS DefinitionsRow-1 Title: This is the First Table-Row of the Description-Table Row-2 Title: This is the Second Table-Row of the Description-Table Row-3: Table-Row 3 Row-4: Table-Row 4 - Default:
- ""
- Code:
- Exact Element Declaration:
public String tableCSSClass() default
-
-