com.lowagie.text.rtf.field
Class RtfTableOfContents

java.lang.Object
  extended by com.lowagie.text.Chunk
      extended by com.lowagie.text.rtf.field.RtfField
          extended by com.lowagie.text.rtf.field.RtfTableOfContents
All Implemented Interfaces:
Element, RtfBasicElement

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 2998 2007-11-20 23:05:13Z hallm $
Author:
Mark Hall (mhall@edu.uni-klu.ac.at), Steffen.Stundzig (Steffen.Stundzig@smb-tec.com), Thomas Bickel (tmb99@inode.at)

Field Summary
private  java.lang.String defaultText
          The default text to display
private static java.lang.String FIELD_INST
          field inst content
 
Fields inherited from class com.lowagie.text.rtf.field.RtfField
document
 
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, SKEW, SPLITCHARACTER, SUBSUPSCRIPT, TEXTRENDERMODE, UNDERLINE
 
Fields inherited from interface com.lowagie.text.rtf.RtfBasicElement
CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR
 
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, JPEG, JPEG2000, KEYWORDS, LIST, LISTITEM, MARKED, MULTI_COLUMN_TEXT, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE
 
Constructor Summary
RtfTableOfContents(java.lang.String defaultText)
          Constructs a RtfTableOfContents.
 
Method Summary
protected  byte[] writeFieldInstContent()
          Deprecated. As of iText 2.0.6 or earlier, replaced by writeFieldInstContent(OutputStream), scheduled for removal at or after 2.1.0
protected  void writeFieldInstContent(java.io.OutputStream result)
          Writes the field instruction content
protected  byte[] writeFieldResultContent()
          Deprecated. As of iText 2.0.6 or earlier, replaced by writeFieldResultContent(OutputStream), scheduled for removal at or after 2.1.0
protected  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, setFieldAlt, setFieldDirty, setFieldEdit, setFieldLocked, setFieldPrivate, setFont, setInHeader, setInTable, setRtfDocument, write, writeContent
 
Methods inherited from class com.lowagie.text.Chunk
addToArray, append, content, font, getAttributes, getChunks, getContent, getFont, getHorizontalScaling, getImage, getKeySet, 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
 

Field Detail

FIELD_INST

private static final java.lang.String FIELD_INST
field inst content

See Also:
Constant Field Values

defaultText

private java.lang.String defaultText
The default text to display

Constructor Detail

RtfTableOfContents

public RtfTableOfContents(java.lang.String defaultText)
Constructs a RtfTableOfContents. The default text is the text that is displayed before the user updates the table of contents

Parameters:
defaultText - The default text to display
Method Detail

writeFieldInstContent

protected byte[] writeFieldInstContent()
                                throws java.io.IOException
Deprecated. As of iText 2.0.6 or earlier, replaced by writeFieldInstContent(OutputStream), scheduled for removal at or after 2.1.0

Writes the field instruction content

Specified by:
writeFieldInstContent in class RtfField
Returns:
A byte array containing with the field instructions
Throws:
java.io.IOException

writeFieldInstContent

protected void writeFieldInstContent(java.io.OutputStream result)
                              throws java.io.IOException
Writes the field instruction content

Overrides:
writeFieldInstContent in class RtfField
Parameters:
result - The OutputStream to write to.
Throws:
java.io.IOException - on i/o errors.

writeFieldResultContent

protected byte[] writeFieldResultContent()
                                  throws java.io.IOException
Deprecated. As of iText 2.0.6 or earlier, replaced by writeFieldResultContent(OutputStream), scheduled for removal at or after 2.1.0

Writes the field result content

Specified by:
writeFieldResultContent in class RtfField
Returns:
An byte array containing the default text
Throws:
java.io.IOException

writeFieldResultContent

protected void writeFieldResultContent(java.io.OutputStream out)
                                throws java.io.IOException
Writes the field result content

Overrides:
writeFieldResultContent in class RtfField
Parameters:
out - The OutputStream to write to.
Throws:
java.io.IOException - on i/o errors.