Package org.apache.poi.hslf.usermodel

Enum HSLFFontInfoPredefined

java.lang.Object

java.lang.Enum<HSLFFontInfoPredefined>

org.apache.poi.hslf.usermodel.HSLFFontInfoPredefined

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HSLFFontInfoPredefined>, FontInfo

public enum HSLFFontInfoPredefined
extends java.lang.Enum<HSLFFontInfoPredefined>
implements FontInfo

Predefined fonts

Since:

POI 3.17-beta2

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARIAL
COURIER_NEW
TIMES_NEW_ROMAN
WINGDINGS

Method Summary

Modifier and Type	Method	Description
FontCharset	getCharset()
FontFamily	getFamily()
java.lang.Integer	getIndex()	Get the index within the collection of Font objects
FontPitch	getPitch()
java.lang.String	getTypeface()
void	setCharset(FontCharset charset)	Sets the charset
void	setFamily(FontFamily family)	Sets the font family class
void	setIndex(int index)	Sets the index within the collection of Font objects
void	setPitch(FontPitch pitch)	Set the font pitch
void	setTypeface(java.lang.String typeface)	Sets the font name
static HSLFFontInfoPredefined	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static HSLFFontInfoPredefined[]	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, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ARIAL

public static final HSLFFontInfoPredefined ARIAL

TIMES_NEW_ROMAN

public static final HSLFFontInfoPredefined TIMES_NEW_ROMAN

COURIER_NEW

public static final HSLFFontInfoPredefined COURIER_NEW

WINGDINGS

public static final HSLFFontInfoPredefined WINGDINGS

Method Detail

values

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

Returns:

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

valueOf

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

getIndex

public java.lang.Integer getIndex()

Description copied from interface: FontInfo

Get the index within the collection of Font objects

Specified by:

getIndex in interface FontInfo

Returns:

unique index number of the underlying record this Font represents (probably you don't care unless you're comparing which one is which)

setIndex

public void setIndex(int index)

Description copied from interface: FontInfo

Sets the index within the collection of Font objects

Specified by:

setIndex in interface FontInfo

Parameters:

index - the index within the collection of Font objects

getTypeface

public java.lang.String getTypeface()

Specified by:

getTypeface in interface FontInfo

Returns:

the full name of the font, i.e. font family + type face

setTypeface

public void setTypeface(java.lang.String typeface)

Description copied from interface: FontInfo

Sets the font name

Specified by:

setTypeface in interface FontInfo

Parameters:

typeface - the full name of the font, when null removes the font definition - removal is implementation specific

getCharset

public FontCharset getCharset()

Specified by:

getCharset in interface FontInfo

Returns:

the font charset

setCharset

public void setCharset(FontCharset charset)

Description copied from interface: FontInfo

Sets the charset

Specified by:

setCharset in interface FontInfo

Parameters:

charset - the charset

getFamily

public FontFamily getFamily()

Specified by:

getFamily in interface FontInfo

Returns:

the family class

setFamily

public void setFamily(FontFamily family)

Description copied from interface: FontInfo

Sets the font family class

Specified by:

setFamily in interface FontInfo

Parameters:

family - the font family class

getPitch

public FontPitch getPitch()

Specified by:

getPitch in interface FontInfo

Returns:

the font pitch or null if unsupported

setPitch

public void setPitch(FontPitch pitch)

Description copied from interface: FontInfo

Set the font pitch

Specified by:

setPitch in interface FontInfo

Parameters:

pitch - the font pitch