1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
/*
* $Id: PdfPageEvent.java,v 1.23 2002/07/09 11:28:24 blowagie Exp $
* $Name: $
*
* Copyright 2001, 2002 Paulo Soares
*
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* http://www.lowagie.com/iText/
*/
package com.lowagie.text.pdf;
import com.lowagie.text.Document;
import com.lowagie.text.Rectangle;
import com.lowagie.text.Paragraph;
/**
* Allows a class to catch several document events.
*<p>
* Note: do not use Document.add() inside a page event.
*
* @author Paulo Soares (psoares@consiste.pt)
*/
public interface PdfPageEvent {
/**
* Called when the document is opened.
*
* @param writer the <CODE>PdfWriter</CODE> for this document
* @param document the document
*/
public void onOpenDocument(PdfWriter writer, Document document);
/**
* Called when a page is initialized.
* <P>
* Note that if even if a page is not written this method is still
* called. It is preferable to use <CODE>onEndPage</CODE> to avoid
* infinite loops.
*
* @param writer the <CODE>PdfWriter</CODE> for this document
* @param document the document
*/
public void onStartPage(PdfWriter writer, Document document);
/**
* Called when a page is finished, just before being written to the document.
*
* @param writer the <CODE>PdfWriter</CODE> for this document
* @param document the document
*/
public void onEndPage(PdfWriter writer, Document document);
/**
* Called when the document is closed.
* <P>
* Note that this method is called with the page number equal
* to the last page plus one.
*
* @param writer the <CODE>PdfWriter</CODE> for this document
* @param document the document
*/
public void onCloseDocument(PdfWriter writer, Document document);
/**
* Called when a Paragraph is written.
* <P>
* <CODE>paragraphPosition</CODE> will hold the height at which the
* paragraph will be written to. This is useful to insert bookmarks with
* more control.
*
* @param writer the <CODE>PdfWriter</CODE> for this document
* @param document the document
* @param paragraphPosition the position the paragraph will be written to
*/
public void onParagraph(PdfWriter writer, Document document, float paragraphPosition);
/**
* Called when a Paragraph is written.
* <P>
* <CODE>paragraphPosition</CODE> will hold the height of the end of the paragraph.
*
* @param writer the <CODE>PdfWriter</CODE> for this document
* @param document the document
* @param paragraphPosition the position of the end of the paragraph
*/
public void onParagraphEnd(PdfWriter writer,Document document,float paragraphPosition);
/**
* Called when a Chapter is written.
* <P>
* <CODE>position</CODE> will hold the height at which the
* chapter will be written to.
*
* @param writer the <CODE>PdfWriter</CODE> for this document
* @param document the document
* @param paragraphPosition the position the chapter will be written to
* @param title the title of the Chapter
*/
public void onChapter(PdfWriter writer,Document document,float paragraphPosition, Paragraph title);
/**
* Called when the end of a Chapter is reached.
* <P>
* <CODE>position</CODE> will hold the height of the end of the chapter.
*
* @param writer the <CODE>PdfWriter</CODE> for this document
* @param document the document
* @param paragraphPosition the position the chapter will be written to
*/
public void onChapterEnd(PdfWriter writer,Document document,float paragraphPosition);
/**
* Called when a Section is written.
* <P>
* <CODE>position</CODE> will hold the height at which the
* section will be written to.
*
* @param writer the <CODE>PdfWriter</CODE> for this document
* @param document the document
* @param paragraphPosition the position the section will be written to
* @param depth the number depth of the section
* @param title the title of the section
*/
public void onSection(PdfWriter writer,Document document,float paragraphPosition, int depth, Paragraph title);
/**
* Called when the end of a Section is reached.
* <P>
* <CODE>position</CODE> will hold the height of the section end.
*
* @param writer the <CODE>PdfWriter</CODE> for this document
* @param document the document
* @param paragraphPosition the position the section will be written to
*/
public void onSectionEnd(PdfWriter writer,Document document,float paragraphPosition);
/**
* Called when a <CODE>Chunk</CODE> with a generic tag is written.
* <P>
* It is usefull to pinpoint the <CODE>Chunk</CODE> location to generate
* bookmarks, for example.
*
* @param writer the <CODE>PdfWriter</CODE> for this document
* @param document the document
* @param rect the <CODE>Rectangle</CODE> containing the <CODE>Chunk</CODE>
* @param text the text of the tag
*/
public void onGenericTag(PdfWriter writer, Document document, Rectangle rect, String text);
}
|
