Package com.lowagie.text.rtf.field
Class RtfTableOfContents
- java.lang.Object
-
- com.lowagie.text.Chunk
-
- com.lowagie.text.rtf.field.RtfField
-
- com.lowagie.text.rtf.field.RtfTableOfContents
-
- All Implemented Interfaces:
com.lowagie.text.Element
,RtfBasicElement
,com.lowagie.text.RtfElementInterface
public class RtfTableOfContents extends RtfField
The RtfTableOfContents together with multiple RtfTOCEntry objects generates a table of contents. The table of contents will display no entries in the viewing program and the user will have to update it first. A text to inform the user of this is displayed instead.- Version:
- $Id: RtfTableOfContents.java 3580 2008-08-06 15:52:00Z howard_s $
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
defaultText
The default text to displayprivate static java.lang.String
FIELD_INST
field inst content-
Fields 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
Constructors Constructor Description RtfTableOfContents(java.lang.String defaultText)
Constructs a RtfTableOfContents.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
writeFieldInstContent(java.io.OutputStream result)
Writes the field instruction contentprotected void
writeFieldResultContent(java.io.OutputStream out)
Writes the field result content-
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, writeContent
-
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 Detail
-
FIELD_INST
private static final java.lang.String FIELD_INST
field inst content- See Also:
- Constant Field Values
-
defaultText
private final java.lang.String defaultText
The default text to display
-
-
Method Detail
-
writeFieldInstContent
protected void writeFieldInstContent(java.io.OutputStream result) throws java.io.IOException
Writes the field instruction content- Specified by:
writeFieldInstContent
in classRtfField
- Parameters:
result
- TheOutputStream
to write to.- Throws:
java.io.IOException
- on i/o errors.
-
writeFieldResultContent
protected void writeFieldResultContent(java.io.OutputStream out) throws java.io.IOException
Writes the field result content- Specified by:
writeFieldResultContent
in classRtfField
- Parameters:
out
- TheOutputStream
to write to.- Throws:
java.io.IOException
- on i/o errors.
-
-