KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * $Id: RtfAnnotation.java 2776 2007-05-23 20:01:40Z hallm $
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.text;
52
53 import java.io.ByteArrayOutputStream JavaDoc;
54 import java.io.IOException JavaDoc;
55 import java.io.OutputStream JavaDoc;
56
57 import com.lowagie.text.Annotation;
58 import com.lowagie.text.rtf.RtfElement;
59 import com.lowagie.text.rtf.document.RtfDocument;
60
61
62 /**
63  * The RtfAnnotation provides support for adding Annotations to the rtf document.
64  * Only simple Annotations with Title / Content are supported.
65  *
66  * @version $Id: RtfAnnotation.java 2776 2007-05-23 20:01:40Z hallm $
67  * @author Mark Hall (mhall@edu.uni-klu.ac.at)
68  * @author Thomas Bickel (tmb99@inode.at)
69  */

70 public class RtfAnnotation extends RtfElement {
71
72     /**
73      * Constant for the id of the annotation
74      */

75     private static final byte[] ANNOTATION_ID = "\\*\\atnid".getBytes();
76     /**
77      * Constant for the author of the annotation
78      */

79     private static final byte[] ANNOTATION_AUTHOR = "\\*\\atnauthor".getBytes();
80     /**
81      * Constant for the actual annotation
82      */

83     private static final byte[] ANNOTATION = "\\*\\annotation".getBytes();
84     
85     /**
86      * The title of this RtfAnnotation
87      */

88     private String JavaDoc title = "";
89     /**
90      * The content of this RtfAnnotation
91      */

92     private String JavaDoc content = "";
93     
94     /**
95      * Constructs a RtfAnnotation based on an Annotation.
96      *
97      * @param doc The RtfDocument this RtfAnnotation belongs to
98      * @param annotation The Annotation this RtfAnnotation is based off
99      */

100     public RtfAnnotation(RtfDocument doc, Annotation annotation) {
101         super(doc);
102         title = annotation.title();
103         content = annotation.content();
104     }
105     
106     /**
107      * Writes the content of the RtfAnnotation
108      *
109      * @return The content of this RtfAnnotation
110      * @deprecated replaced by {@link #writeContent(OutputStream)}
111      */

112     public byte[] write() {
113         ByteArrayOutputStream JavaDoc result = new ByteArrayOutputStream JavaDoc();
114         try {
115             writeContent(result);
116         } catch(IOException JavaDoc ioe) {
117             ioe.printStackTrace();
118         }
119         return result.toByteArray();
120     }
121     /**
122      * Writes the content of the RtfAnnotation
123      */

124     public void writeContent(final OutputStream JavaDoc result) throws IOException JavaDoc
125     {
126         result.write(OPEN_GROUP);
127         result.write(ANNOTATION_ID);
128         result.write(DELIMITER);
129         result.write(intToByteArray(document.getRandomInt()));
130         result.write(CLOSE_GROUP);
131         result.write(OPEN_GROUP);
132         result.write(ANNOTATION_AUTHOR);
133         result.write(DELIMITER);
134         result.write(title.getBytes());
135         result.write(CLOSE_GROUP);
136         result.write(OPEN_GROUP);
137         result.write(ANNOTATION);
138         result.write(RtfParagraph.PARAGRAPH_DEFAULTS);
139         result.write(DELIMITER);
140         result.write(content.getBytes());
141         result.write(CLOSE_GROUP);
142     }
143 }
144
Popular Tags