org.axsl.font

Enum Font.Stretch

java.lang.Object

java.lang.Enum<Font.Stretch>

org.axsl.font.Font.Stretch

All Implemented Interfaces:

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

Enclosing interface:

Font

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

Enumeration of constants needed to describe the "stretch" value of a font.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY Font-stretch constant indicating no preference.
CONDENSED Font-stretch constant indicating condensed.
EXPANDED Font-stretch constant indicating expanded.
EXTRA_CONDENSED Font-stretch constant indicating extra-condensed.
EXTRA_EXPANDED Font-stretch constant indicating extra-expanded.
NORMAL Font-stretch constant indicating normal.
SEMI_CONDENSED Font-stretch constant indicating semi-condensed.
SEMI_EXPANDED Font-stretch constant indicating semi-expanded.
ULTRA_CONDENSED Font-stretch constant indicating ultra-condensed.
ULTRA_EXPANDED Font-stretch constant indicating ultra-expanded.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCssValue() Returns the String describing this stretch in CSS.
java.lang.String	getFoValue() Returns the String describing this stretch in XSL-FO.
byte	getNumericStretch() Returns the numeric stretch value, or the relative stretch between different instances of this class.
static Font.Stretch	parseCss(java.lang.String input, boolean lowerCaseOnly) Parses a CSS2 String into an instance of Font.Stretch.
static Font.Stretch	parseFo(java.lang.String input, boolean lowerCaseOnly) Parses an XSL-FO String into an instance of Font.Stretch.
static Font.Stretch	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Font.Stretch[]	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.Stretch ANY

Font-stretch constant indicating no preference.

ULTRA_CONDENSED

public static final Font.Stretch ULTRA_CONDENSED

Font-stretch constant indicating ultra-condensed.

EXTRA_CONDENSED

public static final Font.Stretch EXTRA_CONDENSED

Font-stretch constant indicating extra-condensed.

CONDENSED

public static final Font.Stretch CONDENSED

Font-stretch constant indicating condensed.

SEMI_CONDENSED

public static final Font.Stretch SEMI_CONDENSED

Font-stretch constant indicating semi-condensed.

NORMAL

public static final Font.Stretch NORMAL

Font-stretch constant indicating normal.

SEMI_EXPANDED

public static final Font.Stretch SEMI_EXPANDED

Font-stretch constant indicating semi-expanded.

EXPANDED

public static final Font.Stretch EXPANDED

Font-stretch constant indicating expanded.

EXTRA_EXPANDED

public static final Font.Stretch EXTRA_EXPANDED

Font-stretch constant indicating extra-expanded.

ULTRA_EXPANDED

public static final Font.Stretch ULTRA_EXPANDED

Font-stretch constant indicating ultra-expanded.

Method Detail

values

public static Font.Stretch[] 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.Stretch c : Font.Stretch.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.Stretch 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

getNumericStretch

public byte getNumericStretch()

Returns the numeric stretch value, or the relative stretch between different instances of this class.

Returns:

The numeric stretch value for this instance, smaller numbers being more condensed, larger numbers being more expanded, or Byte.MIN_VALUE for invalid values.

getCssValue

public java.lang.String getCssValue()

Returns the String describing this stretch in CSS.

Returns:

The String describing this stretch in CSS.

getFoValue

public java.lang.String getFoValue()

Returns the String describing this stretch in XSL-FO.

Returns:

The String describing this stretch in XSL-FO.

parseCss

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

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

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.Stretch, or null if the input is not valid.

parseFo

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

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

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.Stretch, or null if the input is not valid.