com.lowagie.text.rtf.field

Class RtfTOCEntry

public class RtfTOCEntry extends RtfField

The RtfTOCEntry is used together with the RtfTableOfContents to generate a table of contents. Add the RtfTOCEntry in those locations in the document where table of contents entries should link to

Version: $Version:$

Author: Mark Hall (mhall@edu.uni-klu.ac.at) Steffen.Stundzig (Steffen.Stundzig@smb-tec.com)

Field Summary
Stringentry
The entry text of this RtfTOCEntry
booleanshowPageNumber
Whether to show page numbers in the table of contents
static byte[]TEXT_HIDDEN_OFF
Constant for the end of hidden text
static byte[]TEXT_HIDDEN_ON
Constant for the beginning of hidden text
static byte[]TOC_ENTRY_NO_PAGE_NUMBER
Constant for a TOC entry without page numbers
static byte[]TOC_ENTRY_PAGE_NUMBER
Constant for a TOC entry with page numbers
Constructor Summary
RtfTOCEntry(String entry)
Constructs a RtfTOCEntry with a certain entry text.
Method Summary
voidsetShowPageNumber(boolean showPageNumber)
Sets whether to display a page number in the table of contents, or not
byte[]write()
Writes the content of the RtfTOCEntry
protected byte[]writeFieldInstContent()
UNUSED
protected byte[]writeFieldResultContent()
UNUSED

Field Detail

entry

private String entry
The entry text of this RtfTOCEntry

showPageNumber

private boolean showPageNumber
Whether to show page numbers in the table of contents

TEXT_HIDDEN_OFF

private static final byte[] TEXT_HIDDEN_OFF
Constant for the end of hidden text

TEXT_HIDDEN_ON

private static final byte[] TEXT_HIDDEN_ON
Constant for the beginning of hidden text

TOC_ENTRY_NO_PAGE_NUMBER

private static final byte[] TOC_ENTRY_NO_PAGE_NUMBER
Constant for a TOC entry without page numbers

TOC_ENTRY_PAGE_NUMBER

private static final byte[] TOC_ENTRY_PAGE_NUMBER
Constant for a TOC entry with page numbers

Constructor Detail

RtfTOCEntry

public RtfTOCEntry(String entry)
Constructs a RtfTOCEntry with a certain entry text.

Parameters: entry The entry text to display

Method Detail

setShowPageNumber

public void setShowPageNumber(boolean showPageNumber)
Sets whether to display a page number in the table of contents, or not

Parameters: showPageNumber Whether to display a page number or not

write

public byte[] write()
Writes the content of the RtfTOCEntry

Returns: A byte array with the contents of the RtfTOCEntry

writeFieldInstContent

protected byte[] writeFieldInstContent()
UNUSED

Returns: null

Throws: IOException never thrown

writeFieldResultContent

protected byte[] writeFieldResultContent()
UNUSED

Returns: null

Throws: IOException never thrown