Constructor Detail

• DelegatingFOEventHandler

  public DelegatingFOEventHandler​(FOEventHandler delegate)

  Creates a new instance that delegates events to the given object.

  Parameters:

  delegate - the object to which all FO events will be forwarded

Method Detail

• getUserAgent

  public FOUserAgent getUserAgent()

  Description copied from class: FOEventHandler
  Returns the User Agent object associated with this FOEventHandler.

  Overrides:

  getUserAgent in class FOEventHandler

  Returns:

  the User Agent object

• getFontInfo

  public FontInfo getFontInfo()

  Description copied from class: FOEventHandler
  Retrieve the font information for this document

  Overrides:

  getFontInfo in class FOEventHandler

  Returns:

  the FontInfo instance for this document

• startDocument

  public void startDocument()
                     throws org.xml.sax.SAXException

  Description copied from class: FOEventHandler
  This method is called to indicate the start of a new document run.

  Overrides:

  startDocument in class FOEventHandler

  Throws:

  org.xml.sax.SAXException - In case of a problem

• endDocument

  public void endDocument()
                   throws org.xml.sax.SAXException

  Description copied from class: FOEventHandler
  This method is called to indicate the end of a document run.

  Overrides:

  endDocument in class FOEventHandler

  Throws:

  org.xml.sax.SAXException - In case of a problem

• startRoot

  public void startRoot​(Root root)

  Description copied from class: FOEventHandler
  Called upon start of root element.

  Overrides:

  startRoot in class FOEventHandler

  Parameters:

  root - element

• endRoot

  public void endRoot​(Root root)

  Description copied from class: FOEventHandler
  Called upon end of root element.

  Overrides:

  endRoot in class FOEventHandler

  Parameters:

  root - element

• startPageSequence

  public void startPageSequence​(PageSequence pageSeq)

  Overrides:

  startPageSequence in class FOEventHandler

  Parameters:

  pageSeq - PageSequence that is starting.

• endPageSequence

  public void endPageSequence​(PageSequence pageSeq)

  Overrides:

  endPageSequence in class FOEventHandler

  Parameters:

  pageSeq - PageSequence that is ending.

• startPageNumber

  public void startPageNumber​(PageNumber pagenum)

  Overrides:

  startPageNumber in class FOEventHandler

  Parameters:

  pagenum - PageNumber that is starting.

• endPageNumber

  public void endPageNumber​(PageNumber pagenum)

  Overrides:

  endPageNumber in class FOEventHandler

  Parameters:

  pagenum - PageNumber that is ending.

• startPageNumberCitation

  public void startPageNumberCitation​(PageNumberCitation pageCite)

  Overrides:

  startPageNumberCitation in class FOEventHandler

  Parameters:

  pageCite - PageNumberCitation that is starting.

• endPageNumberCitation

  public void endPageNumberCitation​(PageNumberCitation pageCite)

  Overrides:

  endPageNumberCitation in class FOEventHandler

  Parameters:

  pageCite - PageNumberCitation that is ending.

• startPageNumberCitationLast

  public void startPageNumberCitationLast​(PageNumberCitationLast pageLast)

  Overrides:

  startPageNumberCitationLast in class FOEventHandler

  Parameters:

  pageLast - PageNumberCitationLast that is starting.

• endPageNumberCitationLast

  public void endPageNumberCitationLast​(PageNumberCitationLast pageLast)

  Overrides:

  endPageNumberCitationLast in class FOEventHandler

  Parameters:

  pageLast - PageNumberCitationLast that is ending.

• startStatic

  public void startStatic​(StaticContent staticContent)

  Description copied from class: FOEventHandler
  Process start of a Static.

  Overrides:

  startStatic in class FOEventHandler

  Parameters:

  staticContent - StaticContent that is starting

• endStatic

  public void endStatic​(StaticContent statisContent)

  Description copied from class: FOEventHandler
  Process end of a Static.

  Overrides:

  endStatic in class FOEventHandler

  Parameters:

  statisContent - StaticContent that is ending

