001: /*
002: * $Id: RtfTotalPageNumber.java 2776 2007-05-23 20:01:40Z hallm $
003: * $Name$
004: *
005: * Copyright 2005 Jose Hurtado <a href="mailto:jose.hurtado@gft.com">jose.hurtado@gft.com</a>
006: * Parts Copyright 2005 Mark Hall
007: *
008: * The contents of this file are subject to the Mozilla Public License Version 1.1
009: * (the "License"); you may not use this file except in compliance with the License.
010: * You may obtain a copy of the License at http://www.mozilla.org/MPL/
011: *
012: * Software distributed under the License is distributed on an "AS IS" basis,
013: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
014: * for the specific language governing rights and limitations under the License.
015: *
016: * The Original Code is 'iText, a free JAVA-PDF library'.
017: *
018: * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
019: * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
020: * All Rights Reserved.
021: * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
022: * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
023: *
024: * Contributor(s): all the names of the contributors are added in the source code
025: * where applicable.
026: *
027: * Alternatively, the contents of this file may be used under the terms of the
028: * LGPL license (the ?GNU LIBRARY GENERAL PUBLIC LICENSE?), in which case the
029: * provisions of LGPL are applicable instead of those above. If you wish to
030: * allow use of your version of this file only under the terms of the LGPL
031: * License and not to allow others to use your version of this file under
032: * the MPL, indicate your decision by deleting the provisions above and
033: * replace them with the notice and other provisions required by the LGPL.
034: * If you do not delete the provisions above, a recipient may use your version
035: * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
036: *
037: * This library is free software; you can redistribute it and/or modify it
038: * under the terms of the MPL as stated above or under the terms of the GNU
039: * Library General Public License as published by the Free Software Foundation;
040: * either version 2 of the License, or any later version.
041: *
042: * This library is distributed in the hope that it will be useful, but WITHOUT
043: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
044: * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
045: * details.
046: *
047: * If you didn't download this code from the following link, you should check if
048: * you aren't using an obsolete version:
049: * http://www.lowagie.com/iText/
050: */
051:
052: package com.lowagie.text.rtf.field;
053:
054: import java.io.IOException;
055: import java.io.OutputStream;
056:
057: import com.lowagie.text.Font;
058: import com.lowagie.text.rtf.document.RtfDocument;
059:
060: /**
061: * The RtfTotalPageNumber provides the total number of pages field in rtf documents.
062: *
063: * @version $Id: RtfTotalPageNumber.java 2776 2007-05-23 20:01:40Z hallm $
064: * @author Jose Hurtado (jose.hurtado@gft.com)
065: * @author Mark Hall (mhall@edu.uni-klu.ac.at)
066: * @author Thomas Bickel (tmb99@inode.at)
067: */
068: public class RtfTotalPageNumber extends RtfField {
069:
070: /**
071: * Constant for arabic total page numbers.
072: */
073: private static final byte[] ARABIC_TOTAL_PAGES = "NUMPAGES \\\\* Arabic"
074: .getBytes();
075:
076: /**
077: * Constructs a RtfTotalPageNumber. This can be added anywhere to add a total number of pages field.
078: */
079: public RtfTotalPageNumber() {
080: super (null);
081: }
082:
083: /**
084: * Constructs a RtfTotalPageNumber with a specified Font. This can be added anywhere
085: * to add a total number of pages field.
086: * @param font
087: */
088: public RtfTotalPageNumber(Font font) {
089: super (null, font);
090: }
091:
092: /**
093: * Constructs a RtfTotalPageNumber object.
094: *
095: * @param doc The RtfDocument this RtfTotalPageNumber belongs to
096: */
097: public RtfTotalPageNumber(RtfDocument doc) {
098: super (doc);
099: }
100:
101: /**
102: * Constructs a RtfTotalPageNumber object with a specific font.
103: *
104: * @param doc The RtfDocument this RtfTotalPageNumber belongs to
105: * @param font The Font to use
106: */
107: public RtfTotalPageNumber(RtfDocument doc, Font font) {
108: super (doc, font);
109: }
110:
111: /**
112: * Writes the field NUMPAGES instruction with Arabic format
113: *
114: * @return A byte array containing "NUMPAGES \\\\* Arabic".
115: * @deprecated
116: * @throws IOException
117: */
118: protected byte[] writeFieldInstContent() throws IOException {
119: return ARABIC_TOTAL_PAGES;
120: }
121:
122: /**
123: * Writes the field NUMPAGES instruction with Arabic format: "NUMPAGES \\\\* Arabic".
124: */
125: protected void writeFieldInstContent(OutputStream out)
126: throws IOException {
127: out.write(ARABIC_TOTAL_PAGES);
128: }
129:
130: /**
131: * Writes the field result content
132: *
133: * @return An byte array containing "1".
134: * @deprecated
135: * @throws IOException
136: */
137: protected byte[] writeFieldResultContent() throws IOException {
138: return "1".getBytes();
139: }
140:
141: /**
142: * Writes the field result content "1"
143: */
144: protected void writeFieldResultContent(final OutputStream out)
145: throws IOException {
146: out.write("1".getBytes());
147: }
148:
149: }
|