KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > pdf > PdfPTableEvent


1 /*
2  * $Id: PdfPTableEvent.java 1733 2005-05-04 14:33:54Z blowagie $
3  * $Name$
4  *
5  * Copyright 2001, 2002 Paulo Soares
6  *
7  * The contents of this file are subject to the Mozilla Public License Version 1.1
8  * (the "License"); you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
10  *
11  * Software distributed under the License is distributed on an "AS IS" basis,
12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13  * for the specific language governing rights and limitations under the License.
14  *
15  * The Original Code is 'iText, a free JAVA-PDF library'.
16  *
17  * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
18  * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
19  * All Rights Reserved.
20  * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
21  * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
22  *
23  * Contributor(s): all the names of the contributors are added in the source code
24  * where applicable.
25  *
26  * Alternatively, the contents of this file may be used under the terms of the
27  * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
28  * provisions of LGPL are applicable instead of those above. If you wish to
29  * allow use of your version of this file only under the terms of the LGPL
30  * License and not to allow others to use your version of this file under
31  * the MPL, indicate your decision by deleting the provisions above and
32  * replace them with the notice and other provisions required by the LGPL.
33  * If you do not delete the provisions above, a recipient may use your version
34  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
35  *
36  * This library is free software; you can redistribute it and/or modify it
37  * under the terms of the MPL as stated above or under the terms of the GNU
38  * Library General Public License as published by the Free Software Foundation;
39  * either version 2 of the License, or any later version.
40  *
41  * This library is distributed in the hope that it will be useful, but WITHOUT
42  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
43  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
44  * details.
45  *
46  * If you didn't download this code from the following link, you should check if
47  * you aren't using an obsolete version:
48  * http://www.lowagie.com/iText/
49  */
50
51 package com.lowagie.text.pdf;
52
53 /** An interface that can be used to retrieve the position of cells in <CODE>PdfPTable</CODE>.
54  *
55  * @author Paulo Soares (psoares@consiste.pt)
56  */
57 public interface PdfPTableEvent {
58     
59     /** This method is called at the end of the table rendering. The text or graphics are added to
60      * one of the 4 <CODE>PdfContentByte</CODE> contained in
61      * <CODE>canvases</CODE>.<br>
62      * The indexes to <CODE>canvases</CODE> are:<p>
63      * <ul>
64      * <li><CODE>PdfPTable.BASECANVAS</CODE> - the original <CODE>PdfContentByte</CODE>. Anything placed here
65      * will be under the table.
66      * <li><CODE>PdfPTable.BACKGROUNDCANVAS</CODE> - the layer where the background goes to.
67      * <li><CODE>PdfPTable.LINECANVAS</CODE> - the layer where the lines go to.
68      * <li><CODE>PdfPTable.TEXTCANVAS</CODE> - the layer where the text go to. Anything placed here
69      * will be over the table.
70      * </ul>
71      * The layers are placed in sequence on top of each other.
72      * <p>
73      * The <CODE>widths</CODE> and <CODE>heights</CODE> have the coordinates of the cells.<br>
74      * The size of the <CODE>widths</CODE> array is the number of rows.
75      * Each sub-array in <CODE>widths</CODE> corresponds to the x column border positions where
76      * the first element is the x coordinate of the left table border and the last
77      * element is the x coordinate of the right table border.
78      * If colspan is not used all the sub-arrays in <CODE>widths</CODE>
79      * are the same.<br>
80      * For the <CODE>heights</CODE> the first element is the y coordinate of the top table border and the last
81      * element is the y coordinate of the bottom table border.
82      * @param table the <CODE>PdfPTable</CODE> in use
83      * @param widths an array of arrays with the cells' x positions. It has the length of the number
84      * of rows
85      * @param heights an array with the cells' y positions. It has a length of the number
86      * of rows + 1
87      * @param headerRows the number of rows defined for the header.
88      * @param rowStart the first row number after the header
89      * @param canvases an array of <CODE>PdfContentByte</CODE>
90      */
91     public void tableLayout(PdfPTable table, float widths[][], float heights[], int headerRows, int rowStart, PdfContentByte[] canvases);
92
93 }
94
95
Popular Tags