KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: PdfPageEventHelper.java 2366 2006-09-14 23:10:58Z xlv $
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 import com.lowagie.text.Document;
53 import com.lowagie.text.Paragraph;
54 import com.lowagie.text.Rectangle;
55
56 /**
57  * Helps the use of <CODE>PdfPageEvent</CODE> by implementing all the interface methods.
58  * A class can extend <CODE>PdfPageEventHelper</CODE> and only implement the
59  * needed methods.
60  *<p>
61  * Note: do not use Document.add() inside a page event.
62  * @author Paulo Soares (psoares@consiste.pt)
63  */
64
65 public class PdfPageEventHelper implements PdfPageEvent {
66     
67 /**
68  * Called when the document is opened.
69  *
70  * @param writer the <CODE>PdfWriter</CODE> for this document
71  * @param document the document
72  */
73     public void onOpenDocument(PdfWriter writer,Document document) {
74     }
75     
76 /**
77  * Called when a page is initialized.
78  * <P>
79  * Note that if even if a page is not written this method is still
80  * called. It is preferable to use <CODE>onEndPage</CODE> to avoid
81  * infinite loops.
82  *
83  * @param writer the <CODE>PdfWriter</CODE> for this document
84  * @param document the document
85  */
86     public void onStartPage(PdfWriter writer,Document document) {
87     }
88     
89 /**
90  * Called when a page is finished, just before being written to the document.
91  *
92  * @param writer the <CODE>PdfWriter</CODE> for this document
93  * @param document the document
94  */
95     public void onEndPage(PdfWriter writer,Document document) {
96     }
97     
98 /**
99  * Called when the document is closed.
100  * <P>
101  * Note that this method is called with the page number equal
102  * to the last page plus one.
103  *
104  * @param writer the <CODE>PdfWriter</CODE> for this document
105  * @param document the document
106  */
107     public void onCloseDocument(PdfWriter writer,Document document) {
108     }
109     
110 /**
111  * Called when a Paragraph is written.
112  * <P>
113  * <CODE>paragraphPosition</CODE> will hold the height at which the
114  * paragraph will be written to. This is useful to insert bookmarks with
115  * more control.
116  *
117  * @param writer the <CODE>PdfWriter</CODE> for this document
118  * @param document the document
119  * @param paragraphPosition the position the paragraph will be written to
120  */
121     public void onParagraph(PdfWriter writer,Document document,float paragraphPosition) {
122     }
123     
124 /**
125  * Called when a Paragraph is written.
126  * <P>
127  * <CODE>paragraphPosition</CODE> will hold the height of the end of the paragraph.
128  *
129  * @param writer the <CODE>PdfWriter</CODE> for this document
130  * @param document the document
131  * @param paragraphPosition the position of the end of the paragraph
132  */
133     public void onParagraphEnd(PdfWriter writer,Document document,float paragraphPosition) {
134     }
135     
136 /**
137  * Called when a Chapter is written.
138  * <P>
139  * <CODE>position</CODE> will hold the height at which the
140  * chapter will be written to.
141  *
142  * @param writer the <CODE>PdfWriter</CODE> for this document
143  * @param document the document
144  * @param paragraphPosition the position the chapter will be written to
145  * @param title the title of the Chapter
146  */
147     public void onChapter(PdfWriter writer,Document document,float paragraphPosition,Paragraph title) {
148     }
149     
150 /**
151  * Called when the end of a Chapter is reached.
152  * <P>
153  * <CODE>position</CODE> will hold the height of the end of the chapter.
154  *
155  * @param writer the <CODE>PdfWriter</CODE> for this document
156  * @param document the document
157  * @param position the position of the end of the chapter.
158  */
159     public void onChapterEnd(PdfWriter writer,Document document,float position) {
160     }
161     
162 /**
163  * Called when a Section is written.
164  * <P>
165  * <CODE>position</CODE> will hold the height at which the
166  * section will be written to.
167  *
168  * @param writer the <CODE>PdfWriter</CODE> for this document
169  * @param document the document
170  * @param paragraphPosition the position the section will be written to
171  * @param depth the number depth of the Section
172  * @param title the title of the section
173  */
174     public void onSection(PdfWriter writer,Document document,float paragraphPosition,int depth,Paragraph title) {
175     }
176     
177 /**
178  * Called when the end of a Section is reached.
179  * <P>
180  * <CODE>position</CODE> will hold the height of the section end.
181  *
182  * @param writer the <CODE>PdfWriter</CODE> for this document
183  * @param document the document
184  * @param position the position of the end of the section
185  */
186     public void onSectionEnd(PdfWriter writer,Document document,float position) {
187     }
188     
189 /**
190  * Called when a <CODE>Chunk</CODE> with a generic tag is written.
191  * <P>
192  * It is usefull to pinpoint the <CODE>Chunk</CODE> location to generate
193  * bookmarks, for example.
194  *
195  * @param writer the <CODE>PdfWriter</CODE> for this document
196  * @param document the document
197  * @param rect the <CODE>Rectangle</CODE> containing the <CODE>Chunk</CODE>
198  * @param text the text of the tag
199  */
200     public void onGenericTag(PdfWriter writer,Document document,Rectangle rect,String JavaDoc text) {
201     }
202 }
203
Popular Tags