Package org.apache.fop.accessibility.fo
Class FO2StructureTreeConverter
java.lang.Object
org.apache.fop.fo.FOEventHandler
org.apache.fop.fo.DelegatingFOEventHandler
org.apache.fop.accessibility.fo.FO2StructureTreeConverter
Allows to create the structure tree of an FO document, by converting FO
events into appropriate structure tree events.
-
Field Summary
Fields inherited from class org.apache.fop.fo.FOEventHandler
fontInfo, foUserAgent
-
Constructor Summary
ConstructorDescriptionFO2StructureTreeConverter
(StructureTreeEventHandler structureTreeEventHandler, FOEventHandler delegate) Creates a new instance. -
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 staticContent) Process end of a Static.void
void
endWrapper
(Wrapper wrapper) Process the ending of a wrapper.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.Methods inherited from class org.apache.fop.fo.DelegatingFOEventHandler
getFontInfo, getResults, getUserAgent
-
Field Details
-
converter
The top of theconverters
stack.
-
-
Constructor Details
-
FO2StructureTreeConverter
public FO2StructureTreeConverter(StructureTreeEventHandler structureTreeEventHandler, FOEventHandler delegate) Creates a new instance.- Parameters:
structureTreeEventHandler
- the object that will hold the structure treedelegate
- the FO event handler that must be wrapped by this instance
-
-
Method Details
-
startDocument
Description copied from class:FOEventHandler
This method is called to indicate the start of a new document run.- Overrides:
startDocument
in classDelegatingFOEventHandler
- 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 classDelegatingFOEventHandler
- Throws:
SAXException
- In case of a problem
-
startRoot
Description copied from class:FOEventHandler
Called upon start of root element.- Overrides:
startRoot
in classDelegatingFOEventHandler
- Parameters:
root
- element
-
endRoot
Description copied from class:FOEventHandler
Called upon end of root element.- Overrides:
endRoot
in classDelegatingFOEventHandler
- Parameters:
root
- element
-
startPageSequence
- Overrides:
startPageSequence
in classDelegatingFOEventHandler
- Parameters:
pageSeq
- PageSequence that is starting.
-
endPageSequence
- Overrides:
endPageSequence
in classDelegatingFOEventHandler
- Parameters:
pageSeq
- PageSequence that is ending.
-
startPageNumber
- Overrides:
startPageNumber
in classDelegatingFOEventHandler
- Parameters:
pagenum
- PageNumber that is starting.
-
endPageNumber
- Overrides:
endPageNumber
in classDelegatingFOEventHandler
- Parameters:
pagenum
- PageNumber that is ending.
-
startPageNumberCitation
- Overrides:
startPageNumberCitation
in classDelegatingFOEventHandler
- Parameters:
pageCite
- PageNumberCitation that is starting.
-
endPageNumberCitation
- Overrides:
endPageNumberCitation
in classDelegatingFOEventHandler
- Parameters:
pageCite
- PageNumberCitation that is ending.
-
startPageNumberCitationLast
- Overrides:
startPageNumberCitationLast
in classDelegatingFOEventHandler
- Parameters:
pageLast
- PageNumberCitationLast that is starting.
-
endPageNumberCitationLast
- Overrides:
endPageNumberCitationLast
in classDelegatingFOEventHandler
- Parameters:
pageLast
- PageNumberCitationLast that is ending.
-
startStatic
Description copied from class:FOEventHandler
Process start of a Static.- Overrides:
startStatic
in classDelegatingFOEventHandler
- Parameters:
staticContent
- StaticContent that is starting
-
endStatic
Description copied from class:FOEventHandler
Process end of a Static.- Overrides:
endStatic
in classDelegatingFOEventHandler
- Parameters:
staticContent
- 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 classDelegatingFOEventHandler
- Parameters:
fl
- Flow that is starting.
-
endFlow
- Overrides:
endFlow
in classDelegatingFOEventHandler
- Parameters:
fl
- Flow that is ending.
-
startBlock
- Overrides:
startBlock
in classDelegatingFOEventHandler
- Parameters:
bl
- Block that is starting.
-
endBlock
- Overrides:
endBlock
in classDelegatingFOEventHandler
- Parameters:
bl
- Block that is ending.
-
startBlockContainer
- Overrides:
startBlockContainer
in classDelegatingFOEventHandler
- Parameters:
blc
- BlockContainer that is starting.
-
endBlockContainer
- Overrides:
endBlockContainer
in classDelegatingFOEventHandler
- Parameters:
blc
- BlockContainer that is ending.
-
startInline
- Overrides:
startInline
in classDelegatingFOEventHandler
- Parameters:
inl
- Inline that is starting.
-
endInline
- Overrides:
endInline
in classDelegatingFOEventHandler
- Parameters:
inl
- Inline that is ending.
-
startTable
- Overrides:
startTable
in classDelegatingFOEventHandler
- Parameters:
tbl
- Table that is starting.
-
endTable
- Overrides:
endTable
in classDelegatingFOEventHandler
- Parameters:
tbl
- Table that is ending.
-
startColumn
- Overrides:
startColumn
in classDelegatingFOEventHandler
- Parameters:
tc
- TableColumn that is starting;
-
endColumn
- Overrides:
endColumn
in classDelegatingFOEventHandler
- Parameters:
tc
- TableColumn that is ending;
-
startHeader
- Overrides:
startHeader
in classDelegatingFOEventHandler
- Parameters:
header
- TableHeader that is starting;
-
endHeader
- Overrides:
endHeader
in classDelegatingFOEventHandler
- Parameters:
header
- TableHeader that is ending.
-
startBody
- Overrides:
startBody
in classDelegatingFOEventHandler
- Parameters:
body
- TableBody that is starting.
-
endBody
- Overrides:
endBody
in classDelegatingFOEventHandler
- Parameters:
body
- TableBody that is ending.
-
startRow
- Overrides:
startRow
in classDelegatingFOEventHandler
- Parameters:
tr
- TableRow that is starting.
-
endRow
- Overrides:
endRow
in classDelegatingFOEventHandler
- Parameters:
tr
- TableRow that is ending.
-
startCell
- Overrides:
startCell
in classDelegatingFOEventHandler
- Parameters:
tc
- TableCell that is starting.
-
endCell
- Overrides:
endCell
in classDelegatingFOEventHandler
- Parameters:
tc
- TableCell that is ending.
-
startList
- Overrides:
startList
in classDelegatingFOEventHandler
- Parameters:
lb
- ListBlock that is starting.
-
endList
- Overrides:
endList
in classDelegatingFOEventHandler
- Parameters:
lb
- ListBlock that is ending.
-
startListItem
- Overrides:
startListItem
in classDelegatingFOEventHandler
- Parameters:
li
- ListItem that is starting.
-
endListItem
- Overrides:
endListItem
in classDelegatingFOEventHandler
- Parameters:
li
- ListItem that is ending.
-
startListLabel
Description copied from class:FOEventHandler
Process start of a ListLabel.- Overrides:
startListLabel
in classDelegatingFOEventHandler
- Parameters:
listItemLabel
- ListItemLabel that is starting
-
endListLabel
Description copied from class:FOEventHandler
Process end of a ListLabel.- Overrides:
endListLabel
in classDelegatingFOEventHandler
- Parameters:
listItemLabel
- ListItemLabel that is ending
-
startListBody
Description copied from class:FOEventHandler
Process start of a ListBody.- Overrides:
startListBody
in classDelegatingFOEventHandler
- Parameters:
listItemBody
- ListItemBody that is starting
-
endListBody
Description copied from class:FOEventHandler
Process end of a ListBody.- Overrides:
endListBody
in classDelegatingFOEventHandler
- Parameters:
listItemBody
- ListItemBody that is ending
-
startMarkup
public void startMarkup()Description copied from class:FOEventHandler
Process start of a Markup.- Overrides:
startMarkup
in classDelegatingFOEventHandler
-
endMarkup
public void endMarkup()Description copied from class:FOEventHandler
Process end of a Markup.- Overrides:
endMarkup
in classDelegatingFOEventHandler
-
startLink
Description copied from class:FOEventHandler
Process start of a Link.- Overrides:
startLink
in classDelegatingFOEventHandler
- Parameters:
basicLink
- BasicLink that is starting
-
endLink
Description copied from class:FOEventHandler
Process end of a Link.- Overrides:
endLink
in classDelegatingFOEventHandler
- Parameters:
basicLink
- BasicLink that is ending
-
image
Description copied from class:FOEventHandler
Process an ExternalGraphic.- Overrides:
image
in classDelegatingFOEventHandler
- Parameters:
eg
- ExternalGraphic to process.
-
pageRef
public void pageRef()Description copied from class:FOEventHandler
Process a pageRef.- Overrides:
pageRef
in classDelegatingFOEventHandler
-
startInstreamForeignObject
Description copied from class:FOEventHandler
Process the start of an InstreamForeignObject.- Overrides:
startInstreamForeignObject
in classDelegatingFOEventHandler
- Parameters:
ifo
- InstreamForeignObject that is starting
-
endInstreamForeignObject
Description copied from class:FOEventHandler
Process the end of an InstreamForeignObject.- Overrides:
endInstreamForeignObject
in classDelegatingFOEventHandler
- Parameters:
ifo
- InstreamForeignObject that is ending
-
startFootnote
Description copied from class:FOEventHandler
Process the start of a footnote.- Overrides:
startFootnote
in classDelegatingFOEventHandler
- Parameters:
footnote
- Footnote that is starting
-
endFootnote
Description copied from class:FOEventHandler
Process the ending of a footnote.- Overrides:
endFootnote
in classDelegatingFOEventHandler
- Parameters:
footnote
- Footnote that is ending
-
startFootnoteBody
Description copied from class:FOEventHandler
Process the start of a footnote body.- Overrides:
startFootnoteBody
in classDelegatingFOEventHandler
- Parameters:
body
- FootnoteBody that is starting
-
endFootnoteBody
Description copied from class:FOEventHandler
Process the ending of a footnote body.- Overrides:
endFootnoteBody
in classDelegatingFOEventHandler
- Parameters:
body
- FootnoteBody that is ending
-
startLeader
Description copied from class:FOEventHandler
Process the start of a Leader.- Overrides:
startLeader
in classDelegatingFOEventHandler
- Parameters:
l
- Leader that is starting
-
endLeader
Description copied from class:FOEventHandler
Process the end of a Leader.- Overrides:
endLeader
in classDelegatingFOEventHandler
- Parameters:
l
- Leader that is ending
-
startWrapper
Description copied from class:FOEventHandler
Process the start of a wrapper.- Overrides:
startWrapper
in classDelegatingFOEventHandler
- Parameters:
wrapper
- wrapper that is starting
-
endWrapper
Description copied from class:FOEventHandler
Process the ending of a wrapper.- Overrides:
endWrapper
in classDelegatingFOEventHandler
- Parameters:
wrapper
- wrapper that is ending
-
startRetrieveMarker
Description copied from class:FOEventHandler
Process the start of a retrieve-marker.- Overrides:
startRetrieveMarker
in classDelegatingFOEventHandler
- Parameters:
retrieveMarker
- the retrieve-marker that is starting
-
endRetrieveMarker
Description copied from class:FOEventHandler
Process the ending of a retrieve-marker.- Overrides:
endRetrieveMarker
in classDelegatingFOEventHandler
- 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 classDelegatingFOEventHandler
- 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 classDelegatingFOEventHandler
- 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 classDelegatingFOEventHandler
- Parameters:
retrieveTableMarker
- the retrieve-table-marker that is ending
-
restoreState
Description copied from class:FOEventHandler
- Overrides:
restoreState
in classDelegatingFOEventHandler
-
character
Description copied from class:FOEventHandler
Process a Character.- Overrides:
character
in classDelegatingFOEventHandler
- Parameters:
c
- Character to process.
-
characters
Description copied from class:FOEventHandler
Process character data.- Overrides:
characters
in classDelegatingFOEventHandler
- Parameters:
foText
- text to process
-
startExternalDocument
Description copied from class:FOEventHandler
Process the start of the external-document extension.- Overrides:
startExternalDocument
in classDelegatingFOEventHandler
- Parameters:
document
- the external-document node
-
endExternalDocument
Description copied from class:FOEventHandler
Process the end of the external-document extension.- Overrides:
endExternalDocument
in classDelegatingFOEventHandler
- Parameters:
document
- the external-document node
-