001: /**
002: * $Id: RtfTOC.java 2698 2007-04-19 12:03:08Z blowagie $
003: *
004: * Copyright 2002 by
005: * <a href="http://www.smb-tec.com">SMB</a>
006: * Steffen.Stundzig (Steffen.Stundzig@smb-tec.com)
007: *
008: * The contents of this file are subject to the Mozilla Public License Version 1.1
009: * (the "License"); you may not use this file except in compliance with the License.
010: * You may obtain a copy of the License at http://www.mozilla.org/MPL/
011: *
012: * Software distributed under the License is distributed on an "AS IS" basis,
013: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
014: * for the specific language governing rights and limitations under the License.
015: *
016: * The Original Code is 'iText, a free JAVA-PDF library'.
017: *
018: * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
019: * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
020: * All Rights Reserved.
021: * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
022: * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
023: *
024: * Contributor(s): all the names of the contributors are added in the source code
025: * where applicable.
026: *
027: * Alternatively, the contents of this file may be used under the terms of the
028: * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
029: * provisions of LGPL are applicable instead of those above. If you wish to
030: * allow use of your version of this file only under the terms of the LGPL
031: * License and not to allow others to use your version of this file under
032: * the MPL, indicate your decision by deleting the provisions above and
033: * replace them with the notice and other provisions required by the LGPL.
034: * If you do not delete the provisions above, a recipient may use your version
035: * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
036: *
037: * This library is free software; you can redistribute it and/or modify it
038: * under the terms of the MPL as stated above or under the terms of the GNU
039: * Library General Public License as published by the Free Software Foundation;
040: * either version 2 of the License, or any later version.
041: *
042: * This library is distributed in the hope that it will be useful, but WITHOUT
043: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
044: * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
045: * details.
046: *
047: * If you didn't download this code from the following link, you should check if
048: * you aren't using an obsolete version:
049: * http://www.lowagie.com/iText/
050: */package com.lowagie.text.rtf;
051:
052: import java.io.IOException;
053: import java.io.OutputStream;
054:
055: import com.lowagie.text.Chunk;
056: import com.lowagie.text.DocumentException;
057: import com.lowagie.text.ExceptionConverter;
058: import com.lowagie.text.Font;
059:
060: /**
061: * This class can be used to insert a table of contents into
062: * the RTF document.
063: * Therefore the field TOC is used. It works great in Word 2000.
064: * StarOffice doesn't support such fields. Other word version
065: * are not tested yet.
066: *
067: * ONLY FOR USE WITH THE RtfWriter NOT with the RtfWriter2.
068: *
069: * This class is based on the RtfWriter-package from Mark Hall.
070: * @author Steffen.Stundzig (Steffen.Stundzig@smb-tec.com)
071: * @version $Revision: 2698 $Date: 2007/03/15 19:26:36 $
072: * @deprecated Please move to the RtfWriter2 and associated classes. com.lowagie.text.rtf.field.RtfTableOfContents replaces the functionality of this class.
073: */
074: public class RtfTOC extends Chunk implements RtfField {
075:
076: private String defaultText = "Klicken Sie mit der rechten Maustaste auf diesen Text, um das Inhaltsverzeichnis zu aktualisieren!";
077:
078: private boolean addTOCAsTOCEntry = false;
079:
080: private Font entryFont = null;
081: private String entryName = null;
082:
083: /**
084: * @param tocName the headline of the table of contents
085: * @param tocFont the font for the headline
086: */
087: public RtfTOC(String tocName, Font tocFont) {
088: super (tocName, tocFont);
089: }
090:
091: /**
092: * @see com.lowagie.text.rtf.RtfField#write(com.lowagie.text.rtf.RtfWriter, java.io.OutputStream)
093: */
094: public void write(RtfWriter writer, OutputStream out)
095: throws IOException {
096:
097: writer.writeInitialFontSignature(out, this );
098: out.write(RtfWriter.filterSpecialChar(getContent(), true)
099: .getBytes());
100: writer.writeFinishingFontSignature(out, this );
101:
102: if (addTOCAsTOCEntry) {
103: RtfTOCEntry entry = new RtfTOCEntry(entryName, entryFont);
104: entry.hideText();
105: try {
106: writer.add(entry);
107: } catch (DocumentException de) {
108: throw new ExceptionConverter(de);
109: }
110: }
111:
112: // line break after headline
113: out.write(RtfWriter.escape);
114: out.write(RtfWriter.paragraph);
115: out.write(RtfWriter.delimiter);
116:
117: // toc field entry
118: out.write(RtfWriter.openGroup);
119: out.write(RtfWriter.escape);
120: out.write(RtfWriter.field);
121: // field initialization stuff
122: out.write(RtfWriter.openGroup);
123: out.write(RtfWriter.escape);
124: out.write(RtfWriter.fieldContent);
125: out.write(RtfWriter.delimiter);
126: out.write("TOC".getBytes());
127: // create the TOC based on the 'toc entries'
128: out.write(RtfWriter.delimiter);
129: out.write(RtfWriter.escape);
130: out.write(RtfWriter.escape);
131: out.write("f".getBytes());
132: out.write(RtfWriter.delimiter);
133: // create Hyperlink TOC Entrie
134: out.write(RtfWriter.escape);
135: out.write(RtfWriter.escape);
136: out.write("h".getBytes());
137: out.write(RtfWriter.delimiter);
138: // create the TOC based on the paragraph level
139: out.write(RtfWriter.delimiter);
140: out.write(RtfWriter.escape);
141: out.write(RtfWriter.escape);
142: out.write("u".getBytes());
143: out.write(RtfWriter.delimiter);
144: // create the TOC based on the paragraph headlines 1-5
145: out.write(RtfWriter.delimiter);
146: out.write(RtfWriter.escape);
147: out.write(RtfWriter.escape);
148: out.write("o".getBytes());
149: out.write(RtfWriter.delimiter);
150: out.write("\"1-5\"".getBytes());
151: out.write(RtfWriter.delimiter);
152: out.write(RtfWriter.closeGroup);
153:
154: // field default result stuff
155: out.write(RtfWriter.openGroup);
156: out.write(RtfWriter.escape);
157: out.write(RtfWriter.fieldDisplay);
158: out.write(RtfWriter.delimiter);
159: out.write(defaultText.getBytes());
160: out.write(RtfWriter.delimiter);
161: out.write(RtfWriter.closeGroup);
162: out.write(RtfWriter.closeGroup);
163: }
164:
165: /**
166: * Add a toc entry
167: * @param entryName the name of the entry
168: * @param entryFont the font to be used for the entry
169: */
170: public void addTOCAsTOCEntry(String entryName, Font entryFont) {
171: this .addTOCAsTOCEntry = true;
172: this .entryFont = entryFont;
173: this .entryName = entryName;
174: }
175:
176: /**
177: * Sets the default text of the Table of Contents
178: * @param text the default text
179: */
180: public void setDefaultText(String text) {
181: this.defaultText = text;
182: }
183: }
|