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
public class SVGDocumentHandler extends AbstractSVGDocumentHandler
IFDocumentHandler implementation that writes SVG 1.1.

  • Field Details

    • multiFileUtil

      private MultiFileRenderingUtil multiFileUtil
      Helper class for generating multiple files

    • firstStream

      private StreamResult firstStream

    • currentStream

      private StreamResult currentStream

    • simpleResult

      private Result simpleResult
      Used for single-page documents rendered to a DOM or SAX.

    • reusedParts

      private Document reusedParts

  • Constructor Details

    • SVGDocumentHandler

      public SVGDocumentHandler(IFContext context)
      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

      public String getMimeType()
      Returns the MIME type of the output format that is generated by this implementation.
      Returns:
      the MIME type

    • setResult

      public void setResult(Result result) throws IFException
      Sets the JAXP Result object to receive the generated content.
      Specified by:
      setResult in interface IFDocumentHandler
      Overrides:
      setResult in class AbstractXMLWritingIFDocumentHandler
      Parameters:
      result - the JAXP Result object to receive the generated content
      Throws:
      IFException - if an error occurs setting up the output

    • 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 AbstractIFDocumentHandler
      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.
      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 AbstractSVGDocumentHandler
      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.
      Parameters:
      id - the page sequence's identifier (or null if none is available)
      Throws:
      IFException - if an error occurs while handling this event

    • endPageSequence

      public void endPageSequence() throws IFException
      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 page
      size - the size of the page (equivalent to the MediaBox in PDF)
      Throws:
      IFException - if an error occurs while handling this event

    • prepareHandlerWithOutputStream

      private void prepareHandlerWithOutputStream(int index) throws IFException
      Throws:
      IFException

    • decorate

      private GenerationHelperContentHandler decorate(ContentHandler contentHandler)

    • closeCurrentStream

      private void closeCurrentStream()

    • startPageContent

      public IFPainter startPageContent() throws IFException
      Indicates the start of the page content. The method returns an IFPainter 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

      public void endPageContent() throws IFException
      Indicates the end of the page content. Calls to the IFPainter returned by the respective IFDocumentHandler.startPageContent() method are illegal.
      Throws:
      IFException - if an error occurs while handling this event

    • endPage

      public void endPage() throws IFException
      Indicates the end of a page
      Throws:
      IFException - if an error occurs while handling this event