package Torello.JavaDoc;

/**
 * A class for encapsulating all four JavaDoc Upgrader {@code '.css'} Files, each of which has been
 * saved, in entirety, as a simple Java {@code String}.
 * 
 * <EMBED CLASS='external-html' DATA-FILE-ID=CSS_FILES>
 */
public class CSSFiles implements java.io.Serializable
{
    /* <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
    protected static final long serialVersionUID = 1;


    // ********************************************************************************************
    // ********************************************************************************************
    // Just the File-Name's of the CSS-Files
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=CSSF_COLORS_F>
     * @see #colorsCSS
     */
    public static final String COLORS_CSS_FILENAME = "Colors.css";

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=CSSF_BASE64_ENCODED_F>
     * @see #colorsCSS
     */
    public static final String BASE64_ENCODED_CSS_FILENAME = "Base64-Encoded.css";

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=CSSF_ORIGINAL_WIDGETS_F>
     * @see #originalWidgetsCSS
     */
    public static final String JAVADOC_WIDGETS_CSS_FILENAME = "Original-Widgets.css";

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=CSSF_UPGRADER_WIDGETS_F>
     * @see #upgraderWidgetsCSS
     */
    public static final String UPGRADER_WIDGETS_CSS_FILENAME = "Upgrader-Widgets.css";

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=CSSF_USER_ACCESSORIES_F>
     * @see #userAccessoriesCSS
     */
    public static final String USER_WIDGETS_CSS_FILENAME = "User-Accessories.css";

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=CSSF_PYGMENTS_ORG_F>
     * @see #pygmentsOrgCSS
     */
    public static final String PYGMENTS_ORG_CSS_FILENAME = "Pygments.org.css";

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=CSSF_LIST_FRAMES_F>
     * @see #listFramesCSS
     */
    public static final String LIST_FRAMES_CSS_FILENAME = "List-Frames.css";

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=CSSF_CUSTOMIZED_F>
     * @see #customizedCSS
     */
    public static final String CUSTOMIZED_CSS_FILENAME = "Customized.css";


    // ********************************************************************************************
    // ********************************************************************************************
    // The Actual CSS-Contents of the Files (as a String)
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=CSSF_COLORS>
     * @see #COLORS_CSS_FILENAME
     */
    public final String colorsCSS;

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=CSSF_BASE64_ENCODED>
     * @see #COLORS_CSS_FILENAME
     */
    public final String base64EncodedCSS;

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=CSSF_ORIGINAL_WIDGETS>
     * @see #JAVADOC_WIDGETS_CSS_FILENAME
     */
    public final String originalWidgetsCSS;

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=CSSF_UPGRADER_WIDGETS>
     * @see #UPGRADER_WIDGETS_CSS_FILENAME
     */
    public final String upgraderWidgetsCSS;

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=CSSF_USER_ACCESSORIES>
     * @see #USER_WIDGETS_CSS_FILENAME
     */
    public final String userAccessoriesCSS;

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=CSSF_PYGMENTS_ORG>
     * @see #PYGMENTS_ORG_CSS_FILENAME
     */
    public final String pygmentsOrgCSS;

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=CSSF_LIST_FRAMES>
     * @see #LIST_FRAMES_CSS_FILENAME
     */
    public final String listFramesCSS;

    /**
     * <EMBED CLASS='external-html' DATA-FILE-ID=CSSF_CUSTOMIZED>
     * @see #CUSTOMIZED_CSS_FILENAME
     */
    public final String customizedCSS;


