|
fop 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.fop.fo.FOEventHandler
public abstract class FOEventHandler
Abstract class defining what should be done with SAX events that map to XSL-FO input. The events are actually captured by fo/FOTreeBuilder, passed to the various fo Objects, which in turn, if needed, pass them to an instance of FOEventHandler. Sub-classes will generally fall into one of two categories: 1) a handler that actually builds an FO Tree from the events, or 2) a handler that builds a structured (as opposed to formatted) document, such as our MIF and RTF output targets.
| Field Summary | |
|---|---|
protected FontInfo |
fontInfo
The Font information relevant for this document |
protected FOUserAgent |
foUserAgent
The FOUserAgent for this process |
| Constructor Summary | |
|---|---|
protected |
FOEventHandler()
Constructor for sub-classes that do not need an FOUserAgent instance. |
|
FOEventHandler(FOUserAgent foUserAgent)
Main constructor |
| Method Summary | |
|---|---|
void |
character(Character c)
Process a Character. |
void |
characters(FOText foText)
Process character data. |
void |
endBlock(Block bl)
|
void |
endBlockContainer(BlockContainer blc)
|
void |
endBody(TableBody body)
|
void |
endCell(TableCell tc)
|
void |
endColumn(TableColumn tc)
|
void |
endDocument()
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 |
endFlow(Flow fl)
|
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 |
endInline(Inline inl)
|
void |
endInstreamForeignObject(InstreamForeignObject ifo)
Process the end of an InstreamForeignObject. |
void |
endLeader(Leader l)
Process the end of a Leader. |
void |
endLink(BasicLink basicLink)
Process end of a Link. |
void |
endList(ListBlock lb)
|
void |
endListBody(ListItemBody listItemBody)
Process end of a ListBody. |
void |
endListItem(ListItem li)
|
void |
endListLabel(ListItemLabel listItemLabel)
Process end of a ListLabel. |
void |
endMarkup()
Process end of a Markup. |
void |
endPageNumber(PageNumber pagenum)
|
void |
endPageNumberCitation(PageNumberCitation pageCite)
|
void |
endPageNumberCitationLast(PageNumberCitationLast pageLast)
|
void |
endPageSequence(PageSequence pageSeq)
|
void |
endRoot(Root root)
Called upon end of root element. |
void |
endRow(TableRow tr)
|
void |
endStatic(StaticContent staticContent)
Process end of a Static. |
void |
endTable(Table tbl)
|
void |
endWrapper(Wrapper wrapper)
Process the ending of a wrapper. |
FontInfo |
getFontInfo()
Retrieve the font information for this document |
FormattingResults |
getResults()
Get formatting results. |
FOUserAgent |
getUserAgent()
Returns the User Agent object associated with this FOEventHandler. |
void |
image(ExternalGraphic eg)
Process an ExternalGraphic. |
void |
pageRef()
Process a pageRef. |
void |
startBlock(Block bl)
|
void |
startBlockContainer(BlockContainer blc)
|
void |
startBody(TableBody body)
|
void |
startCell(TableCell tc)
|
void |
startColumn(TableColumn tc)
|
void |
startDocument()
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 |
startFlow(Flow fl)
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 |
startFootnoteBody(FootnoteBody body)
Process the start of a footnote body. |
void |
startHeader(TableHeader header)
|
void |
startInline(Inline inl)
|
void |
startInstreamForeignObject(InstreamForeignObject ifo)
Process the start of an InstreamForeignObject. |
void |
startLeader(Leader l)
Process the start of a Leader. |
void |
startLink(BasicLink basicLink)
Process start of a Link. |
void |
startList(ListBlock lb)
|
void |
startListBody(ListItemBody listItemBody)
Process start of a ListBody. |
void |
startListItem(ListItem li)
|
void |
startListLabel(ListItemLabel listItemLabel)
Process start of a ListLabel. |
void |
startMarkup()
Process start of a Markup. |
void |
startPageNumber(PageNumber pagenum)
|
void |
startPageNumberCitation(PageNumberCitation pageCite)
|
void |
startPageNumberCitationLast(PageNumberCitationLast pageLast)
|
void |
startPageSequence(PageSequence pageSeq)
|
void |
startRoot(Root root)
Called upon start of root element. |
void |
startRow(TableRow tr)
|
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 java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected FOUserAgent foUserAgent
protected FontInfo fontInfo
| Constructor Detail |
|---|
public FOEventHandler(FOUserAgent foUserAgent)
foUserAgent - the apps.FOUserAgent instance for this processprotected FOEventHandler()
FOUserAgent instance.
| Method Detail |
|---|
public FOUserAgent getUserAgent()
public FontInfo getFontInfo()
public void startDocument()
throws org.xml.sax.SAXException
org.xml.sax.SAXException - In case of a problem
public void endDocument()
throws org.xml.sax.SAXException
org.xml.sax.SAXException - In case of a problempublic void startRoot(Root root)
root - elementpublic void endRoot(Root root)
root - elementpublic void startPageSequence(PageSequence pageSeq)
pageSeq - PageSequence that is starting.public void endPageSequence(PageSequence pageSeq)
pageSeq - PageSequence that is ending.public void startPageNumber(PageNumber pagenum)
pagenum - PageNumber that is starting.public void endPageNumber(PageNumber pagenum)
pagenum - PageNumber that is ending.public void startPageNumberCitation(PageNumberCitation pageCite)
pageCite - PageNumberCitation that is starting.public void endPageNumberCitation(PageNumberCitation pageCite)
pageCite - PageNumberCitation that is ending.public void startPageNumberCitationLast(PageNumberCitationLast pageLast)
pageLast - PageNumberCitationLast that is starting.public void endPageNumberCitationLast(PageNumberCitationLast pageLast)
pageLast - PageNumberCitationLast that is ending.public void startFlow(Flow fl)
fl - Flow that is starting.public void endFlow(Flow fl)
fl - Flow that is ending.public void startBlock(Block bl)
bl - Block that is starting.public void endBlock(Block bl)
bl - Block that is ending.public void startBlockContainer(BlockContainer blc)
blc - BlockContainer that is starting.public void endBlockContainer(BlockContainer blc)
blc - BlockContainer that is ending.public void startInline(Inline inl)
inl - Inline that is starting.public void endInline(Inline inl)
inl - Inline that is ending.public void startTable(Table tbl)
tbl - Table that is starting.public void endTable(Table tbl)
tbl - Table that is ending.public void startColumn(TableColumn tc)
tc - TableColumn that is starting;public void endColumn(TableColumn tc)
tc - TableColumn that is ending;public void startHeader(TableHeader header)
header - TableHeader that is starting;public void endHeader(TableHeader header)
header - TableHeader that is ending.public void startFooter(TableFooter footer)
footer - TableFooter that is starting.public void endFooter(TableFooter footer)
footer - TableFooter that is ending.public void startBody(TableBody body)
body - TableBody that is starting.public void endBody(TableBody body)
body - TableBody that is ending.public void startRow(TableRow tr)
tr - TableRow that is starting.public void endRow(TableRow tr)
tr - TableRow that is ending.public void startCell(TableCell tc)
tc - TableCell that is starting.public void endCell(TableCell tc)
tc - TableCell that is ending.public void startList(ListBlock lb)
lb - ListBlock that is starting.public void endList(ListBlock lb)
lb - ListBlock that is ending.public void startListItem(ListItem li)
li - ListItem that is starting.public void endListItem(ListItem li)
li - ListItem that is ending.public void startListLabel(ListItemLabel listItemLabel)
listItemLabel - ListItemLabel that is startingpublic void endListLabel(ListItemLabel listItemLabel)
listItemLabel - ListItemLabel that is endingpublic void startListBody(ListItemBody listItemBody)
listItemBody - ListItemBody that is startingpublic void endListBody(ListItemBody listItemBody)
listItemBody - ListItemBody that is endingpublic void startStatic(StaticContent staticContent)
staticContent - StaticContent that is startingpublic void endStatic(StaticContent staticContent)
staticContent - StaticContent that is endingpublic void startMarkup()
public void endMarkup()
public void startLink(BasicLink basicLink)
basicLink - BasicLink that is startingpublic void endLink(BasicLink basicLink)
basicLink - BasicLink that is endingpublic void image(ExternalGraphic eg)
eg - ExternalGraphic to process.public void pageRef()
public void startInstreamForeignObject(InstreamForeignObject ifo)
ifo - InstreamForeignObject that is startingpublic void endInstreamForeignObject(InstreamForeignObject ifo)
ifo - InstreamForeignObject that is endingpublic void startFootnote(Footnote footnote)
footnote - Footnote that is startingpublic void endFootnote(Footnote footnote)
footnote - Footnote that is endingpublic void startFootnoteBody(FootnoteBody body)
body - FootnoteBody that is startingpublic void endFootnoteBody(FootnoteBody body)
body - FootnoteBody that is endingpublic void startLeader(Leader l)
l - Leader that is startingpublic void endLeader(Leader l)
l - Leader that is endingpublic void startWrapper(Wrapper wrapper)
wrapper - wrapper that is startingpublic void endWrapper(Wrapper wrapper)
wrapper - wrapper that is endingpublic void character(Character c)
c - Character to process.public void characters(FOText foText)
foText - text to processpublic void startExternalDocument(ExternalDocument document)
document - the external-document nodepublic void endExternalDocument(ExternalDocument document)
document - the external-document nodepublic FormattingResults getResults()
|
fop 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||