Package com.lowagie.text.rtf

Class RtfTOC

java.lang.Object

com.lowagie.text.Chunk

com.lowagie.text.rtf.RtfTOC

All Implemented Interfaces:

Element, RtfField

public class RtfTOC
extends Chunk
implements RtfField

Deprecated.

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

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.1 $Date: 2009/08/28 20:31:00 $

Author:

Steffen.Stundzig@smb-tec.com

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	addTOCAsTOCEntry	Deprecated.
private java.lang.String	defaultText	Deprecated.
private Font	entryFont	Deprecated.
private java.lang.String	entryName	Deprecated.

Fields inherited from class com.lowagie.text.Chunk

ACTION, attributes, BACKGROUND, COLOR, content, ENCODING, font, GENERICTAG, HSCALE, HYPHENATION, IMAGE, LOCALDESTINATION, LOCALGOTO, NEWLINE, NEWPAGE, NEXTPAGE, OBJECT_REPLACEMENT_CHARACTER, PDFANNOTATION, REMOTEGOTO, SEPARATOR, SKEW, SPLITCHARACTER, SUBSUPSCRIPT, TAB, TEXTRENDERMODE, UNDERLINE

Fields inherited from interface com.lowagie.text.Element

ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE, YMARK

Constructor Summary

Constructors

Constructor	Description
RtfTOC(java.lang.String tocName, Font tocFont)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	addTOCAsTOCEntry(java.lang.String entryName, Font entryFont)	Deprecated. Add a toc entry
void	setDefaultText(java.lang.String text)	Deprecated. Sets the default text of the Table of Contents
void	write(RtfWriter writer, java.io.OutputStream out)	Deprecated. Writes an RTF field.

Methods inherited from class com.lowagie.text.Chunk

append, getAttributes, getChunks, getContent, getFont, getHorizontalScaling, getHyphenation, getImage, getTextRise, getWidthPoint, hasAttributes, isContent, isEmpty, isNestable, process, setAction, setAnchor, setAnchor, setAnnotation, setAttributes, setBackground, setBackground, setFont, setGenericTag, setHorizontalScaling, setHyphenation, setLocalDestination, setLocalGoto, 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

Field Detail

defaultText

private java.lang.String defaultText

Deprecated.

addTOCAsTOCEntry

private boolean addTOCAsTOCEntry

Deprecated.

entryFont

private Font entryFont

Deprecated.

entryName

private java.lang.String entryName

Deprecated.

Constructor Detail

RtfTOC

public RtfTOC(java.lang.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,
                  java.io.OutputStream out)
           throws java.io.IOException

Deprecated.

Description copied from interface: RtfField

Writes an RTF field.

Specified by:

write in interface RtfField

Throws:

java.io.IOException

See Also:

RtfField.write(com.lowagie.text.rtf.RtfWriter, java.io.OutputStream)

addTOCAsTOCEntry

public void addTOCAsTOCEntry(java.lang.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(java.lang.String text)

Deprecated.

Sets the default text of the Table of Contents

Parameters:

text - the default text