public class PSDocumentHandler extends AbstractBinaryWritingIFDocumentHandler
IFDocumentHandler
implementation
that produces PostScript.Modifier and Type | Class and Description |
---|---|
static interface |
PSDocumentHandler.FOPPSGenerator |
class |
PSDocumentHandler.FOPPSGeneratorImpl |
fontInfo, outputStream
Constructor and Description |
---|
PSDocumentHandler(IFContext context)
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
endDocument()
Indicates the end of a document.
|
void |
endDocumentHeader()
Indicates the end of the document header.
|
void |
endPage()
Indicates the end of a page
|
void |
endPageContent()
Indicates the end of the page content.
|
void |
endPageHeader()
Indicates the end of the page header.
|
void |
endPageSequence()
Indicates the end of a page sequence.
|
void |
endPageTrailer()
Indicates the end of the page trailer.
|
IFDocumentHandlerConfigurator |
getConfigurator()
Returns the configurator for this document handler, if any.
|
org.apache.xmlgraphics.ps.PSResource |
getFormForImage(String uri)
Returns a PSResource instance representing a image as a PostScript form.
|
String |
getMimeType()
Returns the MIME type of the output format that is generated by this implementation.
|
protected org.apache.fop.render.ps.PSFontResource |
getPSResourceForFontKey(String key)
Returns the PSResource for the given font key.
|
PSRenderingUtil |
getPSUtil() |
void |
handleExtensionObject(Object extension)
Handles an extension object.
|
void |
startDocument()
Indicates the start of a document.
|
void |
startPage(int index,
String name,
String pageMasterName,
Dimension size)
Indicates the start of a new page.
|
IFPainter |
startPageContent()
Indicates the start of the page content.
|
void |
startPageHeader()
Indicates the start of the page header.
|
void |
startPageSequence(String id)
Indicates the start of a new page sequence.
|
void |
startPageTrailer()
Indicates the start of the page trailer.
|
boolean |
supportsPagesOutOfOrder()
Indicates whether the painter supports to handle the pages in mixed order rather than
ascending order.
|
getFontInfo, setDefaultFontInfo, setFontInfo, setResult
endDocumentTrailer, getContext, getDocumentNavigationHandler, getStructureTreeEventHandler, getUserAgent, setDocumentLocale, startDocumentHeader, startDocumentTrailer
public PSDocumentHandler(IFContext context)
public boolean supportsPagesOutOfOrder()
public String getMimeType()
public IFDocumentHandlerConfigurator getConfigurator()
public PSRenderingUtil getPSUtil()
public void startDocument() throws IFException
startDocument
in interface IFDocumentHandler
startDocument
in class AbstractBinaryWritingIFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void endDocumentHeader() throws IFException
endDocumentHeader
in interface IFDocumentHandler
endDocumentHeader
in class AbstractIFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void endDocument() throws IFException
endDocument
in interface IFDocumentHandler
endDocument
in class AbstractBinaryWritingIFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void startPageSequence(String id) throws IFException
id
- the page sequence's identifier (or null if none is available)IFException
- if an error occurs while handling this eventpublic void endPageSequence() throws IFException
IFException
- if an error occurs while handling this eventpublic void startPage(int index, String name, String pageMasterName, Dimension size) throws IFException
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)IFException
- if an error occurs while handling this eventpublic void startPageHeader() throws IFException
startPageHeader
in interface IFDocumentHandler
startPageHeader
in class AbstractIFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void endPageHeader() throws IFException
endPageHeader
in interface IFDocumentHandler
endPageHeader
in class AbstractIFDocumentHandler
IFException
- if an error occurs while handling this eventpublic IFPainter startPageContent() throws IFException
IFPainter
interface
which is used to paint the page contents.IFException
- if an error occurs while handling this eventpublic void endPageContent() throws IFException
IFPainter
returned by the
respective IFDocumentHandler.startPageContent()
method are illegal.IFException
- if an error occurs while handling this eventpublic void startPageTrailer() throws IFException
startPageTrailer
in interface IFDocumentHandler
startPageTrailer
in class AbstractIFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void endPageTrailer() throws IFException
endPageTrailer
in interface IFDocumentHandler
endPageTrailer
in class AbstractIFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void endPage() throws IFException
IFException
- if an error occurs while handling this eventpublic void handleExtensionObject(Object extension) throws IFException
extension
- the extension objectIFException
- if an error occurs while handling this eventprotected org.apache.fop.render.ps.PSFontResource getPSResourceForFontKey(String key)
key
- the font key ("F*")public org.apache.xmlgraphics.ps.PSResource getFormForImage(String uri)
uri
- the image URICopyright © 2025 Apache Software Foundation. All rights reserved.