com.itextpdf.tool.xml.css.apply.ChunkCssApplier Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xmlworker Show documentation
Show all versions of xmlworker Show documentation
Parses XML to PDF, with CSS support, using iText
/*
*
* This file is part of the iText (R) project.
Copyright (c) 1998-2017 iText Group NV
* Authors: Balder Van Camp, Emiel Ackermann, et al.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License version 3
* as published by the Free Software Foundation with the addition of the
* following permission added to Section 15 as permitted in Section 7(a):
* FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
* ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
* OF THIRD PARTY RIGHTS
*
* 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 http://www.gnu.org/licenses or write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA, 02110-1301 USA, or download the license from the following URL:
* http://itextpdf.com/terms-of-use/
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License.
*
* In accordance with Section 7(b) of the GNU Affero General Public License,
* a covered work must retain the producer line in every PDF that is created
* or manipulated using iText.
*
* You can be released from the requirements of the license by purchasing
* a commercial license. Buying such a license is mandatory as soon as you
* develop commercial activities involving the iText software without
* disclosing the source code of your own applications.
* These activities include: offering paid services to customers as an ASP,
* serving PDFs on the fly in a web application, shipping iText with a closed
* source product.
*
* For more information, please contact iText Software Corp. at this
* address: [email protected]
*/
package com.itextpdf.tool.xml.css.apply;
import com.itextpdf.text.*;
import com.itextpdf.text.Font;
import com.itextpdf.text.html.HtmlUtilities;
import com.itextpdf.text.pdf.BaseFont;
import com.itextpdf.text.pdf.PdfContentByte;
import com.itextpdf.tool.xml.Tag;
import com.itextpdf.tool.xml.css.CSS;
import com.itextpdf.tool.xml.css.CssUtils;
import com.itextpdf.tool.xml.css.FontSizeTranslator;
import com.itextpdf.tool.xml.html.CssApplier;
import com.itextpdf.tool.xml.pipeline.html.HtmlPipelineContext;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
/**
* Applies CSS Rules to Chunks
*/
public class ChunkCssApplier implements CssApplier {
/**
* FF4 and IE8 provide normal text and bold text. All other values are translated to one of these 2 styles
* 100 - 500 and "lighter" = normal.
* 600 - 900 and "bolder" = bold.
*/
public static final List BOLD = Arrays.asList(new String[]{"bold", "bolder", "600", "700", "800", "900"});
protected final CssUtils utils = CssUtils.getInstance();
protected FontProvider fontProvider;
public ChunkCssApplier() {
this(null);
}
public ChunkCssApplier(FontProvider fontProvider) {
if (fontProvider != null) {
this.fontProvider = fontProvider;
} else {
this.fontProvider = new FontFactoryImp();
}
}
public Chunk apply(final Chunk c, final Tag t) {
return apply(c, t, null, null, null);
}
/**
*
* @param c the Chunk to apply CSS to.
* @param t the tag containing the chunk data
* @return the styled chunk
*/
public Chunk apply(final Chunk c, final Tag t, final MarginMemory mm, final PageSizeContainable psc, final HtmlPipelineContext ctx) {
Font f = applyFontStyles(t);
float size = f.getSize();
Map rules = t.getCSS();
for (Entry entry : rules.entrySet()) {
String key = entry.getKey();
String value = entry.getValue();
if (CSS.Property.FONT_STYLE.equalsIgnoreCase(key)) {
if (value.equalsIgnoreCase(CSS.Value.OBLIQUE)) {
c.setSkew(0, 12);
}
} else if (CSS.Property.LETTER_SPACING.equalsIgnoreCase(key)) {
String letterSpacing = rules.get(CSS.Property.LETTER_SPACING);
float letterSpacingValue = 0f;
if (utils.isRelativeValue(value)) {
letterSpacingValue = utils.parseRelativeValue(letterSpacing, f.getSize());
} else if (utils.isMetricValue(value)){
letterSpacingValue = utils.parsePxInCmMmPcToPt(letterSpacing);
}
c.setCharacterSpacing(letterSpacingValue);
} else if (null != rules.get(CSS.Property.XFA_FONT_HORIZONTAL_SCALE)) { // only % allowed; need a catch block NumberFormatExc?
c.setHorizontalScaling(Float.parseFloat(rules.get(CSS.Property.XFA_FONT_HORIZONTAL_SCALE).replace("%", "")) / 100);
}
}
// following styles are separate from the for each loop, because they are based on font settings like size.
if (null != rules.get(CSS.Property.VERTICAL_ALIGN)) {
String value = rules.get(CSS.Property.VERTICAL_ALIGN);
if (value.equalsIgnoreCase(CSS.Value.SUPER) || value.equalsIgnoreCase(CSS.Value.TOP) || value.equalsIgnoreCase(CSS.Value.TEXT_TOP)) {
c.setTextRise((float) (size / 2 + 0.5));
} else if (value.equalsIgnoreCase(CSS.Value.SUB) || value.equalsIgnoreCase(CSS.Value.BOTTOM) || value.equalsIgnoreCase(CSS.Value.TEXT_BOTTOM)) {
c.setTextRise(-size / 2);
} else {
c.setTextRise(utils.parsePxInCmMmPcToPt(value));
}
}
String xfaVertScale = rules.get(CSS.Property.XFA_FONT_VERTICAL_SCALE);
if (null != xfaVertScale) {
if (xfaVertScale.contains("%")) {
size *= Float.parseFloat(xfaVertScale.replace("%", "")) / 100;
c.setHorizontalScaling(100 / Float.parseFloat(xfaVertScale.replace("%", "")));
}
}
if (null != rules.get(CSS.Property.TEXT_DECORATION)) {
String[] splitValues = rules.get(CSS.Property.TEXT_DECORATION).split("\\s+");
for (String value : splitValues) {
if (CSS.Value.UNDERLINE.equalsIgnoreCase(value)) {
c.setUnderline(null, 0.75f, 0, 0, -0.125f, PdfContentByte.LINE_CAP_BUTT);
}
if (CSS.Value.LINE_THROUGH.equalsIgnoreCase(value)) {
c.setUnderline(null, 0.75f, 0, 0, 0.25f, PdfContentByte.LINE_CAP_BUTT);
}
}
}
if (null != rules.get(CSS.Property.BACKGROUND_COLOR)) {
c.setBackground(HtmlUtilities.decodeColor(rules.get(CSS.Property.BACKGROUND_COLOR)));
}
f.setSize(size);
c.setFont(f);
Float leading = null;
if(rules.get(CSS.Property.LINE_HEIGHT) != null) {
String value = rules.get(CSS.Property.LINE_HEIGHT);
if(utils.isNumericValue(value)) {
leading = Float.parseFloat(value) * c.getFont().getSize();
} else if (utils.isRelativeValue(value)) {
leading = utils.parseRelativeValue(value, c.getFont().getSize());
} else if (utils.isMetricValue(value)){
leading = utils.parsePxInCmMmPcToPt(value);
}
}
if (leading != null) {
c.setLineHeight(leading);
}
return c;
}
public Font applyFontStyles(final Tag t) {
String fontName = null;
String encoding = BaseFont.CP1252;
float size = FontSizeTranslator.getInstance().getFontSize(t);
if (size == Font.UNDEFINED)
size = Font.DEFAULTSIZE;
int style = Font.UNDEFINED;
BaseColor color = null;
Map rules = t.getCSS();
for (Entry entry : rules.entrySet()) {
String key = entry.getKey();
String value = entry.getValue();
if (CSS.Property.FONT_WEIGHT.equalsIgnoreCase(key)) {
if (isBoldValue(value)) {
if (style == Font.ITALIC) {
style = Font.BOLDITALIC;
} else {
style = Font.BOLD;
}
} else {
if (style == Font.BOLDITALIC) {
style = Font.ITALIC;
} else if (style == Font.BOLD) {
style = Font.NORMAL;
}
}
} else if (CSS.Property.FONT_STYLE.equalsIgnoreCase(key)) {
if (value.equalsIgnoreCase(CSS.Value.ITALIC)) {
if (style == Font.BOLD) {
style = Font.BOLDITALIC;
} else {
style = Font.ITALIC;
}
}
} else if (CSS.Property.FONT_FAMILY.equalsIgnoreCase(key)) {
// TODO improve fontfamily parsing (what if a font family has a comma in the name ? )
fontName = value;
} else if (CSS.Property.COLOR.equalsIgnoreCase(key)) {
color = HtmlUtilities.decodeColor(value);
}
}
if (fontName != null) {
if (fontName.contains(",")) {
String[] fonts = fontName.split(",");
Font firstFont = null;
for (String s : fonts) {
s = utils.trimAndRemoveQuoutes(s);
if (fontProvider.isRegistered(s)) {
Font f = fontProvider.getFont(s, encoding, BaseFont.EMBEDDED, size, style, color);
if (f != null && (style == Font.NORMAL || style == Font.UNDEFINED || (f.getStyle() & style) == 0)) {
return f;
}
if (firstFont == null) {
firstFont = f;
}
}
}
if (firstFont != null) {
return firstFont;
} else {
if (fonts.length > 0) {
fontName = utils.trimAndRemoveQuoutes(fontName.split(",")[0]);
} else {
fontName = null;
}
}
} else {
fontName = utils.trimAndRemoveQuoutes(fontName);
}
}
return fontProvider.getFont(fontName, encoding, BaseFont.EMBEDDED, size, style, color);
}
/**
* Method used for retrieving the widest word of a chunk of text. All styles of the chunk will be taken into account when calculating the width of the words.
*
* @param c chunk of which the widest word is required.
*
* @return float containing the width of the widest word.
*/
public float getWidestWord(final Chunk c) {
String[] words = c.getContent().split("\\s");
float widestWord = 0;
for (int i = 0; i < words.length; i++) {
Chunk word = new Chunk(words[i]);
copyChunkStyles(c, word);
if (word.getWidthPoint() > widestWord) {
widestWord = word.getWidthPoint();
}
}
return widestWord;
}
/**
* Method used for copying styles from one chunk to another. Could be deprecated if the content of a chunk can be overwritten.
*
* @param source chunk which contains the required styles.
* @param target chunk which needs the required styles.
*/
public void copyChunkStyles(final Chunk source, final Chunk target) {
target.setFont(source.getFont());
target.setAttributes(source.getAttributes());
target.setCharacterSpacing(source.getCharacterSpacing());
target.setHorizontalScaling(source.getHorizontalScaling());
target.setHorizontalScaling(source.getHorizontalScaling());
}
public FontProvider getFontProvider() {
return this.fontProvider;
}
public void setFontProvider(FontProvider fontProvider) {
this.fontProvider = fontProvider;
}
protected boolean isBoldValue(String value) {
value = value.trim();
return CSS.Value.BOLD.contains(value) ||
(value.length() == 3 && value.endsWith("00") && value.charAt(0) >= '6' && value.charAt(0) <= '9');
}
}