• startFlow

  public void startFlow​(Flow fl)

  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 class FOEventHandler

  Parameters:

  fl - Flow that is starting.

• endFlow

  public void endFlow​(Flow fl)

  Overrides:

  endFlow in class FOEventHandler

  Parameters:

  fl - Flow that is ending.

• startBlock

  public void startBlock​(Block bl)

  Overrides:

  startBlock in class FOEventHandler

  Parameters:

  bl - Block that is starting.

• endBlock

  public void endBlock​(Block bl)

  Overrides:

  endBlock in class FOEventHandler

  Parameters:

  bl - Block that is ending.

• startBlockContainer

  public void startBlockContainer​(BlockContainer blc)

  Overrides:

  startBlockContainer in class FOEventHandler

  Parameters:

  blc - BlockContainer that is starting.

• endBlockContainer

  public void endBlockContainer​(BlockContainer blc)

  Overrides:

  endBlockContainer in class FOEventHandler

  Parameters:

  blc - BlockContainer that is ending.

• startInline

  public void startInline​(Inline inl)

  Overrides:

  startInline in class FOEventHandler

  Parameters:

  inl - Inline that is starting.

• endInline

  public void endInline​(Inline inl)

  Overrides:

  endInline in class FOEventHandler

  Parameters:

  inl - Inline that is ending.

• startTable

  public void startTable​(Table tbl)

  Overrides:

  startTable in class FOEventHandler

  Parameters:

  tbl - Table that is starting.

• endTable

  public void endTable​(Table tbl)

  Overrides:

  endTable in class FOEventHandler

  Parameters:

  tbl - Table that is ending.

• startColumn

  public void startColumn​(TableColumn tc)

  Overrides:

  startColumn in class FOEventHandler

  Parameters:

  tc - TableColumn that is starting;

• endColumn

  public void endColumn​(TableColumn tc)

  Overrides:

  endColumn in class FOEventHandler

  Parameters:

  tc - TableColumn that is ending;

• startHeader

  public void startHeader​(TableHeader header)

  Overrides:

  startHeader in class FOEventHandler

  Parameters:

  header - TableHeader that is starting;

• endHeader

  public void endHeader​(TableHeader header)

  Overrides:

  endHeader in class FOEventHandler

  Parameters:

  header - TableHeader that is ending.

• startFooter

  public void startFooter​(TableFooter footer)

  Overrides:

  startFooter in class FOEventHandler

  Parameters:

  footer - TableFooter that is starting.

• endFooter

  public void endFooter​(TableFooter footer)

  Overrides:

  endFooter in class FOEventHandler

  Parameters:

  footer - TableFooter that is ending.

• startBody

  public void startBody​(TableBody body)

  Overrides:

  startBody in class FOEventHandler

  Parameters:

  body - TableBody that is starting.

• endBody

  public void endBody​(TableBody body)

  Overrides:

  endBody in class FOEventHandler

  Parameters:

  body - TableBody that is ending.

• startRow

  public void startRow​(TableRow tr)

  Overrides:

  startRow in class FOEventHandler

  Parameters:

  tr - TableRow that is starting.

• endRow

  public void endRow​(TableRow tr)

  Overrides:

  endRow in class FOEventHandler

  Parameters:

  tr - TableRow that is ending.

• startCell

  public void startCell​(TableCell tc)

  Overrides:

  startCell in class FOEventHandler

  Parameters:

  tc - TableCell that is starting.

• endCell

  public void endCell​(TableCell tc)

  Overrides:

  endCell in class FOEventHandler

  Parameters:

  tc - TableCell that is ending.

• startList

  public void startList​(ListBlock lb)

  Overrides:

  startList in class FOEventHandler

  Parameters:

  lb - ListBlock that is starting.

• endList

  public void endList​(ListBlock lb)

  Overrides:

  endList in class FOEventHandler

  Parameters:

  lb - ListBlock that is ending.

• startListItem

  public void startListItem​(ListItem li)

  Overrides:

  startListItem in class FOEventHandler

  Parameters:

  li - ListItem that is starting.

