com.itextpdf.styledxmlparser.css.CssStyleSheet 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 iText modules to parse HTML and XML
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2023 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.styledxmlparser.css;
import com.itextpdf.commons.utils.MessageFormatUtil;
import com.itextpdf.styledxmlparser.CssRuleSetComparator;
import com.itextpdf.styledxmlparser.logs.StyledXmlParserLogMessageConstant;
import com.itextpdf.styledxmlparser.css.media.MediaDeviceDescription;
import com.itextpdf.styledxmlparser.css.resolve.shorthand.IShorthandResolver;
import com.itextpdf.styledxmlparser.css.resolve.shorthand.ShorthandResolverFactory;
import com.itextpdf.styledxmlparser.css.validate.CssDeclarationValidationMaster;
import com.itextpdf.styledxmlparser.node.INode;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
/**
* Class that stores all the CSS statements, and thus acts as a CSS style sheet.
*/
public class CssStyleSheet {
/** The list of CSS statements. */
private List statements;
/**
* Creates a new {@link CssStyleSheet} instance.
*/
public CssStyleSheet() {
statements = new ArrayList<>();
}
/**
* Adds a CSS statement to the style sheet.
*
* @param statement the CSS statement
*/
public void addStatement(CssStatement statement) {
statements.add(statement);
}
/**
* Append another CSS style sheet to this one.
*
* @param anotherCssStyleSheet the other CSS style sheet
*/
public void appendCssStyleSheet(CssStyleSheet anotherCssStyleSheet) {
statements.addAll(anotherCssStyleSheet.statements);
}
/* (non-Javadoc)
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
for (CssStatement statement : statements) {
if (sb.length() > 0) {
sb.append("\n");
}
sb.append(statement.toString());
}
return sb.toString();
}
/**
* Gets the CSS statements of this style sheet.
*
* @return the CSS statements
*/
public List getStatements() {
return Collections.unmodifiableList(statements);
}
/**
* Gets the CSS declarations.
*
* @param node the node
* @param deviceDescription the media device description
* @return the CSS declarations
*/
public List getCssDeclarations(INode node, MediaDeviceDescription deviceDescription) {
List ruleSets = getCssRuleSets(node, deviceDescription);
Map declarations = new LinkedHashMap<>();
for (CssRuleSet ruleSet : ruleSets) {
populateDeclarationsMap(ruleSet.getNormalDeclarations(), declarations);
}
for (CssRuleSet ruleSet : ruleSets) {
populateDeclarationsMap(ruleSet.getImportantDeclarations(), declarations);
}
return new ArrayList<>(declarations.values());
}
/**
* Gets the CSS declarations.
*
* @param ruleSets list of css rule sets
* @return the CSS declarations
*/
public static Map extractStylesFromRuleSets(List ruleSets) {
Map declarations = new LinkedHashMap<>();
for (CssRuleSet ruleSet : ruleSets) {
populateDeclarationsMap(ruleSet.getNormalDeclarations(), declarations);
}
for (CssRuleSet ruleSet : ruleSets) {
populateDeclarationsMap(ruleSet.getImportantDeclarations(), declarations);
}
Map stringMap = new LinkedHashMap<>();
for (Map.Entry entry : declarations.entrySet()) {
stringMap.put(entry.getKey(), entry.getValue().getExpression());
}
return stringMap;
}
/**
* Populates the CSS declarations map.
*
* @param declarations the declarations
* @param map the map
*/
private static void populateDeclarationsMap(List declarations, Map map) {
for (CssDeclaration declaration : declarations) {
IShorthandResolver shorthandResolver = ShorthandResolverFactory.getShorthandResolver(declaration.getProperty());
if (shorthandResolver == null) {
putDeclarationInMapIfValid(map, declaration);
} else {
List resolvedShorthandProps = shorthandResolver.resolveShorthand(declaration.getExpression());
populateDeclarationsMap(resolvedShorthandProps, map);
}
}
}
/**
* Gets the CSS rule sets.
*
* @param node the node
* @param deviceDescription the device description
* @return the css rule sets
*/
public List getCssRuleSets(INode node, MediaDeviceDescription deviceDescription) {
List ruleSets = new ArrayList<>();
for (CssStatement statement : statements) {
ruleSets.addAll(statement.getCssRuleSets(node, deviceDescription));
}
Collections.sort(ruleSets, new CssRuleSetComparator());
return ruleSets;
}
/**
* Puts a declaration in a styles map if the declaration is valid.
*
* @param stylesMap the styles map
* @param cssDeclaration the css declaration
*/
private static void putDeclarationInMapIfValid(Map stylesMap, CssDeclaration cssDeclaration) {
if (CssDeclarationValidationMaster.checkDeclaration(cssDeclaration)) {
stylesMap.put(cssDeclaration.getProperty(), cssDeclaration);
} else {
Logger logger = LoggerFactory.getLogger(ICssResolver.class);
logger.warn(MessageFormatUtil.format(StyledXmlParserLogMessageConstant.INVALID_CSS_PROPERTY_DECLARATION,
cssDeclaration));
}
}
}