fop 0.94 | |
Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.fop.apps.Fop
public class Fop
extends java.lang.Object
Constructor Summary | |
| |
| |
|
Method Summary | |
DefaultHandler |
|
FormattingResults |
|
FOUserAgent |
|
static String |
|
void |
|
public Fop(String outputFormat)
Deprecated. End-users should use
FopFactory.newFop(String)
instead! This constructor will become invisible with FOP 1.0.Constructor for FOP with a default FOUserAgent. It uses MIME types to select the output format (ex. "application/pdf" for PDF).
- Parameters:
outputFormat
- the MIME type of the output format to use (ex. "application/pdf").
public Fop(String outputFormat, FOUserAgent ua) throws FOPException
Deprecated. End-users should use
FopFactory.newFop(String,FOUserAgent)
instead! This constructor will become invisible with FOP 1.0.Constructor for use with already-created FOUserAgents. It uses MIME types to select the output format (ex. "application/pdf" for PDF).
- Parameters:
outputFormat
- the MIME type of the output format to use (ex. "application/pdf").ua
- FOUserAgent object
- Throws:
FOPException
- if setting up the DefaultHandler fails
public Fop(String outputFormat, FOUserAgent ua, OutputStream stream) throws FOPException
Deprecated. End-users should use
FopFactory.newFop(String,FOUserAgent,OutputStream)
instead! This constructor will become invisible with FOP 1.0.Constructor for use with already-created FOUserAgents. It uses MIME types to select the output format (ex. "application/pdf" for PDF).
- Parameters:
outputFormat
- the MIME type of the output format to use (ex. "application/pdf").ua
- FOUserAgent objectstream
- the output stream
- Throws:
FOPException
- if setting up the DefaultHandler fails
public DefaultHandler getDefaultHandler() throws FOPException
Returns the DefaultHandler object used to generate the document. Checking for null and the exception is only for the deprecated constructor.
- Returns:
- the SAX DefaultHandler for handling the SAX events.
- Throws:
FOPException
- if setting up the DefaultHandler fails
public FormattingResults getResults()
Returns the results of the rendering process. Information includes the total number of pages generated and the number of pages per page-sequence. Call this method only after the rendering process is finished. Note that the results are only available for output formats which make use of FOP's layout engine (PDF, PS, etc.).
- Returns:
- the results of the rendering process, or null for flow-oriented output formats like RTF and MIF.
public FOUserAgent getUserAgent()
Get the FOUserAgent instance for this process
- Returns:
- the user agent
public static String getVersion()
Deprecated. Use
Version.getVersion()
instead! This method will be removed with FOP 1.0.Get the version of FOP
- Returns:
- the version string
public void setOutputStream(OutputStream stream)
Deprecated. Use one of the factory methods on
FopFactory
with an OutputStream parameter instead. This method will be removed with FOP 1.0.Set the OutputStream to use to output the result of the Render (if applicable)
- Parameters:
stream
- the stream to output the result of rendering to
fop 0.94 |