using System;
using System.IO;
using iTextSharp.text;
using iTextSharp.text.rtf.document;
/*
 * $Id: RtfTotalPageNumber.cs,v 1.1 2005/07/04 22:51:36 psoares33 Exp $
 * $Name:  $
 *
 * Copyright 2005 Jose Hurtado <a href="mailto:jose.hurtado@gft.com">jose.hurtado@gft.com</a>
 * Parts Copyright 2005 Mark Hall
 *
 * The contents of this file are subject to the Mozilla Public License Version 1.1
 * (the "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the License.
 *
 * The Original Code is 'iText, a free JAVA-PDF library'.
 *
 * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
 * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
 * All Rights Reserved.
 * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
 * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
 *
 * Contributor(s): all the names of the contributors are added in the source code
 * where applicable.
 *
 * Alternatively, the contents of this file may be used under the terms of the
 * LGPL license (the ?GNU LIBRARY GENERAL PUBLIC LICENSE?), in which case the
 * provisions of LGPL are applicable instead of those above.  If you wish to
 * allow use of your version of this file only under the terms of the LGPL
 * License and not to allow others to use your version of this file under
 * the MPL, indicate your decision by deleting the provisions above and
 * replace them with the notice and other provisions required by the LGPL.
 * If you do not delete the provisions above, a recipient may use your version
 * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the MPL as stated above or under the terms of the GNU
 * Library General Public License as published by the Free Software Foundation;
 * either version 2 of the License, or any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
 * details.
 *
 * If you didn't download this code from the following link, you should check if
 * you aren't using an obsolete version:
 * http://www.lowagie.com/iText/
 */

namespace iTextSharp.text.rtf.field {

    /**
    * The RtfTotalPageNumber provides the total number of pages field in rtf documents.
    * 
    * @version $Version:$
    * @author Jose Hurtado (jose.hurtado@gft.com)
    * @author Mark Hall (mhall@edu.uni-klu.ac.at)
    */
    public class RtfTotalPageNumber : RtfField {

        /**
        * Constant for arabic total page numbers.
        */
        private static byte[] ARABIC_TOTAL_PAGES = DocWriter.GetISOBytes("NUMPAGES \\\\* Arabic");
        
        /**
        * Constructs a RtfTotalPageNumber. This can be added anywhere to add a total number of pages field.
        */
        public RtfTotalPageNumber() : base(null) {
        }
        
        /**
        * Constructs a RtfTotalPageNumber with a specified Font. This can be added anywhere
        * to add a total number of pages field.
        * @param font
        */
        public RtfTotalPageNumber(Font font) : base(null, font) {
        }
        
        /**
        * Constructs a RtfTotalPageNumber object.
        * 
        * @param doc The RtfDocument this RtfTotalPageNumber belongs to
        */
        public RtfTotalPageNumber(RtfDocument doc) : base(doc) {
        }
        
        /**
        * Constructs a RtfTotalPageNumber object with a specific font.
        * 
        * @param doc The RtfDocument this RtfTotalPageNumber belongs to
        * @param font The Font to use
        */
        public RtfTotalPageNumber(RtfDocument doc, Font font) : base(doc, font) {
        }
        
        /**
        * Writes the field NUMPAGES instruction with Arabic format
        * 
        * @return A byte array containing "NUMPAGES \\\\* Arabic".
        * @throws IOException
        */
        protected override byte[] WriteFieldInstContent() {
            return ARABIC_TOTAL_PAGES;
        }

        /**
        * Writes the field result content
        * 
        * @return An byte array containing "1".
        * @throws IOException
        */
        protected override byte[] WriteFieldResultContent() {
            return new byte[]{(byte)'1'};
        }
    }
}