Package org.apache.fop.render.intermediate.util

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

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(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, String name, String pageMasterName, Dimension size)	Indicates the start of a new page.
void	startPageSequence(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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

inPageSequence

private boolean inPageSequence

Constructor Details

IFPageSequenceFilter

public IFPageSequenceFilter(IFDocumentHandler delegate)

Method Details

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 interface IFDocumentHandler

Overrides:

startDocument in class IFDocumentHandlerProxy

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 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).

Specified by:

startDocumentHeader in interface IFDocumentHandler

Overrides:

startDocumentHeader in class IFDocumentHandlerProxy

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 interface IFDocumentHandler

Overrides:

endDocumentHeader in class IFDocumentHandlerProxy

Throws:

IFException - if an error occurs while handling this event

startPageSequence

public void startPageSequence(String id)
                       throws IFException

Indicates the start of a new page sequence.

Specified by:

startPageSequence in interface IFDocumentHandler

Overrides:

startPageSequence in class IFDocumentHandlerProxy

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 interface IFDocumentHandler

Overrides:

startPage in class IFDocumentHandlerProxy

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 page

size - 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 interface IFDocumentHandler

Overrides:

endPageSequence in class IFDocumentHandlerProxy

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 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).

Specified by:

startDocumentTrailer in interface IFDocumentHandler

Overrides:

startDocumentTrailer in class IFDocumentHandlerProxy

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 the IFDocumentHandler.endDocument() method.

Specified by:

endDocumentTrailer in interface IFDocumentHandler

Overrides:

endDocumentTrailer in class IFDocumentHandlerProxy

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 interface IFDocumentHandler

Overrides:

endDocument in class IFDocumentHandlerProxy

Throws:

IFException - if an error occurs while handling this event

handleExtensionObject

public void handleExtensionObject(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 interface IFDocumentHandler

Overrides:

handleExtensionObject in class IFDocumentHandlerProxy

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 interface IFDocumentHandler

Overrides:

getDocumentNavigationHandler in class IFDocumentHandlerProxy

Returns:

the document navigation handler or null if not supported