Interface FontInfo
- All Known Implementing Classes:
HSLFFontInfo
,HSLFFontInfoPredefined
,HwmfFont
public interface FontInfo
A FontInfo object holds information about a font configuration.
It is roughly an equivalent to the LOGFONT structure in Windows GDI.
If an implementation doesn't provide a property, the getter will return null
-
if the value is unset, a default value will be returned.
Setting a unsupported property results in an UnsupportedOperationException
.
- Since:
- POI 3.17-beta2
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiongetIndex()
Get the index within the collection of Font objectsgetPitch()
void
setCharset
(FontCharset charset) Sets the charsetvoid
setFamily
(FontFamily family) Sets the font family classvoid
setIndex
(int index) Sets the index within the collection of Font objectsvoid
Set the font pitchvoid
setTypeface
(String typeface) Sets the font name
-
Method Details
-
getIndex
Integer getIndex()Get the index within the collection of Font objects- 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
void setIndex(int index) Sets the index within the collection of Font objects- Parameters:
index
- the index within the collection of Font objects- Throws:
UnsupportedOperationException
- if unsupported
-
getTypeface
String getTypeface()- Returns:
- the full name of the font, i.e. font family + type face
-
setTypeface
Sets the font name- Parameters:
typeface
- the full name of the font, whennull
removes the font definition - removal is implementation specific
-
getCharset
FontCharset getCharset()- Returns:
- the font charset
-
setCharset
Sets the charset- Parameters:
charset
- the charset
-
getFamily
FontFamily getFamily()- Returns:
- the family class
-
setFamily
Sets the font family class- Parameters:
family
- the font family class
-
getPitch
FontPitch getPitch()- Returns:
- the font pitch or
null
if unsupported
-
setPitch
Set the font pitch- Parameters:
pitch
- the font pitch- Throws:
UnsupportedOperationException
- if unsupported
-