java.lang.Object
- Torello.JavaDoc.CSSFiles

All Implemented Interfaces:

java.io.Serializable
```
public class CSSFiles
extends java.lang.Object
implements java.io.Serializable
```
A class for encapsulating all four JavaDoc Upgrader '.css' Files, each of which has been saved, in entirety, as a simple Java String. This class subsumes all CSS-Files that are utilized by the JavaDoc Upgrader.

See Also:

Serialized Form
Hi-Lited Source-Code:
- View Here: Torello/JavaDoc/CSSFiles.java
- Open New Browser-Tab: Torello/JavaDoc/CSSFiles.java
File Size: 11,106 Bytes Line Count: 291 '\n' Characters Found

Field Summary

Serializable ID

Modifier and Type	Field
`protected static long`	`serialVersionUID`

File-Name Static-Fields
Modifier and Type	Field
`static String`	`BASE64_ENCODED_CSS_FILENAME`
`static String`	`COLORS_CSS_FILENAME`
`static String`	`CUSTOMIZED_CSS_FILENAME`
`static String`	`JAVADOC_WIDGETS_CSS_FILENAME`
`static String`	`LIST_FRAMES_CSS_FILENAME`
`static String`	`PYGMENTS_ORG_CSS_FILENAME`
`static String`	`UPGRADER_WIDGETS_CSS_FILENAME`
`static String`	`USER_WIDGETS_CSS_FILENAME`

CSS-Definition Instance-Fields
Modifier and Type	Field
`String`	`base64EncodedCSS`
`String`	`colorsCSS`
`String`	`customizedCSS`
`String`	`listFramesCSS`
`String`	`originalWidgetsCSS`
`String`	`pygmentsOrgCSS`
`String`	`upgraderWidgetsCSS`
`String`	`userAccessoriesCSS`

Constructor Summary

Constructors
Constructor	Description
`CSSFiles(String colorsCSS, String base64EncodedCSS, String originalWidgetsCSS, String upgraderWidgetsCSS, String userAccessoriesCSS, String pygmentsOrgCSS, String listFramesCSS, String customizedCSS)`	Constructs an instance of this class by assigning the input parameters to the fields of the exact same name.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- serialVersionUID
  
  🡇 ⇈ ⮫ 🗕 🗗 🗖
```
protected static final long serialVersionUID
```
  See Also:
  
  Constant Field Values
  
  Code:
  
  Exact Field Declaration Expression:
  
  protected static final long serialVersionUID = 1;
- COLORS_CSS_FILENAME
  
  🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
```
public static final java.lang.String COLORS_CSS_FILENAME
```
  This static constant holds a '.css' File-Name. This particular file is one which holds the Java-Doc Upgrader CSS Color-Scheme.
  
  File-Name Field:
  This String-Field contains a File-Name only, it does not store actual CSS-Definitions.
  See Also:
  
  colorsCSS, Constant Field Values
  
  Code:
  
  Exact Field Declaration Expression:
  
  public static final String COLORS_CSS_FILENAME = "Colors.css";
- BASE64_ENCODED_CSS_FILENAME
  
  🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
```
public static final java.lang.String BASE64_ENCODED_CSS_FILENAME
```
  This static constant holds a '.css' File-Name. This particular file is one which holds Base-64 Encoded Image Data.
  
  File-Name Field:
  This String-Field contains a File-Name only, it does not store actual CSS-Definitions.
  See Also:
  
  colorsCSS, Constant Field Values
  
  Code:
  
  Exact Field Declaration Expression:
  
  public static final String BASE64_ENCODED_CSS_FILENAME = "Base64-Encoded.css";
- JAVADOC_WIDGETS_CSS_FILENAME
  
  🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
```
public static final java.lang.String JAVADOC_WIDGETS_CSS_FILENAME
```
  This static constant holds a '.css' File-Name. This particular file is one which holds CSS Definitions which are applied to HTML-Structures that were originally generated and inserted by the actual Java-Oracle 'javadoc' Tool itself.
  
  File-Name Field:
  This String-Field contains a File-Name only, it does not store actual CSS-Definitions.
  See Also:
  
  originalWidgetsCSS, Constant Field Values
  
  Code:
  
  Exact Field Declaration Expression:
  
  public static final String JAVADOC_WIDGETS_CSS_FILENAME = "Original-Widgets.css";
