com.itextpdf.styledxmlparser.resolver.font.BasicFontProvider Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of styled-xml-parser Show documentation
Show all versions of styled-xml-parser Show documentation
Styled XML parser is used by iText7 modules to parse HTML and XML
The newest version!
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2025 Apryse Group NV
Authors: Apryse Software.
This program is offered under a commercial and under the AGPL license.
For commercial licensing, contact us at https://itextpdf.com/sales. For AGPL licensing, see below.
AGPL licensing:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see calligraphyFontsTempList = new ArrayList<>();
/** The path to the shipped fonts. */
protected String shippedFontResourcePath;
/** The file names of the shipped fonts. */
protected List shippedFontNames;
/**
* Creates a new {@link BasicFontProvider} instance.
*/
public BasicFontProvider() {
this(true, false);
}
/**
* Creates a new {@link BasicFontProvider} instance.
*
* @param registerStandardPdfFonts use true if you want to register the standard Type 1 fonts (can't be embedded)
* @param registerSystemFonts use true if you want to register the system fonts (can require quite some resources)
*/
public BasicFontProvider(boolean registerStandardPdfFonts, boolean registerSystemFonts) {
this(registerStandardPdfFonts, registerSystemFonts, DEFAULT_FONT_FAMILY);
}
/**
* Creates a new {@link BasicFontProvider} instance.
*
* @param registerStandardPdfFonts use true if you want to register the standard Type 1 fonts (can't be embedded)
* @param registerShippedFonts use true if you want to register the shipped fonts (can be embedded)
* @param registerSystemFonts use true if you want to register the system fonts (can require quite some resources)
*/
public BasicFontProvider(boolean registerStandardPdfFonts, boolean registerShippedFonts,
boolean registerSystemFonts) {
this(registerStandardPdfFonts, registerShippedFonts, registerSystemFonts, DEFAULT_FONT_FAMILY);
}
/**
* Creates a new {@link BasicFontProvider} instance.
*
* @param registerStandardPdfFonts use true if you want to register the standard Type 1 fonts (can't be embedded)
* @param registerSystemFonts use true if you want to register the system fonts (can require quite some resources)
* @param defaultFontFamily default font family
*/
public BasicFontProvider(boolean registerStandardPdfFonts, boolean registerSystemFonts, String defaultFontFamily) {
this(registerStandardPdfFonts, true, registerSystemFonts, defaultFontFamily);
}
/**
* Creates a new {@link BasicFontProvider} instance.
*
* @param registerStandardPdfFonts use true if you want to register the standard Type 1 fonts (can't be embedded)
* @param registerShippedFonts use true if you want to register the shipped fonts (can be embedded)
* @param registerSystemFonts use true if you want to register the system fonts (can require quite some resources)
* @param defaultFontFamily default font family
*/
public BasicFontProvider(boolean registerStandardPdfFonts, boolean registerShippedFonts,
boolean registerSystemFonts, String defaultFontFamily) {
super(defaultFontFamily);
if (registerStandardPdfFonts) {
addStandardPdfFonts();
}
if (registerSystemFonts) {
addSystemFonts();
}
if (registerShippedFonts) {
initShippedFontsResourcePath();
addAllAvailableFonts(addCalligraphFonts());
}
}
/**
* Creates a new {@link BasicFontProvider} instance.
*
* @param fontSet predefined set of fonts, could be null.
* @param defaultFontFamily default font family.
*/
public BasicFontProvider(FontSet fontSet, String defaultFontFamily) {
super(fontSet, defaultFontFamily);
}
/**
* This method loads a list of noto fonts from pdfCalligraph (if it is present in the classpath) into FontProvider.
* The list is the following (each font is represented in regular and bold types): NotoSansArabic, NotoSansGurmukhi,
* NotoSansOriya, NotoSerifBengali, NotoSerifDevanagari, NotoSerifGujarati, NotoSerifHebrew, NotoSerifKannada,
* NotoSerifKhmer, NotoSerifMalayalam, NotoSerifTamil, NotoSerifTelugu, NotoSerifThai.
* If it's needed to have a BasicFontProvider without typography fonts loaded,
* create an extension of BasicFontProvider and override this method, so it does nothing and only returns null.
*
* @return a unicode {@link Range} that excludes the loaded from pdfCalligraph fonts,
* i.e. the unicode range that is to be rendered with any other font contained in this FontProvider
*/
protected Range addCalligraphFonts() {
if (TypographyUtils.isPdfCalligraphAvailable()) {
try {
Map fontStreams = TypographyUtils.loadShippedFonts();
this.calligraphyFontsTempList.addAll(fontStreams.values());
// here we return a unicode range that excludes the loaded from the calligraph module fonts
// i.e. the unicode range that is to be rendered with standard or shipped free fonts
return FREE_FONT_RANGE;
} catch (Exception e) {
LOGGER.error(StyledXmlParserLogMessageConstant.ERROR_LOADING_FONT, e);
}
}
return null;
}
/**
* Adds fonts shipped with the font provider.
* For {@link BasicFontProvider} this method does nothing but can be overridden to load additional fonts.
*
* @param rangeToLoad a unicode {@link Range} to load characters
*/
protected void addShippedFonts(Range rangeToLoad) {
if (!isResourcePathAvailable()) {
return;
}
for (String fontName : shippedFontNames) {
try (InputStream stream = ResourceUtil.getResourceStream(shippedFontResourcePath + fontName)) {
byte[] fontProgramBytes = StreamUtil.inputStreamToArray(stream);
addFont(fontProgramBytes, null, rangeToLoad);
} catch (Exception e) {
LOGGER.error(StyledXmlParserLogMessageConstant.ERROR_LOADING_FONT, e);
}
}
}
/**
* Initialize path to shipped fonts and list of font files.
*/
protected void initShippedFontsResourcePath() {
shippedFontResourcePath = HTML_TO_PDF_SHIPPED_FONT_RESOURCE_PATH;
shippedFontNames = new ArrayList<>();
//not using Collection.addAll() for auto porting
for (String font : HTML_TO_PDF_SHIPPED_FONT_NAMES) {
shippedFontNames.add(font);
}
}
private boolean isResourcePathAvailable() {
try (InputStream stream = ResourceUtil.getResourceStream(shippedFontResourcePath + shippedFontNames.get(0))) {
if (stream == null) {
return false;
}
} catch (IOException e) {
//ignore this exception, since we're just checking that such resource path is available
return false;
}
return true;
}
private void addAllAvailableFonts(Range rangeToLoad) {
addShippedFonts(rangeToLoad);
for(byte[] fontData : calligraphyFontsTempList) {
addFont(fontData, null);
}
calligraphyFontsTempList.clear();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy