Package org.apache.poi.common.usermodel.fonts

Enum FontFamily

java.lang.Object

java.lang.Enum<FontFamily>

org.apache.poi.common.usermodel.fonts.FontFamily

All Implemented Interfaces:

Serializable, Comparable<FontFamily>

public enum FontFamily
extends Enum<FontFamily>

A property of a font that describes its general appearance.

Since:

POI 3.17-beta2

Enum Constant Summary

Enum Constants

Enum Constant	Description
FF_DECORATIVE	Novelty fonts.
FF_DONTCARE	The default font is specified, which is implementation-dependent.
FF_MODERN	Fonts with constant stroke width, with or without serifs.
FF_ROMAN	Fonts with variable stroke widths, which are proportional to the actual widths of the glyphs, and which have serifs.
FF_SCRIPT	Fonts designed to look like handwriting.
FF_SWISS	Fonts with variable stroke widths, which are proportional to the actual widths of the glyphs, and which do not have serifs.

Method Summary

Modifier and Type	Method	Description
int	getFlag()
static FontFamily	valueOf(int nativeId)	Returns the enum constant of this type with the specified name.
static FontFamily	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FontFamily	valueOfPitchFamily(byte pitchAndFamily)	Get FontFamily from combined native id
static FontFamily[]	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

FF_DONTCARE

public static final FontFamily FF_DONTCARE

The default font is specified, which is implementation-dependent.

FF_ROMAN

public static final FontFamily FF_ROMAN

Fonts with variable stroke widths, which are proportional to the actual widths of the glyphs, and which have serifs. "MS Serif" is an example.

FF_SWISS

public static final FontFamily FF_SWISS

Fonts with variable stroke widths, which are proportional to the actual widths of the glyphs, and which do not have serifs. "MS Sans Serif" is an example.

FF_MODERN

public static final FontFamily FF_MODERN

Fonts with constant stroke width, with or without serifs. Fixed-width fonts are usually modern. "Pica", "Elite", and "Courier New" are examples.

FF_SCRIPT

public static final FontFamily FF_SCRIPT

Fonts designed to look like handwriting. "Script" and "Cursive" are examples.

FF_DECORATIVE

public static final FontFamily FF_DECORATIVE

Novelty fonts. "Old English" is an example.

Method Detail

values

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

Returns:

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

valueOf

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

getFlag

public int getFlag()

valueOf

public static FontFamily valueOf(int nativeId)

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:

nativeId - 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

valueOfPitchFamily

public static FontFamily valueOfPitchFamily(byte pitchAndFamily)

Get FontFamily from combined native id

Parameters:

pitchAndFamily - The PitchFamily to decode.

Returns:

The resulting FontFamily