• endListItem

  public void endListItem​(ListItem li)

  Overrides:

  endListItem in class FOEventHandler

  Parameters:

  li - ListItem that is ending.

• startListLabel

  public void startListLabel​(ListItemLabel listItemLabel)

  Description copied from class: FOEventHandler
  Process start of a ListLabel.

  Overrides:

  startListLabel in class FOEventHandler

  Parameters:

  listItemLabel - ListItemLabel that is starting

• endListLabel

  public void endListLabel​(ListItemLabel listItemLabel)

  Description copied from class: FOEventHandler
  Process end of a ListLabel.

  Overrides:

  endListLabel in class FOEventHandler

  Parameters:

  listItemLabel - ListItemLabel that is ending

• startListBody

  public void startListBody​(ListItemBody listItemBody)

  Description copied from class: FOEventHandler
  Process start of a ListBody.

  Overrides:

  startListBody in class FOEventHandler

  Parameters:

  listItemBody - ListItemBody that is starting

• endListBody

  public void endListBody​(ListItemBody listItemBody)

  Description copied from class: FOEventHandler
  Process end of a ListBody.

  Overrides:

  endListBody in class FOEventHandler

  Parameters:

  listItemBody - ListItemBody that is ending

• startMarkup

  public void startMarkup()

  Description copied from class: FOEventHandler
  Process start of a Markup.

  Overrides:

  startMarkup in class FOEventHandler

• endMarkup

  public void endMarkup()

  Description copied from class: FOEventHandler
  Process end of a Markup.

  Overrides:

  endMarkup in class FOEventHandler

• startLink

  public void startLink​(BasicLink basicLink)

  Description copied from class: FOEventHandler
  Process start of a Link.

  Overrides:

  startLink in class FOEventHandler

  Parameters:

  basicLink - BasicLink that is starting

• endLink

  public void endLink​(BasicLink basicLink)

  Description copied from class: FOEventHandler
  Process end of a Link.

  Overrides:

  endLink in class FOEventHandler

  Parameters:

  basicLink - BasicLink that is ending

• image

  public void image​(ExternalGraphic eg)

  Description copied from class: FOEventHandler
  Process an ExternalGraphic.

  Overrides:

  image in class FOEventHandler

  Parameters:

  eg - ExternalGraphic to process.

• pageRef

  public void pageRef()

  Description copied from class: FOEventHandler
  Process a pageRef.

  Overrides:

  pageRef in class FOEventHandler

• startInstreamForeignObject

  public void startInstreamForeignObject​(InstreamForeignObject ifo)

  Description copied from class: FOEventHandler
  Process the start of an InstreamForeignObject.

  Overrides:

  startInstreamForeignObject in class FOEventHandler

  Parameters:

  ifo - InstreamForeignObject that is starting

• endInstreamForeignObject

  public void endInstreamForeignObject​(InstreamForeignObject ifo)

  Description copied from class: FOEventHandler
  Process the end of an InstreamForeignObject.

  Overrides:

  endInstreamForeignObject in class FOEventHandler

  Parameters:

  ifo - InstreamForeignObject that is ending

• startFootnote

  public void startFootnote​(Footnote footnote)

  Description copied from class: FOEventHandler
  Process the start of a footnote.

  Overrides:

  startFootnote in class FOEventHandler

  Parameters:

  footnote - Footnote that is starting

• endFootnote

  public void endFootnote​(Footnote footnote)

  Description copied from class: FOEventHandler
  Process the ending of a footnote.

  Overrides:

  endFootnote in class FOEventHandler

  Parameters:

  footnote - Footnote that is ending

• startFootnoteBody

  public void startFootnoteBody​(FootnoteBody body)

  Description copied from class: FOEventHandler
  Process the start of a footnote body.

  Overrides:

  startFootnoteBody in class FOEventHandler

  Parameters:

  body - FootnoteBody that is starting

• endFootnoteBody

  public void endFootnoteBody​(FootnoteBody body)

  Description copied from class: FOEventHandler
  Process the ending of a footnote body.

  Overrides:

  endFootnoteBody in class FOEventHandler

  Parameters:

  body - FootnoteBody that is ending

