com.lowagie.text.rtf
Class RtfTOC

java.lang.Object
  com.lowagie.text.Chunk
      com.lowagie.text.rtf.RtfTOC

All Implemented Interfaces:

Element, MarkupAttributes, RtfField

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.22 $Date: 2004/12/14 15:14:43 $

Author:

Steffen.Stundzig@smb-tec.com

Field Summary

private boolean	addTOCAsTOCEntry
private java.lang.String	defaultText
private Font	entryFont
private java.lang.String	entryName

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

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, GRAPHIC, HEADER, IMGRAW, IMGTEMPLATE, JPEG, KEYWORDS, LIST, LISTITEM, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE

Constructor Summary

RtfTOC(java.lang.String tocName, Font tocFont)

Method Summary

void	addTOCAsTOCEntry(java.lang.String entryName, Font entryFont) Add a toc entry
void	setDefaultText(java.lang.String text) Sets the default text of the Table of Contents
void	write(RtfWriter writer, java.io.OutputStream out) 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, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.lowagie.text.Element

toString

Field Detail

defaultText

private java.lang.String defaultText

addTOCAsTOCEntry

private boolean addTOCAsTOCEntry

entryFont

private Font entryFont

entryName

private java.lang.String entryName

Constructor Detail

RtfTOC

public RtfTOC(java.lang.String tocName,
              Font tocFont)

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

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)

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)

Sets the default text of the Table of Contents

Parameters:

text - the default text