001: /*
002: * $Id: DocListener.java 2564 2007-02-01 15:47:38Z blowagie $
003: * $Name$
004: *
005: * Copyright (c) 1999, 2000, 2001, 2002 Bruno Lowagie.
006: *
007: * The contents of this file are subject to the Mozilla Public License Version 1.1
008: * (the "License"); you may not use this file except in compliance with the License.
009: * You may obtain a copy of the License at http://www.mozilla.org/MPL/
010: *
011: * Software distributed under the License is distributed on an "AS IS" basis,
012: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
013: * for the specific language governing rights and limitations under the License.
014: *
015: * The Original Code is 'iText, a free JAVA-PDF library'.
016: *
017: * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
018: * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
019: * All Rights Reserved.
020: * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
021: * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
022: *
023: * Contributor(s): all the names of the contributors are added in the source code
024: * where applicable.
025: *
026: * Alternatively, the contents of this file may be used under the terms of the
027: * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
028: * provisions of LGPL are applicable instead of those above. If you wish to
029: * allow use of your version of this file only under the terms of the LGPL
030: * License and not to allow others to use your version of this file under
031: * the MPL, indicate your decision by deleting the provisions above and
032: * replace them with the notice and other provisions required by the LGPL.
033: * If you do not delete the provisions above, a recipient may use your version
034: * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
035: *
036: * This library is free software; you can redistribute it and/or modify it
037: * under the terms of the MPL as stated above or under the terms of the GNU
038: * Library General Public License as published by the Free Software Foundation;
039: * either version 2 of the License, or any later version.
040: *
041: * This library is distributed in the hope that it will be useful, but WITHOUT
042: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
043: * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
044: * details.
045: *
046: * If you didn't download this code from the following link, you should check if
047: * you aren't using an obsolete version:
048: * http://www.lowagie.com/iText/
049: */
050:
051: package com.lowagie.text;
052:
053: /**
054: * A class that implements <CODE>DocListener</CODE> will perform some
055: * actions when some actions are performed on a <CODE>Document</CODE>.
056: *
057: * @see ElementListener
058: * @see Document
059: * @see DocWriter
060: */
061:
062: public interface DocListener extends ElementListener {
063:
064: // methods
065:
066: /**
067: * Signals that the <CODE>Document</CODE> has been opened and that
068: * <CODE>Elements</CODE> can be added.
069: */
070:
071: public void open(); // [L1]
072:
073: /**
074: * Signals that the <CODE>Document</CODE> was closed and that no other
075: * <CODE>Elements</CODE> will be added.
076: * <P>
077: * The outputstream of every writer implementing <CODE>DocListener</CODE> will be closed.
078: */
079:
080: public void close(); // [L2]
081:
082: /**
083: * Signals that an new page has to be started.
084: *
085: * @return <CODE>true</CODE> if the page was added, <CODE>false</CODE> if not.
086: * @throws DocumentException when a document isn't open yet, or has been closed
087: */
088:
089: public boolean newPage(); // [L3]
090:
091: /**
092: * Sets the pagesize.
093: *
094: * @param pageSize the new pagesize
095: * @return a <CODE>boolean</CODE>
096: */
097:
098: public boolean setPageSize(Rectangle pageSize); // [L4]
099:
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,
111: float marginTop, float marginBottom); // [L5]
112:
113: /**
114: * Parameter that allows you to do margin mirroring (odd/even pages)
115: * @param marginMirroring
116: * @return true if succesfull
117: */
118: public boolean setMarginMirroring(boolean marginMirroring); // [L6]
119:
120: /**
121: * Sets the page number.
122: *
123: * @param pageN the new page number
124: */
125:
126: public void setPageCount(int pageN); // [L7]
127:
128: /**
129: * Sets the page number to 0.
130: */
131:
132: public void resetPageCount(); // [L8]
133:
134: /**
135: * Changes the header of this document.
136: *
137: * @param header the new header
138: */
139:
140: public void setHeader(HeaderFooter header); // [L9]
141:
142: /**
143: * Resets the header of this document.
144: */
145:
146: public void resetHeader(); // [L10]
147:
148: /**
149: * Changes the footer of this document.
150: *
151: * @param footer the new footer
152: */
153:
154: public void setFooter(HeaderFooter footer); // [L11]
155:
156: /**
157: * Resets the footer of this document.
158: */
159:
160: public void resetFooter(); // [L12]
161:
162: }
|