Package 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:
com.lowagie.text.Element
,RtfBasicElement
,com.lowagie.text.RtfElementInterface
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 $
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
The entry text of this RtfTOCEntryprivate boolean
Whether to show page numbers in the table of contentsprivate static final byte[]
Constant for the end of hidden textprivate static final byte[]
Constant for the beginning of hidden textprivate static final byte[]
Constant for a TOC entry without page numbersprivate static final byte[]
Constant for a TOC entry with page numbersFields inherited from class com.lowagie.text.Chunk
ACTION, attributes, BACKGROUND, CHAR_SPACING, 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, FOOTNOTE, HEADER, IMGRAW, IMGTEMPLATE, JBIG2, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MODIFICATIONDATE, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE, YMARK
Fields inherited from interface com.lowagie.text.rtf.RtfBasicElement
CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR
-
Constructor Summary
ConstructorsConstructorDescriptionRtfTOCEntry
(String entry) Constructs a RtfTOCEntry with a certain entry text. -
Method Summary
Modifier and TypeMethodDescriptionvoid
setShowPageNumber
(boolean showPageNumber) Sets whether to display a page number in the table of contents, or notvoid
writeContent
(OutputStream result) Writes the content of theRtfTOCEntry
.protected void
unusedprotected void
unusedMethods 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, getCharacterSpacing, getChunkAttributes, getChunks, getContent, getFont, getHorizontalScaling, getHyphenation, getImage, getTextRise, getWidthPoint, hasAttributes, isContent, isNestable, process, setAction, setAnchor, setAnchor, setAnnotation, setBackground, setBackground, setCharacterSpacing, setChunkAttributes, setGenericTag, setHorizontalScaling, setHyphenation, setLocalDestination, setLocalGoto, setNewPage, setRemoteGoto, setRemoteGoto, setSkew, setSplitCharacter, setTextRenderMode, setTextRise, setUnderline, setUnderline, toString, type
-
Field Details
-
TEXT_HIDDEN_ON
private static final byte[] TEXT_HIDDEN_ONConstant for the beginning of hidden text -
TEXT_HIDDEN_OFF
private static final byte[] TEXT_HIDDEN_OFFConstant for the end of hidden text -
TOC_ENTRY_PAGE_NUMBER
private static final byte[] TOC_ENTRY_PAGE_NUMBERConstant for a TOC entry with page numbers -
TOC_ENTRY_NO_PAGE_NUMBER
private static final byte[] TOC_ENTRY_NO_PAGE_NUMBERConstant for a TOC entry without page numbers -
entry
The entry text of this RtfTOCEntry -
showPageNumber
private boolean showPageNumberWhether to show page numbers in the table of contents
-
-
Constructor Details
-
RtfTOCEntry
Constructs a RtfTOCEntry with a certain entry text.- Parameters:
entry
- The entry text to display
-
-
Method Details
-
writeContent
Writes the content of theRtfTOCEntry
.- Specified by:
writeContent
in interfaceRtfBasicElement
- Overrides:
writeContent
in classRtfField
- Parameters:
result
- TheOutputStream
to write to.- Throws:
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
unused- Specified by:
writeFieldInstContent
in classRtfField
- Parameters:
out
- TheOutputStream
to write to.- Throws:
IOException
-
writeFieldResultContent
unused- Specified by:
writeFieldResultContent
in classRtfField
- Parameters:
out
- TheOutputStream
to write to.- Throws:
IOException
- on i/o errors.
-