Modifier and Type	Class and Description
private static class	FontMapperImpl.DefaultFontProvider
private static class	FontMapperImpl.FontMatch A potential match for a font substitution.

Modifier and Type	Field and Description
private static final FontCache	fontCache
private Map<String, FontInfo>	fontInfoByName
private FontProvider	fontProvider
private final TrueTypeFont	lastResortFont
private static final Log	LOG
private final Map<String, List<String>>	substitutes Map of PostScript name substitutes, in priority order.

Access	Constructor and Description
pack-priv	FontMapperImpl()

Method Summary

Modifier and Type	Method and Description
public void	addSubstitute(String PostScript name of the font to match match, String PostScript name of the font to use as a replacement replace) Adds a top-priority substitute for the given font.
private void	addSubstitutes(String match, List<String> replacements)
private Map<String, FontInfo>	createFontInfoByName(List<? extends FontInfo> fontInfoList)
private FontBoxFont	findFont(FontFormat format, String PostScript font name postScriptName) Finds a font with the given PostScript name, or a suitable substitute, or null.
private FontBoxFont	findFontBoxFont(String PostScript font name postScriptName) Finds a font with the given PostScript name, or a suitable substitute, or null.
public CIDFontMapping	getCIDFont(String PostScript name of the mapped font baseFont, PDFontDescriptor FontDescriptor fontDescriptor, PDCIDSystemInfo the CID system info, e.g. "Adobe-Japan1", if any. cidSystemInfo) Implements org.apache.pdfbox.pdmodel.font.FontMapper.getCIDFont. Finds a CFF CID-Keyed font with the given PostScript name, or a suitable substitute, or null.
private String	getFallbackFontName(PDFontDescriptor fontDescriptor) Attempts to find a good fallback based on the font descriptor.
private FontInfo	getFont(FontFormat format, String postScriptName) Finds the named font with the given format.
public FontMapping<FontBoxFont>	getFontBoxFont(String PostScript name of the mapped font baseFont, PDFontDescriptor the FontDescriptor of the font to find fontDescriptor) Implements org.apache.pdfbox.pdmodel.font.FontMapper.getFontBoxFont. Finds a font with the given PostScript name, or a suitable substitute, or null.
public FontCache	getFontCache() Returns the font cache associated with this FontMapper.
private PriorityQueue<FontMapperImpl.FontMatch>	getFontMatches(PDFontDescriptor FontDescriptor, always present. fontDescriptor, PDCIDSystemInfo Font's CIDSystemInfo, may be null. cidSystemInfo) Returns a list of matching fonts, scored by suitability.
private Set<String>	getPostScriptNames(String postScriptName) Gets alternative names, as seen in some PDFs, e.g. PDFBOX-142.
public synchronized FontProvider	getProvider() Returns the font service provider.
private List<String>	getSubstitutes(String postScriptName) Returns the substitutes for a given font.
public FontMapping<TrueTypeFont>	getTrueTypeFont(String PostScript name of the mapped font baseFont, PDFontDescriptor FontDescriptor fontDescriptor) Implements org.apache.pdfbox.pdmodel.font.FontMapper.getTrueTypeFont. Finds a TrueType font with the given PostScript name, or a suitable substitute, or null.
private boolean	isCharSetMatch(PDCIDSystemInfo cidSystemInfo, FontInfo info) Returns true if the character set described by CIDSystemInfo is present in the given font.
private FontMapperImpl.FontMatch	printMatches(PriorityQueue<FontMapperImpl.FontMatch> queue) For debugging.
private boolean	probablyBarcodeFont(PDFontDescriptor fontDescriptor)
public synchronized void	setProvider(FontProvider fontProvider) Sets the font service provider.

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

Field Detail

fontCache	back to summary
private static final FontCache fontCache

fontInfoByName	back to summary
private Map<String, FontInfo> fontInfoByName

fontProvider	back to summary
private FontProvider fontProvider

lastResortFont	back to summary
private final TrueTypeFont lastResortFont

LOG	back to summary
private static final Log LOG

substitutes	back to summary
private final Map<String, List<String>> substitutes Map of PostScript name substitutes, in priority order.

Constructor Detail

FontMapperImpl	back to summary
pack-priv FontMapperImpl()

Method Detail

addSubstitute	back to summary
public void addSubstitute(String match, String replace) Adds a top-priority substitute for the given font. Parameters match:String PostScript name of the font to match replace:String PostScript name of the font to use as a replacement

addSubstitute

back to summary

public void addSubstitute(String match, String replace)

Adds a top-priority substitute for the given font.

Parameters

match:String: PostScript name of the font to match
replace:String: PostScript name of the font to use as a replacement

addSubstitutes	back to summary
private void addSubstitutes(String match, List<String> replacements)

createFontInfoByName	back to summary
private Map<String, FontInfo> createFontInfoByName(List<? extends FontInfo> fontInfoList)

findFont	back to summary
private FontBoxFont findFont(FontFormat format, String postScriptName) Finds a font with the given PostScript name, or a suitable substitute, or null. Parameters postScriptName:String PostScript font name

findFont

back to summary

private FontBoxFont findFont(FontFormat format, String postScriptName)

Finds a font with the given PostScript name, or a suitable substitute, or null.

Parameters

postScriptName:String: PostScript font name

findFontBoxFont	back to summary
private FontBoxFont findFontBoxFont(String postScriptName) Finds a font with the given PostScript name, or a suitable substitute, or null. Parameters postScriptName:String PostScript font name

findFontBoxFont

back to summary

private FontBoxFont findFontBoxFont(String postScriptName)

Finds a font with the given PostScript name, or a suitable substitute, or null.

Parameters

postScriptName:String: PostScript font name

getCIDFont	back to summary
public CIDFontMapping getCIDFont(String baseFont, PDFontDescriptor fontDescriptor, PDCIDSystemInfo cidSystemInfo) Implements org.apache.pdfbox.pdmodel.font.FontMapper.getCIDFont. Finds a CFF CID-Keyed font with the given PostScript name, or a suitable substitute, or null. This method can also map CJK fonts via their CIDSystemInfo (ROS). Parameters baseFont:String Doc from org.apache.pdfbox.pdmodel.font.FontMapper.getCIDFont. PostScript name of the mapped font fontDescriptor:PDFontDescriptor FontDescriptor cidSystemInfo:PDCIDSystemInfo the CID system info, e.g. "Adobe-Japan1", if any. Returns:CIDFontMapping Doc from org.apache.pdfbox.pdmodel.font.FontMapper.getCIDFont. the mapped CIDFont font or null Annotations @Override

getCIDFont

back to summary

public CIDFontMapping getCIDFont(String baseFont, PDFontDescriptor fontDescriptor, PDCIDSystemInfo cidSystemInfo)

Implements org.apache.pdfbox.pdmodel.font.FontMapper.getCIDFont.

Finds a CFF CID-Keyed font with the given PostScript name, or a suitable substitute, or null. This method can also map CJK fonts via their CIDSystemInfo (ROS).

Parameters

baseFont:String

Doc from org.apache.pdfbox.pdmodel.font.FontMapper.getCIDFont.

PostScript name of the mapped font

fontDescriptor:PDFontDescriptor

FontDescriptor

cidSystemInfo:PDCIDSystemInfo

the CID system info, e.g. "Adobe-Japan1", if any.

Returns:CIDFontMapping

Doc from org.apache.pdfbox.pdmodel.font.FontMapper.getCIDFont.

the mapped CIDFont font or null

Annotations

@Override

getFallbackFontName	back to summary
private String getFallbackFontName(PDFontDescriptor fontDescriptor) Attempts to find a good fallback based on the font descriptor.

getFont	back to summary
private FontInfo getFont(FontFormat format, String postScriptName) Finds the named font with the given format.

getFontBoxFont	back to summary
public FontMapping<FontBoxFont> getFontBoxFont(String baseFont, PDFontDescriptor fontDescriptor) Implements org.apache.pdfbox.pdmodel.font.FontMapper.getFontBoxFont. Finds a font with the given PostScript name, or a suitable substitute, or null. This allows any font to be substituted with a PFB, TTF or OTF. Parameters baseFont:String Doc from org.apache.pdfbox.pdmodel.font.FontMapper.getFontBoxFont. PostScript name of the mapped font fontDescriptor:PDFontDescriptor the FontDescriptor of the font to find Returns:FontMapping<FontBoxFont> Doc from org.apache.pdfbox.pdmodel.font.FontMapper.getFontBoxFont. the mapped FontBox font or null Annotations @Override

getFontBoxFont

back to summary

public FontMapping<FontBoxFont> getFontBoxFont(String baseFont, PDFontDescriptor fontDescriptor)

Implements org.apache.pdfbox.pdmodel.font.FontMapper.getFontBoxFont.

Finds a font with the given PostScript name, or a suitable substitute, or null. This allows any font to be substituted with a PFB, TTF or OTF.

Parameters

baseFont:String

Doc from org.apache.pdfbox.pdmodel.font.FontMapper.getFontBoxFont.

PostScript name of the mapped font

fontDescriptor:PDFontDescriptor

the FontDescriptor of the font to find

Returns:FontMapping<FontBoxFont>

Doc from org.apache.pdfbox.pdmodel.font.FontMapper.getFontBoxFont.

the mapped FontBox font or null

Annotations

@Override

getFontCache	back to summary
public FontCache getFontCache() Returns the font cache associated with this FontMapper. This method is needed by FontProvider subclasses.

getFontMatches	back to summary
private PriorityQueue<FontMapperImpl.FontMatch> getFontMatches(PDFontDescriptor fontDescriptor, PDCIDSystemInfo cidSystemInfo) Returns a list of matching fonts, scored by suitability. Positive scores indicate matches for certain attributes, while negative scores indicate mismatches. Zero scores are neutral. Parameters fontDescriptor:PDFontDescriptor FontDescriptor, always present. cidSystemInfo:PDCIDSystemInfo Font's CIDSystemInfo, may be null.

getFontMatches

back to summary

private PriorityQueue<FontMapperImpl.FontMatch> getFontMatches(PDFontDescriptor fontDescriptor, PDCIDSystemInfo cidSystemInfo)

Returns a list of matching fonts, scored by suitability. Positive scores indicate matches for certain attributes, while negative scores indicate mismatches. Zero scores are neutral.

Parameters

fontDescriptor:PDFontDescriptor: FontDescriptor, always present.
cidSystemInfo:PDCIDSystemInfo: Font's CIDSystemInfo, may be null.

getPostScriptNames	back to summary
private Set<String> getPostScriptNames(String postScriptName) Gets alternative names, as seen in some PDFs, e.g. PDFBOX-142.

getProvider	back to summary
public synchronized FontProvider getProvider() Returns the font service provider. Defaults to using FileSystemFontProvider.

getSubstitutes	back to summary
private List<String> getSubstitutes(String postScriptName) Returns the substitutes for a given font.

getTrueTypeFont	back to summary
public FontMapping<TrueTypeFont> getTrueTypeFont(String baseFont, PDFontDescriptor fontDescriptor) Implements org.apache.pdfbox.pdmodel.font.FontMapper.getTrueTypeFont. Finds a TrueType font with the given PostScript name, or a suitable substitute, or null. Parameters baseFont:String Doc from org.apache.pdfbox.pdmodel.font.FontMapper.getTrueTypeFont. PostScript name of the mapped font fontDescriptor:PDFontDescriptor FontDescriptor Returns:FontMapping<TrueTypeFont> Doc from org.apache.pdfbox.pdmodel.font.FontMapper.getTrueTypeFont. the mapped TrueType font or null Annotations @Override

getTrueTypeFont

back to summary

public FontMapping<TrueTypeFont> getTrueTypeFont(String baseFont, PDFontDescriptor fontDescriptor)

Implements org.apache.pdfbox.pdmodel.font.FontMapper.getTrueTypeFont.

Finds a TrueType font with the given PostScript name, or a suitable substitute, or null.

Parameters

baseFont:String

Doc from org.apache.pdfbox.pdmodel.font.FontMapper.getTrueTypeFont.

PostScript name of the mapped font

fontDescriptor:PDFontDescriptor

FontDescriptor

Returns:FontMapping<TrueTypeFont>

Doc from org.apache.pdfbox.pdmodel.font.FontMapper.getTrueTypeFont.

the mapped TrueType font or null

Annotations

@Override

isCharSetMatch	back to summary
private boolean isCharSetMatch(PDCIDSystemInfo cidSystemInfo, FontInfo info) Returns true if the character set described by CIDSystemInfo is present in the given font. Only applies to Adobe-GB1, Adobe-CNS1, Adobe-Japan1, Adobe-Korea1, as per the PDF spec.

printMatches	back to summary
private FontMapperImpl.FontMatch printMatches(PriorityQueue<FontMapperImpl.FontMatch> queue) For debugging. Prints all matches and returns the best match.

probablyBarcodeFont	back to summary
private boolean probablyBarcodeFont(PDFontDescriptor fontDescriptor)

setProvider	back to summary
public synchronized void setProvider(FontProvider fontProvider) Sets the font service provider.

org.apache.pdfbox.pdmodel.font back to summary

private Class FontMapperImpl.DefaultFontProvider

Class Inheritance

extends Object

java.lang.Object
org.apache.pdfbox.pdmodel.font.FontMapperImpl.DefaultFontProvider

Field Summary

Modifier and Type	Field and Description
private static final FontProvider	INSTANCE

Constructor Summary

Access	Constructor and Description
private	DefaultFontProvider()

Method Summary

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

Field Detail

INSTANCE	back to summary
private static final FontProvider INSTANCE

Constructor Detail

DefaultFontProvider	back to summary
private DefaultFontProvider()

org.apache.pdfbox.pdmodel.font back to summary

private Class FontMapperImpl.FontMatch

Class Inheritance

extends Object
implements Comparable<FontMapperImpl.FontMatch>

java.lang.Object
org.apache.pdfbox.pdmodel.font.FontMapperImpl.FontMatch

All Implemented Interfaces

java.lang.Comparable

A potential match for a font substitution.

Field Summary

Modifier and Type	Field and Description
pack-priv final FontInfo	info
pack-priv double	score

Constructor Summary

Access	Constructor and Description
pack-priv	FontMatch(FontInfo info)

Method Summary

Modifier and Type	Method and Description
public int	compareTo(FontMapperImpl.FontMatch the object to be compared. match) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.

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

Field Detail

info	back to summary
pack-priv final FontInfo info

score	back to summary
pack-priv double score

Constructor Detail

FontMatch	back to summary
pack-priv FontMatch(FontInfo info)

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(FontMapperImpl.FontMatch match) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters match:FontMapperImpl.FontMatch the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(FontMapperImpl.FontMatch match)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

match:FontMapperImpl.FontMatch: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

pack-priv final Class FontMapperImpl

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class FontMapperImpl.DefaultFontProvider

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private Class FontMapperImpl.FontMatch

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail