Package org.apache.fop.render.rtf.rtflib.rtfdoc

Class RtfFootnote

java.lang.Object

org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement

org.apache.fop.render.rtf.rtflib.rtfdoc.RtfContainer

org.apache.fop.render.rtf.rtflib.rtfdoc.RtfFootnote

All Implemented Interfaces:

IRtfListContainer, IRtfTextrunContainer

public class RtfFootnote
extends RtfContainer
implements IRtfTextrunContainer, IRtfListContainer

Model of an RTF footnote.

This work was authored by Peter Herweg (pherweg@web.de) and Marc Wilhelm Kuester.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	bBody
(package private) RtfContainer	body
(package private) RtfList	list
(package private) RtfTextrun	textrunInline

Fields inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement

attrib, parent, writer

Constructor Summary

Constructors

Constructor	Description
RtfFootnote(RtfContainer parent, Writer w)	Create an RTF list item as a child of given container with default attributes.

Method Summary

Modifier and Type	Method	Description
void	endBody()	end body
RtfTextrun	getTextrun()	Returns the current RtfTextrun object.
RtfList	newList(RtfAttributes attrs)	Close the current list, if any, and starts a new one
void	startBody()	start body
protected void	writeRtfContent()	write RTF code of all our children

Methods inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfContainer

addChild, containsText, dump, findChildren, getChildCount, getChildren, getOptions, isEmpty, okToWriteRtf, setChildren, setOptions, toString

Methods inherited from class org.apache.fop.render.rtf.rtflib.rtfdoc.RtfElement

close, getParentOfClass, getRtfAttributes, getRtfFile, isClosed, newLine, writeAttributes, writeControlWord, writeControlWordNS, writeExceptionInRtf, writeGroupMark, writeOneAttribute, writeOneAttributeNS, writeRtf, writeRtfPrefix, writeRtfSuffix, writeStarControlWord, writeStarControlWordNS

Methods inherited from class java.lang.Object

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

Field Details

textrunInline

RtfTextrun textrunInline

body

RtfContainer body

list

RtfList list

bBody

boolean bBody

Constructor Details

RtfFootnote

RtfFootnote(RtfContainer parent,
 Writer w)
     throws IOException

Create an RTF list item as a child of given container with default attributes.

Parameters:

parent - a container

w - a writer

Throws:

IOException - if not caught

Method Details

getTextrun

public RtfTextrun getTextrun()
                      throws IOException

Description copied from interface: IRtfTextrunContainer

Returns the current RtfTextrun object. Opens a new one if necessary.

Specified by:

getTextrun in interface IRtfTextrunContainer

Returns:

a text run

Throws:

IOException - if not caught

writeRtfContent

protected void writeRtfContent()
                        throws IOException

write RTF code of all our children

Overrides:

writeRtfContent in class RtfContainer

Throws:

IOException - for I/O problems

newList

public RtfList newList(RtfAttributes attrs)
                throws IOException

Description copied from interface: IRtfListContainer

Close the current list, if any, and starts a new one

Specified by:

newList in interface IRtfListContainer

Parameters:

attrs - some attributes

Returns:

an rtf list

Throws:

IOException - if not caught

startBody

public void startBody()

start body

endBody

public void endBody()

end body