Package | Description |
---|---|
org.apache.fop.apps |
Application classes used for running FOP embedded in other applications.
|
org.apache.fop.area |
FOP's area tree.
|
org.apache.fop.cli |
This package contains the command-line client for Apache FOP.
|
org.apache.fop.fo |
Classes, constants and basic infrastructure for the FO tree.
|
org.apache.fop.fo.expr |
Classes for XSL expressions and functions.
|
org.apache.fop.fo.properties |
Classes representing the various property types as well as supporting data structures for the FO tree.
|
org.apache.fop.render |
Generic renderer interface.
|
org.apache.fop.render.afp | |
org.apache.fop.render.awt |
AWT Renderer used for displaying rendered pages in Java applications.
|
org.apache.fop.render.awt.viewer |
AWT Viewer PreviewDialog and PreviewPanel.
|
org.apache.fop.render.bitmap |
Bitmap Renderer which creates TIFF and PNG images from rendered pages.
|
org.apache.fop.render.java2d |
Java2D Renderer which paints rendered pages on Graphics2D instances.
|
org.apache.fop.render.mif |
MIF Output Support
|
org.apache.fop.render.pcl |
PCL Renderer (Supports PCL5 and HP GL/2)
|
org.apache.fop.render.pdf |
PDF Renderer
|
org.apache.fop.render.print |
Renderer which prints rendered pages directly to a printer.
|
org.apache.fop.render.ps |
PostScript Renderer
|
org.apache.fop.render.rtf |
RTF (Rich Text Format) Output Support
|
org.apache.fop.render.svg |
SVG (Structured Vector Graphics) Renderer
|
org.apache.fop.render.txt |
Plain Text Renderer
|
org.apache.fop.render.xml |
Area Tree XML Renderer.
|
org.apache.fop.servlet |
This package contains two sample FOP servlets.
|
org.apache.fop.traits |
Trait classes and other supporting data structures.
|
org.apache.fop.util |
Various utility classes (I/O, codecs, color support, service discovers etc.).
|
Modifier and Type | Method and Description |
---|---|
FOUserAgent |
Fop.getUserAgent()
Get the FOUserAgent instance associated with the rendering run represented by this instance.
|
FOUserAgent |
FopFactory.newFOUserAgent()
Returns a new FOUserAgent instance.
|
Modifier and Type | Method and Description |
---|---|
Fop |
FopFactory.newFop(FOUserAgent userAgent)
Returns a new
Fop instance. |
Fop |
FopFactory.newFop(java.lang.String outputFormat,
FOUserAgent userAgent)
Returns a new
Fop instance. |
Fop |
FopFactory.newFop(java.lang.String outputFormat,
FOUserAgent userAgent,
java.io.OutputStream stream)
Returns a new
Fop instance. |
Modifier and Type | Method and Description |
---|---|
org.xml.sax.ContentHandler |
AreaTreeParser.getContentHandler(AreaTreeModel treeModel,
FOUserAgent userAgent)
Creates a new ContentHandler instance that you can send the area tree XML to.
|
void |
AreaTreeParser.parse(javax.xml.transform.Source src,
AreaTreeModel treeModel,
FOUserAgent userAgent)
Parses an intermediate file (area tree XML) into an AreaTreeModel instance by adding
pages to it.
|
protected void |
AreaTreeHandler.setupModel(FOUserAgent userAgent,
java.lang.String outputFormat,
java.io.OutputStream stream)
Sets up the AreaTreeModel instance for use by the AreaTreeHandler.
|
Constructor and Description |
---|
AreaTreeHandler(FOUserAgent userAgent,
java.lang.String outputFormat,
java.io.OutputStream stream)
Constructor.
|
CachedRenderPagesModel(FOUserAgent userAgent,
java.lang.String outputFormat,
FontInfo fontInfo,
java.io.OutputStream stream)
Main Constructor
|
RenderPagesModel(FOUserAgent userAgent,
java.lang.String outputFormat,
FontInfo fontInfo,
java.io.OutputStream stream)
Create a new render pages model with the given renderer.
|
Modifier and Type | Method and Description |
---|---|
protected FOUserAgent |
CommandLineOptions.getFOUserAgent()
Get the FOUserAgent for this Command-Line run
|
Modifier and Type | Method and Description |
---|---|
void |
InputHandler.renderTo(FOUserAgent userAgent,
java.lang.String outputFormat)
Renders the pre-setup document.
|
void |
AreaTreeInputHandler.renderTo(FOUserAgent userAgent,
java.lang.String outputFormat,
java.io.OutputStream out)
Generate a document, given an initialized Fop object
|
void |
InputHandler.renderTo(FOUserAgent userAgent,
java.lang.String outputFormat,
java.io.OutputStream out)
Generate a document, given an initialized Fop object
|
Modifier and Type | Field and Description |
---|---|
protected FOUserAgent |
FOEventHandler.foUserAgent
The FOUserAgent for this process
|
Modifier and Type | Method and Description |
---|---|
FOUserAgent |
FONode.getUserAgent()
Returns the user agent for the node.
|
FOUserAgent |
FOEventHandler.getUserAgent()
Returns the User Agent object associated with this FOEventHandler.
|
Constructor and Description |
---|
FOEventHandler(FOUserAgent foUserAgent)
Main constructor
|
FOTreeBuilder(java.lang.String outputFormat,
FOUserAgent foUserAgent,
java.io.OutputStream stream)
FOTreeBuilder constructor |
Modifier and Type | Method and Description |
---|---|
protected FOUserAgent |
PropertyInfo.getUserAgent()
Convenience shortcut to get a reference to the FOUserAgent
|
Modifier and Type | Method and Description |
---|---|
java.awt.Color |
NumericProperty.getColor(FOUserAgent foUserAgent)
This method expects to be overridden by subclasses
|
java.awt.Color |
NCnameProperty.getColor(FOUserAgent foUserAgent)
If a system color, return the corresponding value.
|
Modifier and Type | Method and Description |
---|---|
java.awt.Color |
Property.getColor(FOUserAgent foUserAgent)
This method expects to be overridden by subclasses
|
java.awt.Color |
ColorProperty.getColor(FOUserAgent foUserAgent)
Returns an AWT instance of this color
|
java.awt.Color |
NumberProperty.getColor(FOUserAgent foUserAgent)
Convert NumberProperty to a Color.
|
static ColorProperty |
ColorProperty.getInstance(FOUserAgent foUserAgent,
java.lang.String value)
Set the color given a particular String.
|
Modifier and Type | Field and Description |
---|---|
protected FOUserAgent |
AbstractRenderer.userAgent
user agent
|
protected FOUserAgent |
AbstractRendererConfigurator.userAgent
fop factory configuration
|
Modifier and Type | Method and Description |
---|---|
FOUserAgent |
RendererContext.getUserAgent()
Returns the user agent.
|
FOUserAgent |
RendererContext.RendererContextWrapper.getUserAgent() |
FOUserAgent |
AbstractRenderer.getUserAgent() |
Modifier and Type | Method and Description |
---|---|
FOEventHandler |
RendererFactory.createFOEventHandler(FOUserAgent userAgent,
java.lang.String outputFormat,
java.io.OutputStream out)
Creates FOEventHandler instances based on the desired output.
|
Renderer |
RendererFactory.createRenderer(FOUserAgent userAgent,
java.lang.String outputFormat)
Creates a Renderer object based on render-type desired
|
RendererConfigurator |
AbstractRendererMaker.getConfigurator(FOUserAgent userAgent)
Returns a renderer config object that can be used to
configure the renderer.
|
static org.apache.avalon.framework.configuration.Configuration |
AbstractRendererConfigurator.getRendererConfig(FOUserAgent userAgent,
java.lang.String mimeType)
Returns the configuration subtree for a specific renderer.
|
abstract FOEventHandler |
AbstractFOEventHandlerMaker.makeFOEventHandler(FOUserAgent ua,
java.io.OutputStream out)
Instantiates a new FOEventHandler.
|
abstract Renderer |
AbstractRendererMaker.makeRenderer(FOUserAgent userAgent)
Instantiates a new renderer.
|
void |
RendererContext.setUserAgent(FOUserAgent ua)
Sets the user agent.
|
void |
AbstractRenderer.setUserAgent(FOUserAgent agent)
Set the User Agent.
|
void |
Renderer.setUserAgent(FOUserAgent agent)
Set the User Agent.
|
Constructor and Description |
---|
AbstractRendererConfigurator(FOUserAgent userAgent)
Default constructor
|
DefaultFontResolver(FOUserAgent userAgent)
Main constructor.
|
PrintRendererConfigurator(FOUserAgent userAgent)
Default constructor
|
XMLHandlerConfigurator(FOUserAgent userAgent)
Default constructor
|
Modifier and Type | Method and Description |
---|---|
RendererConfigurator |
AFPRendererMaker.getConfigurator(FOUserAgent userAgent)
Returns a renderer config object that can be used to
configure the renderer.
|
Renderer |
AFPRendererMaker.makeRenderer(FOUserAgent userAgent)
Instantiates a new renderer.
|
void |
AFPRenderer.setUserAgent(FOUserAgent agent)
Set the User Agent.
|
Constructor and Description |
---|
AFPRendererConfigurator(FOUserAgent userAgent)
Default constructor
|
Modifier and Type | Method and Description |
---|---|
Renderer |
AWTRendererMaker.makeRenderer(FOUserAgent ua)
Instantiates a new renderer.
|
void |
AWTRenderer.setUserAgent(FOUserAgent foUserAgent)
Set the User Agent.
|
Modifier and Type | Field and Description |
---|---|
protected FOUserAgent |
PreviewDialog.foUserAgent
The FOUserAgent associated with this window
|
protected FOUserAgent |
PreviewPanel.foUserAgent
The FOUserAgent associated with this panel - often shared with PreviewDialog
|
Modifier and Type | Method and Description |
---|---|
static PreviewDialog |
PreviewDialog.createPreviewDialog(FOUserAgent foUserAgent,
Renderable renderable,
boolean asMainWindow)
Creates and initialize the AWT Viewer main window.
|
void |
Renderable.renderTo(FOUserAgent userAgent,
java.lang.String outputFormat)
Renders the pre-setup document.
|
Constructor and Description |
---|
PreviewDialog(FOUserAgent foUserAgent)
Creates a new PreviewDialog that uses the given renderer.
|
PreviewDialog(FOUserAgent foUserAgent,
Renderable renderable)
Creates a new PreviewDialog that uses the given renderer.
|
PreviewPanel(FOUserAgent foUserAgent,
Renderable renderable,
AWTRenderer renderer)
Creates a new PreviewPanel instance.
|
Modifier and Type | Method and Description |
---|---|
RendererConfigurator |
PNGRendererMaker.getConfigurator(FOUserAgent userAgent)
Returns a renderer config object that can be used to
configure the renderer.
|
RendererConfigurator |
TIFFRendererMaker.getConfigurator(FOUserAgent userAgent)
Returns a renderer config object that can be used to
configure the renderer.
|
Renderer |
PNGRendererMaker.makeRenderer(FOUserAgent ua)
Instantiates a new renderer.
|
Renderer |
TIFFRendererMaker.makeRenderer(FOUserAgent userAgent)
Instantiates a new renderer.
|
void |
TIFFRenderer.setUserAgent(FOUserAgent foUserAgent)
Set the User Agent.
|
Constructor and Description |
---|
TIFFRendererConfigurator(FOUserAgent userAgent)
Default constructor
|
Modifier and Type | Method and Description |
---|---|
FOUserAgent |
Java2DRenderer.getUserAgent() |
Modifier and Type | Method and Description |
---|---|
void |
Java2DRenderer.setUserAgent(FOUserAgent foUserAgent)
Set the User Agent.
|
Constructor and Description |
---|
Java2DRendererConfigurator(FOUserAgent userAgent)
Default constructor
|
Modifier and Type | Method and Description |
---|---|
FOEventHandler |
MIFFOEventHandlerMaker.makeFOEventHandler(FOUserAgent ua,
java.io.OutputStream out) |
Constructor and Description |
---|
MIFHandler(FOUserAgent ua,
java.io.OutputStream os)
Creates a new MIF handler on a given OutputStream.
|
Modifier and Type | Method and Description |
---|---|
RendererConfigurator |
PCLRendererMaker.getConfigurator(FOUserAgent userAgent)
Returns a renderer config object that can be used to
configure the renderer.
|
Renderer |
PCLRendererMaker.makeRenderer(FOUserAgent userAgent)
Instantiates a new renderer.
|
Constructor and Description |
---|
PCLRendererConfigurator(FOUserAgent userAgent)
Default constructor
|
Modifier and Type | Method and Description |
---|---|
RendererConfigurator |
PDFRendererMaker.getConfigurator(FOUserAgent userAgent)
Returns a renderer config object that can be used to
configure the renderer.
|
Renderer |
PDFRendererMaker.makeRenderer(FOUserAgent userAgent)
Instantiates a new renderer.
|
void |
PDFRenderer.setUserAgent(FOUserAgent agent)
Set the User Agent.
|
Constructor and Description |
---|
PDFRendererConfigurator(FOUserAgent userAgent)
Default constructor
|
Modifier and Type | Method and Description |
---|---|
RendererConfigurator |
PrintRendererMaker.getConfigurator(FOUserAgent userAgent)
Returns a renderer config object that can be used to
configure the renderer.
|
Renderer |
PrintRendererMaker.makeRenderer(FOUserAgent userAgent)
Instantiates a new renderer.
|
Modifier and Type | Method and Description |
---|---|
RendererConfigurator |
PSRendererMaker.getConfigurator(FOUserAgent userAgent)
Returns a renderer config object that can be used to
configure the renderer.
|
Renderer |
PSRendererMaker.makeRenderer(FOUserAgent userAgent)
Instantiates a new renderer.
|
static void |
ResourceHandler.process(FOUserAgent userAgent,
java.io.InputStream in,
java.io.OutputStream out,
FontInfo fontInfo,
org.apache.xmlgraphics.ps.dsc.ResourceTracker resTracker,
java.util.Map formResources,
int pageCount,
java.awt.geom.Rectangle2D documentBoundingBox)
Rewrites the temporary PostScript file generated by PSRenderer adding all needed resources
(fonts and images).
|
void |
PSRenderer.setUserAgent(FOUserAgent agent)
Set the User Agent.
|
Constructor and Description |
---|
PSRendererConfigurator(FOUserAgent userAgent)
Default constructor
|
Modifier and Type | Method and Description |
---|---|
FOEventHandler |
RTFFOEventHandlerMaker.makeFOEventHandler(FOUserAgent ua,
java.io.OutputStream out)
Instantiates a new FOEventHandler.
|
Constructor and Description |
---|
RTFHandler(FOUserAgent userAgent,
java.io.OutputStream os)
Creates a new RTF structure handler.
|
Modifier and Type | Method and Description |
---|---|
Renderer |
SVGRendererMaker.makeRenderer(FOUserAgent ua) |
Modifier and Type | Method and Description |
---|---|
RendererConfigurator |
TXTRendererMaker.getConfigurator(FOUserAgent userAgent)
Returns a renderer config object that can be used to
configure the renderer.
|
Renderer |
TXTRendererMaker.makeRenderer(FOUserAgent userAgent)
Instantiates a new renderer.
|
Constructor and Description |
---|
TXTRendererConfigurator(FOUserAgent userAgent)
Default constructor
|
Modifier and Type | Method and Description |
---|---|
RendererConfigurator |
XMLRendererMaker.getConfigurator(FOUserAgent userAgent)
Returns a renderer config object that can be used to
configure the renderer.
|
Renderer |
XMLRendererMaker.makeRenderer(FOUserAgent userAgent)
Instantiates a new renderer.
|
void |
XMLRenderer.setUserAgent(FOUserAgent agent)
Set the User Agent.
|
Modifier and Type | Method and Description |
---|---|
protected FOUserAgent |
FopServlet.getFOUserAgent() |
Modifier and Type | Method and Description |
---|---|
static BorderProps |
BorderProps.valueOf(FOUserAgent foUserAgent,
java.lang.String s)
Returns a BorderProps represtation of a string of the format as written by
BorderProps.toString().
|
Modifier and Type | Method and Description |
---|---|
static java.awt.Color |
ColorUtil.parseColorString(FOUserAgent foUserAgent,
java.lang.String value)
Creates a color from a given string.
|
Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.