Package org.apache.fop.fo
Class DelegatingFOEventHandler
java.lang.Object
org.apache.fop.fo.FOEventHandler
org.apache.fop.fo.DelegatingFOEventHandler
- Direct Known Subclasses:
FO2StructureTreeConverter
This class delegates all FO events to another FOEventHandler instance.
-
Field Summary
Fields inherited from class org.apache.fop.fo.FOEventHandler
fontInfo, foUserAgent
-
Constructor Summary
ConstructorDescriptionDelegatingFOEventHandler
(FOEventHandler delegate) Creates a new instance that delegates events to the given object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Process a Character.void
characters
(FOText foText) Process character data.void
void
void
void
void
endColumn
(TableColumn tc) void
This method is called to indicate the end of a document run.void
endExternalDocument
(ExternalDocument document) Process the end of the external-document extension.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 the end of a Leader.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
endPageNumberCitation
(PageNumberCitation pageCite) void
void
endPageSequence
(PageSequence pageSeq) void
endRetrieveMarker
(RetrieveMarker retrieveMarker) Process the ending of a retrieve-marker.void
endRetrieveTableMarker
(RetrieveTableMarker retrieveTableMarker) Process the ending of a retrieve-table-marker.void
Called upon end of root element.void
void
endStatic
(StaticContent statisContent) Process end of a Static.void
void
endWrapper
(Wrapper wrapper) Process the ending of a wrapper.Retrieve the font information for this documentGet formatting results.Returns the User Agent object associated with this FOEventHandler.void
image
(ExternalGraphic eg) Process an ExternalGraphic.void
pageRef()
Process a pageRef.void
restoreState
(RetrieveMarker retrieveMarker) Restore the state of this event handler as it was when the given fo:retrieve-marker element was processed.void
restoreState
(RetrieveTableMarker retrieveTableMarker) void
startBlock
(Block bl) void
void
void
void
void
This method is called to indicate the start of a new document run.void
startExternalDocument
(ExternalDocument document) Process the start of the external-document extension.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 an InstreamForeignObject.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
startPageNumberCitation
(PageNumberCitation pageCite) void
void
startPageSequence
(PageSequence pageSeq) void
startRetrieveMarker
(RetrieveMarker retrieveMarker) Process the start of a retrieve-marker.void
startRetrieveTableMarker
(RetrieveTableMarker retrieveTableMarker) Process the start of a retrieve-table-marker.void
Called upon start of root element.void
void
startStatic
(StaticContent staticContent) Process start of a Static.void
startTable
(Table tbl) void
startWrapper
(Wrapper wrapper) Process the start of a wrapper.
-
Constructor Details
-
DelegatingFOEventHandler
Creates a new instance that delegates events to the given object.- Parameters:
delegate
- the object to which all FO events will be forwarded
-
-
Method Details
-
getUserAgent
Description copied from class:FOEventHandler
Returns the User Agent object associated with this FOEventHandler.- Overrides:
getUserAgent
in classFOEventHandler
- Returns:
- the User Agent object
-
getFontInfo
Description copied from class:FOEventHandler
Retrieve the font information for this document- Overrides:
getFontInfo
in classFOEventHandler
- Returns:
- the FontInfo instance for this document
-
startDocument
Description copied from class:FOEventHandler
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
Description copied from class:FOEventHandler
This method is called to indicate the end of a document run.- Overrides:
endDocument
in classFOEventHandler
- Throws:
SAXException
- In case of a problem
-
startRoot
Description copied from class:FOEventHandler
Called upon start of root element.- Overrides:
startRoot
in classFOEventHandler
- Parameters:
root
- element
-
endRoot
Description copied from class:FOEventHandler
Called upon end of root element.- Overrides:
endRoot
in classFOEventHandler
- Parameters:
root
- element
-
startPageSequence
- Overrides:
startPageSequence
in classFOEventHandler
- Parameters:
pageSeq
- PageSequence that is starting.
-
endPageSequence
- Overrides:
endPageSequence
in classFOEventHandler
- Parameters:
pageSeq
- PageSequence that is ending.
-
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:
pageCite
- PageNumberCitation that is starting.
-
endPageNumberCitation
- Overrides:
endPageNumberCitation
in classFOEventHandler
- Parameters:
pageCite
- PageNumberCitation that is ending.
-
startPageNumberCitationLast
- Overrides:
startPageNumberCitationLast
in classFOEventHandler
- Parameters:
pageLast
- PageNumberCitationLast that is starting.
-
endPageNumberCitationLast
- Overrides:
endPageNumberCitationLast
in classFOEventHandler
- Parameters:
pageLast
- PageNumberCitationLast that is ending.
-
startStatic
Description copied from class:FOEventHandler
Process start of a Static.- Overrides:
startStatic
in classFOEventHandler
- Parameters:
staticContent
- StaticContent that is starting
-
endStatic
Description copied from class:FOEventHandler
Process end of a Static.- Overrides:
endStatic
in classFOEventHandler
- Parameters:
statisContent
- StaticContent that is ending
-
startFlow
Description copied from class:FOEventHandler
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:
blc
- BlockContainer 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.
-
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.
-
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
Description copied from class:FOEventHandler
Process start of a ListLabel.- Overrides:
startListLabel
in classFOEventHandler
- Parameters:
listItemLabel
- ListItemLabel that is starting
-
endListLabel
Description copied from class:FOEventHandler
Process end of a ListLabel.- Overrides:
endListLabel
in classFOEventHandler
- Parameters:
listItemLabel
- ListItemLabel that is ending
-
startListBody
Description copied from class:FOEventHandler
Process start of a ListBody.- Overrides:
startListBody
in classFOEventHandler
- Parameters:
listItemBody
- ListItemBody that is starting
-
endListBody
Description copied from class:FOEventHandler
Process end of a ListBody.- Overrides:
endListBody
in classFOEventHandler
- Parameters:
listItemBody
- ListItemBody that is ending
-
startMarkup
public void startMarkup()Description copied from class:FOEventHandler
Process start of a Markup.- Overrides:
startMarkup
in classFOEventHandler
-
endMarkup
public void endMarkup()Description copied from class:FOEventHandler
Process end of a Markup.- Overrides:
endMarkup
in classFOEventHandler
-
startLink
Description copied from class:FOEventHandler
Process start of a Link.- Overrides:
startLink
in classFOEventHandler
- Parameters:
basicLink
- BasicLink that is starting
-
endLink
Description copied from class:FOEventHandler
Process end of a Link.- Overrides:
endLink
in classFOEventHandler
- Parameters:
basicLink
- BasicLink that is ending
-
image
Description copied from class:FOEventHandler
Process an ExternalGraphic.- Overrides:
image
in classFOEventHandler
- Parameters:
eg
- ExternalGraphic to process.
-
pageRef
public void pageRef()Description copied from class:FOEventHandler
Process a pageRef.- Overrides:
pageRef
in classFOEventHandler
-
startInstreamForeignObject
Description copied from class:FOEventHandler
Process the start of an InstreamForeignObject.- Overrides:
startInstreamForeignObject
in classFOEventHandler
- Parameters:
ifo
- InstreamForeignObject that is starting
-
endInstreamForeignObject
Description copied from class:FOEventHandler
Process the end of an InstreamForeignObject.- Overrides:
endInstreamForeignObject
in classFOEventHandler
- Parameters:
ifo
- InstreamForeignObject that is ending
-
startFootnote
Description copied from class:FOEventHandler
Process the start of a footnote.- Overrides:
startFootnote
in classFOEventHandler
- Parameters:
footnote
- Footnote that is starting
-
endFootnote
Description copied from class:FOEventHandler
Process the ending of a footnote.- Overrides:
endFootnote
in classFOEventHandler
- Parameters:
footnote
- Footnote that is ending
-
startFootnoteBody
Description copied from class:FOEventHandler
Process the start of a footnote body.- Overrides:
startFootnoteBody
in classFOEventHandler
- Parameters:
body
- FootnoteBody that is starting
-
endFootnoteBody
Description copied from class:FOEventHandler
Process the ending of a footnote body.- Overrides:
endFootnoteBody
in classFOEventHandler
- Parameters:
body
- FootnoteBody that is ending
-
startLeader
Description copied from class:FOEventHandler
Process the start of a Leader.- Overrides:
startLeader
in classFOEventHandler
- Parameters:
l
- Leader that is starting
-
endLeader
Description copied from class:FOEventHandler
Process the end of a Leader.- Overrides:
endLeader
in classFOEventHandler
- Parameters:
l
- Leader that is ending
-
startWrapper
Description copied from class:FOEventHandler
Process the start of a wrapper.- Overrides:
startWrapper
in classFOEventHandler
- Parameters:
wrapper
- wrapper that is starting
-
endWrapper
Description copied from class:FOEventHandler
Process the ending of a wrapper.- Overrides:
endWrapper
in classFOEventHandler
- Parameters:
wrapper
- wrapper that is ending
-
startRetrieveMarker
Description copied from class:FOEventHandler
Process the start of a retrieve-marker.- Overrides:
startRetrieveMarker
in classFOEventHandler
- Parameters:
retrieveMarker
- the retrieve-marker that is starting
-
endRetrieveMarker
Description copied from class:FOEventHandler
Process the ending of a retrieve-marker.- Overrides:
endRetrieveMarker
in classFOEventHandler
- Parameters:
retrieveMarker
- the retrieve-marker that is ending
-
restoreState
Description copied from class:FOEventHandler
Restore the state of this event handler as it was when the given fo:retrieve-marker element was processed. This method is called at marker retrieval time, so that events for the marker descendants are fired within the proper context.The default implementation of this method does nothing.
- Overrides:
restoreState
in classFOEventHandler
- Parameters:
retrieveMarker
- the fo:retrieve-marker element that is retrieving markers
-
startRetrieveTableMarker
Description copied from class:FOEventHandler
Process the start of a retrieve-table-marker.- Overrides:
startRetrieveTableMarker
in classFOEventHandler
- Parameters:
retrieveTableMarker
- the retrieve-table-marker that is starting
-
endRetrieveTableMarker
Description copied from class:FOEventHandler
Process the ending of a retrieve-table-marker.- Overrides:
endRetrieveTableMarker
in classFOEventHandler
- Parameters:
retrieveTableMarker
- the retrieve-table-marker that is ending
-
restoreState
Description copied from class:FOEventHandler
- Overrides:
restoreState
in classFOEventHandler
-
character
Description copied from class:FOEventHandler
Process a Character.- Overrides:
character
in classFOEventHandler
- Parameters:
c
- Character to process.
-
characters
Description copied from class:FOEventHandler
Process character data.- Overrides:
characters
in classFOEventHandler
- Parameters:
foText
- text to process
-
startExternalDocument
Description copied from class:FOEventHandler
Process the start of the external-document extension.- Overrides:
startExternalDocument
in classFOEventHandler
- Parameters:
document
- the external-document node
-
endExternalDocument
Description copied from class:FOEventHandler
Process the end of the external-document extension.- Overrides:
endExternalDocument
in classFOEventHandler
- Parameters:
document
- the external-document node
-
getResults
Description copied from class:FOEventHandler
Get formatting results.- Overrides:
getResults
in classFOEventHandler
- Returns:
- the FormattingResults instance for this document
-