001/*
002 * $Id: TextMarginFinder.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, 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.parser;
045
046import java.awt.geom.Rectangle2D;
047
048/**
049 * Allows you to find the rectangle that contains all the text in a page.
050 * @since 5.0.2
051 */
052public class TextMarginFinder implements RenderListener {
053    private Rectangle2D.Float textRectangle = null;
054    
055        /**
056         * Method invokes by the PdfContentStreamProcessor.
057         * Passes a TextRenderInfo for every text chunk that is encountered.
058         * We'll use this object to obtain coordinates.
059         * @see com.itextpdf.text.pdf.parser.RenderListener#renderText(com.itextpdf.text.pdf.parser.TextRenderInfo)
060         */
061        public void renderText(TextRenderInfo renderInfo) {
062                if (textRectangle == null)
063                    textRectangle = renderInfo.getDescentLine().getBoundingRectange();
064                else
065                    textRectangle.add(renderInfo.getDescentLine().getBoundingRectange());
066                
067                textRectangle.add(renderInfo.getAscentLine().getBoundingRectange());
068
069        }
070
071        /**
072         * Getter for the left margin.
073         * @return the X position of the left margin
074         */
075        public float getLlx() {
076            return textRectangle.x;
077        }
078
079        /**
080         * Getter for the bottom margin.
081         * @return the Y position of the bottom margin
082         */
083        public float getLly() {
084        return textRectangle.y;
085        }
086
087        /**
088         * Getter for the right margin.
089         * @return the X position of the right margin
090         */
091        public float getUrx() {
092                return textRectangle.x + textRectangle.width;
093        }
094
095        /**
096         * Getter for the top margin.
097         * @return the Y position of the top margin
098         */
099        public float getUry() {
100                return textRectangle.y + textRectangle.height;
101        }
102
103        /**
104         * Gets the width of the text block.
105         * @return a width
106         */
107        public float getWidth() {
108                return textRectangle.width;
109        }
110        
111        /**
112         * Gets the height of the text block.
113         * @return a height
114         */
115        public float getHeight() {
116                return textRectangle.height;
117        }
118        
119        /**
120         * @see com.itextpdf.text.pdf.parser.RenderListener#beginTextBlock()
121         */
122        public void beginTextBlock() {
123        // do nothing
124        }
125
126        /**
127         * @see com.itextpdf.text.pdf.parser.RenderListener#endTextBlock()
128         */
129        public void endTextBlock() {
130        // do nothing
131        }
132
133        /**
134         * @see com.itextpdf.text.pdf.parser.RenderListener#renderImage(com.itextpdf.text.pdf.parser.ImageRenderInfo)
135         */
136        public void renderImage(ImageRenderInfo renderInfo) {
137            // do nothing
138        }
139}