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, RtfBasicElement, RtfElementInterface
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 3580 2008-08-06 15:52:00Z howard_s $
- Author:
- Mark Hall (Mark.Hall@mail.room3b.eu), Steffen.Stundzig (Steffen.Stundzig@smb-tec.com), Thomas Bickel (tmb99@inode.at)
Fields inherited from class com.lowagie.text.Chunk |
ACTION, attributes, BACKGROUND, COLOR, content, ENCODING, GENERICTAG, HSCALE, HYPHENATION, IMAGE, LOCALDESTINATION, LOCALGOTO, NEWLINE, NEWPAGE, NEXTPAGE, OBJECT_REPLACEMENT_CHARACTER, PDFANNOTATION, REMOTEGOTO, SEPARATOR, SKEW, SPLITCHARACTER, SUBSUPSCRIPT, TAB, 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, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE, YMARK |
Constructor Summary |
RtfTOCEntry(java.lang.String entry)
Constructs a RtfTOCEntry with a certain entry text. |
Methods inherited from class com.lowagie.text.rtf.field.RtfField |
isEmpty, isFieldAlt, isFieldDirty, isFieldEdit, isFieldLocked, isFieldPrivate, isInHeader, isInTable, setFieldAlt, setFieldDirty, setFieldEdit, setFieldLocked, setFieldPrivate, setFont, setInHeader, setInTable, setRtfDocument |
Methods inherited from class com.lowagie.text.Chunk |
append, getAttributes, getChunks, getContent, getFont, getHorizontalScaling, getHyphenation, getImage, getTextRise, getWidthPoint, hasAttributes, isContent, isNestable, process, setAction, setAnchor, setAnchor, setAnnotation, setAttributes, setBackground, setBackground, setGenericTag, setHorizontalScaling, setHyphenation, setLocalDestination, setLocalGoto, setNewPage, setRemoteGoto, setRemoteGoto, setSkew, setSplitCharacter, setTextRenderMode, setTextRise, setUnderline, setUnderline, toString, type |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
RtfTOCEntry
public RtfTOCEntry(java.lang.String entry)
- Constructs a RtfTOCEntry with a certain entry text.
- Parameters:
entry
- The entry text to display
writeContent
public void writeContent(java.io.OutputStream result)
throws java.io.IOException
- Writes the content of the
RtfTOCEntry
.
- Specified by:
writeContent
in interface RtfBasicElement
- Overrides:
writeContent
in class RtfField
- Parameters:
result
- The OutputStream
to write to.
- Throws:
java.io.IOException
- on i/o errors.
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 void writeFieldInstContent(java.io.OutputStream out)
throws java.io.IOException
- unused
- Specified by:
writeFieldInstContent
in class RtfField
- Parameters:
out
- The OutputStream
to write to.
- Throws:
java.io.IOException
writeFieldResultContent
protected void writeFieldResultContent(java.io.OutputStream out)
throws java.io.IOException
- unused
- Specified by:
writeFieldResultContent
in class RtfField
- Parameters:
out
- The OutputStream
to write to.
- Throws:
java.io.IOException
- on i/o errors.
iText 2.1.7