001: /*
002: * $Id: RtfPageNumber.java 2776 2007-05-23 20:01:40Z hallm $
003: * $Name$
004: *
005: * Copyright 2001, 2002, 2003, 2004 by Mark Hall
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.rtf.field;
052:
053: import java.io.IOException;
054: import java.io.OutputStream;
055:
056: import com.lowagie.text.Font;
057: import com.lowagie.text.rtf.document.RtfDocument;
058:
059: /**
060: * The RtfPageNumber provides the page number field in rtf documents.
061: *
062: * @version $Id: RtfPageNumber.java 2776 2007-05-23 20:01:40Z hallm $
063: * @author Mark Hall (mhall@edu.uni-klu.ac.at)
064: * @author Steffen.Stundzig (Steffen.Stundzig@smb-tec.com)
065: * @author Thomas Bickel (tmb99@inode.at)
066: */
067: public class RtfPageNumber extends RtfField {
068:
069: /**
070: * Constant for the page number
071: */
072: private static final byte[] PAGE_NUMBER = "PAGE".getBytes();
073:
074: /**
075: * Constructs a RtfPageNumber. This can be added anywhere to add a page number field.
076: */
077: public RtfPageNumber() {
078: super (null);
079: }
080:
081: /**
082: * Constructs a RtfPageNumber with a specified Font. This can be added anywhere to
083: * add a page number field.
084: * @param font
085: */
086: public RtfPageNumber(Font font) {
087: super (null, font);
088: }
089:
090: /**
091: * Constructs a RtfPageNumber object.
092: *
093: * @param doc The RtfDocument this RtfPageNumber belongs to
094: */
095: public RtfPageNumber(RtfDocument doc) {
096: super (doc);
097: }
098:
099: /**
100: * Constructs a RtfPageNumber object with a specific font.
101: *
102: * @param doc The RtfDocument this RtfPageNumber belongs to
103: * @param font The Font to use
104: */
105: public RtfPageNumber(RtfDocument doc, Font font) {
106: super (doc, font);
107: }
108:
109: /**
110: * Writes the field instruction content
111: *
112: * @return A byte array containing "PAGE"
113: * @deprecated replaced by {@link #writeFieldInstContent(OutputStream)}
114: * @throws IOException
115: */
116: protected byte[] writeFieldInstContent() throws IOException {
117: return PAGE_NUMBER;
118: }
119:
120: /**
121: * Writes the field instruction content
122: *
123: * @throws IOException
124: */
125: protected void writeFieldInstContent(final OutputStream out)
126: throws IOException {
127: out.write(PAGE_NUMBER);
128: }
129:
130: /**
131: * Writes the field result content
132: *
133: * @return An empty byte array
134: * @deprecated replaced by {@link #writeFieldResultContent(OutputStream)}
135: * @throws IOException
136: */
137: protected byte[] writeFieldResultContent() throws IOException {
138: return new byte[0];
139: }
140:
141: /**
142: * Writes the field result content
143: *
144: * @throws IOException
145: */
146: protected void writeFieldResultContent(final OutputStream out)
147: throws IOException {
148: }
149: }
|