net.sourceforge.jeuclid.context
Enum Parameter

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

public enum Parameter
extends Enum<Parameter>

Possible parameters for the LayoutContext.

Version:
$Revision: 03dc0884e86f $

Enum Constant Summary
ANTIALIAS
          Anti-Alias mode (Boolean) for rendering.
ANTIALIAS_MINSIZE
          Minimum font size for which anti-alias is turned on.
DEBUG
          Debug mode (Boolean).
DISPLAY
          Display style (Display).
FONTS_DOUBLESTRUCK
          List<String> of font families for double-struck.
FONTS_FRAKTUR
          List<String> of font families for fraktur.
FONTS_MONOSPACED
          List<String> of font families for monospaced.
FONTS_SANSSERIF
          List<String> of font families for sans-serif.
FONTS_SCRIPT
          CList<String> of font families for script.
FONTS_SERIF
          List<String> of font families for serif.
MATHBACKGROUND
          Default background color (Color), may be null.
MATHCOLOR
          Default foreground color (Color).
MATHSIZE
          Font size (Float) used for the output.
MFRAC_KEEP_SCRIPTLEVEL
          If true, <mfrac> element will NEVER increase children's scriptlevel (in violation of the spec); otherwise it will behave with accordance to the spec.
SCRIPTLEVEL
          Script level (Integer), defaults to 0.
SCRIPTMINSIZE
          Font size (Float) for smallest script used.
SCRIPTSIZEMULTIPLIER
          Script size multiplier (Float), defaults to 0.71.
 
Method Summary
 Object fromString(String value)
          Attempts to convert a parameter value expressed as string into an instance of the appropriate (for this parameter) type.
 String getOptionDesc()
           
 String getOptionName()
           
 TypeWrapper getTypeWrapper()
           
 String toString(Object value)
          Attempts to convert a parameter value expressed as an object of the appropriate (for this parameter) type into a string representation.
 boolean valid(Object o)
          Checks if the object is of a valid type for this parameter.
static Parameter valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Parameter[] 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

DISPLAY

public static final Parameter DISPLAY
Display style (Display).


MATHSIZE

public static final Parameter MATHSIZE
Font size (Float) used for the output. Defaults to 12.0pt. Please Note: You may also want to set SCRIPTMINZISE.


SCRIPTMINSIZE

public static final Parameter SCRIPTMINSIZE
Font size (Float) for smallest script used. Defaults to 8.0pt.


SCRIPTSIZEMULTIPLIER

public static final Parameter SCRIPTSIZEMULTIPLIER
Script size multiplier (Float), defaults to 0.71.


SCRIPTLEVEL

public static final Parameter SCRIPTLEVEL
Script level (Integer), defaults to 0.


ANTIALIAS_MINSIZE

public static final Parameter ANTIALIAS_MINSIZE
Minimum font size for which anti-alias is turned on. Defaults to 10.0pt


DEBUG

public static final Parameter DEBUG
Debug mode (Boolean). If true, elements will have borders drawn around them.


ANTIALIAS

public static final Parameter ANTIALIAS
Anti-Alias mode (Boolean) for rendering.


MATHCOLOR

public static final Parameter MATHCOLOR
Default foreground color (Color). See 3.2.2.2


MATHBACKGROUND

public static final Parameter MATHBACKGROUND
Default background color (Color), may be null. See 3.2.2.2


FONTS_SANSSERIF

public static final Parameter FONTS_SANSSERIF
List<String> of font families for sans-serif.

See Also:
Parameter

FONTS_SERIF

public static final Parameter FONTS_SERIF
List<String> of font families for serif.

See Also:
Parameter

FONTS_MONOSPACED

public static final Parameter FONTS_MONOSPACED
List<String> of font families for monospaced.

See Also:
Parameter

FONTS_SCRIPT

public static final Parameter FONTS_SCRIPT
CList<String> of font families for script.

See Also:
Parameter

FONTS_FRAKTUR

public static final Parameter FONTS_FRAKTUR
List<String> of font families for fraktur.

See Also:
Parameter

FONTS_DOUBLESTRUCK

public static final Parameter FONTS_DOUBLESTRUCK
List<String> of font families for double-struck.

See Also:
Parameter

MFRAC_KEEP_SCRIPTLEVEL

public static final Parameter MFRAC_KEEP_SCRIPTLEVEL
If true, <mfrac> element will NEVER increase children's scriptlevel (in violation of the spec); otherwise it will behave with accordance to the spec.

Method Detail

values

public static Parameter[] 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 (Parameter c : Parameter.values())
    System.out.println(c);

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

valueOf

public static Parameter 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

getTypeWrapper

public TypeWrapper getTypeWrapper()
Returns:
TypeWrapper instance used for this parameter

getOptionName

public String getOptionName()
Returns:
user-friendly option name associated with this parameter

getOptionDesc

public String getOptionDesc()
Returns:
user-friendly option name associated with this parameter

valid

public boolean valid(Object o)
Checks if the object is of a valid type for this parameter.

Parameters:
o - the object to check
Returns:
true if the parameter can be set.

fromString

public Object fromString(String value)
Attempts to convert a parameter value expressed as string into an instance of the appropriate (for this parameter) type.

Parameters:
value - parameter value as string
Returns:
parameter value as an instance of the proper type

toString

public String toString(Object value)
Attempts to convert a parameter value expressed as an object of the appropriate (for this parameter) type into a string representation.

Parameters:
value - parameter value as object
Returns:
parameter value as string


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