001: /*
002: * $Id: RtfTableOfContents.java 2784 2007-05-24 15:43:40Z hallm $
003: * $Name$
004: *
005: * Copyright 2004 by Mark Hall
006: * Uses code Copyright 2002
007: * Steffen.Stundzig (Steffen.Stundzig@smb-tec.com)
008: *
009: * The contents of this file are subject to the Mozilla Public License Version 1.1
010: * (the "License"); you may not use this file except in compliance with the License.
011: * You may obtain a copy of the License at http://www.mozilla.org/MPL/
012: *
013: * Software distributed under the License is distributed on an "AS IS" basis,
014: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
015: * for the specific language governing rights and limitations under the License.
016: *
017: * The Original Code is 'iText, a free JAVA-PDF library'.
018: *
019: * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
020: * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
021: * All Rights Reserved.
022: * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
023: * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
024: *
025: * Contributor(s): all the names of the contributors are added in the source code
026: * where applicable.
027: *
028: * Alternatively, the contents of this file may be used under the terms of the
029: * LGPL license (the ?GNU LIBRARY GENERAL PUBLIC LICENSE?), in which case the
030: * provisions of LGPL are applicable instead of those above. If you wish to
031: * allow use of your version of this file only under the terms of the LGPL
032: * License and not to allow others to use your version of this file under
033: * the MPL, indicate your decision by deleting the provisions above and
034: * replace them with the notice and other provisions required by the LGPL.
035: * If you do not delete the provisions above, a recipient may use your version
036: * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
037: *
038: * This library is free software; you can redistribute it and/or modify it
039: * under the terms of the MPL as stated above or under the terms of the GNU
040: * Library General Public License as published by the Free Software Foundation;
041: * either version 2 of the License, or any later version.
042: *
043: * This library is distributed in the hope that it will be useful, but WITHOUT
044: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
045: * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
046: * details.
047: *
048: * If you didn't download this code from the following link, you should check if
049: * you aren't using an obsolete version:
050: * http://www.lowagie.com/iText/
051: */
052:
053: package com.lowagie.text.rtf.field;
054:
055: import java.io.*;
056:
057: import com.lowagie.text.Font;
058:
059: /**
060: * The RtfTableOfContents together with multiple RtfTOCEntry objects generates a table
061: * of contents. The table of contents will display no entries in the viewing program
062: * and the user will have to update it first. A text to inform the user of this is
063: * displayed instead.
064: *
065: * @version $Id: RtfTableOfContents.java 2784 2007-05-24 15:43:40Z hallm $
066: * @author Mark Hall (mhall@edu.uni-klu.ac.at)
067: * @author Steffen.Stundzig (Steffen.Stundzig@smb-tec.com)
068: * @author Thomas Bickel (tmb99@inode.at)
069: */
070: public class RtfTableOfContents extends RtfField {
071:
072: /**
073: * field inst content
074: */
075: private final static String FIELD_INST = "TOC \\\\f \\\\h \\\\u \\\\o \"1-5\" ";
076: /**
077: * The default text to display
078: */
079: private String defaultText = "Table of Contents - Click to update";
080:
081: /**
082: * Constructs a RtfTableOfContents. The default text is the text that is displayed
083: * before the user updates the table of contents
084: *
085: * @param defaultText The default text to display
086: */
087: public RtfTableOfContents(String defaultText) {
088: super (null, new Font());
089: this .defaultText = defaultText;
090: }
091:
092: /**
093: * Writes the field instruction content
094: *
095: * @return A byte array containing with the field instructions
096: * @deprecated
097: * @throws IOException
098: */
099: protected byte[] writeFieldInstContent() throws IOException {
100: return FIELD_INST.getBytes();
101: }
102:
103: /**
104: * Writes the field instruction content
105: */
106: protected void writeFieldInstContent(final OutputStream out)
107: throws IOException {
108: out.write(FIELD_INST.getBytes());
109: }
110:
111: /**
112: * Writes the field result content
113: *
114: * @return An byte array containing the default text
115: * @deprecated
116: * @throws IOException
117: */
118: protected byte[] writeFieldResultContent() throws IOException {
119: ByteArrayOutputStream out = new ByteArrayOutputStream();
120: writeFieldResultContent(out);
121: return out.toByteArray();
122: }
123:
124: /**
125: * Writes the field result content
126: */
127: protected void writeFieldResultContent(final OutputStream out)
128: throws IOException {
129: document.filterSpecialChar(out, defaultText, true, true);
130: // byte[] b = getDefaultTextBytes();
131: // if(b != null) out.write(b);
132: }
133:
134: // private byte[] getDefaultTextBytes()
135: // {
136: // return(document.filterSpecialChar(defaultText, true, true).getBytes());
137: // }
138:
139: }
|