Class PdfBoxFontResolver

java.lang.Object

com.openhtmltopdf.pdfboxout.PdfBoxFontResolver

All Implemented Interfaces:

FontResolver

public class PdfBoxFontResolver
extends Object
implements FontResolver

This class handles all font resolving for the PDF generation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	PdfBoxFontResolver.FilePDFontSupplier	Loads a Type0 font on demand
static class	PdfBoxFontResolver.FontDescription	A FontDescription can exist in multiple states.
static enum	PdfBoxFontResolver.FontGroup

Field Summary

Fields

Modifier and Type	Field	Description
private final AbstractFontStore	_builtinFonts
private final org.apache.pdfbox.pdmodel.PDDocument	_doc
private final FallbackFontStore	_finalFallbackFonts
private final FallbackFontStore	_preBuiltinFallbackFonts
private final MainFontStore	_suppliedFonts

Constructor Summary

Constructors

Constructor	Description
PdfBoxFontResolver(SharedContext sharedContext, org.apache.pdfbox.pdmodel.PDDocument doc, FSCacheEx<String, FSCacheValue> pdfMetricsCache, PdfRendererBuilder.PdfAConformance pdfAConformance, boolean pdfUaConform)

Method Summary

Modifier and Type	Method	Description
void	addFont(FSSupplier<InputStream> supplier, String fontFamilyNameOverride, Integer fontWeightOverride, IdentValue fontStyleOverride, boolean subset)	Deprecated. Use addFont(FSSupplier, String, Integer, IdentValue, boolean, FontGroup)
void	addFont(FSSupplier<InputStream> supplier, String fontFamilyNameOverride, Integer fontWeightOverride, IdentValue fontStyleOverride, boolean subset, PdfBoxFontResolver.FontGroup fontGroup)	Adds a font specified by an input stream (truetype) to a specific font group.
void	addFont(PDFontSupplier supplier, String fontFamilyNameOverride, Integer fontWeightOverride, IdentValue fontStyleOverride, boolean subset)	Deprecated. Use addFont(PDFontSupplier, String, Integer, IdentValue, boolean, FontGroup)
void	addFont(PDFontSupplier supplier, String fontFamilyNameOverride, Integer fontWeightOverride, IdentValue fontStyleOverride, boolean subset, PdfBoxFontResolver.FontGroup fontGroup)	Add a font specified by a PDFontSupplier to a specific font group.
void	addFont(File fontFile, String fontFamilyNameOverride, Integer fontWeightOverride, IdentValue fontStyleOverride, boolean subset)	Deprecated. Use addFont(File, String, Integer, IdentValue, boolean, FontGroup)
void	addFont(File fontFile, String fontFamilyNameOverride, Integer fontWeightOverride, IdentValue fontStyleOverride, boolean subset, PdfBoxFontResolver.FontGroup fontGroup)	Add a font file (truetype) to a specific font group.
void	addFontCollection(FSSupplier<InputStream> supplier, String fontFamilyNameOverride, Integer fontWeightOverride, IdentValue fontStyleOverride, boolean subset)	Deprecated. Use addFontCollection(FSSupplier, String, Integer, IdentValue, boolean, FontGroup)
void	addFontCollection(FSSupplier<InputStream> supplier, String fontFamilyNameOverride, Integer fontWeightOverride, IdentValue fontStyleOverride, boolean subset, PdfBoxFontResolver.FontGroup fontGroup)	Adds a font collection (.ttc in an input stream) to a specific font group.
void	addFontCollection(File file, String fontFamilyNameOverride, Integer fontWeightOverride, IdentValue fontStyleOverride, boolean subset)	Deprecated. Use addFontCollection(File, String, Integer, IdentValue, boolean, FontGroup)
void	addFontCollection(File file, String fontFamilyNameOverride, Integer fontWeightOverride, IdentValue fontStyleOverride, boolean subset, PdfBoxFontResolver.FontGroup fontGroup)	Adds a font collection (.ttc file) to a specific group.
void	addFontDirectory(String dir, boolean embedded)	Deprecated. Use addFontDirectory(String, boolean, FontGroup)
void	addFontDirectory(String dir, boolean embedded, PdfBoxFontResolver.FontGroup fontGroup)	Add all fonts in the given directory
void	close()	Free all font resources (i.e.
private FallbackFontStore	getFallbackFontStore(PdfBoxFontResolver.FontGroup fontGroup)
void	importFontFaces(List<FontFaceRule> fontFaces)
private void	resolveFamilyFont(SharedContext ctx, String[] families, float size, IdentValue weight, IdentValue style, IdentValue variant, List<PdfBoxFontResolver.FontDescription> fonts, AbstractFontStore store)
FSFont	resolveFont(SharedContext renderingContext, FontSpecification spec)
private FSFont	resolveFont(SharedContext ctx, String[] families, float size, IdentValue weight, IdentValue style, IdentValue variant)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_doc

private final org.apache.pdfbox.pdmodel.PDDocument _doc

_suppliedFonts

private final MainFontStore _suppliedFonts

_preBuiltinFallbackFonts

private final FallbackFontStore _preBuiltinFallbackFonts

_builtinFonts

private final AbstractFontStore _builtinFonts

_finalFallbackFonts

private final FallbackFontStore _finalFallbackFonts

Constructor Details

PdfBoxFontResolver

public PdfBoxFontResolver(SharedContext sharedContext,
 org.apache.pdfbox.pdmodel.PDDocument doc,
 FSCacheEx<String, FSCacheValue> pdfMetricsCache,
 PdfRendererBuilder.PdfAConformance pdfAConformance,
 boolean pdfUaConform)

Method Details

resolveFont

public FSFont resolveFont(SharedContext renderingContext,
 FontSpecification spec)

Specified by:

resolveFont in interface FontResolver

close

public void close()

Free all font resources (i.e. open files), the document should already be closed.

importFontFaces

public void importFontFaces(List<FontFaceRule> fontFaces)

addFontDirectory

@Deprecated
public void addFontDirectory(String dir,
 boolean embedded)
                      throws IOException

Deprecated.

Use addFontDirectory(String, boolean, FontGroup)

Throws:

IOException

addFontDirectory

public void addFontDirectory(String dir,
 boolean embedded,
 PdfBoxFontResolver.FontGroup fontGroup)
                      throws IOException

Add all fonts in the given directory

Throws:

IOException

addFontCollection

public void addFontCollection(FSSupplier<InputStream> supplier,
 String fontFamilyNameOverride,
 Integer fontWeightOverride,
 IdentValue fontStyleOverride,
 boolean subset,
 PdfBoxFontResolver.FontGroup fontGroup)
                       throws IOException

Adds a font collection (.ttc in an input stream) to a specific font group.

Throws:

IOException

addFontCollection

@Deprecated
public void addFontCollection(FSSupplier<InputStream> supplier,
 String fontFamilyNameOverride,
 Integer fontWeightOverride,
 IdentValue fontStyleOverride,
 boolean subset)
                       throws IOException

Deprecated.

Use addFontCollection(FSSupplier, String, Integer, IdentValue, boolean, FontGroup)

Add fonts using a .ttc TrueTypeCollection

Throws:

IOException

addFontCollection

public void addFontCollection(File file,
 String fontFamilyNameOverride,
 Integer fontWeightOverride,
 IdentValue fontStyleOverride,
 boolean subset,
 PdfBoxFontResolver.FontGroup fontGroup)
                       throws IOException

Adds a font collection (.ttc file) to a specific group.

Throws:

IOException

addFontCollection

@Deprecated
public void addFontCollection(File file,
 String fontFamilyNameOverride,
 Integer fontWeightOverride,
 IdentValue fontStyleOverride,
 boolean subset)
                       throws IOException

Deprecated.

Use addFontCollection(File, String, Integer, IdentValue, boolean, FontGroup)

Add fonts using a .ttc TrueTypeCollection

Throws:

IOException

addFont

public void addFont(File fontFile,
 String fontFamilyNameOverride,
 Integer fontWeightOverride,
 IdentValue fontStyleOverride,
 boolean subset,
 PdfBoxFontResolver.FontGroup fontGroup)
             throws IOException

Add a font file (truetype) to a specific font group.

Throws:

IOException

getFallbackFontStore

private FallbackFontStore getFallbackFontStore(PdfBoxFontResolver.FontGroup fontGroup)

addFont

@Deprecated
public void addFont(File fontFile,
 String fontFamilyNameOverride,
 Integer fontWeightOverride,
 IdentValue fontStyleOverride,
 boolean subset)
             throws IOException

Deprecated.

Use addFont(File, String, Integer, IdentValue, boolean, FontGroup)

Add a font using a existing file. If the file is a TrueTypeCollection, it will be handled as such.

Throws:

IOException

addFont

public void addFont(FSSupplier<InputStream> supplier,
 String fontFamilyNameOverride,
 Integer fontWeightOverride,
 IdentValue fontStyleOverride,
 boolean subset,
 PdfBoxFontResolver.FontGroup fontGroup)

Adds a font specified by an input stream (truetype) to a specific font group.

addFont

@Deprecated
public void addFont(FSSupplier<InputStream> supplier,
 String fontFamilyNameOverride,
 Integer fontWeightOverride,
 IdentValue fontStyleOverride,
 boolean subset)

Deprecated.

Use addFont(FSSupplier, String, Integer, IdentValue, boolean, FontGroup)

Add a font using a InputStream. The given file must be a TrueType Font (.ttf). If you know the underlying stream is a .ttc file you should use addFontCollection(FSSupplier, String, Integer, IdentValue, boolean)

addFont

public void addFont(PDFontSupplier supplier,
 String fontFamilyNameOverride,
 Integer fontWeightOverride,
 IdentValue fontStyleOverride,
 boolean subset,
 PdfBoxFontResolver.FontGroup fontGroup)

Add a font specified by a PDFontSupplier to a specific font group.

addFont

@Deprecated
public void addFont(PDFontSupplier supplier,
 String fontFamilyNameOverride,
 Integer fontWeightOverride,
 IdentValue fontStyleOverride,
 boolean subset)

Deprecated.

Use addFont(PDFontSupplier, String, Integer, IdentValue, boolean, FontGroup)

Add a font using a PDFontSupplier. Use this method if you need special rules for font-loading (like using a font-cache) and subclass the PDFontSupplier.

resolveFont

private FSFont resolveFont(SharedContext ctx,
 String[] families,
 float size,
 IdentValue weight,
 IdentValue style,
 IdentValue variant)

resolveFamilyFont

private void resolveFamilyFont(SharedContext ctx,
 String[] families,
 float size,
 IdentValue weight,
 IdentValue style,
 IdentValue variant,
 List<PdfBoxFontResolver.FontDescription> fonts,
 AbstractFontStore store)