KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > rtf > direct > RtfDirectContent


1 /**
2  * $Id: RtfDirectContent.java 2776 2007-05-23 20:01:40Z hallm $
3  * $Name$
4  *
5  * Copyright 2006 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-2006 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-2006 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 package com.lowagie.text.rtf.direct;
51
52 import java.io.IOException JavaDoc;
53 import java.io.OutputStream JavaDoc;
54
55 import com.lowagie.text.rtf.RtfAddableElement;
56
57 /**
58  * The RtfDirectContent makes it possible to directly add RTF code into
59  * an RTF document. This can be used to directly add RTF fragments that
60  * have been created with other RTF editors. One important aspect is that
61  * font and color numbers will not be modified. This means that the
62  * fonts and colors visible in the final document might not be equivalent
63  * with those set on the direct content.<br /><br />
64  *
65  * For convenience the RtfDirectContent provides a DIRECT_SOFT_LINEBREAK
66  * constant that makes it possible to easily add soft line-breaks anywhere in
67  * the RTF document.
68  *
69  * @version $Id: RtfDirectContent.java 2776 2007-05-23 20:01:40Z hallm $
70  * @author Mark Hall (mhall@edu.uni-klu.ac.at)
71  * @author Thomas Bickel (tmb99@inode.at)
72  */
73 public class RtfDirectContent extends RtfAddableElement {
74     /**
75      * Add the DIRECT_SOFT_LINEBREAK to the Document to insert
76      * a soft line-break at that position.
77      */
78     public static final RtfDirectContent DIRECT_SOFT_LINEBREAK = new RtfDirectContent("\\line");
79     
80     /**
81      * The direct content to add.
82      */
83     private String JavaDoc directContent = "";
84     
85     /**
86      * Constructs a new RtfDirectContent with the content to add.
87      *
88      * @param directContent The content to add.
89      */
90     public RtfDirectContent(String JavaDoc directContent)
91     {
92         this.directContent = directContent;
93     }
94     
95     /**
96      * Writes the direct content.
97      * @deprecated replaced by {@link #writeContent(OutputStream)}
98      */
99     public byte[] write()
100     {
101         return this.directContent.getBytes();
102     }
103     
104     /**
105      * Writes the element content to the given output stream.
106      */
107     public void writeContent(final OutputStream JavaDoc out) throws IOException JavaDoc
108     {
109         final byte[] contentBytes = this.directContent.getBytes();
110         out.write(contentBytes);
111     }
112     
113     
114 }
115
Popular Tags