KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > DocListener


1 /*
2  * $Id: DocListener.java 2564 2007-02-01 15:47:38Z blowagie $
3  * $Name$
4  *
5  * Copyright (c) 1999, 2000, 2001, 2002 Bruno Lowagie.
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;
52
53 /**
54  * A class that implements <CODE>DocListener</CODE> will perform some
55  * actions when some actions are performed on a <CODE>Document</CODE>.
56  *
57  * @see ElementListener
58  * @see Document
59  * @see DocWriter
60  */
61
62 public interface DocListener extends ElementListener {
63     
64     // methods
65
66     /**
67      * Signals that the <CODE>Document</CODE> has been opened and that
68      * <CODE>Elements</CODE> can be added.
69      */
70     
71     public void open(); // [L1]
72
73     /**
74      * Signals that the <CODE>Document</CODE> was closed and that no other
75      * <CODE>Elements</CODE> will be added.
76      * <P>
77      * The outputstream of every writer implementing <CODE>DocListener</CODE> will be closed.
78      */
79         
80     public void close(); // [L2]
81
82     /**
83      * Signals that an new page has to be started.
84      *
85      * @return <CODE>true</CODE> if the page was added, <CODE>false</CODE> if not.
86      * @throws DocumentException when a document isn't open yet, or has been closed
87      */
88         
89     public boolean newPage(); // [L3]
90
91     /**
92      * Sets the pagesize.
93      *
94      * @param pageSize the new pagesize
95      * @return a <CODE>boolean</CODE>
96      */
97         
98     public boolean setPageSize(Rectangle pageSize); // [L4]
99
100     /**
101      * Sets the margins.
102      *
103      * @param marginLeft the margin on the left
104      * @param marginRight the margin on the right
105      * @param marginTop the margin on the top
106      * @param marginBottom the margin on the bottom
107      * @return a <CODE>boolean</CODE>
108      */
109         
110     public boolean setMargins(float marginLeft, float marginRight, float marginTop, float marginBottom); // [L5]
111
112     /**
113      * Parameter that allows you to do margin mirroring (odd/even pages)
114      * @param marginMirroring
115      * @return true if succesfull
116      */
117     public boolean setMarginMirroring(boolean marginMirroring); // [L6]
118
119     /**
120      * Sets the page number.
121      *
122      * @param pageN the new page number
123      */
124         
125     public void setPageCount(int pageN); // [L7]
126
127     /**
128      * Sets the page number to 0.
129      */
130         
131     public void resetPageCount(); // [L8]
132
133     /**
134      * Changes the header of this document.
135      *
136      * @param header the new header
137      */
138     
139     public void setHeader(HeaderFooter header); // [L9]
140
141     /**
142      * Resets the header of this document.
143      */
144     
145     public void resetHeader(); // [L10]
146
147     /**
148      * Changes the footer of this document.
149      *
150      * @param footer the new footer
151      */
152     
153     public void setFooter(HeaderFooter footer); // [L11]
154
155     /**
156      * Resets the footer of this document.
157      */
158     
159     public void resetFooter(); // [L12]
160
161 }
Popular Tags