com.itextpdf.text.pdf.PdfPTableEvent Maven / Gradle / Ivy
/*
* $Id: 43320bdebc736588e42cbb8848551fd140e16349 $
*
* This file is part of the iText (R) project.
* Copyright (c) 1998-2016 iText Group NV
* 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
* ITEXT GROUP. ITEXT GROUP 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.pdf;
/** An interface that can be used to retrieve the position of cells in PdfPTable.
*
* @author Paulo Soares
*/
public interface PdfPTableEvent {
/** This method is called at the end of the table rendering. The text or graphics are added to
* one of the 4 PdfContentByte contained in
* canvases.
* The indexes to canvases are:
*
* PdfPTable.BASECANVAS - the original PdfContentByte. Anything placed here
* will be under the table.
* PdfPTable.BACKGROUNDCANVAS - the layer where the background goes to.
* PdfPTable.LINECANVAS - the layer where the lines go to.
* PdfPTable.TEXTCANVAS - the layer where the text go to. Anything placed here
* will be over the table.
*
* The layers are placed in sequence on top of each other.
*
* The widths and heights have the coordinates of the cells.
* The size of the widths array is the number of rows.
* Each sub-array in widths corresponds to the x column border positions where
* the first element is the x coordinate of the left table border and the last
* element is the x coordinate of the right table border.
* If colspan is not used all the sub-arrays in widths
* are the same.
* For the heights the first element is the y coordinate of the top table border and the last
* element is the y coordinate of the bottom table border.
* @param table the PdfPTable in use
* @param widths an array of arrays with the cells' x positions. It has the length of the number
* of rows
* @param heights an array with the cells' y positions. It has a length of the number
* of rows + 1
* @param headerRows the number of rows defined for the header.
* @param rowStart the first row number after the header
* @param canvases an array of PdfContentByte
*/
public void tableLayout(PdfPTable table, float widths[][], float heights[], int headerRows, int rowStart, PdfContentByte[] canvases);
}