1 /*
2 * Copyright 2002 - 2007 JEuclid, http://jeuclid.sf.net
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 /* $Id: ParameterKey.java 310 2007-05-18 20:26:36Z maxberger $ */
18
19 package net.sourceforge.jeuclid;
20
21 /**
22 * A class to hold parameters for the rendering process.
23 * <p>
24 * Each parameter is passed using the String datatype, and then converted back
25 * into the internal dataype. The following assumptions are made for the given
26 * datatypes:
27 * <dl>
28 * <dt>float</dt>
29 * <dd>must be a valid integer or floating point number, parsable with
30 * {@link Float#parseFloat(String)}.</dd>
31 * <dt>boolean</dt>
32 * <dd>must be "true" or "false", parsable with
33 * {@link Boolean#parseBoolean(String)}.</dd>
34 * <dt>font list</dt>
35 * <dd>is a comma separated lists of font families which should be used when
36 * a font of this type is selected. When selecting the actual font, the list
37 * is followed in the order given, and the first font which is installed on
38 * the system and contains the needed character is used. It is therefore
39 * suggested to add "complete" unicode fonts to the end of the list to support
40 * all characters.</dd>
41 * <dt>colors</dt>
42 * <dd>are passed using the standard html colornames or the #rrggbb or
43 * #rrggbbaa notation.</dd>
44 * </dl>
45 *
46 * @author Erik Putrycz, Max Berger
47 * @version $Revision: 310 $
48 */
49 public enum ParameterKey {
50 /**
51 * File type (String) for the output used by converter functions. Must be
52 * a valid mime-type.
53 */
54 OutFileType,
55 /**
56 * Font size (float) used for the output. Defaults to 12.0pt.
57 */
58 FontSize,
59 /**
60 * Debug mode (boolean). If true, elements will have borders drawn around
61 * them.
62 */
63 DebugMode,
64 /**
65 * Anti-Alias mode (boolean) for rendering.
66 */
67 AntiAlias,
68 /**
69 * Default foreground color (String). See 3.2.2.2
70 */
71 ForegroundColor,
72 /**
73 * Default background color (String). See 3.2.2.2
74 */
75 BackgroundColor,
76 /**
77 * Comma separated list of font families for sans-serif.
78 *
79 * @see ParameterKey
80 */
81 FontsSanserif,
82 /**
83 * Comma separated list of font families for serif.
84 *
85 * @see ParameterKey
86 */
87 FontsSerif,
88 /**
89 * Comma separated list of font families for monospaced.
90 *
91 * @see ParameterKey
92 */
93 FontsMonospaced,
94 /**
95 * Comma separated list of font families for script.
96 *
97 * @see ParameterKey
98 */
99 FontsScript,
100 /**
101 * Comma separated list of font families for fraktur.
102 *
103 * @see ParameterKey
104 */
105 FontsFraktur,
106 /**
107 * Comma separated list of font families for double-struck.
108 *
109 * @see ParameterKey
110 */
111 FontsDoublestruck,
112 }