KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > rtf > RtfBasicElement


1 /*
2  * $Id: RtfBasicElement.java 2808 2007-05-30 10:58:16Z psoares33 $
3  * $Name$
4  *
5  * Copyright 2001, 2002, 2003, 2004 by Mark Hall
6  *
7  * The contents of this file are subject to the Mozilla Public License Version 1.1
8  * (the "License"); you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
10  *
11  * Software distributed under the License is distributed on an "AS IS" basis,
12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13  * for the specific language governing rights and limitations under the License.
14  *
15  * The Original Code is 'iText, a free JAVA-PDF library'.
16  *
17  * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
18  * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
19  * All Rights Reserved.
20  * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
21  * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
22  *
23  * Contributor(s): all the names of the contributors are added in the source code
24  * where applicable.
25  *
26  * Alternatively, the contents of this file may be used under the terms of the
27  * LGPL license (the ?GNU LIBRARY GENERAL PUBLIC LICENSE?), in which case the
28  * provisions of LGPL are applicable instead of those above. If you wish to
29  * allow use of your version of this file only under the terms of the LGPL
30  * License and not to allow others to use your version of this file under
31  * the MPL, indicate your decision by deleting the provisions above and
32  * replace them with the notice and other provisions required by the LGPL.
33  * If you do not delete the provisions above, a recipient may use your version
34  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
35  *
36  * This library is free software; you can redistribute it and/or modify it
37  * under the terms of the MPL as stated above or under the terms of the GNU
38  * Library General Public License as published by the Free Software Foundation;
39  * either version 2 of the License, or any later version.
40  *
41  * This library is distributed in the hope that it will be useful, but WITHOUT
42  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
43  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
44  * details.
45  *
46  * If you didn't download this code from the following link, you should check if
47  * you aren't using an obsolete version:
48  * http://www.lowagie.com/iText/
49  */
50
51 package com.lowagie.text.rtf;
52
53 import java.io.IOException JavaDoc;
54 import java.io.OutputStream JavaDoc;
55
56 import com.lowagie.text.rtf.document.RtfDocument;
57
58 /**
59  * The RtfBasicElement interface defines the interface for elements that can
60  * be added to the RtfWriter.
61  *
62  * @version $Id: RtfBasicElement.java 2808 2007-05-30 10:58:16Z psoares33 $
63  * @author Mark Hall (mhall@edu.uni-klu.ac.at)
64  * @author Thomas Bickel (tmb99@inode.at)
65  */
66 public interface RtfBasicElement {
67     /**
68      * Constant for the beginning of a rtf group
69      */
70     public static final byte[] OPEN_GROUP = "{".getBytes();
71     /**
72      * Constant for the end of an rtf group
73      */
74     public static final byte[] CLOSE_GROUP = "}".getBytes();
75     /**
76      * Constant for a delimiter in rtf
77      */
78     public static final byte[] DELIMITER = " ".getBytes();
79     /**
80      * Constant for a comma delimiter in rtf
81      */
82     public static final byte[] COMMA_DELIMITER = ";".getBytes();
83     /**
84      * The factor to use for translating from iText to rtf measurments
85      */
86     public static final double TWIPS_FACTOR = 20;
87
88     /**
89      * Return the content of the Element in a byte array
90      *
91      * @return The byte array containing the data
92      * @deprecated replaced by {@link #writeContent(java.io.OutputStream)}
93      */
94     public byte[] write();
95     
96     /**
97      * Writes the element content to the given output stream.
98      * This method replaces the {@link #write()} method which is now deprecated.
99      *
100      * @param out
101      */
102     public void writeContent(OutputStream JavaDoc out) throws IOException JavaDoc;
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 }
125
Popular Tags