- UPGRADER_WIDGETS_CSS_FILENAME
  
  🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
```
public static final java.lang.String UPGRADER_WIDGETS_CSS_FILENAME
```
  This static constant holds a '.css' File-Name. This particular file is one which holds CSS Definitions for any / all HTML-Structures which have been generated and inserted by the Upgrader Tool.
  
  File-Name Field:
  This String-Field contains a File-Name only, it does not store actual CSS-Definitions.
  See Also:
  
  upgraderWidgetsCSS, Constant Field Values
  
  Code:
  
  Exact Field Declaration Expression:
  
  public static final String UPGRADER_WIDGETS_CSS_FILENAME = "Upgrader-Widgets.css";
- USER_WIDGETS_CSS_FILENAME
  
  🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
```
public static final java.lang.String USER_WIDGETS_CSS_FILENAME
```
  This static constant holds a '.css' File-Name. This particular file is one which holds CSS Definitions for HTML-Structures that are manually inserted by the User / Programmer.
  
  File-Name Field:
  This String-Field contains a File-Name only, it does not store actual CSS-Definitions.
  See Also:
  
  userAccessoriesCSS, Constant Field Values
  
  Code:
  
  Exact Field Declaration Expression:
  
  public static final String USER_WIDGETS_CSS_FILENAME = "User-Accessories.css";
- PYGMENTS_ORG_CSS_FILENAME
  
  🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
```
public static final java.lang.String PYGMENTS_ORG_CSS_FILENAME
```
  This static constant holds a '.css' File-Name. This particular file is one which holds CSS Definitions for the HiLite.ME (Pygments.org) Syntax-HiLiting Server.
  
  File-Name Field:
  This String-Field contains a File-Name only, it does not store actual CSS-Definitions.
  See Also:
  
  pygmentsOrgCSS, Constant Field Values
  
  Code:
  
  Exact Field Declaration Expression:
  
  public static final String PYGMENTS_ORG_CSS_FILENAME = "Pygments.org.css";
- LIST_FRAMES_CSS_FILENAME
  
  🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
```
public static final java.lang.String LIST_FRAMES_CSS_FILENAME
```
  This static constant holds a '.css' File-Name. The contents of the file specified by this file-name are CSS rules and definitions to be applied to 'package-frame.html' and 'overview-frame.html' files.
  
  File-Name Field:
  This String-Field contains a File-Name only, it does not store actual CSS-Definitions.
  See Also:
  
  listFramesCSS, Constant Field Values
  
  Code:
  
  Exact Field Declaration Expression:
  
  public static final String LIST_FRAMES_CSS_FILENAME = "List-Frames.css";
- CUSTOMIZED_CSS_FILENAME
  
  🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
```
public static final java.lang.String CUSTOMIZED_CSS_FILENAME
```
  This static constant holds a '.css' File-Name. This particular file is optional, and not inserted into Java-Doc Web-Page headers by default. The file itself, when used, will contain user supplied CSS rules and definitions to be used by the programmer, to apply to their own HTML constructs.
  
  File-Name Field:
  This String-Field contains a File-Name only, it does not store actual CSS-Definitions.
  See Also:
  
  customizedCSS, Constant Field Values
  
  Code:
  
  Exact Field Declaration Expression:
  
  public static final String CUSTOMIZED_CSS_FILENAME = "Customized.css";
- colorsCSS
  
  🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
```
public final java.lang.String colorsCSS
```
  Contains the Upgrader's Color-Scheme for any & all explicity named colors amongst CSS-Rules employed by the Java-Doc Upgrader.
  
  View CSS Definitions File:
  The complete file, the one used by the upgrader by default, may be viewed with the link provided below.
  
  Colors.css
  See Also:
  
  COLORS_CSS_FILENAME
  
  Code:
  
  Exact Field Declaration Expression:
  
  public final String colorsCSS;
- base64EncodedCSS
  
  🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
