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

Modifier and Type	Field and Description
private final AbstractFontStore	_builtinFonts
private final PDDocument	_doc
private final FallbackFontStore	_finalFallbackFonts
private final FallbackFontStore	_preBuiltinFallbackFonts
private final MainFontStore	_suppliedFonts

Access	Constructor and Description
public	PdfBoxFontResolver(SharedContext sharedContext, PDDocument doc, FSCacheEx<String, FSCacheValue> pdfMetricsCache, PdfRendererBuilder.PdfAConformance pdfAConformance, boolean pdfUaConform)

Method Summary

Modifier and Type	Method and Description
public 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.
public void	addFont(File fontFile, final String fontFamilyNameOverride, final Integer fontWeightOverride, final IdentValue fontStyleOverride, final boolean subset) Deprecated Use `addFont(File, String, Integer, IdentValue, boolean, FontGroup)` Add a font using a existing file.
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.
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.
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.
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.
public 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.
public void	addFontCollection(FSSupplier<InputStream> supplier, final String fontFamilyNameOverride, final Integer fontWeightOverride, final IdentValue fontStyleOverride, final boolean subset) Deprecated Use `addFontCollection(FSSupplier, String, Integer, IdentValue, boolean, FontGroup)` Add fonts using a .ttc TrueTypeCollection
public 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.
public void	addFontCollection(File file, final String fontFamilyNameOverride, final Integer fontWeightOverride, final IdentValue fontStyleOverride, final boolean subset) Deprecated Use `addFontCollection(File, String, Integer, IdentValue, boolean, FontGroup)` Add fonts using a .ttc TrueTypeCollection
public void	addFontDirectory(String dir, boolean embedded) Deprecated Use `addFontDirectory(String, boolean, FontGroup)`
public void	addFontDirectory(String dir, boolean embedded, PdfBoxFontResolver.FontGroup fontGroup) Add all fonts in the given directory
public void	close() Free all font resources (i.e. open files), the document should already be closed.
private FallbackFontStore	getFallbackFontStore(PdfBoxFontResolver.FontGroup fontGroup)
public 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)
public FSFont	resolveFont(SharedContext renderingContext, FontSpecification spec) Implements com.openhtmltopdf.extend.FontResolver.resolveFont.
private FSFont	resolveFont(SharedContext ctx, String[] families, float size, IdentValue weight, IdentValue style, IdentValue variant)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

_builtinFonts	back to summary
private final AbstractFontStore _builtinFonts

_doc	back to summary
private final PDDocument _doc

_finalFallbackFonts	back to summary
private final FallbackFontStore _finalFallbackFonts

_preBuiltinFallbackFonts	back to summary
private final FallbackFontStore _preBuiltinFallbackFonts

_suppliedFonts	back to summary
private final MainFontStore _suppliedFonts

Constructor Detail

PdfBoxFontResolver	back to summary
public PdfBoxFontResolver(SharedContext sharedContext, PDDocument doc, FSCacheEx<String, FSCacheValue> pdfMetricsCache, PdfRendererBuilder.PdfAConformance pdfAConformance, boolean pdfUaConform)

Method Detail

addFont	back to summary
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.

addFont back to summary

