Package org.apache.fop.render.java2d
Class Java2DDocumentHandler
java.lang.Object
org.apache.fop.render.java2d.Java2DDocumentHandler
- All Implemented Interfaces:
IFDocumentHandler
IFDocumentHandler
implementation that produces
Graphics2D instance.-
Constructor Summary
-
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
endPage()
Indicates the end of a pagevoid
Indicates the end of the page content.void
Indicates the end of the page header.void
Indicates the end of a page sequence.void
Indicates the end of the page trailer.Returns the configurator for this document handler, if any.Returns the associated intermediate format context object.Returns a document navigation handler if this feature is supported.Returns the font set to work with.Returns the MIME type of the output format that is generated by this implementation.void
handleExtensionObject
(Object extension) Handles an extension object.void
setContext
(IFContext context) void
setDefaultFontInfo
(FontInfo fontInfo) Sets the default font set (with no custom configuration).void
setDocumentLocale
(Locale locale) void
setFontInfo
(FontInfo fontInfo) Sets the font set to work with.void
Sets the JAXP Result object to receive the generated content.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.Indicates the start of the page content.void
Indicates the start of the page header.void
Indicates the start of a new page sequence.void
Indicates the start of the page trailer.boolean
Indicates whether the painter supports to handle the pages in mixed order rather than ascending order.
-
Constructor Details
-
Java2DDocumentHandler
public Java2DDocumentHandler()
-
-
Method Details
-
setContext
-
getContext
Description copied from interface:IFDocumentHandler
Returns the associated intermediate format context object.- Specified by:
getContext
in interfaceIFDocumentHandler
- Returns:
- the context object
-
setResult
Description copied from interface:IFDocumentHandler
Sets the JAXP Result object to receive the generated content.- Specified by:
setResult
in interfaceIFDocumentHandler
- Parameters:
result
- the JAXP Result object to receive the generated content- Throws:
IFException
- if an error occurs setting up the output
-
setFontInfo
Description copied from interface:IFDocumentHandler
Sets the font set to work with.- Specified by:
setFontInfo
in interfaceIFDocumentHandler
- Parameters:
fontInfo
- the font info object
-
getFontInfo
Description copied from interface:IFDocumentHandler
Returns the font set to work with.- Specified by:
getFontInfo
in interfaceIFDocumentHandler
- Returns:
- the font info object
-
setDefaultFontInfo
Description copied from interface:IFDocumentHandler
Sets the default font set (with no custom configuration).- Specified by:
setDefaultFontInfo
in interfaceIFDocumentHandler
- Parameters:
fontInfo
- the font info object to populate
-
getConfigurator
Description copied from interface:IFDocumentHandler
Returns the configurator for this document handler, if any.- Specified by:
getConfigurator
in interfaceIFDocumentHandler
- Returns:
- the configurator or null if there's no configurator
-
getStructureTreeEventHandler
- Specified by:
getStructureTreeEventHandler
in interfaceIFDocumentHandler
- Returns:
- the structure tree builder
-
supportsPagesOutOfOrder
public boolean supportsPagesOutOfOrder()Description copied from interface:IFDocumentHandler
Indicates whether the painter supports to handle the pages in mixed order rather than ascending order.- Specified by:
supportsPagesOutOfOrder
in interfaceIFDocumentHandler
- Returns:
- true if out-of-order handling is supported
-
getMimeType
Description copied from interface:IFDocumentHandler
Returns the MIME type of the output format that is generated by this implementation.- Specified by:
getMimeType
in interfaceIFDocumentHandler
- Returns:
- the MIME type
-
startDocument
Description copied from interface:IFDocumentHandler
Indicates the start of a document. This method may only be called once before any other event method.- Specified by:
startDocument
in interfaceIFDocumentHandler
- Throws:
IFException
- if an error occurs while handling this event
-
endDocument
Description copied from interface:IFDocumentHandler
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
- Throws:
IFException
- if an error occurs while handling this event
-
setDocumentLocale
- Specified by:
setDocumentLocale
in interfaceIFDocumentHandler
- Parameters:
locale
- Locale of the document.
-
startDocumentHeader
Description copied from interface:IFDocumentHandler
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
- Throws:
IFException
- if an error occurs while handling this event
-
endDocumentHeader
Description copied from interface:IFDocumentHandler
Indicates the end of the document header. This method is called before the first page sequence.- Specified by:
endDocumentHeader
in interfaceIFDocumentHandler
- Throws:
IFException
- if an error occurs while handling this event
-
startDocumentTrailer
Description copied from interface:IFDocumentHandler
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
- Throws:
IFException
- if an error occurs while handling this event
-
endDocumentTrailer
Description copied from interface:IFDocumentHandler
Indicates the end of the document trailer. This method is called right before theIFDocumentHandler.endDocument()
method.- Specified by:
endDocumentTrailer
in interfaceIFDocumentHandler
- Throws:
IFException
- if an error occurs while handling this event
-
startPageSequence
Description copied from interface:IFDocumentHandler
Indicates the start of a new page sequence.- Specified by:
startPageSequence
in interfaceIFDocumentHandler
- Parameters:
id
- the page sequence's identifier (or null if none is available)- Throws:
IFException
- if an error occurs while handling this event
-
endPageSequence
Description copied from interface:IFDocumentHandler
Indicates the end of a page sequence.- Specified by:
endPageSequence
in interfaceIFDocumentHandler
- Throws:
IFException
- if an error occurs while handling this event
-
startPage
public void startPage(int index, String name, String pageMasterName, Dimension size) throws IFException Description copied from interface:IFDocumentHandler
Indicates the start of a new page.- Specified by:
startPage
in interfaceIFDocumentHandler
- 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
-
endPage
Description copied from interface:IFDocumentHandler
Indicates the end of a page- Specified by:
endPage
in interfaceIFDocumentHandler
- Throws:
IFException
- if an error occurs while handling this event
-
startPageHeader
Description copied from interface:IFDocumentHandler
Indicates the start of the page header.- Specified by:
startPageHeader
in interfaceIFDocumentHandler
- Throws:
IFException
- if an error occurs while handling this event
-
endPageHeader
Description copied from interface:IFDocumentHandler
Indicates the end of the page header.- Specified by:
endPageHeader
in interfaceIFDocumentHandler
- Throws:
IFException
- if an error occurs while handling this event
-
startPageContent
Description copied from interface:IFDocumentHandler
Indicates the start of the page content. The method returns anIFPainter
interface which is used to paint the page contents.- Specified by:
startPageContent
in interfaceIFDocumentHandler
- Returns:
- the IFPainter for the page content
- Throws:
IFException
- if an error occurs while handling this event
-
endPageContent
Description copied from interface:IFDocumentHandler
Indicates the end of the page content. Calls to theIFPainter
returned by the respectiveIFDocumentHandler.startPageContent()
method are illegal.- Specified by:
endPageContent
in interfaceIFDocumentHandler
- Throws:
IFException
- if an error occurs while handling this event
-
startPageTrailer
Description copied from interface:IFDocumentHandler
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).- Specified by:
startPageTrailer
in interfaceIFDocumentHandler
- Throws:
IFException
- if an error occurs while handling this event
-
endPageTrailer
Description copied from interface:IFDocumentHandler
Indicates the end of the page trailer.- Specified by:
endPageTrailer
in interfaceIFDocumentHandler
- Throws:
IFException
- if an error occurs while handling this event
-
handleExtensionObject
Description copied from interface:IFDocumentHandler
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
- Parameters:
extension
- the extension object- Throws:
IFException
- if an error occurs while handling this event
-