com.itextpdf.html2pdf.attach.impl.OutlineHandler Maven / Gradle / Ivy
Show all versions of html2pdf Show documentation
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2019 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;
import com.itextpdf.html2pdf.LogMessageConstant;
import com.itextpdf.html2pdf.attach.ITagWorker;
import com.itextpdf.html2pdf.attach.ProcessorContext;
import com.itextpdf.io.util.MessageFormatUtil;
import com.itextpdf.kernel.pdf.PdfOutline;
import com.itextpdf.kernel.pdf.PdfString;
import com.itextpdf.kernel.pdf.navigation.PdfDestination;
import com.itextpdf.layout.element.IElement;
import com.itextpdf.layout.property.Property;
import com.itextpdf.styledxmlparser.node.IElementNode;
import com.itextpdf.styledxmlparser.node.impl.jsoup.node.JsoupElementNode;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.Deque;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.Map;
/**
* A {@link OutlineHandler} handles creating outlines for tags.
*
* This class is not reusable and a new instance shall be created for every new conversion process.
*/
public class OutlineHandler {
/**
* The Constant DESTINATION_PREFIX.
*/
private static final String DESTINATION_PREFIX = "pdfHTML-iText-outline-";
/**
* The current outline.
*/
private PdfOutline currentOutline;
/**
* The destinations in process.
*/
private Deque destinationsInProcess = new LinkedList();
/**
* The levels in process.
*/
private Deque levelsInProcess = new LinkedList();
/**
* The tag priorities mapping.
*/
private Map tagPrioritiesMapping = new HashMap();
/**
* The unique IDs.
*/
private Map uniqueIDs = new HashMap();
/**
* Creates an OutlineHandler with standard predefined mappings.
*
* @return the outline handler
*/
public static OutlineHandler createStandardHandler() {
OutlineHandler handler = new OutlineHandler();
handler.putTagPriorityMapping("h1", 1);
handler.putTagPriorityMapping("h2", 2);
handler.putTagPriorityMapping("h3", 3);
handler.putTagPriorityMapping("h4", 4);
handler.putTagPriorityMapping("h5", 5);
handler.putTagPriorityMapping("h6", 6);
return handler;
}
/**
* Put tag priority mapping.
*
* @param tagName the tag name
* @param priority the priority
* @return the outline handler
*/
public OutlineHandler putTagPriorityMapping(String tagName, Integer priority) {
tagPrioritiesMapping.put(tagName, priority);
return this;
}
/**
* Put all tag priority mappings.
*
* @param mappings the mappings
* @return the outline handler
*/
public OutlineHandler putAllTagPriorityMappings(Map mappings) {
tagPrioritiesMapping.putAll(mappings);
return this;
}
/**
* Gets the tag priority mapping.
*
* @param tagName the tag name
* @return the tag priority mapping
*/
public Integer getTagPriorityMapping(String tagName) {
return tagPrioritiesMapping.get(tagName);
}
/**
* Checks for tag priority mapping.
*
* @param tagName the tag name
* @return true, if the tag name is listed in the tag priorities mapping
*/
public boolean hasTagPriorityMapping(String tagName) {
return tagPrioritiesMapping.containsKey(tagName);
}
/**
* Resets the current state so that this {@link OutlineHandler} is ready to process new document
*/
public void reset() {
currentOutline = null;
destinationsInProcess.clear();
levelsInProcess.clear();
uniqueIDs.clear();
}
/**
* Adds the outline.
*
* @param tagWorker the tag worker
* @param element the element
* @param context the processor context
* @return the outline handler
*/
OutlineHandler addOutline(ITagWorker tagWorker, IElementNode element, ProcessorContext context) {
String tagName = element.name();
if (null != tagWorker && hasTagPriorityMapping(tagName) && context.getPdfDocument() != null) {
int level = (int) getTagPriorityMapping(tagName);
if (null == currentOutline) {
currentOutline = context.getPdfDocument().getOutlines(false);
}
PdfOutline parent = currentOutline;
while (!levelsInProcess.isEmpty() && level <= levelsInProcess.getFirst()) {
parent = parent.getParent();
levelsInProcess.pop();
}
String content = ((JsoupElementNode) element).text();
if (content.isEmpty()) {
content = getUniqueID(tagName);
}
PdfOutline outline = parent.addOutline(content);
String destination = DESTINATION_PREFIX + getUniqueID(DESTINATION_PREFIX);
outline.addDestination(PdfDestination.makeDestination(new PdfString(destination)));
destinationsInProcess.push(destination);
levelsInProcess.push(level);
currentOutline = outline;
}
return this;
}
/**
* Adds the destination.
*
* @param tagWorker the tag worker
* @param element the element
* @return the outline handler
*/
OutlineHandler addDestination(ITagWorker tagWorker, IElementNode element) {
String tagName = element.name();
if (null != tagWorker && hasTagPriorityMapping(tagName) && destinationsInProcess.size()>0) {
String content = destinationsInProcess.pop();
if (tagWorker.getElementResult() instanceof IElement) {
tagWorker.getElementResult().setProperty(Property.DESTINATION, content);
} else {
Logger logger = LoggerFactory.getLogger(OutlineHandler.class);
logger.warn(MessageFormatUtil.format(LogMessageConstant.NO_IPROPERTYCONTAINER_RESULT_FOR_THE_TAG, tagName));
}
}
return this;
}
/**
* Gets the unique ID.
*
* @param key the key
* @return the unique ID
*/
private String getUniqueID(String key) {
if (!uniqueIDs.containsKey(key)) {
uniqueIDs.put(key, 1);
}
int id = (int) uniqueIDs.get(key);
uniqueIDs.put(key, id + 1);
return key + id;
}
}