Class PSDocumentHandler

    • Constructor Detail

      • PSDocumentHandler

        public PSDocumentHandler​(IFContext context)
        Default constructor.
    • Method Detail

      • 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 java.lang.String getMimeType()
        Returns the MIME type of the output format that is generated by this implementation.
        Returns:
        the MIME type
      • getConfigurator

        public IFDocumentHandlerConfigurator getConfigurator()
        Returns the configurator for this document handler, if any.
        Returns:
        the configurator or null if there's no configurator
      • startPageSequence

        public void startPageSequence​(java.lang.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,
                              java.lang.String name,
                              java.lang.String pageMasterName,
                              java.awt.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
      • 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
      • endPage

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

        public void handleExtensionObject​(java.lang.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.
        Parameters:
        extension - the extension object
        Throws:
        IFException - if an error occurs while handling this event
      • getPSResourceForFontKey

        protected org.apache.fop.render.ps.PSFontResource getPSResourceForFontKey​(java.lang.String key)
        Returns the PSResource for the given font key.
        Parameters:
        key - the font key ("F*")
        Returns:
        the matching PSResource
      • getFormForImage

        public org.apache.xmlgraphics.ps.PSResource getFormForImage​(java.lang.String uri)
        Returns a PSResource instance representing a image as a PostScript form.
        Parameters:
        uri - the image URI
        Returns:
        a PSResource instance