com.itextpdf.text.html.HtmlEncoder Maven / Gradle / Ivy
Show all versions of itextpdf Show documentation
/*
*
* This file is part of the iText (R) project.
Copyright (c) 1998-2022 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.text.html;
import java.util.HashSet;
import java.util.Set;
import com.itextpdf.text.Element;
import com.itextpdf.text.BaseColor;
/**
* This class converts a String to the HTML-format of a String.
*
* To convert the String, each character is examined:
*
* - ASCII-characters from 000 till 031 are represented as &#xxx;
* (with xxx = the value of the character)
* - ASCII-characters from 032 t/m 127 are represented by the character itself, except for:
*
* - '\n' becomes <BR>\n
*
- " becomes "
*
- & becomes &
*
- < becomes <
*
- > becomes >
*
* - ASCII-characters from 128 till 255 are represented as &#xxx;
* (with xxx = the value of the character)
*
*
* Example:
*
* String htmlPresentation = HtmlEncoder.encode("Marie-Thérèse Sørensen");
*
* for more info: see O'Reilly; "HTML: The Definitive Guide" (page 164)
*
* @deprecated since 5.5.2
*/
@Deprecated
public final class HtmlEncoder {
/**
* This class will never be constructed.
*/
private HtmlEncoder() {
}
// membervariables
/**
* List with the HTML translation of all the characters.
* @since 5.0.6 (renamed from htmlCode)
*/
private static final String[] HTML_CODE = new String[256];
static {
for (int i = 0; i < 10; i++) {
HTML_CODE[i] = "�" + i + ";";
}
for (int i = 10; i < 32; i++) {
HTML_CODE[i] = "�" + i + ";";
}
for (int i = 32; i < 128; i++) {
HTML_CODE[i] = String.valueOf((char)i);
}
// Special characters
HTML_CODE['\t'] = "\t";
HTML_CODE['\n'] = "
\n";
HTML_CODE['\"'] = """; // double quote
HTML_CODE['&'] = "&"; // ampersand
HTML_CODE['<'] = "<"; // lower than
HTML_CODE['>'] = ">"; // greater than
for (int i = 128; i < 256; i++) {
HTML_CODE[i] = "&#" + i + ";";
}
}
// methods
/**
* Converts a String to the HTML-format of this String.
*
* @param string The String to convert
* @return a String
*/
public static String encode(String string) {
int n = string.length();
char character;
StringBuffer buffer = new StringBuffer();
// loop over all the characters of the String.
for (int i = 0; i < n; i++) {
character = string.charAt(i);
// the Htmlcode of these characters are added to a StringBuffer one by one
if (character < 256) {
buffer.append(HTML_CODE[character]);
}
else {
// Improvement posted by Joachim Eyrich
buffer.append("&#").append((int)character).append(';');
}
}
return buffer.toString();
}
/**
* Converts a BaseColor into a HTML representation of this BaseColor.
*
* @param color the BaseColor that has to be converted.
* @return the HTML representation of this BaseColor
*/
public static String encode(BaseColor color) {
StringBuffer buffer = new StringBuffer("#");
if (color.getRed() < 16) {
buffer.append('0');
}
buffer.append(Integer.toString(color.getRed(), 16));
if (color.getGreen() < 16) {
buffer.append('0');
}
buffer.append(Integer.toString(color.getGreen(), 16));
if (color.getBlue() < 16) {
buffer.append('0');
}
buffer.append(Integer.toString(color.getBlue(), 16));
return buffer.toString();
}
/**
* Translates the alignment value.
*
* @param alignment the alignment value
* @return the translated value
*/
public static String getAlignment(int alignment) {
switch(alignment) {
case Element.ALIGN_LEFT:
return HtmlTags.ALIGN_LEFT;
case Element.ALIGN_CENTER:
return HtmlTags.ALIGN_CENTER;
case Element.ALIGN_RIGHT:
return HtmlTags.ALIGN_RIGHT;
case Element.ALIGN_JUSTIFIED:
case Element.ALIGN_JUSTIFIED_ALL:
return HtmlTags.ALIGN_JUSTIFY;
case Element.ALIGN_TOP:
return HtmlTags.ALIGN_TOP;
case Element.ALIGN_MIDDLE:
return HtmlTags.ALIGN_MIDDLE;
case Element.ALIGN_BOTTOM:
return HtmlTags.ALIGN_BOTTOM;
case Element.ALIGN_BASELINE:
return HtmlTags.ALIGN_BASELINE;
default:
return "";
}
}
/**
* Set containing tags that trigger a new line.
* @since iText 5.0.6
*/
private static final Set NEWLINETAGS = new HashSet();
static {
// Following list are the basic html tags that force new lines
// List may be extended as we discover them
NEWLINETAGS.add(HtmlTags.P);
NEWLINETAGS.add(HtmlTags.BLOCKQUOTE);
NEWLINETAGS.add(HtmlTags.BR);
}
/**
* Returns true if the tag causes a new line like p, br etc.
* @since iText 5.0.6
*/
public static boolean isNewLineTag(String tag) {
return NEWLINETAGS.contains(tag);
}
}