Package org.apache.fop.render.rtf
Class RTFHandler
java.lang.Object
org.apache.fop.fo.FOEventHandler
org.apache.fop.render.rtf.RTFHandler
RTF Handler: generates RTF output using the structure events from
the FO Tree sent to this structure handler.
-
Field Summary
Fields inherited from class org.apache.fop.fo.FOEventHandler
fontInfo, foUserAgent
-
Constructor Summary
ConstructorDescriptionRTFHandler
(FOUserAgent userAgent, OutputStream os) Creates a new RTF structure handler. -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
void
void
void
endColumn
(TableColumn tc) boolean
endContainer
(Class containerClass) Closes any mismatched tags that are detected in the RTF structure.void
This method is called to indicate the end of a document run.void
void
endFooter
(TableFooter footer) void
endFootnote
(Footnote footnote) Process the ending of a footnote.void
endFootnoteBody
(FootnoteBody body) Process the ending of a footnote body.void
endHeader
(TableHeader header) void
void
Process the end of an InstreamForeignObject.void
Process end of a Link.void
void
endListBody
(ListItemBody listItemBody) Process end of a ListBody.void
endListItem
(ListItem li) void
endListLabel
(ListItemLabel listItemLabel) Process end of a ListLabel.void
Process end of a Markup.void
endPageNumber
(PageNumber pagenum) void
endPageSequence
(PageSequence pageSeq) void
void
endStatic
(StaticContent statisContent) Process end of a Static.void
protected void
Central exception handler for I/O exceptions.void
image
(ExternalGraphic eg) Process an ExternalGraphic.void
pageRef()
Process a pageRef.void
startBlock
(Block bl) void
void
void
void
void
This method is called to indicate the start of a new document run.void
This method is called to indicate the start of a new fo:flow or fo:static-content.void
startFooter
(TableFooter footer) void
startFootnote
(Footnote footnote) Process the start of a footnote.void
Process the start of a footnote body.void
startHeader
(TableHeader header) void
startInline
(Inline inl) void
Process the start of a Leader.void
Process start of a Link.void
void
startListBody
(ListItemBody listItemBody) Process start of a ListBody.void
void
startListLabel
(ListItemLabel listItemLabel) Process start of a ListLabel.void
Process start of a Markup.void
startPageNumber
(PageNumber pagenum) void
void
void
startPageSequence
(PageSequence pageSeq) void
void
startStatic
(StaticContent staticContent) Process start of a Static.void
startTable
(Table tbl) void
text
(FOText text, CharSequence characters) Methods inherited from class org.apache.fop.fo.FOEventHandler
character, characters, endExternalDocument, endLeader, endPageNumberCitation, endPageNumberCitationLast, endRetrieveMarker, endRetrieveTableMarker, endRoot, endWrapper, getFontInfo, getResults, getUserAgent, restoreState, restoreState, startExternalDocument, startInstreamForeignObject, startRetrieveMarker, startRetrieveTableMarker, startRoot, startWrapper
-
Constructor Details
-
RTFHandler
Creates a new RTF structure handler.- Parameters:
userAgent
- the FOUserAgent for this processos
- OutputStream to write to
-
-
Method Details
-
handleIOTrouble
Central exception handler for I/O exceptions.- Parameters:
ioe
- IOException to handle
-
startDocument
This method is called to indicate the start of a new document run.- Overrides:
startDocument
in classFOEventHandler
- Throws:
SAXException
- In case of a problem
-
endDocument
This method is called to indicate the end of a document run.- Overrides:
endDocument
in classFOEventHandler
- Throws:
SAXException
- In case of a problem
-
startPageSequence
- Overrides:
startPageSequence
in classFOEventHandler
- Parameters:
pageSeq
- PageSequence that is starting.
-
endPageSequence
- Overrides:
endPageSequence
in classFOEventHandler
- Parameters:
pageSeq
- PageSequence that is ending.
-
startFlow
This method is called to indicate the start of a new fo:flow or fo:static-content. This method also handles fo:static-content tags, because the StaticContent class is derived from the Flow class.- Overrides:
startFlow
in classFOEventHandler
- Parameters:
fl
- Flow that is starting.
-
endFlow
- Overrides:
endFlow
in classFOEventHandler
- Parameters:
fl
- Flow that is ending.
-
startBlock
- Overrides:
startBlock
in classFOEventHandler
- Parameters:
bl
- Block that is starting.
-
endBlock
- Overrides:
endBlock
in classFOEventHandler
- Parameters:
bl
- Block that is ending.
-
startBlockContainer
- Overrides:
startBlockContainer
in classFOEventHandler
- Parameters:
blc
- BlockContainer that is starting.
-
endBlockContainer
- Overrides:
endBlockContainer
in classFOEventHandler
- Parameters:
bl
- BlockContainer that is ending.
-
startTable
- Overrides:
startTable
in classFOEventHandler
- Parameters:
tbl
- Table that is starting.
-
endTable
- Overrides:
endTable
in classFOEventHandler
- Parameters:
tbl
- Table that is ending.
-
startColumn
- Overrides:
startColumn
in classFOEventHandler
- Parameters:
tc
- TableColumn that is starting;
-
endColumn
- Overrides:
endColumn
in classFOEventHandler
- Parameters:
tc
- TableColumn that is ending;
-
startHeader
- Overrides:
startHeader
in classFOEventHandler
- Parameters:
header
- TableHeader that is starting;
-
endHeader
- Overrides:
endHeader
in classFOEventHandler
- Parameters:
header
- TableHeader that is ending.
-
startInline
- Overrides:
startInline
in classFOEventHandler
- Parameters:
inl
- Inline that is starting.
-
endInline
- Overrides:
endInline
in classFOEventHandler
- Parameters:
inl
- Inline that is ending.
-
startBody
- Overrides:
startBody
in classFOEventHandler
- Parameters:
body
- TableBody that is starting.
-
endBody
- Overrides:
endBody
in classFOEventHandler
- Parameters:
body
- TableBody that is ending.
-
startRow
- Overrides:
startRow
in classFOEventHandler
- Parameters:
tr
- TableRow that is starting.
-
endRow
- Overrides:
endRow
in classFOEventHandler
- Parameters:
tr
- TableRow that is ending.
-
startCell
- Overrides:
startCell
in classFOEventHandler
- Parameters:
tc
- TableCell that is starting.
-
endCell
- Overrides:
endCell
in classFOEventHandler
- Parameters:
tc
- TableCell that is ending.
-
startList
- Overrides:
startList
in classFOEventHandler
- Parameters:
lb
- ListBlock that is starting.
-
endList
- Overrides:
endList
in classFOEventHandler
- Parameters:
lb
- ListBlock that is ending.
-
startListItem
- Overrides:
startListItem
in classFOEventHandler
- Parameters:
li
- ListItem that is starting.
-
endListItem
- Overrides:
endListItem
in classFOEventHandler
- Parameters:
li
- ListItem that is ending.
-
startListLabel
Process start of a ListLabel.- Overrides:
startListLabel
in classFOEventHandler
- Parameters:
listItemLabel
- ListItemLabel that is starting
-
endListLabel
Process end of a ListLabel.- Overrides:
endListLabel
in classFOEventHandler
- Parameters:
listItemLabel
- ListItemLabel that is ending
-
startListBody
Process start of a ListBody.- Overrides:
startListBody
in classFOEventHandler
- Parameters:
listItemBody
- ListItemBody that is starting
-
endListBody
Process end of a ListBody.- Overrides:
endListBody
in classFOEventHandler
- Parameters:
listItemBody
- ListItemBody that is ending
-
startStatic
Process start of a Static.- Overrides:
startStatic
in classFOEventHandler
- Parameters:
staticContent
- StaticContent that is starting
-
endStatic
Process end of a Static.- Overrides:
endStatic
in classFOEventHandler
- Parameters:
statisContent
- StaticContent that is ending
-
startMarkup
public void startMarkup()Process start of a Markup.- Overrides:
startMarkup
in classFOEventHandler
-
endMarkup
public void endMarkup()Process end of a Markup.- Overrides:
endMarkup
in classFOEventHandler
-
startLink
Process start of a Link.- Overrides:
startLink
in classFOEventHandler
- Parameters:
basicLink
- BasicLink that is starting
-
endLink
Process end of a Link.- Overrides:
endLink
in classFOEventHandler
- Parameters:
basicLink
- BasicLink that is ending
-
image
Process an ExternalGraphic.- Overrides:
image
in classFOEventHandler
- Parameters:
eg
- ExternalGraphic to process.
-
endInstreamForeignObject
Process the end of an InstreamForeignObject.- Overrides:
endInstreamForeignObject
in classFOEventHandler
- Parameters:
ifo
- InstreamForeignObject that is ending
-
pageRef
public void pageRef()Process a pageRef.- Overrides:
pageRef
in classFOEventHandler
-
startFootnote
Process the start of a footnote.- Overrides:
startFootnote
in classFOEventHandler
- Parameters:
footnote
- Footnote that is starting
-
endFootnote
Process the ending of a footnote.- Overrides:
endFootnote
in classFOEventHandler
- Parameters:
footnote
- Footnote that is ending
-
startFootnoteBody
Process the start of a footnote body.- Overrides:
startFootnoteBody
in classFOEventHandler
- Parameters:
body
- FootnoteBody that is starting
-
endFootnoteBody
Process the ending of a footnote body.- Overrides:
endFootnoteBody
in classFOEventHandler
- Parameters:
body
- FootnoteBody that is ending
-
startLeader
Process the start of a Leader.- Overrides:
startLeader
in classFOEventHandler
- Parameters:
l
- Leader that is starting
-
text
- Parameters:
text
- FOText objectcharacters
- CharSequence of the characters to process.
-
startPageNumber
- Overrides:
startPageNumber
in classFOEventHandler
- Parameters:
pagenum
- PageNumber that is starting.
-
endPageNumber
- Overrides:
endPageNumber
in classFOEventHandler
- Parameters:
pagenum
- PageNumber that is ending.
-
startPageNumberCitation
- Overrides:
startPageNumberCitation
in classFOEventHandler
- Parameters:
l
- PageNumberCitation that is starting.
-
startPageNumberCitationLast
- Overrides:
startPageNumberCitationLast
in classFOEventHandler
- Parameters:
l
- PageNumberCitationLast that is starting.
-
endContainer
Closes any mismatched tags that are detected in the RTF structure.- Parameters:
containerClass
- The class representing the tag to close.- Returns:
- Determines whether the tag mismatch has been handled.
-