com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of html2pdf Show documentation
Show all versions of html2pdf Show documentation
pdfHTML is an iText 7 add-on that lets you to parse (X)HTML snippets and the associated CSS and converts
them to PDF.
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2017 iText Group NV
Authors: Bruno Lowagie, Paulo Soares, 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.html2pdf.css.resolve;
import com.itextpdf.html2pdf.css.CssConstants;
import com.itextpdf.html2pdf.css.CssDeclaration;
import com.itextpdf.html2pdf.css.resolve.shorthand.impl.BorderShorthandResolver;
import com.itextpdf.html2pdf.css.util.CssUtils;
import com.itextpdf.html2pdf.html.AttributeConstants;
import com.itextpdf.html2pdf.html.TagConstants;
import com.itextpdf.html2pdf.html.node.IAttribute;
import com.itextpdf.html2pdf.html.node.IElementNode;
import com.itextpdf.html2pdf.html.node.INode;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* Utilities class that converts HTML styles to CSS.
*/
class HtmlStylesToCssConverter {
/**
* Maps HTML styles to a specific converter.
*/
private static final Map htmlAttributeConverters;
static {
htmlAttributeConverters = new HashMap<>();
htmlAttributeConverters.put(AttributeConstants.ALIGN, new AlignAttributeConverter());
htmlAttributeConverters.put(AttributeConstants.BORDER, new BorderAttributeConverter());
htmlAttributeConverters.put(AttributeConstants.BGCOLOR, new BgColorAttributeConverter());
htmlAttributeConverters.put(AttributeConstants.CELLPADDING, new CellPaddingAttributeConverter());
htmlAttributeConverters.put(AttributeConstants.COLOR, new FontColorAttributeConverter());
htmlAttributeConverters.put(AttributeConstants.DIR, new DirAttributeConverter());
htmlAttributeConverters.put(AttributeConstants.SIZE, new SizeAttributeConverter());
htmlAttributeConverters.put(AttributeConstants.FACE, new FontFaceAttributeConverter());
htmlAttributeConverters.put(AttributeConstants.NOSHADE, new NoShadeAttributeConverter());
htmlAttributeConverters.put(AttributeConstants.TYPE, new TypeAttributeConverter());
htmlAttributeConverters.put(AttributeConstants.WIDTH, new WidthAttributeConverter());
htmlAttributeConverters.put(AttributeConstants.HEIGHT, new HeightAttributeConverter());
htmlAttributeConverters.put(AttributeConstants.VALIGN, new VAlignAttributeConverter());
}
/**
* Converts a the HTML styles of an element to a list of {@link CssDeclaration} instances.
*
* @param element the element
* @return the resulting list of {@link CssDeclaration} instances.
*/
public static List convert(IElementNode element) {
ArrayList convertedHtmlStyles = new ArrayList<>();
if (element.getAdditionalHtmlStyles() != null) {
HashMap additionalStyles = new HashMap<>();
for (Map styles : element.getAdditionalHtmlStyles()) {
additionalStyles.putAll(styles);
}
convertedHtmlStyles.ensureCapacity(convertedHtmlStyles.size() + additionalStyles.size());
for (Map.Entry entry : additionalStyles.entrySet()) {
convertedHtmlStyles.add(new CssDeclaration(entry.getKey(), entry.getValue()));
}
}
for (IAttribute a : element.getAttributes()) {
IAttributeConverter aConverter = htmlAttributeConverters.get(a.getKey());
if (aConverter != null && aConverter.isSupportedForElement(element.name())) {
convertedHtmlStyles.addAll(aConverter.convert(element, a.getValue()));
}
}
return convertedHtmlStyles;
}
/**
* Interface for all the attribute converter classes.
*/
private interface IAttributeConverter {
/**
* Checks if the converter is supported for a specific element.
*
* @param elementName the element name
* @return true, if the converter is supported
*/
boolean isSupportedForElement(String elementName);
/**
* Converts a specific HTML style to a {@link CssDeclaration}.
*
* @param element the element
* @param value the value of the HTML style
* @return a list of {@link CssDeclaration} instances
*/
List convert(IElementNode element, String value);
}
/**
* {@link IAttributeConverter} implementation for HTML border styles.
*/
private static class BorderAttributeConverter implements IAttributeConverter {
/**
* Applies borders to the tables and cells.
*
* @param node the node
* @param borderStyles the border styles
*/
private static void applyBordersToTableCells(INode node, Map borderStyles) {
List nodes = node.childNodes();
for (INode childNode : nodes) {
if (childNode instanceof IElementNode) {
IElementNode elementNode = (IElementNode) childNode;
if (TagConstants.TD.equals(elementNode.name()) || TagConstants.TH.equals(elementNode.name())) {
elementNode.addAdditionalHtmlStyles(borderStyles);
} else {
applyBordersToTableCells(childNode, borderStyles);
}
}
}
}
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#isSupportedForElement(java.lang.String)
*/
@Override
public boolean isSupportedForElement(String elementName) {
return TagConstants.IMG.equals(elementName) || TagConstants.TABLE.equals(elementName);
}
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#convert(com.itextpdf.html2pdf.html.node.IElementNode, java.lang.String)
*/
@Override
public List convert(IElementNode element, String value) {
Float width = CssUtils.parseFloat(value);
if (width != null) {
if (TagConstants.TABLE.equals(element.name()) && width != 0) {
List declarations = new BorderShorthandResolver().resolveShorthand("1px solid");
Map styles = new HashMap<>(declarations.size());
for (CssDeclaration declaration : declarations) {
styles.put(declaration.getProperty(), declaration.getExpression());
}
applyBordersToTableCells(element, styles);
}
if (width >= 0) {
return Arrays.asList(new CssDeclaration(CssConstants.BORDER, value + "px solid"));
}
}
return Collections.emptyList();
}
}
/**
* {@link IAttributeConverter} implementation for table's cellpadding.
*/
private static class CellPaddingAttributeConverter implements IAttributeConverter {
/**
* Applies paddings to the table's cells.
*
* @param node the node
* @param paddingStyle cellpadding
*/
private static void applyPaddingsToTableCells(INode node, Map paddingStyle) {
List nodes = node.childNodes();
for (INode childNode : nodes) {
if (childNode instanceof IElementNode) {
IElementNode elementNode = (IElementNode) childNode;
if (TagConstants.TD.equals(elementNode.name()) || TagConstants.TH.equals(elementNode.name())) {
elementNode.addAdditionalHtmlStyles(paddingStyle);
} else {
applyPaddingsToTableCells(childNode, paddingStyle);
}
}
}
}
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#isSupportedForElement(java.lang.String)
*/
@Override
public boolean isSupportedForElement(String elementName) {
return TagConstants.TABLE.equals(elementName);
}
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#convert(com.itextpdf.html2pdf.html.node.IElementNode, java.lang.String)
*/
@Override
public List convert(IElementNode element, String value) {
Float cellPadding = CssUtils.parseFloat(value);
if (cellPadding != null) {
if (TagConstants.TABLE.equals(element.name())) {
Map styles = new HashMap<>();
styles.put(CssConstants.PADDING, value + "px");
applyPaddingsToTableCells(element, styles);
}
}
return Collections.emptyList();
}
}
/**
* {@link IAttributeConverter} implementation for HTML background color styles.
*/
private static class BgColorAttributeConverter implements IAttributeConverter {
/**
* The supported tags.
*/
private static Set supportedTags = new HashSet<>(
Arrays.asList(TagConstants.BODY, TagConstants.COL, TagConstants.COLGROUP, TagConstants.MARQUEE,
TagConstants.TABLE, TagConstants.TBODY, TagConstants.TFOOT, TagConstants.TD, TagConstants.TH,
TagConstants.TR));
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#isSupportedForElement(java.lang.String)
*/
@Override
public boolean isSupportedForElement(String elementName) {
return supportedTags.contains(elementName);
}
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#convert(com.itextpdf.html2pdf.html.node.IElementNode, java.lang.String)
*/
@Override
public List convert(IElementNode element, String value) {
return Arrays.asList(new CssDeclaration(CssConstants.BACKGROUND_COLOR, value));
}
}
/**
* {@link IAttributeConverter} implementation for font color styles.
*/
private static class FontColorAttributeConverter implements IAttributeConverter {
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#isSupportedForElement(java.lang.String)
*/
@Override
public boolean isSupportedForElement(String elementName) {
return TagConstants.FONT.equals(elementName);
}
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#convert(com.itextpdf.html2pdf.html.node.IElementNode, java.lang.String)
*/
@Override
public List convert(IElementNode element, String value) {
return Arrays.asList(new CssDeclaration(CssConstants.COLOR, value));
}
}
/**
* {@link IAttributeConverter} implementation for size properties.
*/
private static class SizeAttributeConverter implements IAttributeConverter {
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#isSupportedForElement(java.lang.String)
*/
@Override
public boolean isSupportedForElement(String elementName) {
return TagConstants.FONT.equals(elementName) || TagConstants.HR.equals(elementName);
}
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#convert(com.itextpdf.html2pdf.html.node.IElementNode, java.lang.String)
*/
@Override
public List convert(IElementNode element, String value) {
String cssValueEquivalent = null;
String cssPropertyEquivalent = null;
String elementName = element.name();
if (TagConstants.FONT.equals(elementName)) {
cssPropertyEquivalent = CssConstants.FONT_SIZE;
try {
boolean signedValue = value.contains("-") || value.contains("+");
int htmlFontSize = Integer.parseInt(value);
if (signedValue) {
htmlFontSize = 3 + htmlFontSize;
}
if (htmlFontSize < 2) {
cssValueEquivalent = CssConstants.X_SMALL;
} else if (htmlFontSize > 6) {
cssValueEquivalent = "48px";
} else if (htmlFontSize == 2) {
cssValueEquivalent = CssConstants.SMALL;
} else if (htmlFontSize == 3) {
cssValueEquivalent = CssConstants.MEDIUM;
} else if (htmlFontSize == 4) {
cssValueEquivalent = CssConstants.LARGE;
} else if (htmlFontSize == 5) {
cssValueEquivalent = CssConstants.X_LARGE;
} else if (htmlFontSize == 6) {
cssValueEquivalent = CssConstants.XX_LARGE;
}
} catch (NumberFormatException ex) {
cssValueEquivalent = CssConstants.MEDIUM;
}
} else if (TagConstants.HR.equals(elementName)) {
cssPropertyEquivalent = CssConstants.HEIGHT;
cssValueEquivalent = value + CssConstants.PX;
}
return Arrays.asList(new CssDeclaration(cssPropertyEquivalent, cssValueEquivalent));
}
}
/**
* {@link IAttributeConverter} implementation for HTML font face styles.
*/
private static class FontFaceAttributeConverter implements IAttributeConverter {
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#isSupportedForElement(java.lang.String)
*/
@Override
public boolean isSupportedForElement(String elementName) {
return TagConstants.FONT.equals(elementName);
}
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#convert(com.itextpdf.html2pdf.html.node.IElementNode, java.lang.String)
*/
@Override
public List convert(IElementNode element, String value) {
return Arrays.asList(new CssDeclaration(CssConstants.FONT_FAMILY, value));
}
}
/**
* {@link IAttributeConverter} implementation for HTML ordered list types.
*/
private static class TypeAttributeConverter implements IAttributeConverter {
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#isSupportedForElement(java.lang.String)
*/
@Override
public boolean isSupportedForElement(String elementName) {
return TagConstants.OL.equals(elementName);
}
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#convert(com.itextpdf.html2pdf.html.node.IElementNode, java.lang.String)
*/
@Override
public List convert(IElementNode element, String value) {
String cssEquivalent = null;
switch (value) {
case AttributeConstants._1:
cssEquivalent = CssConstants.DECIMAL;
break;
case AttributeConstants.A:
cssEquivalent = CssConstants.UPPER_ALPHA;
break;
case AttributeConstants.a:
cssEquivalent = CssConstants.LOWER_ALPHA;
break;
case AttributeConstants.I:
cssEquivalent = CssConstants.UPPER_ROMAN;
break;
case AttributeConstants.i:
cssEquivalent = CssConstants.LOWER_ROMAN;
break;
}
return Arrays.asList(new CssDeclaration(CssConstants.LIST_STYLE_TYPE, cssEquivalent));
}
}
/**
* {@link IAttributeConverter} implementation for HTML direction styles (e.g. right to left direction).
*/
private static class DirAttributeConverter implements IAttributeConverter {
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#isSupportedForElement(java.lang.String)
*/
@Override
public boolean isSupportedForElement(String elementName) {
return true;
}
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#convert(com.itextpdf.html2pdf.html.node.IElementNode, java.lang.String)
*/
@Override
public List convert(IElementNode element, String value) {
return Arrays.asList(new CssDeclaration(CssConstants.DIRECTION, value));
}
}
/**
* {@link IAttributeConverter} implementation for HTML width values.
*/
private static class WidthAttributeConverter implements IAttributeConverter {
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#isSupportedForElement(java.lang.String)
*/
@Override
public boolean isSupportedForElement(String elementName) {
return TagConstants.HR.equals(elementName) || TagConstants.IMG.equals(elementName)
|| TagConstants.TABLE.equals(elementName) || TagConstants.TD.equals(elementName)
|| TagConstants.TH.equals(elementName) || TagConstants.COLGROUP.equals(elementName)
|| TagConstants.COL.equals(elementName);
}
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#convert(com.itextpdf.html2pdf.html.node.IElementNode, java.lang.String)
*/
@Override
public List convert(IElementNode element, String value) {
// Trim semicolons at the end because they seem to not affect the value in browsers
String cssEquivalent = value.replaceAll(";+$", "");
if (!CssUtils.isMetricValue(cssEquivalent) && !cssEquivalent.endsWith(CssConstants.PERCENTAGE)) {
cssEquivalent += CssConstants.PX;
}
return Arrays.asList(new CssDeclaration(CssConstants.WIDTH, cssEquivalent));
}
}
/**
* {@link IAttributeConverter} implementation for HTML height values.
*/
private static class HeightAttributeConverter implements IAttributeConverter {
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#isSupportedForElement(java.lang.String)
*/
@Override
public boolean isSupportedForElement(String elementName) {
return TagConstants.IMG.equals(elementName) || TagConstants.TD.equals(elementName);
}
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#convert(com.itextpdf.html2pdf.html.node.IElementNode, java.lang.String)
*/
@Override
public List convert(IElementNode element, String value) {
// Trim semicolons at the end because they seem to not affect the value in browsers
String cssEquivalent = value.replaceAll(";+$", "");
if (!CssUtils.isMetricValue(cssEquivalent) && !cssEquivalent.endsWith(CssConstants.PERCENTAGE)) {
cssEquivalent += CssConstants.PX;
}
return Arrays.asList(new CssDeclaration(CssConstants.HEIGHT, cssEquivalent));
}
}
/**
* {@link IAttributeConverter} implementation for HTML horizontal alignment styles.
*/
private static class AlignAttributeConverter implements IAttributeConverter {
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#isSupportedForElement(java.lang.String)
*/
@Override
public boolean isSupportedForElement(String elementName) {
return TagConstants.HR.equals(elementName) || TagConstants.TABLE.equals(elementName) || TagConstants.IMG.equals(elementName)
|| TagConstants.TD.equals(elementName) || TagConstants.DIV.equals(elementName) || TagConstants.P.equals(elementName);
}
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#convert(com.itextpdf.html2pdf.html.node.IElementNode, java.lang.String)
*/
@Override
public List convert(IElementNode element, String value) {
List result = new ArrayList(2);
if (TagConstants.HR.equals(element.name())
// html align-center attribute doesn't apply text wrapping
|| (TagConstants.TABLE.equals(element.name()) && AttributeConstants.CENTER.equals(value))) {
String leftMargin = null;
String rightMargin = null;
if (AttributeConstants.RIGHT.equals(value)) {
leftMargin = CssConstants.AUTO;
rightMargin = "0";
} else if (AttributeConstants.LEFT.equals(value)) {
leftMargin = "0";
rightMargin = CssConstants.AUTO;
} else if (AttributeConstants.CENTER.equals(value)) {
leftMargin = CssConstants.AUTO;
rightMargin = CssConstants.AUTO;
}
if (leftMargin != null) {
result.add(new CssDeclaration(CssConstants.MARGIN_LEFT, leftMargin));
result.add(new CssDeclaration(CssConstants.MARGIN_RIGHT, rightMargin));
}
} else if (TagConstants.TABLE.equals(element.name()) || TagConstants.IMG.equals(element.name())) {
if (TagConstants.IMG.equals(element.name()) && AttributeConstants.TOP.equals(value)
&& AttributeConstants.MIDDLE.equals(value) && AttributeConstants.BOTTOM.equals(value)) {
result.add(new CssDeclaration(CssConstants.VERTICAL_ALIGN, value));
} else if (AttributeConstants.LEFT.equals(value) || AttributeConstants.RIGHT.equals(value)) {
result.add(new CssDeclaration(CssConstants.FLOAT, value));
}
} else {
// TODO in fact, align attribute also affects horizontal alignment of all child blocks (not only direct children),
// however this effect conflicts in queer manner with 'text-align' property if it set on the same blocks explicitly via CSS
// (see HorizontalAlignmentTest#alignAttribute01)
result.add(new CssDeclaration(CssConstants.TEXT_ALIGN, value));
}
return result;
}
}
/**
* {@link IAttributeConverter} implementation for HTML shade styles.
*/
private static class NoShadeAttributeConverter implements IAttributeConverter {
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#isSupportedForElement(java.lang.String)
*/
@Override
public boolean isSupportedForElement(String elementName) {
return TagConstants.HR.equals(elementName);
}
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#convert(com.itextpdf.html2pdf.html.node.IElementNode, java.lang.String)
*/
@Override
public List convert(IElementNode element, String value) {
return Arrays.asList(
new CssDeclaration(CssConstants.HEIGHT, "2px"),
new CssDeclaration(CssConstants.BORDER_WIDTH, "0"),
new CssDeclaration(CssConstants.BACKGROUND_COLOR, "gray")
);
}
}
/**
* {@link IAttributeConverter} implementation for HTML vertical alignment styles.
*/
private static class VAlignAttributeConverter implements IAttributeConverter {
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#isSupportedForElement(java.lang.String)
*/
@Override
public boolean isSupportedForElement(String elementName) {
return TagConstants.TD.equals(elementName) || TagConstants.TH.equals(elementName)
|| TagConstants.TR.equals(elementName);
}
/* (non-Javadoc)
* @see com.itextpdf.html2pdf.css.resolve.HtmlStylesToCssConverter.IAttributeConverter#convert(com.itextpdf.html2pdf.html.node.IElementNode, java.lang.String)
*/
@Override
public List convert(IElementNode element, String value) {
return Arrays.asList(new CssDeclaration(CssConstants.VERTICAL_ALIGN, value));
}
}
}