    // ********************************************************************************************
    // ********************************************************************************************
    // Constructor
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Constructs an instance of this class by assigning the input parameters to the fields of the
     * exact same name.
     * 
     * @param colorsCSS {@code '.css'} File-Contents for the CSS-File that defines the color-scheme
     * for any / all explicity named colors on this page hierarchy.
     * 
     * <BR /><TABLE CLASS=JDBriefTable>
     * <TR><TH>Link</TH><TH>Link-Contents</TH></TR>
     * <TR> <TD>{@link #colorsCSS}</TD>
     *      <TD>CSS File-as-a-{@code String} Field</TD>
     *      </TR>
     * <TR> <TD>{@link #COLORS_CSS_FILENAME}</TD>
     *      <TD>CSS File-Name</TD>
     *      </TR>
     * <TR> <TD><CODE><A HREF='hilite-files/Colors.css.html'>Colors.css</A></CODE></TD>
     *      <TD>Upgrader Default-File Contents</TD>
     *      </TR>
     * </TABLE>
     * 
     * @param base64EncodedCSS {@code '.css'} File-Contents for the CSS-File that defines the color-scheme
     * for any / all explicity named colors on this page hierarchy.
     * 
     * <BR /><TABLE CLASS=JDBriefTable>
     * <TR><TH>Link</TH><TH>Link-Contents</TH></TR>
     * <TR> <TD>{@link #base64EncodedCSS}</TD>
     *      <TD>CSS File-as-a-{@code String} Field</TD>
     *      </TR>
     * <TR> <TD>{@link #BASE64_ENCODED_CSS_FILENAME}</TD>
     *      <TD>CSS File-Name</TD>
     *      </TR>
     * <TR> <TD><CODE><A HREF='hilite-files/Base64-Encoded.css.html'>Base64-Encoded.css</A></CODE></TD>
     *      <TD>Upgrader Default-File Contents</TD>
     *      </TR>
     * </TABLE>
     * 
     * @param originalWidgetsCSS {@code '.css'} File-Contents for CSS that's used on Original
     * JavaDoc Components.
     * 
     * <BR /><TABLE CLASS=JDBriefTable>
     * <TR><TH>Link</TH><TH>Link-Contents</TH></TR>
     * <TR> <TD>{@link #originalWidgetsCSS}</TD>
     *      <TD>CSS File-as-a-{@code String} Field</TD>
     *      </TR>
     * <TR> <TD>{@link #JAVADOC_WIDGETS_CSS_FILENAME}</TD>
     *      <TD>CSS File-Name</TD>
     *      </TR>
     * <TR> <TD><CODE><A HREF='hilite-files/Original-Widgets.css.html'>Original-Widgets.css
     *          </A></CODE></TD>
     *      <TD>Upgrader Default-File Contents</TD>
     *      </TR>
     * </TABLE>
     * 
     * @param upgraderWidgetsCSS {@code '.css'} File-Contents for CSS that's used on Upgrader-Added
     * Components.
     * 
     * <BR /><TABLE CLASS=JDBriefTable>
     * 
     * <TR><TH>Link</TH><TH>Link-Contents</TH></TR>
     * 
     * <TR> <TD>{@link #upgraderWidgetsCSS}</TD>
     *      <TD>CSS File-as-a-{@code String} Field</TD>
     *      </TR>
     * <TR> <TD>{@link #UPGRADER_WIDGETS_CSS_FILENAME}</TD>
     *      <TD>CSS File-Name</TD>
     *      </TR>
     * <TR> <TD><CODE><A HREF='hilite-files/Upgrader-Widgets.css.html'>Upgrader-Widgets.css
     *          </A></CODE></TD>
     *      <TD>Upgrader Default-File Contents</TD>
     *      </TR>
     * 
     * </TABLE>
     * 
     * @param userAccessoriesCSS {@code '.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.
     * 
     * <BR /><TABLE CLASS=JDBriefTable>
     * <TR><TH>Link</TH><TH>Link-Contents</TH></TR>
     * <TR> <TD>{@link #userAccessoriesCSS}</TD>
     *      <TD>CSS File-as-a-{@code String} Field</TD>
     *      </TR>
     * <TR> <TD>{@link #USER_WIDGETS_CSS_FILENAME}</TD>
     *      <TD>CSS File-Name</TD>
     *      </TR>
     * <TR> <TD><CODE><A HREF='hilite-files/User-Accessories.css.html'>User-Accessories.css
     *          </A></CODE></TD>
     *      <TD>Upgrader Default-File Contents</TD>
     *      </TR>
     * </TABLE>
     * 
     * @param pygmentsOrgCSS {@code '.css'} File-Contents for CSS that mimics the
     * {@code 'pygments.org'} Syntax HiLiter.
     * 
     * <BR /><TABLE CLASS=JDBriefTable>
     * <TR><TH>Link</TH><TH>Link-Contents</TH></TR>
     * <TR> <TD>{@link #pygmentsOrgCSS}</TD>
     *      <TD>CSS File-as-a-{@code String} Field</TD>
     *      </TR>
     * <TR> <TD>{@link #PYGMENTS_ORG_CSS_FILENAME}</TD>
     *      <TD>CSS File-Name</TD>
     *      </TR>
     * <TR> <TD><CODE><A HREF='hilite-files/Pygments.org.css.html'>Pygments.org.css
     *          </A></CODE></TD>
     *      <TD>Upgrader Default-File Contents</TD>
     *      </TR>
     * </TABLE>
     * 
     * @param listFramesCSS {@code '.css'} File-Contents for the CSS that is used to format the
     * the {@code 'overview-frame.html'} and {@code 'package-frame.html'} Files.
     * 
     * <BR /><TABLE CLASS=JDBriefTable>
     * <TR><TH>Link</TH><TH>Link-Contents</TH></TR>
     * <TR> <TD>{@link #listFramesCSS}</TD>
     *      <TD>CSS File-as-a-{@code String} Field</TD>
     *      </TR>
     * <TR> <TD>{@link #LIST_FRAMES_CSS_FILENAME}</TD>
     *      <TD>CSS File-Name</TD>
     *      </TR>
     * <TR> <TD><CODE><A HREF='hilite-files/List-Frames.css.html'>List-Frames.css
     *          </A></CODE></TD>
     *      <TD>Upgrader Default-File Contents</TD>
     *      </TR>
     * </TABLE>
     * 
     * @param customizedCSS Potential {@code '.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.
     * 
     * <BR /><BR />This parameter may be either null, or a zero-length {@code String}.  If this
     * parameter does not contain any CSS-Rules, then no such {@code '.css'} File will be placed in
     * the root Java-Doc {@code 'stylesheets/'}, nor will links to this file be inserted into any
     * of the Java-Doc Web-Pages.
     * 
     * <BR /><BR /><B STYLE='color: red;'>See Field Definitions for:</B>
     * 
     * {@link #customizedCSS} and {@link #CUSTOMIZED_CSS_FILENAME}
     */
    public CSSFiles(
        final String colorsCSS,
        final String base64EncodedCSS,
        final String originalWidgetsCSS,
        final String upgraderWidgetsCSS,
        final String userAccessoriesCSS,
        final String pygmentsOrgCSS,
        final String listFramesCSS,
        final String customizedCSS
    )
    {
        this.colorsCSS          = colorsCSS;
        this.base64EncodedCSS   = base64EncodedCSS;
        this.originalWidgetsCSS = originalWidgetsCSS;
        this.upgraderWidgetsCSS = upgraderWidgetsCSS;
        this.userAccessoriesCSS = userAccessoriesCSS;
        this.pygmentsOrgCSS     = pygmentsOrgCSS;
        this.listFramesCSS      = listFramesCSS;
        this.customizedCSS      = customizedCSS;
    }
}