001: /**
002: * $Id: RtfTOCEntry.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.Font;
057:
058: /**
059: * This class can be used to insert entries for a table of contents into
060: * the RTF document.
061: *
062: * ONLY FOR USE WITH THE RtfWriter NOT with the RtfWriter2.
063: *
064: * This class is based on the RtfWriter-package from Mark Hall.
065: * @author Steffen.Stundzig (Steffen.Stundzig@smb-tec.com)
066: * @version $Revision: 2698 $Date: 2007/03/15 19:26:36 $
067: * @deprecated Please move to the RtfWriter2 and associated classes. com.lowagie.text.rtf.field.RtfTOCEntry replaces the functionality of this class.
068: */
069: public class RtfTOCEntry extends Chunk implements RtfField {
070:
071: private boolean hideText = false;
072:
073: private boolean hidePageNumber = false;
074:
075: private String entryName;
076:
077: private Font entryFont;
078:
079: private Font contentFont;
080:
081: /**
082: * Constructs an entry for the Table of Contents
083: * @param content the content of the entry
084: * @param contentFont the font
085: */
086: public RtfTOCEntry(String content, Font contentFont) {
087: this (content, contentFont, content, contentFont);
088: // super( content, font );
089: // this.entryName = content;
090: // printEntryNameAsText = true;
091: }
092:
093: /**
094: * Constructs an entry for the Table of Contents
095: * @param content the content of the entry
096: * @param contentFont the font
097: * @param entryName name of the entry
098: * @param entryFont font of the entryname
099: */
100: public RtfTOCEntry(String content, Font contentFont,
101: String entryName, Font entryFont) {
102: super (content, contentFont);
103: // hide the text of the entry, because it is printed
104: this .entryName = entryName;
105: this .entryFont = entryFont;
106: this .contentFont = contentFont;
107: }
108:
109: /**
110: * @see com.lowagie.text.rtf.RtfField#write(com.lowagie.text.rtf.RtfWriter, java.io.OutputStream)
111: */
112: public void write(RtfWriter writer, OutputStream out)
113: throws IOException {
114:
115: if (!hideText) {
116: writer.writeInitialFontSignature(out, new Chunk("",
117: contentFont));
118: out.write(RtfWriter.filterSpecialChar(getContent(), true)
119: .getBytes());
120: writer.writeFinishingFontSignature(out, new Chunk("",
121: contentFont));
122: }
123:
124: if (!entryFont.equals(contentFont)) {
125: writer.writeInitialFontSignature(out, new Chunk("",
126: entryFont));
127: writeField(out);
128: writer.writeFinishingFontSignature(out, new Chunk("",
129: entryFont));
130: } else {
131: writer.writeInitialFontSignature(out, new Chunk("",
132: contentFont));
133: writeField(out);
134: writer.writeFinishingFontSignature(out, new Chunk("",
135: contentFont));
136: }
137: }
138:
139: private void writeField(OutputStream out) throws IOException {
140:
141: // always hide the toc entry
142: out.write(RtfWriter.openGroup);
143: out.write(RtfWriter.escape);
144: out.write("v".getBytes());
145:
146: // tc field entry
147: out.write(RtfWriter.openGroup);
148: out.write(RtfWriter.escape);
149: if (!hidePageNumber) {
150: out.write("tc".getBytes());
151: } else {
152: out.write("tcn".getBytes());
153: }
154: out.write(RtfWriter.delimiter);
155: out.write(RtfWriter.filterSpecialChar(entryName, true)
156: .getBytes());
157: out.write(RtfWriter.delimiter);
158: out.write(RtfWriter.closeGroup);
159:
160: out.write(RtfWriter.closeGroup);
161: }
162:
163: /**
164: * sets the hideText value to true
165: */
166: public void hideText() {
167: hideText = true;
168: }
169:
170: /**
171: * sets the hidePageNumber value to true
172: */
173: public void hidePageNumber() {
174: hidePageNumber = true;
175: }
176: }
|