addFont	back to summary
public void addFont(File fontFile, final String fontFamilyNameOverride, final Integer fontWeightOverride, final IdentValue fontStyleOverride, final 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. Annotations @Deprecated

public void addFont(File fontFile, final String fontFamilyNameOverride, final Integer fontWeightOverride, final IdentValue fontStyleOverride, final 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.

Annotations

@Deprecated

addFont	back to summary
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 back to summary

addFont	back to summary
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)` Annotations @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)

Annotations

@Deprecated

addFont	back to summary
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 back to summary

addFont	back to summary
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`. Annotations @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.

Annotations

@Deprecated

addFontCollection	back to summary
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.

addFontCollection back to summary

addFontCollection	back to summary
public void addFontCollection(FSSupplier<InputStream> supplier, final String fontFamilyNameOverride, final Integer fontWeightOverride, final IdentValue fontStyleOverride, final boolean subset) throws IOException Deprecated Use `addFontCollection(FSSupplier, String, Integer, IdentValue, boolean, FontGroup)` Add fonts using a .ttc TrueTypeCollection Annotations @Deprecated

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

Deprecated

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

Add fonts using a .ttc TrueTypeCollection

Annotations

@Deprecated

addFontCollection	back to summary
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.

addFontCollection back to summary

addFontCollection	back to summary
public void addFontCollection(File file, final String fontFamilyNameOverride, final Integer fontWeightOverride, final IdentValue fontStyleOverride, final boolean subset) throws IOException Deprecated Use `addFontCollection(File, String, Integer, IdentValue, boolean, FontGroup)` Add fonts using a .ttc TrueTypeCollection Annotations @Deprecated

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

Deprecated

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

Add fonts using a .ttc TrueTypeCollection

Annotations

@Deprecated

addFontDirectory	back to summary
public void addFontDirectory(String dir, boolean embedded) throws IOException Deprecated Use `addFontDirectory(String, boolean, FontGroup)` Annotations @Deprecated

addFontDirectory	back to summary
public void addFontDirectory(String dir, boolean embedded, PdfBoxFontResolver.FontGroup fontGroup) throws IOException Add all fonts in the given directory

close	back to summary
public void close() Free all font resources (i.e. open files), the document should already be closed.

getFallbackFontStore	back to summary
private FallbackFontStore getFallbackFontStore(PdfBoxFontResolver.FontGroup fontGroup)

importFontFaces	back to summary
public void importFontFaces(List<FontFaceRule> fontFaces)

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

resolveFont	back to summary
public FSFont resolveFont(SharedContext renderingContext, FontSpecification spec) Implements com.openhtmltopdf.extend.FontResolver.resolveFont. Annotations @Override

resolveFont

back to summary

public FSFont resolveFont(SharedContext renderingContext, FontSpecification spec)

Implements com.openhtmltopdf.extend.FontResolver.resolveFont.

Annotations

@Override

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

com.openhtmltopdf.pdfboxout back to summary

private Class PdfBoxFontResolver.FilePDFontSupplier

Class Inheritance

extends Object
implements FSSupplier<PDFont>

java.lang.Object
com.openhtmltopdf.pdfboxout.PdfBoxFontResolver.FilePDFontSupplier

All Implemented Interfaces

com.openhtmltopdf.extend.FSSupplier

Loads a Type0 font on demand

Field Summary

Modifier and Type	Field and Description
private final PDDocument	_doc
private final File	_fontFile

Constructor Summary

Access	Constructor and Description
pack-priv	FilePDFontSupplier(File fontFile, PDDocument doc)

Method Summary

Modifier and Type	Method and Description
public PDFont	supply() Implements com.openhtmltopdf.extend.FSSupplier.supply.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_doc	back to summary
private final PDDocument _doc

_fontFile	back to summary
private final File _fontFile

Constructor Detail

FilePDFontSupplier	back to summary
pack-priv FilePDFontSupplier(File fontFile, PDDocument doc)

Method Detail

supply	back to summary
public PDFont supply() Implements com.openhtmltopdf.extend.FSSupplier.supply. Annotations @Override

supply

back to summary

public PDFont supply()

Implements com.openhtmltopdf.extend.FSSupplier.supply.

Annotations

@Override

com.openhtmltopdf.pdfboxout back to summary

public Class PdfBoxFontResolver.FontDescription

Class Inheritance

extends Object
implements MinimalFontDescription

java.lang.Object
com.openhtmltopdf.pdfboxout.PdfBoxFontResolver.FontDescription

All Implemented Interfaces

com.openhtmltopdf.outputdevice.helper.MinimalFontDescription

A FontDescription can exist in multiple states. Firstly the font may or may not be realized. Fonts are automatically realized upon calling getFont() Secondly, the metrics may or may not be available. If not available, you can attempt to retrieve them by realizing the font.

Field Summary

Modifier and Type	Field and Description
private final PDDocument	_doc
private final String	_family
private PDFont	_font
private FSSupplier<PDFont>	_fontSupplier
private final boolean	_isFromFontFace
private final boolean	_isSubset
private PdfBoxRawPDFontMetrics	_metrics
private final FSCacheEx<String, FSCacheValue>	_metricsCache
private final IdentValue	_style
private FSSupplier<InputStream>	_supplier
private final int	_weight

Constructor Summary

Access	Constructor and Description
public	FontDescription(PDFont font, IdentValue style, int weight) Create a font description from one of the PDF built-in fonts.
public	FontDescription(PDDocument doc, FSSupplier<InputStream> supplier, int weight, IdentValue style, String family, boolean isFromFontFace, boolean isSubset, FSCacheEx<String, FSCacheValue> metricsCache) Create a font description from an input stream supplier.
private	FontDescription(PDDocument doc, PDFont font, IdentValue style, int weight) Create a font description when a PDFont is definitely available to begin with.
public	FontDescription(PDDocument doc, FSSupplier<PDFont> fontSupplier, IdentValue style, int weight, String family, boolean isFromFontFace, boolean isSubset, FSCacheEx<String, FSCacheValue> metricsCache) Creates a font description from a PDFont supplier.

Method Summary

Modifier and Type	Method and Description
private String	createFontMetricsCacheKey(String family, int weight, IdentValue style)
public String	getFamily()
public PDFont	Returns: the font or null if there was a problem. getFont() Downloads and parses the font if required.
public PdfBoxRawPDFontMetrics	Returns: the font metrics or null if there was a problem. getFontMetrics() Downloads and parses the font if required (metrics were not available from cache).
private PdfBoxRawPDFontMetrics	getFontMetricsFromCache(String family, int weight, IdentValue style)
public IdentValue	getStyle() Implements com.openhtmltopdf.outputdevice.helper.MinimalFontDescription.getStyle.
public int	getWeight() Implements com.openhtmltopdf.outputdevice.helper.MinimalFontDescription.getWeight.
public boolean	isFontAvailable() Returns whether the font is available yet.
public boolean	isFromFontFace()
public boolean	isMetricsAvailable() If the metrics are available yet.
private boolean	loadMetrics()
private void	putFontMetricsInCache(String family, int weight, IdentValue style, PdfBoxRawPDFontMetrics metrics)
public boolean	realizeFont()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

_doc	back to summary
private final PDDocument _doc

_family	back to summary
private final String _family

_font	back to summary
private PDFont _font

_fontSupplier	back to summary
private FSSupplier<PDFont> _fontSupplier

_isFromFontFace	back to summary
private final boolean _isFromFontFace

_isSubset	back to summary
private final boolean _isSubset

_metrics	back to summary
private PdfBoxRawPDFontMetrics _metrics

_metricsCache	back to summary
private final FSCacheEx<String, FSCacheValue> _metricsCache

_style	back to summary
private final IdentValue _style

_supplier	back to summary
private FSSupplier<InputStream> _supplier

_weight	back to summary
private final int _weight

Constructor Detail

FontDescription	back to summary
public FontDescription(PDFont font, IdentValue style, int weight) Create a font description from one of the PDF built-in fonts.

FontDescription back to summary

public FontDescription(PDDocument doc, FSSupplier<InputStream> supplier, int weight, IdentValue style, String family, boolean isFromFontFace, boolean isSubset, FSCacheEx<String, FSCacheValue> metricsCache)

Create a font description from an input stream supplier. The input stream will only be accessed if getFont() or getFontMetrics() (and the font metrics were not available from cache) are called.

FontDescription	back to summary
private FontDescription(PDDocument doc, PDFont font, IdentValue style, int weight) Create a font description when a PDFont is definitely available to begin with. Currently only used for PDF built-in fonts.

FontDescription	back to summary
public FontDescription(PDDocument doc, FSSupplier<PDFont> fontSupplier, IdentValue style, int weight, String family, boolean isFromFontFace, boolean isSubset, FSCacheEx<String, FSCacheValue> metricsCache) Creates a font description from a PDFont supplier. The supplier will only be called upon if `getFont()` or `getFontMetrics()` (and the font metrics were not available from cache) are called.

Method Detail

createFontMetricsCacheKey	back to summary
private String createFontMetricsCacheKey(String family, int weight, IdentValue style)

getFamily	back to summary
public String getFamily()

getFont

back to summary

public PDFont getFont()

Downloads and parses the font if required. Should only be called when the font is definitely needed.

Returns:PDFont: the font or null if there was a problem.

getFontMetrics back to summary

public PdfBoxRawPDFontMetrics getFontMetrics()

Downloads and parses the font if required (metrics were not available from cache). Should only be called when the font metrics are definitely needed.

Returns:PdfBoxRawPDFontMetrics: the font metrics or null if there was a problem.
See Also: isMetricsAvailable()

getFontMetricsFromCache	back to summary
private PdfBoxRawPDFontMetrics getFontMetricsFromCache(String family, int weight, IdentValue style)

getStyle

back to summary

public IdentValue getStyle()

Implements com.openhtmltopdf.outputdevice.helper.MinimalFontDescription.getStyle.

Annotations

@Override

getWeight

back to summary

public int getWeight()

Implements com.openhtmltopdf.outputdevice.helper.MinimalFontDescription.getWeight.

Annotations

@Override

isFontAvailable back to summary

public boolean isFontAvailable()

Returns whether the font is available yet.

See Also: getFont()

isFromFontFace	back to summary
public boolean isFromFontFace()

isMetricsAvailable back to summary

public boolean isMetricsAvailable()

If the metrics are available yet.

See Also: getFontMetrics()

loadMetrics	back to summary
private boolean loadMetrics()

putFontMetricsInCache	back to summary
private void putFontMetricsInCache(String family, int weight, IdentValue style, PdfBoxRawPDFontMetrics metrics)

realizeFont	back to summary
public boolean realizeFont()

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

Modifier and Type	Field and Description
public static final PdfBoxFontResolver.FontGroup	FINAL_FALLBACK
public static final PdfBoxFontResolver.FontGroup	MAIN
public static final PdfBoxFontResolver.FontGroup	PRE_BUILT_IN_FALLBACK

Modifier and Type	Method and Description
public static PdfBoxFontResolver.FontGroup	valueOf(String name)
public static PdfBoxFontResolver.FontGroup[]	values()

public Class PdfBoxFontResolver

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PdfBoxFontResolver.FilePDFontSupplier

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class PdfBoxFontResolver.FontDescription

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum PdfBoxFontResolver.FontGroup

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail