org.axsl.font

Enum Font.Variant

java.lang.Object

java.lang.Enum<Font.Variant>

org.axsl.font.Font.Variant

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Font.Variant>

Enclosing interface:

Font

public static enum Font.Variant
extends java.lang.Enum<Font.Variant>

Enumeration of constants needed to describe the variant of a font.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY Font-variant constant indicating no preference.
NORMAL Font-variant constant indicating that small-caps is off.
SMALL_CAPS Font-variant constant indicating that small-caps is on.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCssValue() Returns the String describing this variant in CSS.
java.lang.String	getFoValue() Returns the String describing this variant in XSL-FO.
static Font.Variant	parseCss(java.lang.String input, boolean lowerCaseOnly) Parses a CSS2 String into an instance of Font.Variant.
static Font.Variant	parseFo(java.lang.String input, boolean lowerCaseOnly) Parses an XSL-FO String into an instance of Font.Variant.
static Font.Variant	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Font.Variant[]	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

ANY

public static final Font.Variant ANY

Font-variant constant indicating no preference.

NORMAL

public static final Font.Variant NORMAL

Font-variant constant indicating that small-caps is off.

SMALL_CAPS

public static final Font.Variant SMALL_CAPS

Font-variant constant indicating that small-caps is on.

Method Detail

values

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

Returns:

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

valueOf

public static Font.Variant valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getCssValue

public java.lang.String getCssValue()

Returns the String describing this variant in CSS.

Returns:

The String describing this variant in CSS.

getFoValue

public java.lang.String getFoValue()

Returns the String describing this variant in XSL-FO.

Returns:

The String describing this variant in XSL-FO.

parseCss

public static Font.Variant parseCss(java.lang.String input,
                                    boolean lowerCaseOnly)

Parses a CSS2 String into an instance of Font.Variant.

Parameters:

input - The CSS2-style String to be converted.

lowerCaseOnly - Set to true to insist that all input values be lowercase. There is some ambiguity about whether CSS is case-sensitive or not. If it is, all input should be lower case.

Returns:

An instance of Font.Variant, or null if the input is not valid.

parseFo

public static Font.Variant parseFo(java.lang.String input,
                                   boolean lowerCaseOnly)

Parses an XSL-FO String into an instance of Font.Variant.

Parameters:

input - The XSL-FO-style String to be converted.

lowerCaseOnly - Set to true to insist that all input values be lowercase. There is some ambiguity about whether XSL-FO is case-sensitive or not. If it is, all input should be lower case.

Returns:

An instance of Font.Variant, or null if the input is not valid.