001: /*
002: * $Id: RtfBasicElement.java 2808 2007-05-30 10:58:16Z psoares33 $
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;
052:
053: import java.io.IOException;
054: import java.io.OutputStream;
055:
056: import com.lowagie.text.rtf.document.RtfDocument;
057:
058: /**
059: * The RtfBasicElement interface defines the interface for elements that can
060: * be added to the RtfWriter.
061: *
062: * @version $Id: RtfBasicElement.java 2808 2007-05-30 10:58:16Z psoares33 $
063: * @author Mark Hall (mhall@edu.uni-klu.ac.at)
064: * @author Thomas Bickel (tmb99@inode.at)
065: */
066: public interface RtfBasicElement {
067: /**
068: * Constant for the beginning of a rtf group
069: */
070: public static final byte[] OPEN_GROUP = "{".getBytes();
071: /**
072: * Constant for the end of an rtf group
073: */
074: public static final byte[] CLOSE_GROUP = "}".getBytes();
075: /**
076: * Constant for a delimiter in rtf
077: */
078: public static final byte[] DELIMITER = " ".getBytes();
079: /**
080: * Constant for a comma delimiter in rtf
081: */
082: public static final byte[] COMMA_DELIMITER = ";".getBytes();
083: /**
084: * The factor to use for translating from iText to rtf measurments
085: */
086: public static final double TWIPS_FACTOR = 20;
087:
088: /**
089: * Return the content of the Element in a byte array
090: *
091: * @return The byte array containing the data
092: * @deprecated replaced by {@link #writeContent(java.io.OutputStream)}
093: */
094: public byte[] write();
095:
096: /**
097: * Writes the element content to the given output stream.
098: * This method replaces the {@link #write()} method which is now deprecated.
099: *
100: * @param out
101: */
102: public void writeContent(OutputStream out) throws IOException;
103:
104: /**
105: * Sets the RtfDocument this RtfElement belongs to
106: *
107: * @param doc The RtfDocument to use
108: */
109: public void setRtfDocument(RtfDocument doc);
110:
111: /**
112: * Sets whether this RtfBasicElement is in a table
113: *
114: * @param inTable Whether this RtfBasicElement is in a table
115: */
116: public void setInTable(boolean inTable);
117:
118: /**
119: * Sets whether this RtfBasicElement is in a header
120: *
121: * @param inHeader Whether this RtfBasicElement is in a header
122: */
123: public void setInHeader(boolean inHeader);
124: }
|