com.itextpdf.layout.font

Class FontProvider

java.lang.Object

com.itextpdf.layout.font.FontProvider

Direct Known Subclasses:

BasicFontProvider

public class FontProvider
extends Object

Main entry point of font selector logic. Contains reusable FontSet and collection of PdfFonts. FontProvider depends on PdfDocument due to PdfFont, so it cannot be reused for different documents unless reset with reset() or recreated with getFontSet(). In the former case the FontSelectorCache is reused and in the latter it's reinitialised. FontProvider the only end point for creating PdfFont.

It is allowed to use only one FontProvider per document. If additional fonts per element needed, another instance of FontSet can be used. For more details see Property.FONT_SET, getPdfFont(FontInfo, FontSet), getStrategy(String, List, FontCharacteristics, FontSet).

Note, FontProvider does not close created FontPrograms, because of possible conflicts with FontCache.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	defaultFontFamily The default font-family is used by FontSelector if it's impossible to select a font for all other set font-families
protected Map<FontInfo,PdfFont>	pdfFonts

Constructor Summary

Constructors

Constructor and Description
FontProvider() Creates a new instance of FontProvider.
FontProvider(FontSet fontSet) Creates a new instance of FontProvider
FontProvider(FontSet fontSet, String defaultFontFamily) Creates a new instance of FontProvider
FontProvider(String defaultFontFamily) Creates a new instance of FontProvider.

Method Summary

Modifier and Type	Method and Description
int	addDirectory(String dir)
boolean	addFont(byte[] fontData)
boolean	addFont(byte[] fontData, String encoding)
boolean	addFont(byte[] fontData, String encoding, Range unicodeRange)
boolean	addFont(FontProgram fontProgram)
boolean	addFont(FontProgram fontProgram, String encoding)
boolean	addFont(FontProgram fontProgram, String encoding, Range unicodeRange)
boolean	addFont(String fontPath)
boolean	addFont(String fontPath, String encoding)
boolean	addFont(String fontPath, String encoding, Range unicodeRange)
int	addStandardPdfFonts()
int	addSystemFonts()
protected FontSelector	createFontSelector(Collection<FontInfo> fonts, List<String> fontFamilies, FontCharacteristics fc) Create a new instance of FontSelector.
boolean	getDefaultCacheFlag()
boolean	getDefaultEmbeddingFlag()
String	getDefaultEncoding(FontProgram fontProgram)
String	getDefaultFontFamily() Gets the default font-family
FontSelector	getFontSelector(List<String> fontFamilies, FontCharacteristics fc) Create FontSelector or get from cache.
FontSelector	getFontSelector(List<String> fontFamilies, FontCharacteristics fc, FontSet additionalFonts) Create FontSelector or get from cache.
FontSet	getFontSet() Gets FontSet.
PdfFont	getPdfFont(FontInfo fontInfo) Get from cache or create a new instance of PdfFont.
PdfFont	getPdfFont(FontInfo fontInfo, FontSet additionalFonts) Get from cache or create a new instance of PdfFont.
FontSelectorStrategy	getStrategy(String text, List<String> fontFamilies)
FontSelectorStrategy	getStrategy(String text, List<String> fontFamilies, FontCharacteristics fc)
FontSelectorStrategy	getStrategy(String text, List<String> fontFamilies, FontCharacteristics fc, FontSet additionalFonts)
void	reset() Resets PdfFont cache.

Methods inherited from class java.lang.Object

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

Field Detail

defaultFontFamily

protected final String defaultFontFamily

The default font-family is used by FontSelector if it's impossible to select a font for all other set font-families

pdfFonts

protected final Map<FontInfo,PdfFont> pdfFonts

Constructor Detail

FontProvider

public FontProvider(FontSet fontSet)

Creates a new instance of FontProvider

Parameters:

fontSet - predefined set of fonts, could be null.

FontProvider

public FontProvider()

Creates a new instance of FontProvider.

FontProvider

public FontProvider(String defaultFontFamily)

Creates a new instance of FontProvider.

