Package org.apache.poi.hslf.record
Class FontCollection
- java.lang.Object
-
- org.apache.poi.hslf.record.Record
-
- org.apache.poi.hslf.record.RecordContainer
-
- org.apache.poi.hslf.record.FontCollection
-
- All Implemented Interfaces:
GenericRecord
public final class FontCollection extends RecordContainer
FontCollection
ia a container that holds information about all the fonts in the presentation.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description HSLFFontInfo
addFont(java.io.InputStream fontData)
HSLFFontInfo
addFont(FontInfo fontInfo)
Add font with the given FontInfo configuration to the font collection.HSLFFontInfo
getFontInfo(int index)
Lookup a FontInfo object by its internal font indexHSLFFontInfo
getFontInfo(java.lang.String typeface)
Lookup a FontInfo object by its typefaceHSLFFontInfo
getFontInfo(java.lang.String typeface, FontCharset charset)
Lookup a FontInfo object by its typefacejava.util.List<HSLFFontInfo>
getFonts()
java.util.Map<java.lang.String,java.util.function.Supplier<?>>
getGenericProperties()
int
getNumberOfFonts()
long
getRecordType()
Return the type, which is 2005void
writeOut(java.io.OutputStream out)
Write the contents of the record back, so it can be written to disk-
Methods inherited from class org.apache.poi.hslf.record.RecordContainer
addChildAfter, addChildBefore, appendChildRecord, findFirstOfType, getChildRecords, handleParentAwareRecords, isAnAtom, removeChild, setChildRecord, writeOut
-
Methods inherited from class org.apache.poi.hslf.record.Record
buildRecordAtOffset, createRecordForType, findChildRecords, getGenericChildren, getGenericRecordType, writeLittleEndian, writeLittleEndian
-
-
-
-
Method Detail
-
getRecordType
public long getRecordType()
Return the type, which is 2005- Specified by:
getRecordType
in classRecord
-
writeOut
public void writeOut(java.io.OutputStream out) throws java.io.IOException
Write the contents of the record back, so it can be written to disk
-
addFont
public HSLFFontInfo addFont(FontInfo fontInfo)
Add font with the given FontInfo configuration to the font collection. The returned FontInfo contains the HSLF specific details and the collection uniquely contains fonts based on their typeface, i.e. calling the method with FontInfo objects having the same name results in the same HSLFFontInfo reference.- Parameters:
fontInfo
- the FontInfo configuration, can be a instance ofHSLFFontInfo
,HSLFFontInfoPredefined
or a custom implementation- Returns:
- the register HSLFFontInfo object
-
addFont
public HSLFFontInfo addFont(java.io.InputStream fontData) throws java.io.IOException
- Throws:
java.io.IOException
-
getFontInfo
public HSLFFontInfo getFontInfo(java.lang.String typeface)
Lookup a FontInfo object by its typeface- Parameters:
typeface
- the full font name- Returns:
- the HSLFFontInfo for the given name or
null
if not found
-
getFontInfo
public HSLFFontInfo getFontInfo(java.lang.String typeface, FontCharset charset)
Lookup a FontInfo object by its typeface- Parameters:
typeface
- the full font namecharset
- the charset- Returns:
- the HSLFFontInfo for the given name or
null
if not found
-
getFontInfo
public HSLFFontInfo getFontInfo(int index)
Lookup a FontInfo object by its internal font index- Parameters:
index
- the internal font index- Returns:
- the HSLFFontInfo for the given index or
null
if not found
-
getNumberOfFonts
public int getNumberOfFonts()
- Returns:
- the number of registered fonts
-
getFonts
public java.util.List<HSLFFontInfo> getFonts()
-
getGenericProperties
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
- Specified by:
getGenericProperties
in interfaceGenericRecord
- Overrides:
getGenericProperties
in classRecordContainer
-
-