|
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.util.IFDocumentHandlerProxy
This class is a simple proxy that delegates all method calls to another IFDocumentHandler
instance.
| Field Summary | |
protected IFDocumentHandler |
delegate
the delegate IFDocumentHandler |
| Constructor Summary | |
IFDocumentHandlerProxy(IFDocumentHandler delegate)
Creates a new proxy instance. |
|
| Method Summary | |
void |
endDocument()
Indicates the end of a document. This method may only be called once after the whole document has been handled. Implementations can release resources (close streams). It is an error to call any event method after this method. |
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 |
endPage()
Indicates the end of a page |
void |
endPageContent()
Indicates the end of the page content. Calls to the IFPainter returned by the
respective IFDocumentHandler.startPageContent() method are illegal. |
void |
endPageHeader()
Indicates the end of the page header. |
void |
endPageSequence()
Indicates the end of a page sequence. |
void |
endPageTrailer()
Indicates the end of the page trailer. |
IFDocumentHandlerConfigurator |
getConfigurator()
Returns the configurator for this document handler, if any. |
IFContext |
getContext()
Returns the associated intermediate format context object. |
IFDocumentNavigationHandler |
getDocumentNavigationHandler()
Returns a document navigation handler if this feature is supported. |
FontInfo |
getFontInfo()
Returns the font set to work with. |
java.lang.String |
getMimeType()
Returns the MIME type of the output format that is generated by this implementation. |
void |
handleExtensionObject(java.lang.Object extension)
Handles an extension object. This can be a DOM document or any arbitrary object. If an implementation doesn't know how to handle a particular extension it is simply ignored. |
void |
setContext(IFContext context)
Sets the intermediate format context object. |
void |
setDefaultFontInfo(FontInfo fontInfo)
Sets the default font set (with no custom configuration). |
void |
setFontInfo(FontInfo fontInfo)
Sets the font set to work with. |
void |
setResult(javax.xml.transform.Result result)
Sets the JAXP Result object to receive the generated content. |
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 |
startPage(int index,
java.lang.String name,
java.lang.String pageMasterName,
java.awt.Dimension size)
Indicates the start of a new page. |
IFPainter |
startPageContent()
Indicates the start of the page content. The method returns an IFPainter interface
which is used to paint the page contents. |
void |
startPageHeader()
Indicates the start of the page header. |
void |
startPageSequence(java.lang.String id)
Indicates the start of a new page sequence. |
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). |
boolean |
supportsPagesOutOfOrder()
Indicates whether the painter supports to handle the pages in mixed order rather than ascending order. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
protected IFDocumentHandler delegate
| Constructor Detail |
public IFDocumentHandlerProxy(IFDocumentHandler delegate)
delegate - the delegate instance| Method Detail |
public boolean supportsPagesOutOfOrder()
supportsPagesOutOfOrder in interface IFDocumentHandlerpublic java.lang.String getMimeType()
getMimeType in interface IFDocumentHandlerpublic void setContext(IFContext context)
setContext in interface IFDocumentHandlercontext - the context objectpublic IFContext getContext()
getContext in interface IFDocumentHandlerpublic FontInfo getFontInfo()
getFontInfo in interface IFDocumentHandlerpublic void setFontInfo(FontInfo fontInfo)
setFontInfo in interface IFDocumentHandlerfontInfo - the font info objectpublic void setDefaultFontInfo(FontInfo fontInfo)
setDefaultFontInfo in interface IFDocumentHandlerfontInfo - the font info object to populatepublic IFDocumentHandlerConfigurator getConfigurator()
getConfigurator in interface IFDocumentHandlerpublic IFDocumentNavigationHandler getDocumentNavigationHandler()
getDocumentNavigationHandler in interface IFDocumentHandler
public void setResult(javax.xml.transform.Result result)
throws IFException
setResult in interface IFDocumentHandlerresult - the JAXP Result object to receive the generated content
IFException - if an error occurs setting up the output
public void startDocument()
throws IFException
startDocument in interface IFDocumentHandlerIFException - if an error occurs while handling this event
public 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 IFDocumentHandlerIFException - if an error occurs while handling this event
public void endDocumentHeader()
throws IFException
endDocumentHeader in interface IFDocumentHandlerIFException - if an error occurs while handling this event
public void startPageSequence(java.lang.String id)
throws IFException
startPageSequence in interface IFDocumentHandlerid - the page sequence's identifier (or null if none is available)
IFException - if an error occurs while handling this event
public void startPage(int index,
java.lang.String name,
java.lang.String pageMasterName,
java.awt.Dimension size)
throws IFException
startPage in interface IFDocumentHandlerindex - the index of the page (0-based)name - the page name (usually the formatted page number)pageMasterName - the name of the simple-page-master that generated this pagesize - the size of the page (equivalent to the MediaBox in PDF)
IFException - if an error occurs while handling this event
public void startPageHeader()
throws IFException
startPageHeader in interface IFDocumentHandlerIFException - if an error occurs while handling this event
public void endPageHeader()
throws IFException
endPageHeader in interface IFDocumentHandlerIFException - if an error occurs while handling this event
public IFPainter startPageContent()
throws IFException
IFPainter interface
which is used to paint the page contents.
startPageContent in interface IFDocumentHandlerIFException - if an error occurs while handling this event
public void endPageContent()
throws IFException
IFPainter returned by the
respective IFDocumentHandler.startPageContent() method are illegal.
endPageContent in interface IFDocumentHandlerIFException - if an error occurs while handling this event
public void startPageTrailer()
throws IFException
startPageTrailer in interface IFDocumentHandlerIFException - if an error occurs while handling this event
public void endPageTrailer()
throws IFException
endPageTrailer in interface IFDocumentHandlerIFException - if an error occurs while handling this event
public void endPage()
throws IFException
endPage in interface IFDocumentHandlerIFException - if an error occurs while handling this event
public void endPageSequence()
throws IFException
endPageSequence in interface IFDocumentHandlerIFException - if an error occurs while handling this event
public 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 IFDocumentHandlerIFException - if an error occurs while handling this event
public void endDocumentTrailer()
throws IFException
IFDocumentHandler.endDocument() method.
endDocumentTrailer in interface IFDocumentHandlerIFException - if an error occurs while handling this event
public void endDocument()
throws IFException
endDocument in interface IFDocumentHandlerIFException - if an error occurs while handling this event
public void handleExtensionObject(java.lang.Object extension)
throws IFException
handleExtensionObject in interface IFDocumentHandlerextension - the extension object
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 | ||||||||||