Parameters:

defaultFontFamily - default font family.

FontProvider

public FontProvider(FontSet fontSet,
                    String defaultFontFamily)

Creates a new instance of FontProvider

Parameters:

fontSet - predefined set of fonts, could be null.

defaultFontFamily - default font family.

Method Detail

addFont

public boolean addFont(FontProgram fontProgram,
                       String encoding,
                       Range unicodeRange)

addFont

public boolean addFont(FontProgram fontProgram,
                       String encoding)

addFont

public boolean addFont(FontProgram fontProgram)

addFont

public boolean addFont(String fontPath,
                       String encoding,
                       Range unicodeRange)

addFont

public boolean addFont(String fontPath,
                       String encoding)

addFont

public boolean addFont(String fontPath)

addFont

public boolean addFont(byte[] fontData,
                       String encoding,
                       Range unicodeRange)

addFont

public boolean addFont(byte[] fontData,
                       String encoding)

addFont

public boolean addFont(byte[] fontData)

addDirectory

public int addDirectory(String dir)

addSystemFonts

public int addSystemFonts()

addStandardPdfFonts

public int addStandardPdfFonts()

getFontSet

public FontSet getFontSet()

Gets FontSet.

Returns:

the fontset

getDefaultFontFamily

public String getDefaultFontFamily()

Gets the default font-family

Returns:

the default font-family

getDefaultEncoding

public String getDefaultEncoding(FontProgram fontProgram)

getDefaultCacheFlag

public boolean getDefaultCacheFlag()

getDefaultEmbeddingFlag

public boolean getDefaultEmbeddingFlag()

getStrategy

public FontSelectorStrategy getStrategy(String text,
                                        List<String> fontFamilies,
                                        FontCharacteristics fc,
                                        FontSet additionalFonts)

getStrategy

public FontSelectorStrategy getStrategy(String text,
                                        List<String> fontFamilies,
                                        FontCharacteristics fc)

getStrategy

public FontSelectorStrategy getStrategy(String text,
                                        List<String> fontFamilies)

getFontSelector

public final FontSelector getFontSelector(List<String> fontFamilies,
                                          FontCharacteristics fc)

Create FontSelector or get from cache.

Parameters:

fontFamilies - target font families

fc - instance of FontCharacteristics.

Returns:

an instance of FontSelector.

See Also:

createFontSelector(Collection, List, FontCharacteristics), getFontSelector(List, FontCharacteristics, FontSet)

getFontSelector

public final FontSelector getFontSelector(List<String> fontFamilies,
                                          FontCharacteristics fc,
                                          FontSet additionalFonts)

Create FontSelector or get from cache.

Parameters:

fontFamilies - target font families

fc - instance of FontCharacteristics.

additionalFonts - set of additional fonts.

Returns:

an instance of FontSelector.

See Also:

}

createFontSelector

protected FontSelector createFontSelector(Collection<FontInfo> fonts,
                                          List<String> fontFamilies,
                                          FontCharacteristics fc)

Create a new instance of FontSelector. While caching is main responsibility of getFontSelector(List, FontCharacteristics, FontSet). This method just create a new instance of FontSelector.

Parameters:

fonts - Set of all available fonts in current context.

fontFamilies - target font families

fc - instance of FontCharacteristics.

Returns:

an instance of FontSelector.

getPdfFont

public PdfFont getPdfFont(FontInfo fontInfo)

Get from cache or create a new instance of PdfFont.

Parameters:

fontInfo - font info, to create FontProgram and PdfFont.

Returns:

cached or new instance of PdfFont.

getPdfFont

public PdfFont getPdfFont(FontInfo fontInfo,
                          FontSet additionalFonts)

Get from cache or create a new instance of PdfFont.

Parameters:

fontInfo - font info, to create FontProgram and PdfFont.

additionalFonts - set of additional fonts to consider.

Returns:

cached or new instance of PdfFont.

reset

public void reset()

Resets PdfFont cache. After calling that method FontProvider can be reused with another PdfDocument