com.itextpdf.html2pdf.attach.impl.layout.PageContextProperties 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.attach.impl.layout;
import com.itextpdf.html2pdf.css.CssRuleName;
import com.itextpdf.html2pdf.css.page.PageContextNode;
import com.itextpdf.html2pdf.css.page.PageMarginBoxContextNode;
import com.itextpdf.html2pdf.css.resolve.CssContext;
import com.itextpdf.html2pdf.css.resolve.ICssResolver;
import com.itextpdf.html2pdf.html.node.INode;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
/**
* Properties class for the {@link PageContextProcessor}.
*/
class PageContextProperties {
/**
* List containing possible names for page margin boxes.
*/
private static final List pageMarginBoxNames = Arrays.asList(
CssRuleName.TOP_LEFT_CORNER,
CssRuleName.TOP_LEFT,
CssRuleName.TOP_CENTER,
CssRuleName.TOP_RIGHT,
CssRuleName.TOP_RIGHT_CORNER,
CssRuleName.RIGHT_TOP,
CssRuleName.RIGHT_MIDDLE,
CssRuleName.RIGHT_BOTTOM,
CssRuleName.BOTTOM_RIGHT_CORNER,
CssRuleName.BOTTOM_RIGHT,
CssRuleName.BOTTOM_CENTER,
CssRuleName.BOTTOM_LEFT,
CssRuleName.BOTTOM_LEFT_CORNER,
CssRuleName.LEFT_BOTTOM,
CssRuleName.LEFT_MIDDLE,
CssRuleName.LEFT_TOP
);
/**
* The page context node.
*/
private PageContextNode pageContextNode;
/**
* The page margin boxes.
*/
private List pageMarginBoxes;
/**
* Instantiates a new {@link PageContextProperties} instance.
*
* @param pageProps the page context node
* @param pagesMarginBoxes the page margin boxes
*/
private PageContextProperties(PageContextNode pageProps, List pagesMarginBoxes) {
this.pageContextNode = pageProps;
this.pageMarginBoxes = pagesMarginBoxes;
}
/**
* Resolves a node with a {@link PageContextProperties} instance as result.
*
* @param rootNode the root node to resolve
* @param cssResolver the CSS resolver
* @param context the CSS context
* @param pageClasses the page classes
* @return the {@link PageContextProperties} for a specific node
*/
public static PageContextProperties resolve(INode rootNode, ICssResolver cssResolver, CssContext context, String... pageClasses) {
PageContextNode pageProps = getResolvedPageClassNode(rootNode, cssResolver, context, pageClasses);
List pagesMarginBoxes = getResolvedMarginBoxes(pageProps, cssResolver, context);
return new PageContextProperties(pageProps, pagesMarginBoxes);
}
/**
* Gets the resolved margin boxes.
*
* @param pageClassNode the page contex node
* @param cssResolver the CSS resolver
* @param context the CSS context
* @return the resolved margin boxes
*/
private static List getResolvedMarginBoxes(PageContextNode pageClassNode, ICssResolver cssResolver, CssContext context) {
List resolvedMarginBoxes = new ArrayList<>();
for (String pageMarginBoxName : pageMarginBoxNames) {
PageMarginBoxContextNode marginBoxNode = new PageMarginBoxContextNode(pageClassNode, pageMarginBoxName);
Map marginBoxStyles = cssResolver.resolveStyles(marginBoxNode, context);
if (!marginBoxNode.childNodes().isEmpty()) {
marginBoxNode.setStyles(marginBoxStyles);
resolvedMarginBoxes.add(marginBoxNode);
}
context.setQuotesDepth(0);
}
return resolvedMarginBoxes;
}
/**
* Gets the resolved page class node.
*
* @param rootNode the root node
* @param cssResolver the CSS resolver
* @param context the CSS context
* @param pageClasses the page classes
* @return the resolved page class node
*/
private static PageContextNode getResolvedPageClassNode(INode rootNode, ICssResolver cssResolver, CssContext context, String... pageClasses) {
PageContextNode pagesClassNode = new PageContextNode(rootNode);
for (String pageClass : pageClasses) {
pagesClassNode.addPageClass(pageClass);
}
Map pageClassStyles = cssResolver.resolveStyles(pagesClassNode, context);
pagesClassNode.setStyles(pageClassStyles);
return pagesClassNode;
}
/**
* Gets the resolved page context node.
*
* @return the resolved page context node
*/
PageContextNode getResolvedPageContextNode() {
return pageContextNode;
}
/**
* Gets the resolved page margin boxes.
*
* @return the resolved page margin boxes
*/
List getResolvedPageMarginBoxes() {
return pageMarginBoxes;
}
}