org.apache.fop.render.rtf

Class RTFHandler


public class RTFHandler
extends FOEventHandler

RTF Handler: generates RTF output using the structure events from the FO Tree sent to this structure handler.
Authors:
Bertrand Delacretaz
Trembicki-Guy, Ed
Boris Poud??rous
Peter Herweg
Andreas Putz

Field Summary

Fields inherited from class org.apache.fop.fo.FOEventHandler

foUserAgent, fontInfo, propertyListMaker, whiteSpaceHandler

Constructor Summary

RTFHandler(FOUserAgent userAgent, OutputStream os)
Creates a new RTF structure handler.

Method Summary

void
endBlock(Block bl)
void
endBlockContainer(BlockContainer bl)
void
endBody(TableBody tb)
void
endCell(TableCell tc)
void
endColumn(TableColumn tc)
void
endDocument()
void
endFlow(Flow fl)
void
endFooter(TableBody tf)
void
endFootnote(Footnote footnote)
void
endFootnoteBody(FootnoteBody body)
void
endHeader(TableBody th)
void
endInline(Inline inl)
void
endLink()
void
endList(ListBlock lb)
void
endListBody()
void
endListItem(ListItem li)
void
endListLabel()
void
endMarkup()
void
endPageNumber(PageNumber pagenum)
void
endPageSequence(PageSequence pageSeq)
void
endRow(TableRow tr)
void
endStatic()
void
endTable(Table tbl)
void
foreignObject(InstreamForeignObject ifo)
void
image(ExternalGraphic eg)
void
leader(Leader l)
void
pageRef()
void
startBlock(Block bl)
void
startBlockContainer(BlockContainer blc)
void
startBody(TableBody tb)
void
startCell(TableCell tc)
void
startColumn(TableColumn tc)
void
startDocument()
void
startFlow(Flow fl)
void
startFooter(TableBody tf)
void
startFootnote(Footnote footnote)
void
startFootnoteBody(FootnoteBody body)
void
startHeader(TableBody th)
void
startInline(Inline inl)
void
startLink(BasicLink basicLink)
void
startList(ListBlock lb)
void
startListBody()
void
startListItem(ListItem li)
void
startListLabel()
void
startMarkup()
void
startPageNumber(PageNumber pagenum)
void
startPageSequence(PageSequence pageSeq)
void
startRow(TableRow tr)
void
startStatic()
void
startTable(Table tbl)
void
text(FOText text, char[] data, int start, int length)

Methods inherited from class org.apache.fop.fo.FOEventHandler

character, characters, endBlock, endBlockContainer, endBody, endCell, endColumn, endDocument, endFlow, endFooter, endFootnote, endFootnoteBody, endHeader, endInline, endLink, endList, endListBody, endListItem, endListLabel, endMarkup, endPageNumber, endPageSequence, endRow, endStatic, endTable, foreignObject, getFontInfo, getIDReferences, getPropertyListMaker, getUserAgent, getXMLWhiteSpaceHandler, image, inMarker, leader, pageRef, setPropertyListMaker, startBlock, startBlockContainer, startBody, startCell, startColumn, startDocument, startFlow, startFooter, startFootnote, startFootnoteBody, startHeader, startInline, startLink, startList, startListBody, startListItem, startListLabel, startMarkup, startPageNumber, startPageSequence, startRow, startStatic, startTable, switchMarkerContext

Constructor Details

RTFHandler

public RTFHandler(FOUserAgent userAgent,
                  OutputStream os)
Creates a new RTF structure handler.
Parameters:
userAgent - the FOUserAgent for this process
os - OutputStream to write to

Method Details

endBlock

public void endBlock(Block bl)
Overrides:
endBlock in interface FOEventHandler
Parameters:
bl - Block that is ending

endBlockContainer

public void endBlockContainer(BlockContainer bl)
Overrides:
endBlockContainer in interface FOEventHandler
Parameters:
bl - BlockContainer that is ending

endBody

public void endBody(TableBody tb)
Overrides:
endBody in interface FOEventHandler
Parameters:
tb - TableBody that is ending

endCell

public void endCell(TableCell tc)
Overrides:
endCell in interface FOEventHandler
Parameters:
tc - TableCell that is ending

endColumn

public void endColumn(TableColumn tc)
Overrides:
endColumn in interface FOEventHandler
Parameters:
tc - TableColumn that is ending;

endDocument

public void endDocument()
            throws SAXException
Overrides:
endDocument in interface FOEventHandler

endFlow

public void endFlow(Flow fl)
Overrides:
endFlow in interface FOEventHandler
Parameters:
fl - Flow that is ending

endFooter

public void endFooter(TableBody tf)
Overrides:
endFooter in interface FOEventHandler
Parameters:
tf - TableFooter that is ending

endFootnote

public void endFootnote(Footnote footnote)
Overrides:
endFootnote in interface FOEventHandler
Parameters:
footnote - Footnote that is ending

endFootnoteBody

public void endFootnoteBody(FootnoteBody body)
Overrides:
endFootnoteBody in interface FOEventHandler
Parameters:
body - FootnoteBody that is ending

endHeader

public void endHeader(TableBody th)
Overrides:
endHeader in interface FOEventHandler
Parameters:
th - TableBody that is ending

endInline

public void endInline(Inline inl)
Overrides:
endInline in interface FOEventHandler
Parameters:
inl - Inline that is ending.

endLink

