Class IFConcatenator.IFPageSequenceFilter
- java.lang.Object
-
- org.apache.fop.render.intermediate.util.IFDocumentHandlerProxy
-
- org.apache.fop.render.intermediate.util.IFConcatenator.IFPageSequenceFilter
-
- All Implemented Interfaces:
IFDocumentHandler
- Enclosing class:
- IFConcatenator
private class IFConcatenator.IFPageSequenceFilter extends IFDocumentHandlerProxy
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
inPageSequence
-
Fields inherited from class org.apache.fop.render.intermediate.util.IFDocumentHandlerProxy
delegate
-
-
Constructor Summary
Constructors Constructor Description IFPageSequenceFilter(IFDocumentHandler delegate)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
endDocument()
Indicates the end of a document.void
endDocumentHeader()
Indicates the end of the document header.void
endDocumentTrailer()
Indicates the end of the document trailer.void
endPageSequence()
Indicates the end of a page sequence.IFDocumentNavigationHandler
getDocumentNavigationHandler()
Returns a document navigation handler if this feature is supported.void
handleExtensionObject(java.lang.Object extension)
Handles an extension object.void
startDocument()
Indicates the start of a document.void
startDocumentHeader()
Indicates the start of the document header.void
startDocumentTrailer()
Indicates the start of the document trailer.void
startPage(int index, java.lang.String name, java.lang.String pageMasterName, java.awt.Dimension size)
Indicates the start of a new page.void
startPageSequence(java.lang.String id)
Indicates the start of a new page sequence.-
Methods inherited from class org.apache.fop.render.intermediate.util.IFDocumentHandlerProxy
endPage, endPageContent, endPageHeader, endPageTrailer, getConfigurator, getContext, getFontInfo, getMimeType, getStructureTreeEventHandler, setDefaultFontInfo, setDocumentLocale, setFontInfo, setResult, startPageContent, startPageHeader, startPageTrailer, supportsPagesOutOfOrder
-
-
-
-
Constructor Detail
-
IFPageSequenceFilter
public IFPageSequenceFilter(IFDocumentHandler delegate)
-
-
Method Detail
-
startDocument
public void startDocument() throws IFException
Indicates the start of a document. This method may only be called once before any other event method.- Specified by:
startDocument
in interfaceIFDocumentHandler
- Overrides:
startDocument
in classIFDocumentHandlerProxy
- Throws:
IFException
- if an error occurs while handling this event
-
startDocumentHeader
public void startDocumentHeader() throws IFException
Indicates the start of the document header. This method is called right after theIFDocumentHandler.startDocument()
method. Extensions sent to this painter betweenIFDocumentHandler.startDocumentHeader()
andIFDocumentHandler.endDocumentHeader()
apply to the document as a whole (like document metadata).- Specified by:
startDocumentHeader
in interfaceIFDocumentHandler
- Overrides:
startDocumentHeader
in classIFDocumentHandlerProxy
- Throws:
IFException
- if an error occurs while handling this event
-
endDocumentHeader
public void endDocumentHeader() throws IFException
Indicates the end of the document header. This method is called before the first page sequence.- Specified by:
endDocumentHeader
in interfaceIFDocumentHandler
- Overrides:
endDocumentHeader
in classIFDocumentHandlerProxy
- Throws:
IFException
- if an error occurs while handling this event
-
startPageSequence
public void startPageSequence(java.lang.String id) throws IFException
Indicates the start of a new page sequence.- Specified by:
startPageSequence
in interfaceIFDocumentHandler
- Overrides:
startPageSequence
in classIFDocumentHandlerProxy
- Parameters:
id
- the page sequence's identifier (or null if none is available)- Throws:
IFException
- if an error occurs while handling this event
-
startPage
public void startPage(int index, java.lang.String name, java.lang.String pageMasterName, java.awt.Dimension size) throws IFException
Indicates the start of a new page.- Specified by:
startPage
in interfaceIFDocumentHandler
- Overrides:
startPage
in classIFDocumentHandlerProxy
- Parameters:
index
- 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)- Throws:
IFException
- if an error occurs while handling this event
-
endPageSequence
public void endPageSequence() throws IFException
Indicates the end of a page sequence.- Specified by:
endPageSequence
in interfaceIFDocumentHandler
- Overrides:
endPageSequence
in classIFDocumentHandlerProxy
- Throws:
IFException
- if an error occurs while handling this event
-
startDocumentTrailer
public void startDocumentTrailer() throws IFException
Indicates the start of the document trailer. This method is called after the last page sequence. Extensions sent to the painter betweenIFDocumentHandler.startDocumentTrailer()
andIFDocumentHandler.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).- Specified by:
startDocumentTrailer
in interfaceIFDocumentHandler
- Overrides:
startDocumentTrailer
in classIFDocumentHandlerProxy
- Throws:
IFException
- if an error occurs while handling this event
-
endDocumentTrailer
public void endDocumentTrailer() throws IFException
Indicates the end of the document trailer. This method is called right before theIFDocumentHandler.endDocument()
method.- Specified by:
endDocumentTrailer
in interfaceIFDocumentHandler
- Overrides:
endDocumentTrailer
in classIFDocumentHandlerProxy
- Throws:
IFException
- if an error occurs while handling this event
-
endDocument
public void endDocument() throws IFException
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.- Specified by:
endDocument
in interfaceIFDocumentHandler
- Overrides:
endDocument
in classIFDocumentHandlerProxy
- Throws:
IFException
- if an error occurs while handling this event
-
handleExtensionObject
public void handleExtensionObject(java.lang.Object extension) throws IFException
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.- Specified by:
handleExtensionObject
in interfaceIFDocumentHandler
- Overrides:
handleExtensionObject
in classIFDocumentHandlerProxy
- Parameters:
extension
- the extension object- Throws:
IFException
- if an error occurs while handling this event
-
getDocumentNavigationHandler
public IFDocumentNavigationHandler getDocumentNavigationHandler()
Returns a document navigation handler if this feature is supported.- Specified by:
getDocumentNavigationHandler
in interfaceIFDocumentHandler
- Overrides:
getDocumentNavigationHandler
in classIFDocumentHandlerProxy
- Returns:
- the document navigation handler or null if not supported
-
-