net.sourceforge.jeuclid
Enum ParameterKey

java.lang.Object
  extended by java.lang.Enum<ParameterKey>
      extended by net.sourceforge.jeuclid.ParameterKey
All Implemented Interfaces:
Serializable, Comparable<ParameterKey>

public enum ParameterKey
extends Enum<ParameterKey>

A class to hold parameters for the rendering process.

Each parameter is passed using the String datatype, and then converted back into the internal dataype. The following assumptions are made for the given datatypes:

float
must be a valid integer or floating point number, parsable with Float.parseFloat(String).
boolean
must be "true" or "false", parsable with Boolean.parseBoolean(String).
font list
is a comma separated lists of font families which should be used when a font of this type is selected. When selecting the actual font, the list is followed in the order given, and the first font which is installed on the system and contains the needed character is used. It is therefore suggested to add "complete" unicode fonts to the end of the list to support all characters.
colors
are passed using the standard html colornames or the #rrggbb or #rrggbbaa notation.

Version:
$Revision: 310 $
Author:
Erik Putrycz, Max Berger

Enum Constant Summary
AntiAlias
          Anti-Alias mode (boolean) for rendering.
BackgroundColor
          Default background color (String).
DebugMode
          Debug mode (boolean).
FontsDoublestruck
          Comma separated list of font families for double-struck.
FontsFraktur
          Comma separated list of font families for fraktur.
FontSize
          Font size (float) used for the output.
FontsMonospaced
          Comma separated list of font families for monospaced.
FontsSanserif
          Comma separated list of font families for sans-serif.
FontsScript
          Comma separated list of font families for script.
FontsSerif
          Comma separated list of font families for serif.
ForegroundColor
          Default foreground color (String).
OutFileType
          File type (String) for the output used by converter functions.
 
Method Summary
static ParameterKey valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ParameterKey[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

OutFileType

public static final ParameterKey OutFileType
File type (String) for the output used by converter functions. Must be a valid mime-type.


FontSize

public static final ParameterKey FontSize
Font size (float) used for the output. Defaults to 12.0pt.


DebugMode

public static final ParameterKey DebugMode
Debug mode (boolean). If true, elements will have borders drawn around them.


AntiAlias

public static final ParameterKey AntiAlias
Anti-Alias mode (boolean) for rendering.


ForegroundColor

public static final ParameterKey ForegroundColor
Default foreground color (String). See 3.2.2.2


BackgroundColor

public static final ParameterKey BackgroundColor
Default background color (String). See 3.2.2.2


FontsSanserif

public static final ParameterKey FontsSanserif
Comma separated list of font families for sans-serif.

See Also:
ParameterKey

FontsSerif

public static final ParameterKey FontsSerif
Comma separated list of font families for serif.

See Also:
ParameterKey

FontsMonospaced

public static final ParameterKey FontsMonospaced
Comma separated list of font families for monospaced.

See Also:
ParameterKey

FontsScript

public static final ParameterKey FontsScript
Comma separated list of font families for script.

See Also:
ParameterKey

FontsFraktur

public static final ParameterKey FontsFraktur
Comma separated list of font families for fraktur.

See Also:
ParameterKey

FontsDoublestruck

public static final ParameterKey FontsDoublestruck
Comma separated list of font families for double-struck.

See Also:
ParameterKey
Method Detail

values

public static ParameterKey[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (ParameterKey c : ParameterKey.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static ParameterKey valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null


Copyright © 2002-2008 The JEuclid project. All Rights Reserved.