com.lowagie.text.rtf
Class RtfTOC

java.lang.Object
  extended by com.lowagie.text.Chunk
      extended by com.lowagie.text.rtf.RtfTOC
All Implemented Interfaces:
Element, MarkupAttributes, RtfField

Deprecated. Please move to the RtfWriter2 and associated classes. com.lowagie.text.rtf.field.RtfTableOfContents replaces the functionality of this class.

public class RtfTOC
extends Chunk
implements RtfField

This class can be used to insert a table of contents into the RTF document. Therefore the field TOC is used. It works great in Word 2000. StarOffice doesn't support such fields. Other word version are not tested yet. ONLY FOR USE WITH THE RtfWriter NOT with the RtfWriter2. This class is based on the RtfWriter-package from Mark Hall.

Version:
$Revision: 1.23 $Date: 2006/02/09 17:25:25 $
Author:
Steffen.Stundzig@smb-tec.com

Field Summary
 
Fields inherited from class com.lowagie.text.Chunk
ACTION, attributes, BACKGROUND, COLOR, content, ENCODING, font, GENERICTAG, HSCALE, HYPHENATION, IMAGE, LOCALDESTINATION, LOCALGOTO, markupAttributes, NEWLINE, NEWPAGE, NEXTPAGE, OBJECT_REPLACEMENT_CHARACTER, PDFANNOTATION, REMOTEGOTO, SKEW, SPLITCHARACTER, SUBSUPSCRIPT, TEXTRENDERMODE, UNDERLINE
 
Constructor Summary
RtfTOC(String tocName, Font tocFont)
          Deprecated.  
 
Method Summary
 void addTOCAsTOCEntry(String entryName, Font entryFont)
          Deprecated. Add a toc entry
 void setDefaultText(String text)
          Deprecated. Sets the default text of the Table of Contents
 void write(RtfWriter writer, OutputStream out)
          Deprecated. Writes an RTF field.
 
Methods inherited from class com.lowagie.text.Chunk
addToArray, append, content, font, getAttributes, getChunks, getHorizontalScaling, getImage, getKeySet, getMarkupAttribute, getMarkupAttributeNames, getMarkupAttributes, getTextRise, getWidthPoint, hasAttributes, isEmpty, isTag, process, setAction, setAnchor, setAnchor, setAnnotation, setBackground, setBackground, setFont, setGenericTag, setHorizontalScaling, setHyphenation, setLocalDestination, setLocalGoto, setMarkupAttribute, setMarkupAttributes, setNewPage, setRemoteGoto, setRemoteGoto, setSkew, setSplitCharacter, setTextRenderMode, setTextRise, setUnderline, setUnderline, toString, type
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RtfTOC

public RtfTOC(String tocName,
              Font tocFont)
Deprecated. 
Parameters:
tocName - the headline of the table of contents
tocFont - the font for the headline
Method Detail

write

public void write(RtfWriter writer,
                  OutputStream out)
           throws IOException
Deprecated. 
Description copied from interface: RtfField
Writes an RTF field.

Specified by:
write in interface RtfField
Throws:
IOException
See Also:
RtfField.write(com.lowagie.text.rtf.RtfWriter, java.io.OutputStream)

addTOCAsTOCEntry

public void addTOCAsTOCEntry(String entryName,
                             Font entryFont)
Deprecated. 
Add a toc entry

Parameters:
entryName - the name of the entry
entryFont - the font to be used for the entry

setDefaultText

public void setDefaultText(String text)
Deprecated. 
Sets the default text of the Table of Contents

Parameters:
text - the default text


Copyright © 2006-2007 EGIZ - E-Government Innovationszentrum. All Rights Reserved.