```
public final java.lang.String base64EncodedCSS
```
  Contains Base-64 Encoded Image Data. These images may be used in any location needed, and can be easily accessed via CSS variable-accesors var(-JD-NAME).
  
  View CSS Definitions File:
  The complete file, the one used by the upgrader by default, may be viewed with the link provided below.
  
  Base64-Encoded.css
  See Also:
  
  COLORS_CSS_FILENAME
  
  Code:
  
  Exact Field Declaration Expression:
  
  public final String base64EncodedCSS;
- originalWidgetsCSS
  
  🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
```
public final java.lang.String originalWidgetsCSS
```
  Contains CSS Definitions that are applied to components which were created by the original 'javadoc' Tool.
  
  View CSS Definitions File:
  The complete file, the one used by the upgrader by default, may be viewed with the link provided below.
  
  Original-Widgets.css
  See Also:
  
  JAVADOC_WIDGETS_CSS_FILENAME
  
  Code:
  
  Exact Field Declaration Expression:
  
  public final String originalWidgetsCSS;
- upgraderWidgetsCSS
  
  🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
```
public final java.lang.String upgraderWidgetsCSS
```
  Contains CSS Definitions that are applied to components which were created by the JavaDoc Upgrader Tool.
  
  View CSS Definitions File:
  The complete file, the one used by the upgrader by default, may be viewed with the link provided below.
  
  Upgrader-Widgets.css
  See Also:
  
  UPGRADER_WIDGETS_CSS_FILENAME
  
  Code:
  
  Exact Field Declaration Expression:
  
  public final String upgraderWidgetsCSS;
- userAccessoriesCSS
  
  🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
```
public final java.lang.String userAccessoriesCSS
```
  Contains CSS Definitions that are applied to components that are only inserted onto a Java Doc Web-Page by a programmer or user. If no such manual insertions have been conducted, these CSS Definitions are superfluous and would remain fully unused.
  
  View CSS Definitions File:
  The complete file, the one used by the upgrader by default, may be viewed with the link provided below.
  
  User-Accessories.css
  See Also:
  
  USER_WIDGETS_CSS_FILENAME
  
  Code:
  
  Exact Field Declaration Expression:
  
  public final String userAccessoriesCSS;
- pygmentsOrgCSS
  
  🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
```
public final java.lang.String pygmentsOrgCSS
```
  Contains CSS Definitions that are applied to HiLited Source-Code, provided by 'Pygments.org' (the engine behind HiLiteMe).
  
  View CSS Definitions File:
  The complete file, the one used by the upgrader by default, may be viewed with the link provided below.
  
  Pygments.org.css
  See Also:
  
  PYGMENTS_ORG_CSS_FILENAME
  
  Code:
  
  Exact Field Declaration Expression:
  
  public final String pygmentsOrgCSS;
- listFramesCSS
  
  🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
```
public final java.lang.String listFramesCSS
```
  Contains CSS Definitions that are used inside the 'package-frame.html' and 'overview-frame.html' files.
  
  View CSS Definitions File:
  The complete file, the one used by the upgrader by default, may be viewed with the link provided below.
  
  List-Frames.css
  See Also:
  
  LIST_FRAMES_CSS_FILENAME
  
  Code:
  
  Exact Field Declaration Expression:
  
  public final String listFramesCSS;
- customizedCSS
  
  🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
```
public final java.lang.String customizedCSS
```
  By default, the upgrader does not employ the 'customized.css' file. This file is intended to contain user supplied rules and definitions for any additional HTML Elements inserted by the user.
  
  If the user would like to have an additional '.css' file inserted into all Java Doc / Upgrader Web-Pages, then simply provide a CSS definitions to this String-Field, and the String will be saved as a file named 'customized.css', and copied to the root Java Doc 'stylesheets/' directory.
  
  When such a file is created, a link to this file will be inserted into all Java-Doc Web-Pages.
  See Also:
  
  CUSTOMIZED_CSS_FILENAME
  
  Code:
  
  Exact Field Declaration Expression:
  
  public final String customizedCSS;

Constructor Detail

CSSFiles

🡅 ⇈ ⮫ 🗕 🗗 🗖

