Package org.apache.fop.render.svg
Class SVGDocumentHandler
java.lang.Object
org.apache.fop.render.intermediate.AbstractIFDocumentHandler
org.apache.fop.render.intermediate.AbstractXMLWritingIFDocumentHandler
org.apache.fop.render.svg.AbstractSVGDocumentHandler
org.apache.fop.render.svg.SVGDocumentHandler
- All Implemented Interfaces:
IFDocumentHandler
,SVGConstants
,XMLConstants
IFDocumentHandler
implementation
that writes SVG 1.1.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate StreamResult
private StreamResult
private MultiFileRenderingUtil
Helper class for generating multiple filesprivate Document
private Result
Used for single-page documents rendered to a DOM or SAX.Fields inherited from class org.apache.fop.render.svg.AbstractSVGDocumentHandler
fontInfo, state
Fields inherited from class org.apache.fop.render.intermediate.AbstractXMLWritingIFDocumentHandler
handler, tFactory
Fields inherited from interface org.apache.fop.render.svg.SVGConstants
FILE_EXTENSION_SVG, MIME_SVG_PRINT, MIME_TYPE, NAMESPACE, SVG_ELEMENT
Fields inherited from interface org.apache.fop.util.XMLConstants
CDATA, XLINK_HREF, XLINK_NAMESPACE, XLINK_PREFIX, XML_NAMESPACE, XML_PREFIX, XML_SPACE, XMLNS_NAMESPACE_URI, XMLNS_PREFIX
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate void
private GenerationHelperContentHandler
decorate
(ContentHandler contentHandler) void
Indicates the end of a document.void
Indicates the end of the document header.void
endPage()
Indicates the end of a pagevoid
Indicates the end of the page content.void
Indicates the end of a page sequence.Returns the MIME type of the output format that is generated by this implementation.private void
prepareHandlerWithOutputStream
(int index) void
Sets the JAXP Result object to receive the generated content.void
Indicates the start of a document.void
Indicates the start of a new page.Indicates the start of the page content.void
Indicates the start of a new page sequence.boolean
Indicates whether the painter supports to handle the pages in mixed order rather than ascending order.Methods inherited from class org.apache.fop.render.svg.AbstractSVGDocumentHandler
getConfigurator, getFontInfo, getMainNamespace, handleExtensionObject, setDefaultFontInfo, setFontInfo, startDocumentHeader
Methods inherited from class org.apache.fop.render.intermediate.AbstractXMLWritingIFDocumentHandler
createContentHandler
Methods inherited from class org.apache.fop.render.intermediate.AbstractIFDocumentHandler
endDocumentTrailer, endPageHeader, endPageTrailer, getContext, getDocumentNavigationHandler, getStructureTreeEventHandler, getUserAgent, setDocumentLocale, startDocumentTrailer, startPageHeader, startPageTrailer
-
Field Details
-
multiFileUtil
Helper class for generating multiple files -
firstStream
-
currentStream
-
simpleResult
Used for single-page documents rendered to a DOM or SAX. -
reusedParts
-
-
Constructor Details
-
SVGDocumentHandler
Default constructor.
-
-
Method Details
-
supportsPagesOutOfOrder
public boolean supportsPagesOutOfOrder()Indicates whether the painter supports to handle the pages in mixed order rather than ascending order.- Returns:
- true if out-of-order handling is supported
-
getMimeType
Returns the MIME type of the output format that is generated by this implementation.- Returns:
- the MIME type
-
setResult
Sets the JAXP Result object to receive the generated content.- Specified by:
setResult
in interfaceIFDocumentHandler
- Overrides:
setResult
in classAbstractXMLWritingIFDocumentHandler
- Parameters:
result
- the JAXP Result object to receive the generated content- Throws:
IFException
- if an error occurs setting up the output
-
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 classAbstractIFDocumentHandler
- 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.- 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 classAbstractSVGDocumentHandler
- Throws:
IFException
- if an error occurs while handling this event
-
startPageSequence
Indicates the start of a new page sequence.- Parameters:
id
- the page sequence's identifier (or null if none is available)- Throws:
IFException
- if an error occurs while handling this event
-
endPageSequence
Indicates the end of a page sequence.- 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.- 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
-
prepareHandlerWithOutputStream
- Throws:
IFException
-
decorate
-
closeCurrentStream
private void closeCurrentStream() -
startPageContent
Indicates the start of the page content. The method returns anIFPainter
interface which is used to paint the page contents.- Returns:
- the IFPainter for the page content
- Throws:
IFException
- if an error occurs while handling this event
-
endPageContent
Indicates the end of the page content. Calls to theIFPainter
returned by the respectiveIFDocumentHandler.startPageContent()
method are illegal.- Throws:
IFException
- if an error occurs while handling this event
-
endPage
Indicates the end of a page- Throws:
IFException
- if an error occurs while handling this event
-