com.lowagie.text.rtf.field
Class RtfTOCEntry
java.lang.Object
com.lowagie.text.Chunk
com.lowagie.text.rtf.field.RtfField
com.lowagie.text.rtf.field.RtfTOCEntry
- All Implemented Interfaces:
- Element, MarkupAttributes, RtfBasicElement
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@smb-tec.com
Fields inherited from class com.lowagie.text.Chunk |
ACTION, attributes, BACKGROUND, COLOR, content, ENCODING, GENERICTAG, HSCALE, HYPHENATION, IMAGE, LOCALDESTINATION, LOCALGOTO, markupAttributes, NEWLINE, NEWPAGE, NEXTPAGE, OBJECT_REPLACEMENT_CHARACTER, PDFANNOTATION, REMOTEGOTO, SKEW, SPLITCHARACTER, SUBSUPSCRIPT, TEXTRENDERMODE, UNDERLINE |
Constructor Summary |
RtfTOCEntry(String entry,
Font font)
Constructs a RtfTOCEntry with a certain entry text. |
Methods inherited from class com.lowagie.text.rtf.field.RtfField |
isEmpty, isFieldAlt, isFieldDirty, isFieldEdit, isFieldLocked, isFieldPrivate, setFieldAlt, setFieldDirty, setFieldEdit, setFieldLocked, setFieldPrivate, setInHeader, setInTable, setRtfDocument |
Methods inherited from class com.lowagie.text.Chunk |
addToArray, append, content, font, getAttributes, getChunks, getHorizontalScaling, getImage, getKeySet, getMarkupAttribute, getMarkupAttributeNames, getMarkupAttributes, getTextRise, getWidthPoint, hasAttributes, 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, toString, type |
RtfTOCEntry
public RtfTOCEntry(String entry,
Font font)
- Constructs a RtfTOCEntry with a certain entry text.
- Parameters:
entry
- The entry text to displayfont
- The Font to use
write
public byte[] write()
- Writes the content of the RtfTOCEntry
- Specified by:
write
in interface RtfBasicElement
- Overrides:
write
in class RtfField
- Returns:
- A byte array with the contents of the RtfTOCEntry
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
writeFieldInstContent
protected byte[] writeFieldInstContent()
throws IOException
- UNUSED
- Specified by:
writeFieldInstContent
in class RtfField
- Returns:
- null
- Throws:
IOException
- never thrown
writeFieldResultContent
protected byte[] writeFieldResultContent()
throws IOException
- UNUSED
- Specified by:
writeFieldResultContent
in class RtfField
- Returns:
- null
- Throws:
IOException
- never thrown
Copyright © 2006-2007 EGIZ - E-Government Innovationszentrum. All Rights Reserved.