|
fop 1.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.render.intermediate.AbstractIFDocumentHandler
Abstract base class for IFDocumentHandler
implementations.
Constructor Summary | |
AbstractIFDocumentHandler()
Default constructor. |
Method Summary | |
void |
endDocumentHeader()
Indicates the end of the document header. This method is called before the first page sequence. |
void |
endDocumentTrailer()
Indicates the end of the document trailer. This method is called right before the IFDocumentHandler.endDocument() method. |
void |
endPageHeader()
Indicates the end of the page header. |
void |
endPageTrailer()
Indicates the end of the page trailer. |
IFContext |
getContext()
Returns the associated intermediate format context object. |
IFDocumentNavigationHandler |
getDocumentNavigationHandler()
Returns a document navigation handler if this feature is supported. |
FOUserAgent |
getUserAgent()
Returns the associated user agent. |
void |
setContext(IFContext context)
Sets the intermediate format context object. |
void |
startDocument()
Indicates the start of a document. This method may only be called once before any other event method. |
void |
startDocumentHeader()
Indicates the start of the document header. This method is called right after the IFDocumentHandler.startDocument() method. Extensions sent to this painter between
IFDocumentHandler.startDocumentHeader() and IFDocumentHandler.endDocumentHeader() apply to the document as
a whole (like document metadata). |
void |
startDocumentTrailer()
Indicates the start of the document trailer. This method is called after the last page sequence. Extensions sent to the painter between IFDocumentHandler.startDocumentTrailer() and IFDocumentHandler.endDocumentTrailer() apply to the document as
a whole and is used for document-level content that is only known after all pages have
been rendered (like named destinations or the bookmark tree). |
void |
startPageHeader()
Indicates the start of the page header. |
void |
startPageTrailer()
Indicates the start of the page trailer. The page trailer is used for writing down page elements which are only know after handling the page itself (like PDF targets). |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.fop.render.intermediate.IFDocumentHandler |
endDocument, endPage, endPageContent, endPageSequence, getConfigurator, getFontInfo, getMimeType, handleExtensionObject, setDefaultFontInfo, setFontInfo, setResult, startPage, startPageContent, startPageSequence, supportsPagesOutOfOrder |
Constructor Detail |
public AbstractIFDocumentHandler()
Method Detail |
public void setContext(IFContext context)
setContext
in interface IFDocumentHandler
context
- the context objectpublic IFContext getContext()
getContext
in interface IFDocumentHandler
public FOUserAgent getUserAgent()
public IFDocumentNavigationHandler getDocumentNavigationHandler()
getDocumentNavigationHandler
in interface IFDocumentHandler
public void startDocument() throws IFException
startDocument
in interface IFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void startDocumentHeader() throws IFException
IFDocumentHandler.startDocument()
method. Extensions sent to this painter between
IFDocumentHandler.startDocumentHeader()
and IFDocumentHandler.endDocumentHeader()
apply to the document as
a whole (like document metadata).
startDocumentHeader
in interface IFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void endDocumentHeader() throws IFException
endDocumentHeader
in interface IFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void startDocumentTrailer() throws IFException
IFDocumentHandler.startDocumentTrailer()
and IFDocumentHandler.endDocumentTrailer()
apply to the document as
a whole and is used for document-level content that is only known after all pages have
been rendered (like named destinations or the bookmark tree).
startDocumentTrailer
in interface IFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void endDocumentTrailer() throws IFException
IFDocumentHandler.endDocument()
method.
endDocumentTrailer
in interface IFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void startPageHeader() throws IFException
startPageHeader
in interface IFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void endPageHeader() throws IFException
endPageHeader
in interface IFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void startPageTrailer() throws IFException
startPageTrailer
in interface IFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void endPageTrailer() throws IFException
endPageTrailer
in interface IFDocumentHandler
IFException
- if an error occurs while handling this event
|
fop 1.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |