001/*
002 * $Id: PdfPTableEvent.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
046/** An interface that can be used to retrieve the position of cells in <CODE>PdfPTable</CODE>.
047 *
048 * @author Paulo Soares
049 */
050public interface PdfPTableEvent {
051    
052    /** This method is called at the end of the table rendering. The text or graphics are added to
053     * one of the 4 <CODE>PdfContentByte</CODE> contained in
054     * <CODE>canvases</CODE>.<br>
055     * The indexes to <CODE>canvases</CODE> are:<p>
056     * <ul>
057     * <li><CODE>PdfPTable.BASECANVAS</CODE> - the original <CODE>PdfContentByte</CODE>. Anything placed here
058     * will be under the table.
059     * <li><CODE>PdfPTable.BACKGROUNDCANVAS</CODE> - the layer where the background goes to.
060     * <li><CODE>PdfPTable.LINECANVAS</CODE> - the layer where the lines go to.
061     * <li><CODE>PdfPTable.TEXTCANVAS</CODE> - the layer where the text go to. Anything placed here
062     * will be over the table.
063     * </ul>
064     * The layers are placed in sequence on top of each other.
065     * <p>
066     * The <CODE>widths</CODE> and <CODE>heights</CODE> have the coordinates of the cells.<br>
067     * The size of the <CODE>widths</CODE> array is the number of rows.
068     * Each sub-array in <CODE>widths</CODE> corresponds to the x column border positions where
069     * the first element is the x coordinate of the left table border and the last
070     * element is the x coordinate of the right table border. 
071     * If colspan is not used all the sub-arrays in <CODE>widths</CODE>
072     * are the same.<br>
073     * For the <CODE>heights</CODE> the first element is the y coordinate of the top table border and the last
074     * element is the y coordinate of the bottom table border.
075     * @param table the <CODE>PdfPTable</CODE> in use
076     * @param widths an array of arrays with the cells' x positions. It has the length of the number
077     * of rows
078     * @param heights an array with the cells' y positions. It has a length of the number
079     * of rows + 1
080     * @param headerRows the number of rows defined for the header.
081     * @param rowStart the first row number after the header
082     * @param canvases an array of <CODE>PdfContentByte</CODE>
083     */    
084    public void tableLayout(PdfPTable table, float widths[][], float heights[], int headerRows, int rowStart, PdfContentByte[] canvases);
085
086}
087