KickJava   Java API By Example, From Geeks To Geeks.

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


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