com.lowagie.text.rtf.text

Class RtfFootnote

java.lang.Object

com.lowagie.text.rtf.RtfElement

com.lowagie.text.rtf.text.RtfPhrase

com.lowagie.text.rtf.text.RtfFootnote

All Implemented Interfaces:

RtfBasicElement, com.lowagie.text.RtfElementInterface

public class RtfFootnote
extends RtfPhrase

The RtfFootnote provides support for adding Footnotes to the rtf document. Only simple Footnotes with Title / Content are supported.

Version:

$Id: RtfFootnote.java 3580 2008-08-06 15:52:00Z howard_s $

Author:

Mark Hall (Mark.Hall@mail.room3b.eu), Thomas Bickel (tmb99@inode.at)

Field Summary

Fields

Modifier and Type	Field and Description
protected RtfParagraphStyle	paragraphStyle An optional RtfParagraphStyle to use for styling.

Fields inherited from class com.lowagie.text.rtf.text.RtfPhrase

chunks, IN_TABLE, LINE_SPACING, PARAGRAPH_DEFAULTS, PLAIN

Fields inherited from class com.lowagie.text.rtf.RtfElement

document, inHeader, inTable

Fields inherited from interface com.lowagie.text.rtf.RtfBasicElement

CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR

Constructor Summary

Constructors

Constructor and Description
RtfFootnote(RtfDocument doc, com.lowagie.text.Footnote footnote) Constructs a RtfFootnote based on an Footnote.

Method Summary

Modifier and Type	Method and Description
void	writeContent(OutputStream result) Writes the content of the RtfFootnote

Methods inherited from class com.lowagie.text.rtf.text.RtfPhrase

setInHeader, setInTable, setRtfDocument

Methods inherited from class com.lowagie.text.rtf.RtfElement

intToByteArray, isInTable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

paragraphStyle

protected RtfParagraphStyle paragraphStyle

An optional RtfParagraphStyle to use for styling.

Constructor Detail

RtfFootnote

public RtfFootnote(RtfDocument doc,
                   com.lowagie.text.Footnote footnote)

Constructs a RtfFootnote based on an Footnote.

Parameters:

doc - The RtfDocument this RtfFootnote belongs to

footnote - The Footnote this RtfFootnote is based off

Method Detail

writeContent

public void writeContent(OutputStream result)
                  throws IOException

Writes the content of the RtfFootnote

Specified by:

writeContent in interface RtfBasicElement

Overrides:

writeContent in class RtfPhrase

Parameters:

result - The OutputStream to write the content to

Throws:

IOException