public CSSFiles(java.lang.String colorsCSS,
                java.lang.String base64EncodedCSS,
                java.lang.String originalWidgetsCSS,
                java.lang.String upgraderWidgetsCSS,
                java.lang.String userAccessoriesCSS,
                java.lang.String pygmentsOrgCSS,
                java.lang.String listFramesCSS,
                java.lang.String customizedCSS)

Constructs an instance of this class by assigning the input parameters to the fields of the exact same name.

Parameters:

colorsCSS - '.css' File-Contents for the CSS-File that defines the color-scheme for any / all explicity named colors on this page hierarchy.

Link	Link-Contents
`colorsCSS`	CSS File-as-a-`String` Field
`COLORS_CSS_FILENAME`	CSS File-Name
`Colors.css`	Upgrader Default-File Contents

base64EncodedCSS - '.css' File-Contents for the CSS-File that defines the color-scheme for any / all explicity named colors on this page hierarchy.

Link	Link-Contents
`base64EncodedCSS`	CSS File-as-a-`String` Field
`BASE64_ENCODED_CSS_FILENAME`	CSS File-Name
`Base64-Encoded.css`	Upgrader Default-File Contents

originalWidgetsCSS - '.css' File-Contents for CSS that's used on Original JavaDoc Components.

Link	Link-Contents
`originalWidgetsCSS`	CSS File-as-a-`String` Field
`JAVADOC_WIDGETS_CSS_FILENAME`	CSS File-Name
`Original-Widgets.css`	Upgrader Default-File Contents

upgraderWidgetsCSS - '.css' File-Contents for CSS that's used on Upgrader-Added Components.

Link	Link-Contents
`upgraderWidgetsCSS`	CSS File-as-a-`String` Field
`UPGRADER_WIDGETS_CSS_FILENAME`	CSS File-Name
`Upgrader-Widgets.css`	Upgrader Default-File Contents

userAccessoriesCSS - '.css' File-Contents for CSS that's used on Components which are only present on a Web-Page if those components were addded / inserted by the programmer.

Link	Link-Contents
`userAccessoriesCSS`	CSS File-as-a-`String` Field
`USER_WIDGETS_CSS_FILENAME`	CSS File-Name
`User-Accessories.css`	Upgrader Default-File Contents

pygmentsOrgCSS - '.css' File-Contents for CSS that mimics the 'pygments.org' Syntax HiLiter.

Link	Link-Contents
`pygmentsOrgCSS`	CSS File-as-a-`String` Field
`PYGMENTS_ORG_CSS_FILENAME`	CSS File-Name
`Pygments.org.css`	Upgrader Default-File Contents

listFramesCSS - '.css' File-Contents for the CSS that is used to format the the 'overview-frame.html' and 'package-frame.html' Files.

Link	Link-Contents
`listFramesCSS`	CSS File-as-a-`String` Field
`LIST_FRAMES_CSS_FILENAME`	CSS File-Name
`List-Frames.css`	Upgrader Default-File Contents

customizedCSS - Potential '.css' File-Contents provided by the user for HTML Elements that have been created and included by the programmer, not by the upgrader or by javadoc.

This parameter may be either null, or a zero-length String. If this parameter does not contain any CSS-Rules, then no such '.css' File will be placed in the root Java-Doc 'stylesheets/', nor will links to this file be inserted into any of the Java-Doc Web-Pages.

See Field Definitions for: customizedCSS and CUSTOMIZED_CSS_FILENAME

Class CSSFiles

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

COLORS_CSS_FILENAME

BASE64_ENCODED_CSS_FILENAME

JAVADOC_WIDGETS_CSS_FILENAME

UPGRADER_WIDGETS_CSS_FILENAME

USER_WIDGETS_CSS_FILENAME

PYGMENTS_ORG_CSS_FILENAME

LIST_FRAMES_CSS_FILENAME

CUSTOMIZED_CSS_FILENAME

colorsCSS

base64EncodedCSS

originalWidgetsCSS

upgraderWidgetsCSS

userAccessoriesCSS

pygmentsOrgCSS

listFramesCSS

customizedCSS

Constructor Detail

CSSFiles