com.lowagie.text.rtf
Class RtfTOCEntry

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

Deprecated. Please move to the RtfWriter2 and associated classes. com.lowagie.text.rtf.field.RtfTOCEntry replaces the functionality of this class.

public class RtfTOCEntry
extends Chunk
implements RtfField

This class can be used to insert entries for a table of contents into the RTF document. ONLY FOR USE WITH THE RtfWriter NOT with the RtfWriter2. This class is based on the RtfWriter-package from Mark Hall.

Version:
$Revision: 2149 $Date: 2004/12/14 15:14:44 $
Author:
Steffen.Stundzig@smb-tec.com

Field Summary
private  Font contentFont
          Deprecated.  
private  Font entryFont
          Deprecated.  
private  String entryName
          Deprecated.  
private  boolean hidePageNumber
          Deprecated.  
private  boolean hideText
          Deprecated.  
 
Fields inherited from class com.lowagie.text.Chunk
ACTION, attributes, BACKGROUND, COLOR, content, ENCODING, font, 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(String content, Font contentFont)
          Deprecated. Constructs an entry for the Table of Contents
RtfTOCEntry(String content, Font contentFont, String entryName, Font entryFont)
          Deprecated. Constructs an entry for the Table of Contents
 
Method Summary
 void hidePageNumber()
          Deprecated. sets the hidePageNumber value to true
 void hideText()
          Deprecated. sets the hideText value to true
 void write(RtfWriter writer, OutputStream out)
          Deprecated. Writes an RTF field.
private  void writeField(OutputStream out)
          Deprecated.  
 
Methods inherited from class com.lowagie.text.Chunk
append, getAttributes, getChunks, getContent, getFont, getHorizontalScaling, getHyphenation, getImage, getTextRise, getWidthPoint, hasAttributes, isContent, isEmpty, isNestable, process, setAction, setAnchor, setAnchor, setAnnotation, setAttributes, setBackground, setBackground, setFont, 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

hideText

private boolean hideText
Deprecated. 

hidePageNumber

private boolean hidePageNumber
Deprecated. 

entryName

private String entryName
Deprecated. 

entryFont

private Font entryFont
Deprecated. 

contentFont

private Font contentFont
Deprecated. 
Constructor Detail

RtfTOCEntry

public RtfTOCEntry(String content,
                   Font contentFont)
Deprecated. 
Constructs an entry for the Table of Contents

Parameters:
content - the content of the entry
contentFont - the font

RtfTOCEntry

public RtfTOCEntry(String content,
                   Font contentFont,
                   String entryName,
                   Font entryFont)
Deprecated. 
Constructs an entry for the Table of Contents

Parameters:
content - the content of the entry
contentFont - the font
entryName - name of the entry
entryFont - font of the entryname
Method Detail

write

public void write(RtfWriter writer,
                  OutputStream out)
           throws IOException
Deprecated. 
Description copied from interface: RtfField
Writes an RTF field.

Specified by:
write in interface RtfField
Throws:
IOException
See Also:
RtfField.write(com.lowagie.text.rtf.RtfWriter, java.io.OutputStream)

writeField

private void writeField(OutputStream out)
                 throws IOException
Deprecated. 
Throws:
IOException

hideText

public void hideText()
Deprecated. 
sets the hideText value to true


hidePageNumber

public void hidePageNumber()
Deprecated. 
sets the hidePageNumber value to true


Hosted by Hostbasket