3rdPartyLibraries/iTechSharp/iTextSharp/text/rtf/RtfElement.cs

using System;
using System.IO;
using iTextSharp.text.rtf.document;
using iTextSharp.text;
/*
 * $Id: RtfElement.cs,v 1.5 2008/05/16 19:30:14 psoares33 Exp $
 * 
 *
 * Copyright 2001, 2002, 2003, 2004 by 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 {

    /**
    * RtfElement is the base class for all RTF Element classes
    *
    * Version: $Id: RtfElement.cs,v 1.5 2008/05/16 19:30:14 psoares33 Exp $
    * @author Mark Hall (Mark.Hall@mail.room3b.eu)
    */
    public abstract class RtfElement : IRtfBasicElement {
        /**
        * Constant for the beginning of a rtf group
        */
        public static byte[] OPEN_GROUP = {(byte)'{'};
        /**
        * Constant for the end of an rtf group
        */
        public static byte[] CLOSE_GROUP = {(byte)'}'};
        /**
        * Constant for a delimiter in rtf
        */
        public static byte[] DELIMITER = {(byte)' '};
        /**
        * Constant for a comma delimiter in rtf
        */
        public static byte[] COMMA_DELIMITER = {(byte)';'};
        /**
        * The factor to use for translating from iText to rtf measurments
        */
        public const double TWIPS_FACTOR = 20;

        /**
        * The RtfDocument this RtfElement belongs to
        */
        protected RtfDocument document = null;
        /**
        * Whether this RtfElement is in a table
        */
        protected bool inTable = false;
        /**
        * Whether this RtfElement is in a header
        */
        protected bool inHeader = false;
        
        /**
        * Constructs a RtfElement belonging to the specified RtfDocument.
        * 
        * @param doc The RtfDocument this RtfElement belongs to
        */
        public RtfElement(RtfDocument doc) : base(){
            this.document = doc;
        }

        /**
        * Transforms an integer into its String representation and then returns the bytes
        * of that string.
        *
        * @param i The integer to convert
        * @return A byte array representing the integer
        */
        public byte[] IntToByteArray(int i) {
            return DocWriter.GetISOBytes(i.ToString());
        }

        /**
        * Writes the element content to the given output stream.
        */    
        public abstract void WriteContent(Stream outp);
        
        /**
        * Sets the RtfDocument this RtfElement belongs to
        * 
        * @param doc The RtfDocument to use
        */
        public virtual void SetRtfDocument(RtfDocument doc) {
            this.document = doc;
        }
        
        /**
        * Gets whether this RtfElement is in a table
        * 
        * @return Whether this RtfElement is in a table
        */
        public virtual bool IsInTable() {
            return inTable;
        }
        
        /**
        * Sets whether this RtfElement is in a table
        * 
        * @param inTable <code>True</code> if this RtfElement is in a table, <code>false</code> otherwise
        */
        public virtual void SetInTable(bool inTable) {
            this.inTable = inTable;
        }
        
        /**
        * Sets whether this RtfElement is in a header
        * 
        * @param inHeader <code>True</code> if this RtfElement is in a header, <code>false</code> otherwise
        */
        public virtual void SetInHeader(bool inHeader) {
            this.inHeader = inHeader;
        }
    }
}