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

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

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

All Implemented Interfaces:
RtfField, Element

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.

author: < - a href="mailto:Steffen.Stundzig@smb-tec.com">Steffen.Stundzig@smb-tec.com

version: $ - Revision: 1.22 $Date: 2004/12/14 15:14:44 $

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 content, Font contentFont) { this( content, contentFont, content, contentFont ); // super( content, font ); // this.entryName = content; // printEntryNameAsText = true; } Constructs an entry for the Table of Contents Parameters: `content` - the content of the entry `contentFont` - the font
public RtfTOCEntry(String content, Font contentFont, String entryName, Font entryFont) { super( content, contentFont ); // hide the text of the entry, because it is printed this.entryName = entryName; this.entryFont = entryFont; this.contentFont = contentFont; } 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

 public RtfTOCEntry(String content,
    Font contentFont) {
    
        this( content, contentFont, content, contentFont );
//        super( content, font );
//        this.entryName = content;
//        printEntryNameAsText = true;
}

Constructs an entry for the Table of Contents

Parameters:

content - the content of the entry

contentFont - the font

 public RtfTOCEntry(String content,
    Font contentFont,
    String entryName,
    Font entryFont) {
        super( content, contentFont );
        // hide the text of the entry, because it is printed  
        this.entryName = entryName;
        this.entryFont = entryFont;
        this.contentFont = contentFont;
}

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 from com.lowagie.text.rtf.RtfTOCEntry Summary:
hidePageNumber, hideText, write

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.RtfTOCEntry Detail:
public void hidePageNumber() { hidePageNumber = true; } sets the hidePageNumber value to true
public void hideText() { hideText = true; } sets the hideText value to true
public void write(RtfWriter writer, OutputStream out) throws IOException { if (!hideText) { writer.writeInitialFontSignature( out, new Chunk("", contentFont) ); out.write( RtfWriter.filterSpecialChar( content(), true ).getBytes() ); writer.writeFinishingFontSignature( out, new Chunk("", contentFont) ); } if (!entryFont.equals( contentFont )) { writer.writeInitialFontSignature(out, new Chunk("", entryFont) ); writeField( out ); writer.writeFinishingFontSignature(out, new Chunk("", entryFont) ); } else { writer.writeInitialFontSignature(out, new Chunk("", contentFont) ); writeField( out ); writer.writeFinishingFontSignature(out, new Chunk("", contentFont) ); } }

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

 public  void hidePageNumber() {
        hidePageNumber = true;
}

sets the hidePageNumber value to true

 public  void hideText() {
        hideText = true;
}

sets the hideText value to true

 public  void write(RtfWriter writer,
    OutputStream out) throws IOException {
        if (!hideText) {
            writer.writeInitialFontSignature( out, new Chunk("", contentFont) );
            out.write( RtfWriter.filterSpecialChar( content(), true ).getBytes() );
            writer.writeFinishingFontSignature( out, new Chunk("", contentFont) );
        }
        if (!entryFont.equals( contentFont )) {
            writer.writeInitialFontSignature(out, new Chunk("", entryFont) );
            writeField( out );
            writer.writeFinishingFontSignature(out, new Chunk("", entryFont) );
        } else {
            writer.writeInitialFontSignature(out, new Chunk("", contentFont) );
            writeField( out );
            writer.writeFinishingFontSignature(out, new Chunk("", contentFont) );
        }
}