Enum FontFamily
- All Implemented Interfaces:
Serializable
,Comparable<FontFamily>
,java.lang.constant.Constable
A property of a font that describes its general appearance.
- Since:
- POI 3.17-beta2
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionNovelty fonts.The default font is specified, which is implementation-dependent.Fonts with constant stroke width, with or without serifs.Fonts with variable stroke widths, which are proportional to the actual widths of the glyphs, and which have serifs.Fonts designed to look like handwriting.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 TypeMethodDescriptionint
getFlag()
static FontFamily
valueOf
(int nativeId) Returns the enum constant of this type with the specified name.static FontFamily
Returns the enum constant of this type with the specified name.static FontFamily
valueOfPitchFamily
(byte pitchAndFamily) Get FontFamily from combined native idstatic 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
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Enum Constant Details
-
FF_DONTCARE
The default font is specified, which is implementation-dependent. -
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
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
Fonts with constant stroke width, with or without serifs. Fixed-width fonts are usually modern. "Pica", "Elite", and "Courier New" are examples. -
FF_SCRIPT
Fonts designed to look like handwriting. "Script" and "Cursive" are examples. -
FF_DECORATIVE
Novelty fonts. "Old English" is an example.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException
- if the argument is null
-
getFlag
public int getFlag() -
valueOf
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 nameNullPointerException
- if the argument is null
-
valueOfPitchFamily
Get FontFamily from combined native id- Parameters:
pitchAndFamily
- The PitchFamily to decode.- Returns:
- The resulting FontFamily
-