com.lowagie.text.rtf

Class RtfTOCEntry

public class RtfTOCEntry extends Chunk implements RtfField

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

This class can be used to insert entries for a table of contents into the RTF document. ONLY FOR USE WITH THE RtfWriter NOT with the RtfWriter2. This class is based on the RtfWriter-package from Mark Hall.

Version: $Revision: 2698 $Date: 2007/03/15 19:26:36 $

Author: Steffen.Stundzig (Steffen.Stundzig@smb-tec.com)

Field Summary
FontcontentFont
FontentryFont
StringentryName
booleanhidePageNumber
booleanhideText
Constructor Summary
RtfTOCEntry(String content, Font contentFont)
Constructs an entry for the Table of Contents
RtfTOCEntry(String content, Font contentFont, String entryName, Font entryFont)
Constructs an entry for the Table of Contents
Method Summary
voidhidePageNumber()
sets the hidePageNumber value to true
voidhideText()
sets the hideText value to true
voidwrite(RtfWriter writer, OutputStream out)
voidwriteField(OutputStream out)

Field Detail

contentFont

private Font contentFont

entryFont

private Font entryFont

entryName

private String entryName

hidePageNumber

private boolean hidePageNumber

hideText

private boolean hideText

Constructor Detail

RtfTOCEntry

public RtfTOCEntry(String content, Font contentFont)
Constructs an entry for the Table of Contents

Parameters: content the content of the entry contentFont the font

RtfTOCEntry

public RtfTOCEntry(String content, Font contentFont, String entryName, Font entryFont)
Constructs an entry for the Table of Contents

Parameters: content the content of the entry contentFont the font entryName name of the entry entryFont font of the entryname

Method Detail

hidePageNumber

public void hidePageNumber()
sets the hidePageNumber value to true

hideText

public void hideText()
sets the hideText value to true

write

public void write(RtfWriter writer, OutputStream out)

See Also: RtfField

writeField

private void writeField(OutputStream out)