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
ConstructorsConstructorDescriptionDelegatingFOEventHandler(FOEventHandler delegate) Creates a new instance that delegates events to the given object. -
Method Summary
Modifier and TypeMethodDescriptionvoidProcess a Character.voidcharacters(FOText foText) Process character data.voidvoidvoidvoidvoidendColumn(TableColumn tc) voidThis method is called to indicate the end of a document run.voidendExternalDocument(ExternalDocument document) Process the end of the external-document extension.voidvoidendFooter(TableFooter footer) voidendFootnote(Footnote footnote) Process the ending of a footnote.voidendFootnoteBody(FootnoteBody body) Process the ending of a footnote body.voidendHeader(TableHeader header) voidvoidProcess the end of an InstreamForeignObject.voidProcess the end of a Leader.voidProcess end of a Link.voidvoidendListBody(ListItemBody listItemBody) Process end of a ListBody.voidendListItem(ListItem li) voidendListLabel(ListItemLabel listItemLabel) Process end of a ListLabel.voidProcess end of a Markup.voidendPageNumber(PageNumber pagenum) voidendPageNumberCitation(PageNumberCitation pageCite) voidvoidendPageSequence(PageSequence pageSeq) voidendRetrieveMarker(RetrieveMarker retrieveMarker) Process the ending of a retrieve-marker.voidendRetrieveTableMarker(RetrieveTableMarker retrieveTableMarker) Process the ending of a retrieve-table-marker.voidCalled upon end of root element.voidvoidendStatic(StaticContent statisContent) Process end of a Static.voidvoidendWrapper(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.voidimage(ExternalGraphic eg) Process an ExternalGraphic.voidpageRef()Process a pageRef.voidrestoreState(RetrieveMarker retrieveMarker) Restore the state of this event handler as it was when the given fo:retrieve-marker element was processed.voidrestoreState(RetrieveTableMarker retrieveTableMarker) voidstartBlock(Block bl) voidvoidvoidvoidvoidThis method is called to indicate the start of a new document run.voidstartExternalDocument(ExternalDocument document) Process the start of the external-document extension.voidThis method is called to indicate the start of a new fo:flow or fo:static-content.voidstartFooter(TableFooter footer) voidstartFootnote(Footnote footnote) Process the start of a footnote.voidProcess the start of a footnote body.voidstartHeader(TableHeader header) voidstartInline(Inline inl) voidProcess the start of an InstreamForeignObject.voidProcess the start of a Leader.voidProcess start of a Link.voidvoidstartListBody(ListItemBody listItemBody) Process start of a ListBody.voidvoidstartListLabel(ListItemLabel listItemLabel) Process start of a ListLabel.voidProcess start of a Markup.voidstartPageNumber(PageNumber pagenum) voidstartPageNumberCitation(PageNumberCitation pageCite) voidvoidstartPageSequence(PageSequence pageSeq) voidstartRetrieveMarker(RetrieveMarker retrieveMarker) Process the start of a retrieve-marker.voidstartRetrieveTableMarker(RetrieveTableMarker retrieveTableMarker) Process the start of a retrieve-table-marker.voidCalled upon start of root element.voidvoidstartStatic(StaticContent staticContent) Process start of a Static.voidstartTable(Table tbl) voidstartWrapper(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:FOEventHandlerReturns the User Agent object associated with this FOEventHandler.- Overrides:
getUserAgentin classFOEventHandler- Returns:
- the User Agent object
-
getFontInfo
Description copied from class:FOEventHandlerRetrieve the font information for this document- Overrides:
getFontInfoin classFOEventHandler- Returns:
- the FontInfo instance for this document
-
startDocument
Description copied from class:FOEventHandlerThis method is called to indicate the start of a new document run.- Overrides:
startDocumentin classFOEventHandler- Throws:
SAXException- In case of a problem
-
endDocument
Description copied from class:FOEventHandlerThis method is called to indicate the end of a document run.- Overrides:
endDocumentin classFOEventHandler- Throws:
SAXException- In case of a problem
-
startRoot
Description copied from class:FOEventHandlerCalled upon start of root element.- Overrides:
startRootin classFOEventHandler- Parameters:
root- element
-
endRoot
Description copied from class:FOEventHandlerCalled upon end of root element.- Overrides:
endRootin classFOEventHandler- Parameters:
root- element
-
startPageSequence
- Overrides:
startPageSequencein classFOEventHandler- Parameters:
pageSeq- PageSequence that is starting.
-
endPageSequence
- Overrides:
endPageSequencein classFOEventHandler- Parameters:
pageSeq- PageSequence that is ending.
-
startPageNumber
- Overrides:
startPageNumberin classFOEventHandler- Parameters:
pagenum- PageNumber that is starting.
-
endPageNumber
- Overrides:
endPageNumberin classFOEventHandler- Parameters:
pagenum- PageNumber that is ending.
-
startPageNumberCitation
- Overrides:
startPageNumberCitationin classFOEventHandler- Parameters:
pageCite- PageNumberCitation that is starting.
-
endPageNumberCitation
- Overrides:
endPageNumberCitationin classFOEventHandler- Parameters:
pageCite- PageNumberCitation that is ending.
-
startPageNumberCitationLast
- Overrides:
startPageNumberCitationLastin classFOEventHandler- Parameters:
pageLast- PageNumberCitationLast that is starting.
-
endPageNumberCitationLast
- Overrides:
endPageNumberCitationLastin classFOEventHandler- Parameters:
pageLast- PageNumberCitationLast that is ending.
-
startStatic
Description copied from class:FOEventHandlerProcess start of a Static.- Overrides:
startStaticin classFOEventHandler- Parameters:
staticContent- StaticContent that is starting
-
endStatic
Description copied from class:FOEventHandlerProcess end of a Static.- Overrides:
endStaticin classFOEventHandler- Parameters:
statisContent- StaticContent that is ending
-
startFlow
Description copied from class:FOEventHandlerThis 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:
startFlowin classFOEventHandler- Parameters:
fl- Flow that is starting.
-
endFlow
- Overrides:
endFlowin classFOEventHandler- Parameters:
fl- Flow that is ending.
-
startBlock
- Overrides:
startBlockin classFOEventHandler- Parameters:
bl- Block that is starting.
-
endBlock
- Overrides:
endBlockin classFOEventHandler- Parameters:
bl- Block that is ending.
-
startBlockContainer
- Overrides:
startBlockContainerin classFOEventHandler- Parameters:
blc- BlockContainer that is starting.
-
endBlockContainer
- Overrides:
endBlockContainerin classFOEventHandler- Parameters:
blc- BlockContainer that is ending.
-
startInline
- Overrides:
startInlinein classFOEventHandler- Parameters:
inl- Inline that is starting.
-
endInline
- Overrides:
endInlinein classFOEventHandler- Parameters:
inl- Inline that is ending.
-
startTable
- Overrides:
startTablein classFOEventHandler- Parameters:
tbl- Table that is starting.
-
endTable
- Overrides:
endTablein classFOEventHandler- Parameters:
tbl- Table that is ending.
-
startColumn
- Overrides:
startColumnin classFOEventHandler- Parameters:
tc- TableColumn that is starting;
-
endColumn
- Overrides:
endColumnin classFOEventHandler- Parameters:
tc- TableColumn that is ending;
-
startHeader
- Overrides:
startHeaderin classFOEventHandler- Parameters:
header- TableHeader that is starting;
-
endHeader
- Overrides:
endHeaderin classFOEventHandler- Parameters:
header- TableHeader that is ending.
-
startBody
- Overrides:
startBodyin classFOEventHandler- Parameters:
body- TableBody that is starting.
-
endBody
- Overrides:
endBodyin classFOEventHandler- Parameters:
body- TableBody that is ending.
-
startRow
- Overrides:
startRowin classFOEventHandler- Parameters:
tr- TableRow that is starting.
-
endRow
- Overrides:
endRowin classFOEventHandler- Parameters:
tr- TableRow that is ending.
-
startCell
- Overrides:
startCellin classFOEventHandler- Parameters:
tc- TableCell that is starting.
-
endCell
- Overrides:
endCellin classFOEventHandler- Parameters:
tc- TableCell that is ending.
-
startList
- Overrides:
startListin classFOEventHandler- Parameters:
lb- ListBlock that is starting.
-
endList
- Overrides:
endListin classFOEventHandler- Parameters:
lb- ListBlock that is ending.
-
startListItem
- Overrides:
startListItemin classFOEventHandler- Parameters:
li- ListItem that is starting.
-
endListItem
- Overrides:
endListItemin classFOEventHandler- Parameters:
li- ListItem that is ending.
-
startListLabel
Description copied from class:FOEventHandlerProcess start of a ListLabel.- Overrides:
startListLabelin classFOEventHandler- Parameters:
listItemLabel- ListItemLabel that is starting
-
endListLabel
Description copied from class:FOEventHandlerProcess end of a ListLabel.- Overrides:
endListLabelin classFOEventHandler- Parameters:
listItemLabel- ListItemLabel that is ending
-
startListBody
Description copied from class:FOEventHandlerProcess start of a ListBody.- Overrides:
startListBodyin classFOEventHandler- Parameters:
listItemBody- ListItemBody that is starting
-
endListBody
Description copied from class:FOEventHandlerProcess end of a ListBody.- Overrides:
endListBodyin classFOEventHandler- Parameters:
listItemBody- ListItemBody that is ending
-
startMarkup
public void startMarkup()Description copied from class:FOEventHandlerProcess start of a Markup.- Overrides:
startMarkupin classFOEventHandler
-
endMarkup
public void endMarkup()Description copied from class:FOEventHandlerProcess end of a Markup.- Overrides:
endMarkupin classFOEventHandler
-
startLink
Description copied from class:FOEventHandlerProcess start of a Link.- Overrides:
startLinkin classFOEventHandler- Parameters:
basicLink- BasicLink that is starting
-
endLink
Description copied from class:FOEventHandlerProcess end of a Link.- Overrides:
endLinkin classFOEventHandler- Parameters:
basicLink- BasicLink that is ending
-
image
Description copied from class:FOEventHandlerProcess an ExternalGraphic.- Overrides:
imagein classFOEventHandler- Parameters:
eg- ExternalGraphic to process.
-
pageRef
public void pageRef()Description copied from class:FOEventHandlerProcess a pageRef.- Overrides:
pageRefin classFOEventHandler
-
startInstreamForeignObject
Description copied from class:FOEventHandlerProcess the start of an InstreamForeignObject.- Overrides:
startInstreamForeignObjectin classFOEventHandler- Parameters:
ifo- InstreamForeignObject that is starting
-
endInstreamForeignObject
Description copied from class:FOEventHandlerProcess the end of an InstreamForeignObject.- Overrides:
endInstreamForeignObjectin classFOEventHandler- Parameters:
ifo- InstreamForeignObject that is ending
-
startFootnote
Description copied from class:FOEventHandlerProcess the start of a footnote.- Overrides:
startFootnotein classFOEventHandler- Parameters:
footnote- Footnote that is starting
-
endFootnote
Description copied from class:FOEventHandlerProcess the ending of a footnote.- Overrides:
endFootnotein classFOEventHandler- Parameters:
footnote- Footnote that is ending
-
startFootnoteBody
Description copied from class:FOEventHandlerProcess the start of a footnote body.- Overrides:
startFootnoteBodyin classFOEventHandler- Parameters:
body- FootnoteBody that is starting
-
endFootnoteBody
Description copied from class:FOEventHandlerProcess the ending of a footnote body.- Overrides:
endFootnoteBodyin classFOEventHandler- Parameters:
body- FootnoteBody that is ending
-
startLeader
Description copied from class:FOEventHandlerProcess the start of a Leader.- Overrides:
startLeaderin classFOEventHandler- Parameters:
l- Leader that is starting
-
endLeader
Description copied from class:FOEventHandlerProcess the end of a Leader.- Overrides:
endLeaderin classFOEventHandler- Parameters:
l- Leader that is ending
-
startWrapper
Description copied from class:FOEventHandlerProcess the start of a wrapper.- Overrides:
startWrapperin classFOEventHandler- Parameters:
wrapper- wrapper that is starting
-
endWrapper
Description copied from class:FOEventHandlerProcess the ending of a wrapper.- Overrides:
endWrapperin classFOEventHandler- Parameters:
wrapper- wrapper that is ending
-
startRetrieveMarker
Description copied from class:FOEventHandlerProcess the start of a retrieve-marker.- Overrides:
startRetrieveMarkerin classFOEventHandler- Parameters:
retrieveMarker- the retrieve-marker that is starting
-
endRetrieveMarker
Description copied from class:FOEventHandlerProcess the ending of a retrieve-marker.- Overrides:
endRetrieveMarkerin classFOEventHandler- Parameters:
retrieveMarker- the retrieve-marker that is ending
-
restoreState
Description copied from class:FOEventHandlerRestore 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:
restoreStatein classFOEventHandler- Parameters:
retrieveMarker- the fo:retrieve-marker element that is retrieving markers
-
startRetrieveTableMarker
Description copied from class:FOEventHandlerProcess the start of a retrieve-table-marker.- Overrides:
startRetrieveTableMarkerin classFOEventHandler- Parameters:
retrieveTableMarker- the retrieve-table-marker that is starting
-
endRetrieveTableMarker
Description copied from class:FOEventHandlerProcess the ending of a retrieve-table-marker.- Overrides:
endRetrieveTableMarkerin classFOEventHandler- Parameters:
retrieveTableMarker- the retrieve-table-marker that is ending
-
restoreState
Description copied from class:FOEventHandler- Overrides:
restoreStatein classFOEventHandler
-
character
Description copied from class:FOEventHandlerProcess a Character.- Overrides:
characterin classFOEventHandler- Parameters:
c- Character to process.
-
characters
Description copied from class:FOEventHandlerProcess character data.- Overrides:
charactersin classFOEventHandler- Parameters:
foText- text to process
-
startExternalDocument
Description copied from class:FOEventHandlerProcess the start of the external-document extension.- Overrides:
startExternalDocumentin classFOEventHandler- Parameters:
document- the external-document node
-
endExternalDocument
Description copied from class:FOEventHandlerProcess the end of the external-document extension.- Overrides:
endExternalDocumentin classFOEventHandler- Parameters:
document- the external-document node
-
getResults
Description copied from class:FOEventHandlerGet formatting results.- Overrides:
getResultsin classFOEventHandler- Returns:
- the FormattingResults instance for this document
-