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

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 $

Field Summary

Fields

Modifier and Type

Field

Description

private static final byte[]

CHFTN

private static final byte[]

FOOTNOTE

Constant for the actual footnote

protected final RtfParagraphStyle

paragraphStyle

An optional RtfParagraphStyle to use for styling.

private static final byte[]

SUPER

Fields inherited from class RtfPhrase
chunks, IN_TABLE, LINE_SPACING, PARAGRAPH_DEFAULTS, PLAIN

Fields inherited from class RtfElement
document, inHeader, inTable

Fields inherited from interface RtfBasicElement
CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR
Constructor Summary

Constructors

Constructor

Description

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

Constructs a RtfFootnote based on an Footnote.
Method Summary

Modifier and Type

Method

Description

void

writeContent(OutputStream result)

Writes the content of the RtfFootnote

Methods inherited from class RtfPhrase
setInHeader, setInTable, setRtfDocument

Methods inherited from class RtfElement
intToByteArray, isInTable

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- FOOTNOTE
  
  private static final byte[] FOOTNOTE
  
  Constant for the actual footnote
- SUPER
  
  private static final byte[] SUPER
- CHFTN
  
  private static final byte[] CHFTN
- paragraphStyle
  
  protected final RtfParagraphStyle paragraphStyle
  
  An optional RtfParagraphStyle to use for styling.
Constructor Details
- 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 Details
- 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