• startLeader

  public void startLeader​(Leader l)

  Description copied from class: FOEventHandler
  Process the start of a Leader.

  Overrides:

  startLeader in class FOEventHandler

  Parameters:

  l - Leader that is starting

• endLeader

  public void endLeader​(Leader l)

  Description copied from class: FOEventHandler
  Process the end of a Leader.

  Overrides:

  endLeader in class FOEventHandler

  Parameters:

  l - Leader that is ending

• startWrapper

  public void startWrapper​(Wrapper wrapper)

  Description copied from class: FOEventHandler
  Process the start of a wrapper.

  Overrides:

  startWrapper in class FOEventHandler

  Parameters:

  wrapper - wrapper that is starting

• endWrapper

  public void endWrapper​(Wrapper wrapper)

  Description copied from class: FOEventHandler
  Process the ending of a wrapper.

  Overrides:

  endWrapper in class FOEventHandler

  Parameters:

  wrapper - wrapper that is ending

• startRetrieveMarker

  public void startRetrieveMarker​(RetrieveMarker retrieveMarker)

  Description copied from class: FOEventHandler
  Process the start of a retrieve-marker.

  Overrides:

  startRetrieveMarker in class FOEventHandler

  Parameters:

  retrieveMarker - the retrieve-marker that is starting

• endRetrieveMarker

  public void endRetrieveMarker​(RetrieveMarker retrieveMarker)

  Description copied from class: FOEventHandler
  Process the ending of a retrieve-marker.

  Overrides:

  endRetrieveMarker in class FOEventHandler

  Parameters:

  retrieveMarker - the retrieve-marker that is ending

• restoreState

  public void restoreState​(RetrieveMarker retrieveMarker)

  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 class FOEventHandler

  Parameters:

  retrieveMarker - the fo:retrieve-marker element that is retrieving markers

• startRetrieveTableMarker

  public void startRetrieveTableMarker​(RetrieveTableMarker retrieveTableMarker)

  Description copied from class: FOEventHandler
  Process the start of a retrieve-table-marker.

  Overrides:

  startRetrieveTableMarker in class FOEventHandler

  Parameters:

  retrieveTableMarker - the retrieve-table-marker that is starting

• endRetrieveTableMarker

  public void endRetrieveTableMarker​(RetrieveTableMarker retrieveTableMarker)

  Description copied from class: FOEventHandler
  Process the ending of a retrieve-table-marker.

  Overrides:

  endRetrieveTableMarker in class FOEventHandler

  Parameters:

  retrieveTableMarker - the retrieve-table-marker that is ending

• restoreState

  public void restoreState​(RetrieveTableMarker retrieveTableMarker)

  Description copied from class: FOEventHandler
  See FOEventHandler.restoreState(RetrieveMarker).

  Overrides:

  restoreState in class FOEventHandler

• character

  public void character​(Character c)

  Description copied from class: FOEventHandler
  Process a Character.

  Overrides:

  character in class FOEventHandler

  Parameters:

  c - Character to process.

• characters

  public void characters​(FOText foText)

  Description copied from class: FOEventHandler
  Process character data.

  Overrides:

  characters in class FOEventHandler

  Parameters:

  foText - text to process

• startExternalDocument

  public void startExternalDocument​(ExternalDocument document)

  Description copied from class: FOEventHandler
  Process the start of the external-document extension.

  Overrides:

  startExternalDocument in class FOEventHandler

  Parameters:

  document - the external-document node

• endExternalDocument

  public void endExternalDocument​(ExternalDocument document)

  Description copied from class: FOEventHandler
  Process the end of the external-document extension.

  Overrides:

  endExternalDocument in class FOEventHandler

  Parameters:

  document - the external-document node

• getResults

  public FormattingResults getResults()

  Description copied from class: FOEventHandler
  Get formatting results.

  Overrides:

  getResults in class FOEventHandler

  Returns:

  the FormattingResults instance for this document