public void endLink()
Overrides:
endLink in interface FOEventHandler

endList

public void endList(ListBlock lb)
Overrides:
endList in interface FOEventHandler
Parameters:
lb - ListBlock that is ending

endListBody

public void endListBody()
Overrides:
endListBody in interface FOEventHandler

endListItem

public void endListItem(ListItem li)
Overrides:
endListItem in interface FOEventHandler
Parameters:
li - ListItem that is ending

endListLabel

public void endListLabel()
Overrides:
endListLabel in interface FOEventHandler

endMarkup

public void endMarkup()
Overrides:
endMarkup in interface FOEventHandler

endPageNumber

public void endPageNumber(PageNumber pagenum)
Overrides:
endPageNumber in interface FOEventHandler
Parameters:
pagenum - PageNumber that is ending.

endPageSequence

public void endPageSequence(PageSequence pageSeq)
Overrides:
endPageSequence in interface FOEventHandler
Parameters:
pageSeq - PageSequence that is ending

endRow

public void endRow(TableRow tr)
Overrides:
endRow in interface FOEventHandler
Parameters:
tr - TableRow that is ending

endStatic

public void endStatic()
Overrides:
endStatic in interface FOEventHandler

endTable

public void endTable(Table tbl)
Overrides:
endTable in interface FOEventHandler
Parameters:
tbl - Table that is ending

foreignObject

public void foreignObject(InstreamForeignObject ifo)
Overrides:
foreignObject in interface FOEventHandler
Parameters:
ifo - InstreamForeignObject that is starting

image

public void image(ExternalGraphic eg)
Overrides:
image in interface FOEventHandler
Parameters:
eg - ExternalGraphic that is starting

leader

public void leader(Leader l)
Overrides:
leader in interface FOEventHandler
Parameters:
l - Leader that is starting

pageRef

public void pageRef()
Overrides:
pageRef in interface FOEventHandler

startBlock

public void startBlock(Block bl)
Overrides:
startBlock in interface FOEventHandler
Parameters:
bl - Block that is starting

startBlockContainer

public void startBlockContainer(BlockContainer blc)
Overrides:
startBlockContainer in interface FOEventHandler
Parameters:
blc - BlockContainer that is starting

startBody

public void startBody(TableBody tb)
Overrides:
startBody in interface FOEventHandler
Parameters:
tb - TableBody that is starting

startCell

public void startCell(TableCell tc)
Overrides:
startCell in interface FOEventHandler
Parameters:
tc - TableCell that is starting

startColumn

public void startColumn(TableColumn tc)
Overrides:
startColumn in interface FOEventHandler
Parameters:
tc - TableColumn that is starting;

startDocument

public void startDocument()
            throws SAXException
Overrides:
startDocument in interface FOEventHandler

startFlow

public void startFlow(Flow fl)
Overrides:
startFlow in interface FOEventHandler
Parameters:
fl - Flow that is starting

startFooter

public void startFooter(TableBody tf)
Overrides:
startFooter in interface FOEventHandler
Parameters:
tf - TableFooter that is starting

startFootnote

public void startFootnote(Footnote footnote)
Overrides:
startFootnote in interface FOEventHandler
Parameters:
footnote - Footnote that is starting

startFootnoteBody

public void startFootnoteBody(FootnoteBody body)
Overrides:
startFootnoteBody in interface FOEventHandler
Parameters:
body - FootnoteBody that is starting

startHeader

public void startHeader(TableBody th)
Overrides:
startHeader in interface FOEventHandler
Parameters:
th - TableBody that is starting

startInline

public void startInline(Inline inl)
Overrides:
startInline in interface FOEventHandler
Parameters:
inl - Inline that is starting.

startLink

public void startLink(BasicLink basicLink)
Overrides:
startLink in interface FOEventHandler
Parameters:
basicLink - BasicLink that is starting
See Also:
org.apache.fop.fo.FOEventHandler.startLink(BasicLink basicLink)

startList

public void startList(ListBlock lb)
Overrides:
startList in interface FOEventHandler
Parameters:
lb - ListBlock that is starting

startListBody

public void startListBody()
Overrides:
startListBody in interface FOEventHandler

startListItem

public void startListItem(ListItem li)
Overrides:
startListItem in interface FOEventHandler
Parameters:
li - ListItem that is starting

startListLabel

public void startListLabel()
Overrides:
startListLabel in interface FOEventHandler

startMarkup

public void startMarkup()
Overrides:
startMarkup in interface FOEventHandler

startPageNumber

public void startPageNumber(PageNumber pagenum)
Overrides:
startPageNumber in interface FOEventHandler
Parameters:
pagenum - PageNumber that is starting.

startPageSequence

public void startPageSequence(PageSequence pageSeq)
Overrides:
startPageSequence in interface FOEventHandler
Parameters:
pageSeq - PageSequence that is starting

startRow

public void startRow(TableRow tr)
Overrides:
startRow in interface FOEventHandler
Parameters:
tr - TableRow that is starting

startStatic

public void startStatic()
Overrides:
startStatic in interface FOEventHandler

startTable

public void startTable(Table tbl)
Overrides:
startTable in interface FOEventHandler
Parameters:
tbl - Table that is starting

text

public void text(FOText text,
                 char[] data,
                 int start,
                 int length)
Parameters:
text - FOText object
data - Array of characters to process.
start - Offset for characters to process.
length - Portion of array to process.

Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.