com.itextpdf.text.Chunk Maven / Gradle / Ivy
Show all versions of itextpdf Show documentation
/*
* $Id: Chunk.java 5135 2012-05-07 13:18:40Z eugenemark $
*
* This file is part of the iText (R) project.
* Copyright (c) 1998-2012 1T3XT BVBA
* 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 1T3XT,
* 1T3XT 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;
import java.net.URL;
import java.util.List;
import java.util.ArrayList;
import java.util.HashMap;
import com.itextpdf.text.error_messages.MessageLocalization;
import com.itextpdf.text.pdf.HyphenationEvent;
import com.itextpdf.text.pdf.PdfAction;
import com.itextpdf.text.pdf.PdfAnnotation;
import com.itextpdf.text.pdf.PdfContentByte;
import com.itextpdf.text.pdf.draw.DrawInterface;
/**
* This is the smallest significant part of text that can be added to a
* document.
*
* Most elements can be divided in one or more Chunks. A chunk
* is a String with a certain Font. All other
* layout parameters should be defined in the object to which this chunk of text
* is added.
*
* Example:
*
*
*
* Chunk chunk = new Chunk("Hello world",
* FontFactory.getFont(FontFactory.COURIER, 20, Font.ITALIC, new BaseColor(255, 0,
* 0))); document.add(chunk);
*
*
*
*
*/
public class Chunk implements Element {
// public static membervariables
/** The character stand in for an image or a separator. */
public static final String OBJECT_REPLACEMENT_CHARACTER = "\ufffc";
/** This is a Chunk containing a newline. */
public static final Chunk NEWLINE = new Chunk("\n");
/** This is a Chunk containing a newpage. */
public static final Chunk NEXTPAGE = new Chunk("");
static {
NEXTPAGE.setNewPage();
}
// member variables
/** This is the content of this chunk of text. */
protected StringBuffer content = null;
/** This is the Font of this chunk of text. */
protected Font font = null;
/** Contains some of the attributes for this Chunk. */
protected HashMap attributes = null;
// constructors
/**
* Empty constructor.
*/
public Chunk() {
this.content = new StringBuffer();
this.font = new Font();
}
/**
* A Chunk copy constructor.
* @param ck the Chunk to be copied
*/
public Chunk(final Chunk ck) {
if (ck.content != null) {
content = new StringBuffer(ck.content.toString());
}
if (ck.font != null) {
font = new Font(ck.font);
}
if (ck.attributes != null) {
attributes = new HashMap(ck.attributes);
}
}
/**
* Constructs a chunk of text with a certain content and a certain
* Font.
*
* @param content
* the content
* @param font
* the font
*/
public Chunk(final String content, final Font font) {
this.content = new StringBuffer(content);
this.font = font;
}
/**
* Constructs a chunk of text with a certain content, without specifying a
* Font.
*
* @param content
* the content
*/
public Chunk(final String content) {
this(content, new Font());
}
/**
* Constructs a chunk of text with a char and a certain Font.
*
* @param c
* the content
* @param font
* the font
*/
public Chunk(final char c, final Font font) {
this.content = new StringBuffer();
this.content.append(c);
this.font = font;
}
/**
* Constructs a chunk of text with a char, without specifying a Font
* .
*
* @param c
* the content
*/
public Chunk(final char c) {
this(c, new Font());
}
/**
* Constructs a chunk containing an Image.
*
* @param image
* the image
* @param offsetX
* the image offset in the x direction
* @param offsetY
* the image offset in the y direction
*/
public Chunk(final Image image, final float offsetX, final float offsetY) {
this(OBJECT_REPLACEMENT_CHARACTER, new Font());
Image copyImage = Image.getInstance(image);
copyImage.setAbsolutePosition(Float.NaN, Float.NaN);
setAttribute(IMAGE, new Object[] { copyImage, new Float(offsetX),
new Float(offsetY), Boolean.FALSE });
}
/**
* Key for drawInterface of the Separator.
* @since 2.1.2
*/
public static final String SEPARATOR = "SEPARATOR";
/**
* Creates a separator Chunk.
* Note that separator chunks can't be used in combination with tab chunks!
* @param separator the drawInterface to use to draw the separator.
* @since 2.1.2
*/
public Chunk(final DrawInterface separator) {
this(separator, false);
}
/**
* Creates a separator Chunk.
* Note that separator chunks can't be used in combination with tab chunks!
* @param separator the drawInterface to use to draw the separator.
* @param vertical true if this is a vertical separator
* @since 2.1.2
*/
public Chunk(final DrawInterface separator, final boolean vertical) {
this(OBJECT_REPLACEMENT_CHARACTER, new Font());
setAttribute(SEPARATOR, new Object[] {separator, Boolean.valueOf(vertical)});
}
/**
* Key for drawInterface of the tab.
* @since 2.1.2
*/
public static final String TAB = "TAB";
/**
* Creates a tab Chunk.
* Note that separator chunks can't be used in combination with tab chunks!
* @param separator the drawInterface to use to draw the tab.
* @param tabPosition an X coordinate that will be used as start position for the next Chunk.
* @since 2.1.2
*/
public Chunk(final DrawInterface separator, final float tabPosition) {
this(separator, tabPosition, false);
}
/**
* Creates a tab Chunk.
* Note that separator chunks can't be used in combination with tab chunks!
* @param separator the drawInterface to use to draw the tab.
* @param tabPosition an X coordinate that will be used as start position for the next Chunk.
* @param newline if true, a newline will be added if the tabPosition has already been reached.
* @since 2.1.2
*/
public Chunk(final DrawInterface separator, final float tabPosition, final boolean newline) {
this(OBJECT_REPLACEMENT_CHARACTER, new Font());
if (tabPosition < 0) {
throw new IllegalArgumentException(MessageLocalization.getComposedMessage("a.tab.position.may.not.be.lower.than.0.yours.is.1", String.valueOf(tabPosition)));
}
setAttribute(TAB, new Object[] {separator, new Float(tabPosition), Boolean.valueOf(newline), new Float(0)});
}
/**
* Constructs a chunk containing an Image.
*
* @param image
* the image
* @param offsetX
* the image offset in the x direction
* @param offsetY
* the image offset in the y direction
* @param changeLeading
* true if the leading has to be adapted to the image
*/
public Chunk(final Image image, final float offsetX, final float offsetY,
final boolean changeLeading) {
this(OBJECT_REPLACEMENT_CHARACTER, new Font());
setAttribute(IMAGE, new Object[] { image, new Float(offsetX),
new Float(offsetY), Boolean.valueOf(changeLeading) });
}
// implementation of the Element-methods
/**
* Processes the element by adding it (or the different parts) to an
* ElementListener.
*
* @param listener
* an ElementListener
* @return true if the element was processed successfully
*/
public boolean process(final ElementListener listener) {
try {
return listener.add(this);
} catch (DocumentException de) {
return false;
}
}
/**
* Gets the type of the text element.
*
* @return a type
*/
public int type() {
return Element.CHUNK;
}
/**
* Gets all the chunks in this element.
*
* @return an ArrayList
*/
public List getChunks() {
List tmp = new ArrayList();
tmp.add(this);
return tmp;
}
// methods that change the member variables
/**
* appends some text to this Chunk.
*
* @param string
* String
* @return a StringBuffer
*/
public StringBuffer append(final String string) {
return content.append(string);
}
/**
* Sets the font of this Chunk.
*
* @param font
* a Font
*/
public void setFont(final Font font) {
this.font = font;
}
// methods to retrieve information
/**
* Gets the font of this Chunk.
*
* @return a Font
*/
public Font getFont() {
return font;
}
/**
* Returns the content of this Chunk.
*
* @return a String
*/
public String getContent() {
return content.toString().replaceAll("\t", "");
}
/**
* Returns the content of this Chunk.
*
* @return a String
*/
@Override
public String toString() {
return getContent();
}
/**
* Checks is this Chunk is empty.
*
* @return false if the Chunk contains other characters than
* space.
*/
public boolean isEmpty() {
return content.toString().trim().length() == 0
&& content.toString().indexOf("\n") == -1
&& attributes == null;
}
/**
* Gets the width of the Chunk in points.
*
* @return a width in points
*/
public float getWidthPoint() {
if (getImage() != null) {
return getImage().getScaledWidth();
}
return font.getCalculatedBaseFont(true).getWidthPoint(getContent(),
font.getCalculatedSize())
* getHorizontalScaling();
}
// attributes
/**
* Checks the attributes of this Chunk.
*
* @return false if there aren't any.
*/
public boolean hasAttributes() {
return attributes != null;
}
/**
* Gets the attributes for this Chunk.
*
* It may be null.
*
* @return the attributes for this Chunk
*/
public HashMap getAttributes() {
return attributes;
}
/**
* Sets the attributes all at once.
* @param attributes the attributes of a Chunk
*/
public void setAttributes(final HashMap attributes) {
this.attributes = attributes;
}
/**
* Sets an arbitrary attribute.
*
* @param name
* the key for the attribute
* @param obj
* the value of the attribute
* @return this Chunk
*/
private Chunk setAttribute(final String name, final Object obj) {
if (attributes == null)
attributes = new HashMap();
attributes.put(name, obj);
return this;
}
// the attributes are ordered as they appear in the book 'iText in Action'
/** Key for text horizontal scaling. */
public static final String HSCALE = "HSCALE";
/**
* Sets the text horizontal scaling. A value of 1 is normal and a value of
* 0.5f shrinks the text to half it's width.
*
* @param scale
* the horizontal scaling factor
* @return this Chunk
*/
public Chunk setHorizontalScaling(final float scale) {
return setAttribute(HSCALE, new Float(scale));
}
/**
* Gets the horizontal scaling.
*
* @return a percentage in float
*/
public float getHorizontalScaling() {
if (attributes == null)
return 1f;
Float f = (Float) attributes.get(HSCALE);
if (f == null)
return 1f;
return f.floatValue();
}
/** Key for underline. */
public static final String UNDERLINE = "UNDERLINE";
/**
* Sets an horizontal line that can be an underline or a strikethrough.
* Actually, the line can be anywhere vertically and has always the
* Chunk width. Multiple call to this method will produce multiple
* lines.
*
* @param thickness
* the absolute thickness of the line
* @param yPosition
* the absolute y position relative to the baseline
* @return this Chunk
*/
public Chunk setUnderline(final float thickness, final float yPosition) {
return setUnderline(null, thickness, 0f, yPosition, 0f,
PdfContentByte.LINE_CAP_BUTT);
}
/**
* Sets an horizontal line that can be an underline or a strikethrough.
* Actually, the line can be anywhere vertically and has always the
* Chunk width. Multiple call to this method will produce multiple
* lines.
*
* @param color
* the color of the line or null to follow the
* text color
* @param thickness
* the absolute thickness of the line
* @param thicknessMul
* the thickness multiplication factor with the font size
* @param yPosition
* the absolute y position relative to the baseline
* @param yPositionMul
* the position multiplication factor with the font size
* @param cap
* the end line cap. Allowed values are
* PdfContentByte.LINE_CAP_BUTT, PdfContentByte.LINE_CAP_ROUND
* and PdfContentByte.LINE_CAP_PROJECTING_SQUARE
* @return this Chunk
*/
public Chunk setUnderline(final BaseColor color, final float thickness, final float thicknessMul,
final float yPosition, final float yPositionMul, final int cap) {
if (attributes == null)
attributes = new HashMap();
Object obj[] = {
color,
new float[] { thickness, thicknessMul, yPosition, yPositionMul, cap } };
Object unders[][] = Utilities.addToArray((Object[][]) attributes.get(UNDERLINE),
obj);
return setAttribute(UNDERLINE, unders);
}
/** Key for sub/superscript. */
public static final String SUBSUPSCRIPT = "SUBSUPSCRIPT";
/**
* Sets the text displacement relative to the baseline. Positive values rise
* the text, negative values lower the text.
*
* It can be used to implement sub/superscript.
*
* @param rise
* the displacement in points
* @return this Chunk
*/
public Chunk setTextRise(final float rise) {
return setAttribute(SUBSUPSCRIPT, new Float(rise));
}
/**
* Gets the text displacement relative to the baseline.
*
* @return a displacement in points
*/
public float getTextRise() {
if (attributes != null && attributes.containsKey(SUBSUPSCRIPT)) {
Float f = (Float) attributes.get(SUBSUPSCRIPT);
return f.floatValue();
}
return 0.0f;
}
/** Key for text skewing. */
public static final String SKEW = "SKEW";
/**
* Skews the text to simulate italic and other effects. Try alpha=0
* and beta=12.
*
* @param alpha
* the first angle in degrees
* @param beta
* the second angle in degrees
* @return this Chunk
*/
public Chunk setSkew(float alpha, float beta) {
alpha = (float) Math.tan(alpha * Math.PI / 180);
beta = (float) Math.tan(beta * Math.PI / 180);
return setAttribute(SKEW, new float[] { alpha, beta });
}
/** Key for background. */
public static final String BACKGROUND = "BACKGROUND";
/**
* Sets the color of the background Chunk.
*
* @param color
* the color of the background
* @return this Chunk
*/
public Chunk setBackground(final BaseColor color) {
return setBackground(color, 0, 0, 0, 0);
}
/**
* Sets the color and the size of the background Chunk.
*
* @param color
* the color of the background
* @param extraLeft
* increase the size of the rectangle in the left
* @param extraBottom
* increase the size of the rectangle in the bottom
* @param extraRight
* increase the size of the rectangle in the right
* @param extraTop
* increase the size of the rectangle in the top
* @return this Chunk
*/
public Chunk setBackground(final BaseColor color, final float extraLeft, final float extraBottom,
final float extraRight, final float extraTop) {
return setAttribute(BACKGROUND, new Object[] { color,
new float[] { extraLeft, extraBottom, extraRight, extraTop } });
}
/** Key for text rendering mode. */
public static final String TEXTRENDERMODE = "TEXTRENDERMODE";
/**
* Sets the text rendering mode. It can outline text, simulate bold and make
* text invisible.
*
* @param mode
* the text rendering mode. It can be
* PdfContentByte.TEXT_RENDER_MODE_FILL,
* PdfContentByte.TEXT_RENDER_MODE_STROKE,
* PdfContentByte.TEXT_RENDER_MODE_FILL_STROKE and
* PdfContentByte.TEXT_RENDER_MODE_INVISIBLE.
* @param strokeWidth
* the stroke line width for the modes
* PdfContentByte.TEXT_RENDER_MODE_STROKE and
* PdfContentByte.TEXT_RENDER_MODE_FILL_STROKE.
* @param strokeColor
* the stroke color or null to follow the text
* color
* @return this Chunk
*/
public Chunk setTextRenderMode(final int mode, final float strokeWidth,
final BaseColor strokeColor) {
return setAttribute(TEXTRENDERMODE, new Object[] { Integer.valueOf(mode),
new Float(strokeWidth), strokeColor });
}
/** Key for split character. */
public static final String SPLITCHARACTER = "SPLITCHARACTER";
/**
* Sets the split characters.
*
* @param splitCharacter
* the SplitCharacter interface
* @return this Chunk
*/
public Chunk setSplitCharacter(final SplitCharacter splitCharacter) {
return setAttribute(SPLITCHARACTER, splitCharacter);
}
/** Key for hyphenation. */
public static final String HYPHENATION = "HYPHENATION";
/**
* sets the hyphenation engine to this Chunk.
*
* @param hyphenation
* the hyphenation engine
* @return this Chunk
*/
public Chunk setHyphenation(final HyphenationEvent hyphenation) {
return setAttribute(HYPHENATION, hyphenation);
}
/** Key for remote goto. */
public static final String REMOTEGOTO = "REMOTEGOTO";
/**
* Sets a goto for a remote destination for this Chunk.
*
* @param filename
* the file name of the destination document
* @param name
* the name of the destination to go to
* @return this Chunk
*/
public Chunk setRemoteGoto(final String filename, final String name) {
return setAttribute(REMOTEGOTO, new Object[] { filename, name });
}
/**
* Sets a goto for a remote destination for this Chunk.
*
* @param filename
* the file name of the destination document
* @param page
* the page of the destination to go to. First page is 1
* @return this Chunk
*/
public Chunk setRemoteGoto(final String filename, final int page) {
return setAttribute(REMOTEGOTO, new Object[] { filename,
Integer.valueOf(page) });
}
/** Key for local goto. */
public static final String LOCALGOTO = "LOCALGOTO";
/**
* Sets a local goto for this Chunk.
*
* There must be a local destination matching the name.
*
* @param name
* the name of the destination to go to
* @return this Chunk
*/
public Chunk setLocalGoto(final String name) {
return setAttribute(LOCALGOTO, name);
}
/** Key for local destination. */
public static final String LOCALDESTINATION = "LOCALDESTINATION";
/**
* Sets a local destination for this Chunk.
*
* @param name
* the name for this destination
* @return this Chunk
*/
public Chunk setLocalDestination(final String name) {
return setAttribute(LOCALDESTINATION, name);
}
/** Key for generic tag. */
public static final String GENERICTAG = "GENERICTAG";
/**
* Sets the generic tag Chunk.
*
* The text for this tag can be retrieved with PdfPageEvent.
*
* @param text
* the text for the tag
* @return this Chunk
*/
public Chunk setGenericTag(final String text) {
return setAttribute(GENERICTAG, text);
}
/** Key for image. */
public static final String IMAGE = "IMAGE";
/**
* Returns the image.
*
* @return the image
*/
public Image getImage() {
if (attributes == null)
return null;
Object obj[] = (Object[]) attributes.get(Chunk.IMAGE);
if (obj == null)
return null;
else {
return (Image) obj[0];
}
}
/** Key for Action. */
public static final String ACTION = "ACTION";
/**
* Sets an action for this Chunk.
*
* @param action
* the action
* @return this Chunk
*/
public Chunk setAction(final PdfAction action) {
return setAttribute(ACTION, action);
}
/**
* Sets an anchor for this Chunk.
*
* @param url
* the URL to link to
* @return this Chunk
*/
public Chunk setAnchor(final URL url) {
return setAttribute(ACTION, new PdfAction(url.toExternalForm()));
}
/**
* Sets an anchor for this Chunk.
*
* @param url
* the url to link to
* @return this Chunk
*/
public Chunk setAnchor(final String url) {
return setAttribute(ACTION, new PdfAction(url));
}
/** Key for newpage. */
public static final String NEWPAGE = "NEWPAGE";
/**
* Sets a new page tag..
*
* @return this Chunk
*/
public Chunk setNewPage() {
return setAttribute(NEWPAGE, null);
}
/** Key for annotation. */
public static final String PDFANNOTATION = "PDFANNOTATION";
/**
* Sets a generic annotation to this Chunk.
*
* @param annotation
* the annotation
* @return this Chunk
*/
public Chunk setAnnotation(final PdfAnnotation annotation) {
return setAttribute(PDFANNOTATION, annotation);
}
/**
* @see com.itextpdf.text.Element#isContent()
* @since iText 2.0.8
*/
public boolean isContent() {
return true;
}
/**
* @see com.itextpdf.text.Element#isNestable()
* @since iText 2.0.8
*/
public boolean isNestable() {
return true;
}
/**
* Returns the hyphenation (if present).
* @return the HypenationEvent of this Chunk
* @since 2.1.2
*/
public HyphenationEvent getHyphenation() {
if (attributes == null) return null;
return (HyphenationEvent) attributes.get(Chunk.HYPHENATION);
}
// keys used in PdfChunk
/** Key for color. */
public static final String COLOR = "COLOR";
/** Key for encoding. */
public static final String ENCODING = "ENCODING";
/**
* Key for character spacing.
*/
public static final String CHAR_SPACING = "CHAR_SPACING";
/**
* Sets the character spacing.
*
* @param charSpace the character spacing value
* @return this Chunk
*/
public Chunk setCharacterSpacing(final float charSpace) {
return setAttribute(CHAR_SPACING, new Float(charSpace));
}
/**
* Gets the character spacing.
*
* @return a value in float
*/
public float getCharacterSpacing() {
if (attributes != null && attributes.containsKey(CHAR_SPACING)) {
Float f = (Float) attributes.get(CHAR_SPACING);
return f.floatValue();
}
return 0.0f;
}
public static final String WHITESPACE = "WHITESPACE";
public static Chunk createWhitespace(final String content) {
return createWhitespace(content, false);
}
public static Chunk createWhitespace(final String content, final boolean preserve) {
Chunk whitespace = null;
if (!preserve) {
whitespace = new Chunk(' ');
whitespace.setAttribute(WHITESPACE, content);
} else {
whitespace = new Chunk(content);
}
return whitespace;
}
public boolean isWhitespace() {
return attributes != null && attributes.containsKey(WHITESPACE);
}
}