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
-
Field Summary
FieldsFields inherited from class org.apache.fop.render.intermediate.util.IFDocumentHandlerProxy
delegate
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Indicates the end of a document.void
Indicates the end of the document header.void
Indicates the end of the document trailer.void
Indicates the end of a page sequence.Returns a document navigation handler if this feature is supported.void
handleExtensionObject
(Object extension) Handles an extension object.void
Indicates the start of a document.void
Indicates the start of the document header.void
Indicates the start of the document trailer.void
Indicates the start of a new page.void
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
-
Field Details
-
inPageSequence
private boolean inPageSequence
-
-
Constructor Details
-
IFPageSequenceFilter
-
-
Method Details
-
startDocument
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
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
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
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, String name, String pageMasterName, 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
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
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
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
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
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
-