com.lowagie.text.rtf.field: public class: RtfTOCEntry

com.lowagie.text.rtf.field
public class: RtfTOCEntry [javadoc | source]

java.lang.Object
   com.lowagie.text.Chunk
      com.lowagie.text.rtf.field.RtfField
         com.lowagie.text.rtf.field.RtfTOCEntry

All Implemented Interfaces:
RtfBasicElement, Element

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 3373 2008-05-12 16:21:24Z xlv $

author: Mark - Hall (Mark.Hall@mail.room3b.eu)

author: Steffen.Stundzig - (Steffen.Stundzig@smb-tec.com)

author: Thomas - Bickel (tmb99@inode.at)

Fields inherited from com.lowagie.text.rtf.field.RtfField:
document

Fields inherited from com.lowagie.text.Chunk:
OBJECT_REPLACEMENT_CHARACTER, NEWLINE, NEXTPAGE, content, font, attributes, SEPARATOR, TAB, HSCALE, UNDERLINE, SUBSUPSCRIPT, SKEW, BACKGROUND, TEXTRENDERMODE, SPLITCHARACTER, HYPHENATION, REMOTEGOTO, LOCALGOTO, LOCALDESTINATION, GENERICTAG, IMAGE, ACTION, NEWPAGE, PDFANNOTATION, COLOR, ENCODING

Constructor:

Constructor:
public RtfTOCEntry(String entry) { super(null, new Font()); if(entry != null) { this.entry = entry; } } Constructs a RtfTOCEntry with a certain entry text. Parameters: `entry` - The entry text to display

 public RtfTOCEntry(String entry) {
    
        super(null, new Font());
        if(entry != null) {
            this.entry = entry;
        }
}

Constructs a RtfTOCEntry with a certain entry text.

Parameters:

entry - The entry text to display

Method from com.lowagie.text.rtf.field.RtfTOCEntry Summary:
setShowPageNumber, writeContent, writeFieldInstContent, writeFieldResultContent

Methods from com.lowagie.text.rtf.field.RtfField:
isEmpty, isFieldAlt, isFieldDirty, isFieldEdit, isFieldLocked, isFieldPrivate, isInHeader, isInTable, setFieldAlt, setFieldDirty, setFieldEdit, setFieldLocked, setFieldPrivate, setFont, setInHeader, setInTable, setRtfDocument, writeContent, writeFieldInstContent, writeFieldResultContent

Methods from 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 from 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 from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from com.lowagie.text.rtf.field.RtfTOCEntry Detail:
public void setShowPageNumber(boolean showPageNumber) { this.showPageNumber = showPageNumber; } Sets whether to display a page number in the table of contents, or not
public void writeContent(OutputStream result) throws IOException { result.write(TEXT_HIDDEN_ON); result.write(OPEN_GROUP); if(this.showPageNumber) { result.write(TOC_ENTRY_PAGE_NUMBER); } else { result.write(TOC_ENTRY_NO_PAGE_NUMBER); } result.write(DELIMITER); this.document.filterSpecialChar(result, this.entry, true, false); result.write(CLOSE_GROUP); result.write(TEXT_HIDDEN_OFF); } Writes the content of the `RtfTOCEntry`.
protected void writeFieldInstContent(OutputStream out) throws IOException { } unused
protected void writeFieldResultContent(OutputStream out) throws IOException { } unused

Method from com.lowagie.text.rtf.field.RtfTOCEntry Detail:

 public  void setShowPageNumber(boolean showPageNumber) {
        this.showPageNumber = showPageNumber;
}

Sets whether to display a page number in the table of contents, or not

 public  void writeContent(OutputStream result) throws IOException {
    	
        result.write(TEXT_HIDDEN_ON);
        result.write(OPEN_GROUP);
        if(this.showPageNumber) {
            result.write(TOC_ENTRY_PAGE_NUMBER);
        } else {
            result.write(TOC_ENTRY_NO_PAGE_NUMBER);
        }
        result.write(DELIMITER);
        this.document.filterSpecialChar(result, this.entry, true, false);
        result.write(CLOSE_GROUP);
        result.write(TEXT_HIDDEN_OFF);
}

RtfTOCEntry

 protected  void writeFieldInstContent(OutputStream out) throws IOException {

}

unused

 protected  void writeFieldResultContent(OutputStream out) throws IOException {

}

unused