com.lowagie.text.xml.SAXiTextHandler Maven / Gradle / Ivy
/*
* $Id: SAXiTextHandler.java 4070 2009-09-19 18:21:12Z psoares33 $
*
* Copyright 2001, 2002 by Bruno Lowagie.
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or any later version.
*
* This library 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 Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* https://github.com/LibrePDF/OpenPDF
*/
package com.lowagie.text.xml;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Collections;
import java.util.EmptyStackException;
import java.util.Map;
import java.util.Properties;
import java.util.Stack;
import javax.annotation.Nullable;
import com.lowagie.text.Anchor;
import com.lowagie.text.Annotation;
import com.lowagie.text.BadElementException;
import com.lowagie.text.Cell;
import com.lowagie.text.Chunk;
import com.lowagie.text.DocListener;
import com.lowagie.text.DocumentException;
import com.lowagie.text.Element;
import com.lowagie.text.ElementTags;
import com.lowagie.text.ExceptionConverter;
import com.lowagie.text.Font;
import com.lowagie.text.Image;
import com.lowagie.text.List;
import com.lowagie.text.ListItem;
import com.lowagie.text.Meta;
import com.lowagie.text.PageSize;
import com.lowagie.text.Paragraph;
import com.lowagie.text.Phrase;
import com.lowagie.text.Rectangle;
import com.lowagie.text.Section;
import com.lowagie.text.Table;
import com.lowagie.text.TextElementArray;
import com.lowagie.text.factories.ElementFactory;
import com.lowagie.text.pdf.BaseFont;
import com.lowagie.text.pdf.draw.LineSeparator;
import com.lowagie.text.xml.simpleparser.EntitiesToSymbol;
import org.xml.sax.Attributes;
import org.xml.sax.helpers.DefaultHandler;
/**
* This class is a Handler that controls the iText XML to PDF conversion.
* Subclass it, if you want to change the way iText translates XML to PDF.
*/
public class SAXiTextHandler extends DefaultHandler {
/**
* This is the resulting document.
*/
protected DocListener document;
/**
* This is a Stack of objects, waiting to be added to the
* document.
*/
protected Stack stack;
/**
* Counts the number of chapters in this document.
*/
protected int chapters = 0;
/**
* This is the current chunk to which characters can be added.
*/
protected Chunk currentChunk = null;
/**
* This is the current chunk to which characters can be added.
*/
protected boolean ignore = false;
/**
* This is a flag that can be set, if you want to open and close the
* Document-object yourself.
*/
private boolean controlOpenClose = true;
/**
* This hashmap contains all the custom keys and peers.
*/
protected Map myTags;
/**
* current margin of a page.
*/
private float topMargin = 36;
/**
* current margin of a page.
*/
private float rightMargin = 36;
/**
* current margin of a page.
*/
private float leftMargin = 36;
/**
* current margin of a page.
*/
private float bottomMargin = 36;
private BaseFont bf = null;
/**
* @param document the DocListener
*/
public SAXiTextHandler(DocListener document) {
this.document = document;
stack = new Stack<>();
}
/**
* @param document the DocListener
* @param myTags a Map of the tags
* @param bf the base class for the supported fonts
*/
public SAXiTextHandler(DocListener document, Map myTags, BaseFont bf) {
this(document, myTags);
this.bf = bf;
}
/**
* @param document the DocListener
* @param myTags a Map of the tags
*/
public SAXiTextHandler(DocListener document, Map myTags) {
this(document);
this.myTags = myTags;
}
/**
* Sets the parameter that allows you to enable/disable the control over the
* Document.open() and Document.close() method.
*
* If you set this parameter to true (= default), the parser will open the
* Document object when the start-root-tag is encountered and close it when
* the end-root-tag is met. If you set it to false, you have to open and
* close the Document object yourself.
*
* @param controlOpenClose set this to false if you plan to open/close the Document
* yourself
*/
public void setControlOpenClose(boolean controlOpenClose) {
this.controlOpenClose = controlOpenClose;
}
/**
* This method gets called when a start tag is encountered.
*
* @param uri the Uniform Resource Identifier
* @param localName the local name (without prefix), or the empty string if
* Namespace processing is not being performed.
* @param name the name of the tag that is encountered
* @param attributes the list of attributes
*/
public void startElement(String uri, String localName, String name, @Nullable Attributes attributes) {
Properties properties = new Properties();
if (attributes != null) {
for (int i = 0; i < attributes.getLength(); i++) {
String attribute = attributes.getQName(i);
properties.setProperty(attribute, attributes.getValue(i));
}
}
handleStartingTags(name, properties);
}
/**
* This method deals with the starting tags.
*
* @param name the name of the tag
* @param attributes the list of attributes
*/
public void handleStartingTags(String name, Properties attributes) {
if (ignore || ElementTags.IGNORE.equals(name)) {
ignore = true;
return;
}
// maybe there is some meaningful data that wasn't between tags
if (currentChunk != null && isNotBlank(currentChunk.getContent())) {
TextElementArray current;
try {
current = (TextElementArray) stack.pop();
} catch (EmptyStackException ese) {
if (bf == null) {
current = new Paragraph("", new Font());
} else {
current = new Paragraph("", new Font(this.bf));
}
}
current.add(currentChunk);
stack.push(current);
currentChunk = null;
}
// chunks
if (ElementTags.CHUNK.equals(name)) {
currentChunk = ElementFactory.getChunk(attributes);
if (bf != null) {
currentChunk.setFont(new Font(this.bf));
}
return;
}
// symbols
if (ElementTags.ENTITY.equals(name)) {
Font f = new Font();
if (currentChunk != null) {
handleEndingTags(ElementTags.CHUNK);
f = currentChunk.getFont();
}
currentChunk = EntitiesToSymbol.get(attributes.getProperty(ElementTags.ID),
f);
return;
}
// phrases
if (ElementTags.PHRASE.equals(name)) {
stack.push(ElementFactory.getPhrase(attributes));
return;
}
// anchors
if (ElementTags.ANCHOR.equals(name)) {
stack.push(ElementFactory.getAnchor(attributes));
return;
}
// paragraphs and titles
if (ElementTags.PARAGRAPH.equals(name) || ElementTags.TITLE.equals(name)) {
stack.push(ElementFactory.getParagraph(attributes));
return;
}
// lists
if (ElementTags.LIST.equals(name)) {
stack.push(ElementFactory.getList(attributes));
return;
}
// listitems
if (ElementTags.LISTITEM.equals(name)) {
stack.push(ElementFactory.getListItem(attributes));
return;
}
// cells
if (ElementTags.CELL.equals(name)) {
stack.push(ElementFactory.getCell(attributes));
return;
}
// tables
if (ElementTags.TABLE.equals(name)) {
Table table = ElementFactory.getTable(attributes);
float[] widths = table.getProportionalWidths();
for (int i = 0; i < widths.length; i++) {
if (widths[i] == 0) {
widths[i] = 100.0f / widths.length;
}
}
try {
table.setWidths(widths);
} catch (BadElementException bee) {
// this shouldn't happen
throw new ExceptionConverter(bee);
}
stack.push(table);
return;
}
// sections
if (ElementTags.SECTION.equals(name)) {
Element previous = stack.pop();
Section section;
try {
section = ElementFactory.getSection((Section) previous, attributes);
} catch (ClassCastException cce) {
throw new ExceptionConverter(cce);
}
stack.push(previous);
stack.push(section);
return;
}
// chapters
if (ElementTags.CHAPTER.equals(name)) {
stack.push(ElementFactory.getChapter(attributes));
return;
}
// images
if (ElementTags.IMAGE.equals(name)) {
try {
Image img = ElementFactory.getImage(attributes);
try {
addImage(img);
return;
} catch (EmptyStackException ese) {
// if there is no element on the stack, the Image is added
// to the document
try {
document.add(img);
} catch (DocumentException de) {
throw new ExceptionConverter(de);
}
return;
}
} catch (Exception e) {
throw new ExceptionConverter(e);
}
}
// annotations
if (ElementTags.ANNOTATION.equals(name)) {
Annotation annotation = ElementFactory.getAnnotation(attributes);
TextElementArray current;
try {
try {
current = (TextElementArray) stack.pop();
try {
current.add(annotation);
} catch (Exception e) {
document.add(annotation);
}
stack.push(current);
} catch (EmptyStackException ese) {
document.add(annotation);
}
return;
} catch (DocumentException de) {
throw new ExceptionConverter(de);
}
}
// newlines
if (isNewline(name)) {
TextElementArray current;
try {
current = (TextElementArray) stack.pop();
current.add(Chunk.NEWLINE);
stack.push(current);
} catch (EmptyStackException ese) {
if (currentChunk == null) {
try {
document.add(Chunk.NEWLINE);
} catch (DocumentException de) {
throw new ExceptionConverter(de);
}
} else {
currentChunk.append("\n");
}
}
return;
}
// newpage
if (isNewpage(name)) {
TextElementArray current;
try {
current = (TextElementArray) stack.pop();
Chunk newPage = new Chunk("");
newPage.setNewPage();
if (bf != null) {
newPage.setFont(new Font(this.bf));
}
current.add(newPage);
stack.push(current);
} catch (EmptyStackException ese) {
document.newPage();
}
return;
}
if (ElementTags.HORIZONTALRULE.equals(name)) {
TextElementArray current;
LineSeparator hr = new LineSeparator(1.0f, 100.0f, null, Element.ALIGN_CENTER, 0);
try {
current = (TextElementArray) stack.pop();
current.add(hr);
stack.push(current);
} catch (EmptyStackException ese) {
try {
document.add(hr);
} catch (DocumentException de) {
throw new ExceptionConverter(de);
}
}
return;
}
// documentroot
if (isDocumentRoot(name)) {
String key;
String value;
// pagesize and orientation specific code suggested by Samuel Gabriel
// Updated by Ricardo Coutinho. Only use if set in html!
Rectangle pageSize = null;
String orientation = null;
for (Object o : attributes.keySet()) {
key = (String) o;
value = attributes.getProperty(key);
try {
// margin specific code suggested by Reza Nasiri
if (ElementTags.LEFT.equalsIgnoreCase(key))
leftMargin = Float.parseFloat(value + "f");
if (ElementTags.RIGHT.equalsIgnoreCase(key))
rightMargin = Float.parseFloat(value + "f");
if (ElementTags.TOP.equalsIgnoreCase(key))
topMargin = Float.parseFloat(value + "f");
if (ElementTags.BOTTOM.equalsIgnoreCase(key))
bottomMargin = Float.parseFloat(value + "f");
} catch (Exception ex) {
throw new ExceptionConverter(ex);
}
if (ElementTags.PAGE_SIZE.equals(key)) {
try {
Field pageSizeField = PageSize.class.getField(value);
pageSize = (Rectangle) pageSizeField.get(null);
} catch (Exception ex) {
throw new ExceptionConverter(ex);
}
} else if (ElementTags.ORIENTATION.equals(key)) {
try {
if ("landscape".equals(value)) {
orientation = "landscape";
}
} catch (Exception ex) {
throw new ExceptionConverter(ex);
}
} else {
try {
document.add(new Meta(key, value));
} catch (DocumentException de) {
throw new ExceptionConverter(de);
}
}
}
if (pageSize != null) {
if ("landscape".equals(orientation)) {
pageSize = pageSize.rotate();
}
document.setPageSize(pageSize);
}
document.setMargins(leftMargin, rightMargin, topMargin, bottomMargin);
if (controlOpenClose)
document.open();
}
}
/**
* This method gets called when ignorable white space encountered.
*
* @param ch an array of characters
* @param start the start position in the array
* @param length the number of characters to read from the array
*/
public void ignorableWhitespace(char[] ch, int start, int length) {
characters(ch, start, length);
}
/**
* This method gets called when characters are encountered.
*
* @param ch an array of characters
* @param start the start position in the array
* @param length the number of characters to read from the array
*/
public void characters(char[] ch, int start, int length) {
if (ignore) {
return;
}
String content = new String(ch, start, length);
if (content.trim().isEmpty() && content.indexOf(' ') < 0) {
return;
}
StringBuilder buf = new StringBuilder();
int len = content.length();
char character;
boolean newline = false;
for (int i = 0; i < len; i++) {
switch (character = content.charAt(i)) {
case ' ':
if (!newline) {
buf.append(character);
}
break;
case '\n':
if (i > 0) {
newline = true;
buf.append(' ');
}
break;
case '\r':
break;
case '\t':
break;
default:
newline = false;
buf.append(character);
}
}
if (currentChunk == null) {
if (bf == null) {
currentChunk = new Chunk(buf.toString());
} else {
currentChunk = new Chunk(buf.toString(), new Font(this.bf));
}
} else {
currentChunk.append(buf.toString());
}
}
/**
* Sets the font that has to be used.
*
* @param bf the base class for the supported fonts
*/
public void setBaseFont(BaseFont bf) {
this.bf = bf;
}
/**
* This method gets called when an end tag is encountered.
*
* @param uri the Uniform Resource Identifier
* @param lname the local name (without prefix), or the empty string if
* Namespace processing is not being performed.
* @param name the name of the tag that ends
*/
public void endElement(String uri, String lname, String name) {
handleEndingTags(name);
}
/**
* This method deals with the starting tags.
*
* @param name the name of the tag
*/
public void handleEndingTags(String name) {
// System.err.println("Stop: " + name);
if (ElementTags.IGNORE.equals(name)) {
ignore = false;
return;
}
if (ignore)
return;
// tags that don't have any content
if (isNewpage(name) || ElementTags.ANNOTATION.equals(name) || ElementTags.IMAGE.equals(name)
|| isNewline(name)) {
return;
}
try {
// titles of sections and chapters
if (ElementTags.TITLE.equals(name)) {
Paragraph current = (Paragraph) stack.pop();
if (currentChunk != null) {
current.add(currentChunk);
currentChunk = null;
}
Section previous = (Section) stack.pop();
previous.setTitle(current);
stack.push(previous);
return;
}
// all other endtags
if (currentChunk != null) {
TextElementArray current;
try {
current = (TextElementArray) stack.pop();
} catch (EmptyStackException ese) {
current = new Paragraph();
}
current.add(currentChunk);
stack.push(current);
currentChunk = null;
}
// chunks
if (ElementTags.CHUNK.equals(name)) {
return;
}
// phrases, anchors, lists, tables
if (ElementTags.PHRASE.equals(name) || ElementTags.ANCHOR.equals(name) || ElementTags.LIST.equals(name)
|| ElementTags.PARAGRAPH.equals(name)) {
Element current = stack.pop();
try {
TextElementArray previous = (TextElementArray) stack.pop();
previous.add(current);
stack.push(previous);
} catch (EmptyStackException ese) {
document.add(current);
}
return;
}
// listitems
if (ElementTags.LISTITEM.equals(name)) {
ListItem listItem = (ListItem) stack.pop();
List list = (List) stack.pop();
list.add(listItem);
stack.push(list);
}
// tables
if (ElementTags.TABLE.equals(name)) {
Table table = (Table) stack.pop();
try {
TextElementArray previous = (TextElementArray) stack.pop();
previous.add(table);
stack.push(previous);
} catch (EmptyStackException ese) {
document.add(table);
}
return;
}
// rows
if (ElementTags.ROW.equals(name)) {
java.util.List cells = new ArrayList<>();
int columns = 0;
Table table;
Cell cell;
while (true) {
Element element = stack.pop();
if (element.type() == Element.CELL) {
cell = (Cell) element;
columns += cell.getColspan();
cells.add(cell);
} else {
table = (Table) element;
break;
}
}
if (table.getColumns() < columns) {
table.addColumns(columns - table.getColumns());
}
Collections.reverse(cells);
String width;
float[] cellWidths = new float[columns];
boolean[] cellNulls = new boolean[columns];
for (int i = 0; i < columns; i++) {
cellWidths[i] = 0;
cellNulls[i] = true;
}
float total = 0.0f;
int j = 0;
for (Cell value : cells) {
cell = value;
width = cell.getWidthAsString();
if (cell.getWidth() == 0) {
if (cell.getColspan() == 1 && cellWidths[j] == 0) {
try {
cellWidths[j] = 100.0f / columns;
total += cellWidths[j];
} catch (Exception e) {
// empty on purpose
}
} else if (cell.getColspan() == 1) {
cellNulls[j] = false;
}
} else if (cell.getColspan() == 1 && width.endsWith("%")) {
try {
cellWidths[j] = Float.parseFloat(width.substring(0, width.length() - 1) + "f");
total += cellWidths[j];
cellNulls[j] = false;
} catch (Exception e) {
// empty on purpose
}
}
j += cell.getColspan();
table.addCell(cell);
}
float[] widths = table.getProportionalWidths();
if (widths.length == columns) {
float left = 0.0f;
for (int i = 0; i < columns; i++) {
if (cellNulls[i] && widths[i] != 0) {
left += widths[i];
cellWidths[i] = widths[i];
}
}
if (100.0 >= total) {
for (int i = 0; i < widths.length; i++) {
if (cellWidths[i] == 0 && widths[i] != 0) {
cellWidths[i] = (widths[i] / left) * (100.0f - total);
}
}
}
table.setWidths(cellWidths);
}
stack.push(table);
}
// cells
if (ElementTags.CELL.equals(name)) {
return;
}
// sections
if (ElementTags.SECTION.equals(name)) {
stack.pop();
return;
}
// chapters
if (ElementTags.CHAPTER.equals(name)) {
document.add(stack.pop());
return;
}
// the documentroot
if (isDocumentRoot(name)) {
try {
while (true) {
Element element = stack.pop();
try {
TextElementArray previous = (TextElementArray) stack.pop();
previous.add(element);
stack.push(previous);
} catch (EmptyStackException es) {
document.add(element);
}
}
} catch (EmptyStackException ese) {
// empty on purpose
}
if (controlOpenClose) {
document.close();
}
}
} catch (DocumentException de) {
throw new ExceptionConverter(de);
}
}
private boolean isNotBlank(String text) {
return text != null && !text.trim().isEmpty();
}
protected void addImage(Image img) throws EmptyStackException {
// if there is an element on the stack...
Element current = stack.pop();
// ...and it's a Chapter or a Section, the Image can be
// added directly
if (current instanceof Section || current instanceof Cell) {
((TextElementArray) current).add(img);
stack.push(current);
}
// ... if it is a Phrase, we have to wrap the Image in a new Chunk
else if (current instanceof Phrase){
((TextElementArray)current).add(new Chunk(img,0,0));
stack.push(current);
}
// ...if not, we need to to a lot of stuff
else {
Stack newStack = new Stack<>();
while (!(current instanceof Section || current instanceof Cell)) {
newStack.push(current);
if (current instanceof Anchor) {
img.setAnnotation(new Annotation(0, 0, 0,
0, ((Anchor) current).getReference()));
}
current = stack.pop();
}
((TextElementArray) current).add(img);
stack.push(current);
while (!newStack.empty()) {
stack.push(newStack.pop());
}
}
}
/**
* Checks if a certain tag corresponds with the newpage-tag.
*
* @param tag a presumed tagname
* @return true or false
*/
private boolean isNewpage(String tag) {
return ElementTags.NEWPAGE.equals(tag);
}
/**
* Checks if a certain tag corresponds with the newpage-tag.
*
* @param tag a presumed tagname
* @return true or false
*/
private boolean isNewline(String tag) {
return ElementTags.NEWLINE.equals(tag);
}
/**
* Checks if a certain tag corresponds with the roottag.
*
* @param tag a presumed tagname
* @return true if tag equals itext
* ,false otherwise.
*/
protected boolean isDocumentRoot(String tag) {
return ElementTags.ITEXT.equals(tag);
}
}
|