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: $Id: RtfTOCEntry.java 2784 2007-05-24 15:43:40Z hallm $

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

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
voidwriteContent(OutputStream result)
Writes the content of the RtfTOCEntry
protected byte[]writeFieldInstContent()
UNUSED
protected voidwriteFieldInstContent(OutputStream out)
unused
protected byte[]writeFieldResultContent()
UNUSED
protected voidwriteFieldResultContent(OutputStream out)

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()

Deprecated: replaced by writeContent

Writes the content of the RtfTOCEntry

Returns: A byte array with the contents of the RtfTOCEntry

writeContent

public void writeContent(OutputStream result)
Writes the content of the RtfTOCEntry

writeFieldInstContent

protected byte[] writeFieldInstContent()

Deprecated:

UNUSED

Returns: null

Throws: IOException never thrown

writeFieldInstContent

protected void writeFieldInstContent(OutputStream out)
unused

writeFieldResultContent

protected byte[] writeFieldResultContent()

Deprecated:

UNUSED

Returns: null

Throws: IOException never thrown

writeFieldResultContent

protected void writeFieldResultContent(OutputStream out)