SourceForge.net Logo
aXSL API 0.2

org.axsl.font
Enum Font.Stretch

java.lang.Object
  extended by java.lang.Enum<Font.Stretch>
      extended by 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
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
 byte getNumericStretch()
          Returns the numeric stretch value, or the relative stretch between different instances of this class.
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're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, 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 final Font.Stretch[] values()
Returns an array containing the constants of this enum type, in the order they're 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're 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

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.

SourceForge.net Logo
aXSL API 0.2

This documentation was created August 8 2007 by The aXSL Group and may be freely copied. See license for details.