001/*
002 * $Id: PdfTextArray.java 4784 2011-03-15 08:33:00Z blowagie $
003 *
004 * This file is part of the iText (R) project.
005 * Copyright (c) 1998-2011 1T3XT BVBA
006 * Authors: Bruno Lowagie, Paulo Soares, et al.
007 *
008 * This program is free software; you can redistribute it and/or modify
009 * it under the terms of the GNU Affero General Public License version 3
010 * as published by the Free Software Foundation with the addition of the
011 * following permission added to Section 15 as permitted in Section 7(a):
012 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY 1T3XT,
013 * 1T3XT DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
014 *
015 * This program is distributed in the hope that it will be useful, but
016 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
017 * or FITNESS FOR A PARTICULAR PURPOSE.
018 * See the GNU Affero General Public License for more details.
019 * You should have received a copy of the GNU Affero General Public License
020 * along with this program; if not, see http://www.gnu.org/licenses or write to
021 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
022 * Boston, MA, 02110-1301 USA, or download the license from the following URL:
023 * http://itextpdf.com/terms-of-use/
024 *
025 * The interactive user interfaces in modified source and object code versions
026 * of this program must display Appropriate Legal Notices, as required under
027 * Section 5 of the GNU Affero General Public License.
028 *
029 * In accordance with Section 7(b) of the GNU Affero General Public License,
030 * a covered work must retain the producer line in every PDF that is created
031 * or manipulated using iText.
032 *
033 * You can be released from the requirements of the license by purchasing
034 * a commercial license. Buying such a license is mandatory as soon as you
035 * develop commercial activities involving the iText software without
036 * disclosing the source code of your own applications.
037 * These activities include: offering paid services to customers as an ASP,
038 * serving PDFs on the fly in a web application, shipping iText with a closed
039 * source product.
040 *
041 * For more information, please contact iText Software Corp. at this
042 * address: sales@itextpdf.com
043 */
044package com.itextpdf.text.pdf;
045
046import java.util.ArrayList;
047
048/**
049 * <CODE>PdfTextArray</CODE> defines an array with displacements and <CODE>PdfString</CODE>-objects.
050 * <P>
051 * A <CODE>TextArray</CODE> is used with the operator <VAR>TJ</VAR> in <CODE>PdfText</CODE>.
052 * The first object in this array has to be a <CODE>PdfString</CODE>;
053 * see reference manual version 1.3 section 8.7.5, pages 346-347.
054 *       OR
055 * see reference manual version 1.6 section 5.3.2, pages 378-379.
056 */
057
058public class PdfTextArray{
059    ArrayList<Object> arrayList = new ArrayList<Object>();
060
061    // To emit a more efficient array, we consolidate
062    // repeated numbers or strings into single array entries.
063    // "add( 50 ); add( -50 );" will REMOVE the combined zero from the array.
064    // the alternative (leaving a zero in there) was Just Weird.
065    // --Mark Storer, May 12, 2008
066    private String lastStr;
067    private Float lastNum;
068
069    // constructors
070    public PdfTextArray(String str) {
071        add(str);
072    }
073
074    public PdfTextArray() {
075    }
076
077    /**
078     * Adds a <CODE>PdfNumber</CODE> to the <CODE>PdfArray</CODE>.
079     *
080     * @param  number   displacement of the string
081     */
082    public void add(PdfNumber number) {
083        add((float) number.doubleValue());
084    }
085
086    public void add(float number) {
087        if (number != 0) {
088            if (lastNum != null) {
089                lastNum = new Float(number + lastNum.floatValue());
090                if (lastNum.floatValue() != 0) {
091                    replaceLast(lastNum);
092                } else {
093                    arrayList.remove(arrayList.size() - 1);
094                }
095            } else {
096                lastNum = new Float(number);
097                arrayList.add(lastNum);
098            }
099
100            lastStr = null;
101        }
102        // adding zero doesn't modify the TextArray at all
103    }
104
105    public void add(String str) {
106        if (str.length() > 0) {
107            if (lastStr != null) {
108                lastStr = lastStr + str;
109                replaceLast(lastStr);
110            } else {
111                lastStr = str;
112                arrayList.add(lastStr);
113            }
114            lastNum = null;
115        }
116        // adding an empty string doesn't modify the TextArray at all
117    }
118
119    ArrayList<Object> getArrayList() {
120        return arrayList;
121    }
122
123    private void replaceLast(Object obj) {
124        // deliberately throw the IndexOutOfBoundsException if we screw up.
125        arrayList.set(arrayList.size() - 1, obj);
126    }
127}