001: /*
002: * $Id: HtmlEncoder.java 2547 2007-01-26 13:46:13Z blowagie $
003: * $Name$
004: *
005: * Copyright 1999, 2000, 2001, 2002 by Bruno Lowagie.
006: *
007: * The contents of this file are subject to the Mozilla Public License Version 1.1
008: * (the "License"); you may not use this file except in compliance with the License.
009: * You may obtain a copy of the License at http://www.mozilla.org/MPL/
010: *
011: * Software distributed under the License is distributed on an "AS IS" basis,
012: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
013: * for the specific language governing rights and limitations under the License.
014: *
015: * The Original Code is 'iText, a free JAVA-PDF library'.
016: *
017: * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
018: * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
019: * All Rights Reserved.
020: * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
021: * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
022: *
023: * Contributor(s): all the names of the contributors are added in the source code
024: * where applicable.
025: *
026: * Alternatively, the contents of this file may be used under the terms of the
027: * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
028: * provisions of LGPL are applicable instead of those above. If you wish to
029: * allow use of your version of this file only under the terms of the LGPL
030: * License and not to allow others to use your version of this file under
031: * the MPL, indicate your decision by deleting the provisions above and
032: * replace them with the notice and other provisions required by the LGPL.
033: * If you do not delete the provisions above, a recipient may use your version
034: * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
035: *
036: * This library is free software; you can redistribute it and/or modify it
037: * under the terms of the MPL as stated above or under the terms of the GNU
038: * Library General Public License as published by the Free Software Foundation;
039: * either version 2 of the License, or any later version.
040: *
041: * This library is distributed in the hope that it will be useful, but WITHOUT
042: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
043: * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
044: * details.
045: *
046: * If you didn't download this code from the following link, you should check if
047: * you aren't using an obsolete version:
048: * http://www.lowagie.com/iText/
049: */
050:
051: package com.lowagie.text.html;
052:
053: import java.awt.Color;
054:
055: import com.lowagie.text.Element;
056:
057: /**
058: * This class converts a <CODE>String</CODE> to the HTML-format of a String.
059: * <P>
060: * To convert the <CODE>String</CODE>, each character is examined:
061: * <UL>
062: * <LI>ASCII-characters from 000 till 031 are represented as &#xxx;<BR>
063: * (with xxx = the value of the character)
064: * <LI>ASCII-characters from 032 t/m 127 are represented by the character itself, except for:
065: * <UL>
066: * <LI>'\n' becomes <BR>\n
067: * <LI>" becomes &quot;
068: * <LI>& becomes &amp;
069: * <LI>< becomes &lt;
070: * <LI>> becomes &gt;
071: * </UL>
072: * <LI>ASCII-characters from 128 till 255 are represented as &#xxx;<BR>
073: * (with xxx = the value of the character)
074: * </UL>
075: * <P>
076: * Example:
077: * <P><BLOCKQUOTE><PRE>
078: * String htmlPresentation = HtmlEncoder.encode("Marie-Thérèse Sørensen");
079: * </PRE></BLOCKQUOTE><P>
080: * for more info: see O'Reilly; "HTML: The Definitive Guide" (page 164)
081: *
082: * @author mario.maccarini@ugent.be
083: */
084:
085: public class HtmlEncoder {
086:
087: // membervariables
088:
089: /** List with the HTML translation of all the characters. */
090: private static final String[] htmlCode = new String[256];
091:
092: static {
093: for (int i = 0; i < 10; i++) {
094: htmlCode[i] = "�" + i + ";";
095: }
096:
097: for (int i = 10; i < 32; i++) {
098: htmlCode[i] = "�" + i + ";";
099: }
100:
101: for (int i = 32; i < 128; i++) {
102: htmlCode[i] = String.valueOf((char) i);
103: }
104:
105: // Special characters
106: htmlCode['\t'] = "\t";
107: htmlCode['\n'] = "<" + HtmlTags.NEWLINE + " />\n";
108: htmlCode['\"'] = """; // double quote
109: htmlCode['&'] = "&"; // ampersand
110: htmlCode['<'] = "<"; // lower than
111: htmlCode['>'] = ">"; // greater than
112:
113: for (int i = 128; i < 256; i++) {
114: htmlCode[i] = "&#" + i + ";";
115: }
116: }
117:
118: // constructors
119:
120: /**
121: * This class will never be constructed.
122: * <P>
123: * HtmlEncoder only contains static methods.
124: */
125:
126: private HtmlEncoder() {
127: }
128:
129: // methods
130:
131: /**
132: * Converts a <CODE>String</CODE> to the HTML-format of this <CODE>String</CODE>.
133: *
134: * @param string The <CODE>String</CODE> to convert
135: * @return a <CODE>String</CODE>
136: */
137:
138: public static String encode(String string) {
139: int n = string.length();
140: char character;
141: StringBuffer buffer = new StringBuffer();
142: // loop over all the characters of the String.
143: for (int i = 0; i < n; i++) {
144: character = string.charAt(i);
145: // the Htmlcode of these characters are added to a StringBuffer one by one
146: if (character < 256) {
147: buffer.append(htmlCode[character]);
148: } else {
149: // Improvement posted by Joachim Eyrich
150: buffer.append("&#").append((int) character).append(';');
151: }
152: }
153: return buffer.toString();
154: }
155:
156: /**
157: * Converts a <CODE>Color</CODE> into a HTML representation of this <CODE>Color</CODE>.
158: *
159: * @param color the <CODE>Color</CODE> that has to be converted.
160: * @return the HTML representation of this <COLOR>Color</COLOR>
161: */
162:
163: public static String encode(Color color) {
164: StringBuffer buffer = new StringBuffer("#");
165: if (color.getRed() < 16) {
166: buffer.append('0');
167: }
168: buffer.append(Integer.toString(color.getRed(), 16));
169: if (color.getGreen() < 16) {
170: buffer.append('0');
171: }
172: buffer.append(Integer.toString(color.getGreen(), 16));
173: if (color.getBlue() < 16) {
174: buffer.append('0');
175: }
176: buffer.append(Integer.toString(color.getBlue(), 16));
177: return buffer.toString();
178: }
179:
180: /**
181: * Translates the alignment value.
182: *
183: * @param alignment the alignment value
184: * @return the translated value
185: */
186:
187: public static String getAlignment(int alignment) {
188: switch (alignment) {
189: case Element.ALIGN_LEFT:
190: return HtmlTags.ALIGN_LEFT;
191: case Element.ALIGN_CENTER:
192: return HtmlTags.ALIGN_CENTER;
193: case Element.ALIGN_RIGHT:
194: return HtmlTags.ALIGN_RIGHT;
195: case Element.ALIGN_JUSTIFIED:
196: case Element.ALIGN_JUSTIFIED_ALL:
197: return HtmlTags.ALIGN_JUSTIFIED;
198: case Element.ALIGN_TOP:
199: return HtmlTags.ALIGN_TOP;
200: case Element.ALIGN_MIDDLE:
201: return HtmlTags.ALIGN_MIDDLE;
202: case Element.ALIGN_BOTTOM:
203: return HtmlTags.ALIGN_BOTTOM;
204: case Element.ALIGN_BASELINE:
205: return HtmlTags.ALIGN_BASELINE;
206: default:
207: return "";
208: }
209: }
210: }
|