KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > rtf > field > RtfAnchor


1 /*
2  * $Id: RtfAnchor.java 2784 2007-05-24 15:43:40Z hallm $
3  * $Name$
4  *
5  * Copyright 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.field;
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.Anchor;
58 import com.lowagie.text.rtf.document.RtfDocument;
59 import com.lowagie.text.rtf.text.RtfPhrase;
60
61
62 /**
63  * The RtfAnchor is the RTF representation of an Anchor object.
64  *
65  * @version $Id: RtfAnchor.java 2784 2007-05-24 15:43:40Z hallm $
66  * @author Mark Hall (mhall@edu.uni-klu.ac.at)
67  * @author Werner Daehn (Werner.Daehn@BusinessObjects.com)
68  * @author Thomas Bickel (tmb99@inode.at)
69  */
70 public class RtfAnchor extends RtfField
71 {
72     /**
73      * Constant for a hyperlink
74      */
75     private static final byte[] HYPERLINK = "HYPERLINK".getBytes();
76     
77     /**
78      * The url of this RtfAnchor
79      */
80     private String JavaDoc url = "";
81     /**
82      * The RtfPhrase to display for the url
83      */
84     private RtfPhrase content = null;
85
86     /**
87      * Constructs a RtfAnchor based on a RtfField
88      *
89      * @param doc The RtfDocument this RtfAnchor belongs to
90      * @param anchor The Anchor this RtfAnchor is based on
91      */
92     public RtfAnchor(RtfDocument doc, Anchor anchor) {
93         super(doc);
94         this.url = anchor.getReference();
95         this.content = new RtfPhrase(doc, anchor);
96     }
97     
98     /**
99      * Write the field instructions for this RtfAnchor. Sets the field
100      * type to HYPERLINK and then writes the url.
101      *
102      * @return The field instructions for this RtfAnchor
103      * @deprecated replaced by {@link #writeFieldInstContent(OutputStream)}
104      * @throws IOException
105      */
106     protected byte[] writeFieldInstContent() throws IOException JavaDoc
107     {
108         ByteArrayOutputStream JavaDoc result = new ByteArrayOutputStream JavaDoc();
109         writeFieldInstContent(result);
110         return result.toByteArray();
111     }
112     protected void writeFieldInstContent(OutputStream JavaDoc result) throws IOException JavaDoc
113     {
114         result.write(HYPERLINK);
115         result.write(DELIMITER);
116         //.result.write(this.document.filterSpecialChar(url, true, true).getBytes());
117 this.document.filterSpecialChar(result, url, true, true);
118     }
119     
120     /**
121      * Write the field result for this RtfAnchor. Writes the content
122      * of the RtfPhrase.
123      *
124      * @return The field result for this RtfAnchor
125      * @deprecated replaced by {@link #writeFieldResultContent(OutputStream)}
126      * @throws IOException
127      */
128     protected byte[] writeFieldResultContent() throws IOException JavaDoc
129     {
130         return content.write();
131     }
132     /**
133      * Write the field result for this RtfAnchor. Writes the content
134      * of the RtfPhrase.
135      */
136     protected void writeFieldResultContent(OutputStream JavaDoc out) throws IOException JavaDoc
137     {
138         content.writeContent(out);
139     }
140     
141 }
142
Popular Tags