KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > rtf > field > RtfPageNumber


1 /*
2  * $Id: RtfPageNumber.java 2776 2007-05-23 20:01:40Z hallm $
3  * $Name$
4  *
5  * Copyright 2001, 2002, 2003, 2004 by Mark Hall
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.rtf.field;
52
53 import java.io.IOException JavaDoc;
54 import java.io.OutputStream JavaDoc;
55
56 import com.lowagie.text.Font;
57 import com.lowagie.text.rtf.document.RtfDocument;
58
59
60 /**
61  * The RtfPageNumber provides the page number field in rtf documents.
62  *
63  * @version $Id: RtfPageNumber.java 2776 2007-05-23 20:01:40Z hallm $
64  * @author Mark Hall (mhall@edu.uni-klu.ac.at)
65  * @author Steffen.Stundzig (Steffen.Stundzig@smb-tec.com)
66  * @author Thomas Bickel (tmb99@inode.at)
67  */
68 public class RtfPageNumber extends RtfField {
69
70     /**
71      * Constant for the page number
72      */
73     private static final byte[] PAGE_NUMBER = "PAGE".getBytes();
74     
75     /**
76      * Constructs a RtfPageNumber. This can be added anywhere to add a page number field.
77      */
78     public RtfPageNumber() {
79         super(null);
80     }
81     
82     /**
83      * Constructs a RtfPageNumber with a specified Font. This can be added anywhere to
84      * add a page number field.
85      * @param font
86      */
87     public RtfPageNumber(Font font) {
88         super(null, font);
89     }
90     
91     /**
92      * Constructs a RtfPageNumber object.
93      *
94      * @param doc The RtfDocument this RtfPageNumber belongs to
95      */
96     public RtfPageNumber(RtfDocument doc) {
97         super(doc);
98     }
99     
100     /**
101      * Constructs a RtfPageNumber object with a specific font.
102      *
103      * @param doc The RtfDocument this RtfPageNumber belongs to
104      * @param font The Font to use
105      */
106     public RtfPageNumber(RtfDocument doc, Font font) {
107         super(doc, font);
108     }
109     
110     /**
111      * Writes the field instruction content
112      *
113      * @return A byte array containing "PAGE"
114      * @deprecated replaced by {@link #writeFieldInstContent(OutputStream)}
115      * @throws IOException
116      */
117     protected byte[] writeFieldInstContent() throws IOException JavaDoc
118     {
119         return PAGE_NUMBER;
120     }
121     /**
122      * Writes the field instruction content
123      *
124      * @throws IOException
125      */
126     protected void writeFieldInstContent(final OutputStream JavaDoc out) throws IOException JavaDoc
127     {
128         out.write(PAGE_NUMBER);
129     }
130     
131     /**
132      * Writes the field result content
133      *
134      * @return An empty byte array
135      * @deprecated replaced by {@link #writeFieldResultContent(OutputStream)}
136      * @throws IOException
137      */
138     protected byte[] writeFieldResultContent() throws IOException JavaDoc
139     {
140         return new byte[0];
141     }
142     /**
143      * Writes the field result content
144      *
145      * @throws IOException
146      */
147     protected void writeFieldResultContent(final OutputStream JavaDoc out) throws IOException JavaDoc
148     {
149     }
150 }
151
Popular Tags