Package org.apache.fop.render.svg

Class SVGPrintDocumentHandler

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.SVGPrintDocumentHandler
All Implemented Interfaces:
IFDocumentHandler, SVGConstants, XMLConstants
public class SVGPrintDocumentHandler extends AbstractSVGDocumentHandler
IFDocumentHandler implementation that writes SVG Print.

  • Constructor Details

    • SVGPrintDocumentHandler

      public SVGPrintDocumentHandler(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

    • 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

    • 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

    • startPageHeader

      public void startPageHeader() throws IFException
      Indicates the start of the page header.
      Specified by:
      startPageHeader in interface IFDocumentHandler
      Overrides:
      startPageHeader in class AbstractIFDocumentHandler
      Throws:
      IFException - if an error occurs while handling this event

    • endPageHeader

      public void endPageHeader() throws IFException
      Indicates the end of the page header.
      Specified by:
      endPageHeader in interface IFDocumentHandler
      Overrides:
      endPageHeader in class AbstractIFDocumentHandler
      Throws:
      IFException - if an error occurs while handling this event

    • 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

    • startPageTrailer

      public void startPageTrailer() throws IFException
      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 interface IFDocumentHandler
      Overrides:
      startPageTrailer in class AbstractIFDocumentHandler
      Throws:
      IFException - if an error occurs while handling this event

    • endPageTrailer

      public void endPageTrailer() throws IFException
      Indicates the end of the page trailer.
      Specified by:
      endPageTrailer in interface IFDocumentHandler
      Overrides:
      endPageTrailer in class AbstractIFDocumentHandler
      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