aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/rtf/rtflib/rtfdoc/RtfBookmark.java
blob: 6ee287b5ae940daeca661f8faa9889118b013eb0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
/*
 * $Id$
 * ============================================================================
 *                    The Apache Software License, Version 1.1
 * ============================================================================
 *
 * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modifica-
 * tion, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. The end-user documentation included with the redistribution, if any, must
 *    include the following acknowledgment: "This product includes software
 *    developed by the Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself, if
 *    and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "FOP" and "Apache Software Foundation" must not be used to
 *    endorse or promote products derived from this software without prior
 *    written permission. For written permission, please contact
 *    apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache", nor may
 *    "Apache" appear in their name, without prior written permission of the
 *    Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
 * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * ============================================================================
 *
 * This software consists of voluntary contributions made by many individuals
 * on behalf of the Apache Software Foundation and was originally created by
 * James Tauber <jtauber@jtauber.com>. For more information on the Apache
 * Software Foundation, please see <http://www.apache.org/>.
 */

/*
 * This file is part of the RTF library of the FOP project, which was originally
 * created by Bertrand Delacretaz <bdelacretaz@codeconsult.ch> and by other
 * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to
 * the FOP project.
 */

package org.apache.fop.rtf.rtflib.rtfdoc;

import java.io.Writer;
import java.io.IOException;

/**
 * RTF Bookmark.
 * Create an RTF bookmark as a child of given container with default attributes.
 * This class belongs to the "id" attribute processing.
 * @author <a href="mailto:a.putz@skynamics.com">Andreas Putz</a>
 */
public class RtfBookmark extends RtfElement
{
	//////////////////////////////////////////////////
	// @@ Members
	//////////////////////////////////////////////////

	/** Name of the bokkmark */
	private String bookmark = null;
	/** Word 2000 supports a length of 40 characters only */
	public static int maxBookmarkLength = 40;
	/** Word 2000 converts '.' in bookmarks to "_", thats why we control this replacement. */
	public static char replaceCharacter = '_';


	//////////////////////////////////////////////////
	// @@ Construction
	//////////////////////////////////////////////////

	/**
	 * Constructor.
	 *
	 * @param parent a <code>RtfBookmarkContainer</code> value
	 * @param writer a <code>Writer</code> value
	 * @param bookmark Name of the bookmark
	 */
	RtfBookmark (IRtfBookmarkContainer parent, Writer w, String bookmark) throws IOException
	{
		super ((RtfContainer) parent, w);

		int now = bookmark.length ();

		this.bookmark = bookmark.substring (0, now < maxBookmarkLength ? now : maxBookmarkLength);
		this.bookmark = this.bookmark.replace ('.',replaceCharacter);
		this.bookmark = this.bookmark.replace (' ',replaceCharacter);
	}


	//////////////////////////////////////////////////
	// @@ RtfElement implementation
	//////////////////////////////////////////////////

	/**
	 * Is called before writing the Rtf content.
	 *
	 * @throws IOException On Error
	 */
	public void writeRtfPrefix () throws IOException
	{
		startBookmark ();
	}

	/**
	 * Writes the RTF content to m_writer.
	 *
	 * @exception IOException On error
	 */
	public void writeRtfContent () throws IOException
	{
//		this.getRtfFile ().getLog ().logInfo ("Write bookmark '" + bookmark + "'.");
		// No content to write
	}

	/**
	 * Is called after writing the Rtf content.
	 *
	 * @throws IOException On Error
	 */
	public void writeRtfSuffix () throws IOException
	{
		endBookmark ();
	}


	//////////////////////////////////////////////////
	// @@ Private methods
	//////////////////////////////////////////////////

	/**
	 * Writes RTF content to begin the bookmark.
	 *
	 * @throws IOException On error
	 */
	private void startBookmark () throws IOException
	{

		// {\*\bkmkstart test}
		writeRtfBookmark ("bkmkstart");
	}

	/**
	 * Writes RTF content to close the bookmark.
	 *
	 * @throws IOException On error
	 */
	private void endBookmark () throws IOException
	{

		// {\*\bkmkend test}
		writeRtfBookmark ("bkmkend");
	}

	/**
	 * Writes the rtf bookmark.
	 *
	 * @param tag Begin or close tag
	 *
	 * @throws IOException On error
	 */
	private void writeRtfBookmark (String tag) throws IOException
	{
		if (bookmark == null)
		{
			return;

		}

		this.writeGroupMark (true);

		//changed. Now using writeStarControlWord
		this.writeStarControlWord (tag);

		m_writer.write (bookmark);
		this.writeGroupMark (false);
	}

		/** true if this element would generate no "useful" RTF content */
		public boolean isEmpty()
		{
			return bookmark==null || bookmark.trim().length() == 0;
		}
}