001/* 002 * $Id: PdfPageEvent.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; 045import com.itextpdf.text.Document; 046import com.itextpdf.text.Paragraph; 047import com.itextpdf.text.Rectangle; 048 049/** 050 * Allows a class to catch several document events. 051 *<p> 052 * Note: do not use Document.add() inside a page event. 053 * 054 * @author Paulo Soares 055 */ 056 057public interface PdfPageEvent { 058 059/** 060 * Called when the document is opened. 061 * 062 * @param writer the <CODE>PdfWriter</CODE> for this document 063 * @param document the document 064 */ 065 public void onOpenDocument(PdfWriter writer, Document document); 066 067/** 068 * Called when a page is initialized. 069 * <P> 070 * Note that if even if a page is not written this method is still 071 * called. It is preferable to use <CODE>onEndPage</CODE> to avoid 072 * infinite loops. 073 * 074 * @param writer the <CODE>PdfWriter</CODE> for this document 075 * @param document the document 076 */ 077 public void onStartPage(PdfWriter writer, Document document); 078 079/** 080 * Called when a page is finished, just before being written to the document. 081 * 082 * @param writer the <CODE>PdfWriter</CODE> for this document 083 * @param document the document 084 */ 085 public void onEndPage(PdfWriter writer, Document document); 086 087/** 088 * Called when the document is closed. 089 * <P> 090 * Note that this method is called with the page number equal 091 * to the last page plus one. 092 * 093 * @param writer the <CODE>PdfWriter</CODE> for this document 094 * @param document the document 095 */ 096 public void onCloseDocument(PdfWriter writer, Document document); 097 098/** 099 * Called when a Paragraph is written. 100 * <P> 101 * <CODE>paragraphPosition</CODE> will hold the height at which the 102 * paragraph will be written to. This is useful to insert bookmarks with 103 * more control. 104 * 105 * @param writer the <CODE>PdfWriter</CODE> for this document 106 * @param document the document 107 * @param paragraphPosition the position the paragraph will be written to 108 */ 109 public void onParagraph(PdfWriter writer, Document document, float paragraphPosition); 110 111/** 112 * Called when a Paragraph is written. 113 * <P> 114 * <CODE>paragraphPosition</CODE> will hold the height of the end of the paragraph. 115 * 116 * @param writer the <CODE>PdfWriter</CODE> for this document 117 * @param document the document 118 * @param paragraphPosition the position of the end of the paragraph 119 */ 120 public void onParagraphEnd(PdfWriter writer,Document document,float paragraphPosition); 121 122/** 123 * Called when a Chapter is written. 124 * <P> 125 * <CODE>position</CODE> will hold the height at which the 126 * chapter will be written to. 127 * 128 * @param writer the <CODE>PdfWriter</CODE> for this document 129 * @param document the document 130 * @param paragraphPosition the position the chapter will be written to 131 * @param title the title of the Chapter 132 */ 133 public void onChapter(PdfWriter writer,Document document,float paragraphPosition, Paragraph title); 134 135/** 136 * Called when the end of a Chapter is reached. 137 * <P> 138 * <CODE>position</CODE> will hold the height of the end of the chapter. 139 * 140 * @param writer the <CODE>PdfWriter</CODE> for this document 141 * @param document the document 142 * @param paragraphPosition the position the chapter will be written to 143 */ 144 public void onChapterEnd(PdfWriter writer,Document document,float paragraphPosition); 145 146/** 147 * Called when a Section is written. 148 * <P> 149 * <CODE>position</CODE> will hold the height at which the 150 * section will be written to. 151 * 152 * @param writer the <CODE>PdfWriter</CODE> for this document 153 * @param document the document 154 * @param paragraphPosition the position the section will be written to 155 * @param depth the number depth of the section 156 * @param title the title of the section 157 */ 158 public void onSection(PdfWriter writer,Document document,float paragraphPosition, int depth, Paragraph title); 159 160/** 161 * Called when the end of a Section is reached. 162 * <P> 163 * <CODE>position</CODE> will hold the height of the section end. 164 * 165 * @param writer the <CODE>PdfWriter</CODE> for this document 166 * @param document the document 167 * @param paragraphPosition the position the section will be written to 168 */ 169 public void onSectionEnd(PdfWriter writer,Document document,float paragraphPosition); 170 171/** 172 * Called when a <CODE>Chunk</CODE> with a generic tag is written. 173 * <P> 174 * It is useful to pinpoint the <CODE>Chunk</CODE> location to generate 175 * bookmarks, for example. 176 * 177 * @param writer the <CODE>PdfWriter</CODE> for this document 178 * @param document the document 179 * @param rect the <CODE>Rectangle</CODE> containing the <CODE>Chunk</CODE> 180 * @param text the text of the tag 181 */ 182 public void onGenericTag(PdfWriter writer, Document document, Rectangle rect, String text); 183}