| 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.events |
Subsystem for reporting events inside FOP to client applications.
|
| 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 |
An AFP Renderer implementation and supporting classes.
|
| 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.intermediate | |
| 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.svg |
Classes that add SVG support to FOP and SVG->PDF conversion for Batik.
|
| 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 | Description |
|---|---|---|
FOUserAgent |
Fop.getUserAgent() |
Deprecated.
this getter doesn't need to exist.
|
FOUserAgent |
FopFactory.newFOUserAgent() |
Returns a new FOUserAgent instance.
|
| Modifier and Type | Method | Description |
|---|---|---|
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. |
Fop |
FopFactory.newFop(FOUserAgent userAgent) |
Returns a new
Fop instance. |
| Modifier and Type | Method | 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 | 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 | Description |
|---|---|---|
protected FOUserAgent |
CommandLineOptions.getFOUserAgent() |
Get the FOUserAgent for this Command-Line run
|
| Modifier and Type | Method | Description |
|---|---|---|
void |
InputHandler.createCatalogResolver(FOUserAgent userAgent) |
Creates a catalog resolver and uses it for XML parsing and XSLT URI resolution.
|
void |
AreaTreeInputHandler.renderTo(FOUserAgent userAgent,
java.lang.String outputFormat,
java.io.OutputStream out) |
Generate a document, given an initialized Fop object
|
void |
IFInputHandler.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) |
Renders the pre-setup document.
|
void |
InputHandler.renderTo(FOUserAgent userAgent,
java.lang.String outputFormat,
java.io.OutputStream out) |
Generate a document, given an initialized Fop object
|
| Constructor | Description |
|---|---|
FOPEventListenerProxy(EventListener delegate,
FOUserAgent userAgent) |
Main constructor.
|
| Modifier and Type | Field | Description |
|---|---|---|
protected FOUserAgent |
FOEventHandler.foUserAgent |
The FOUserAgent for this process
|
| Modifier and Type | Method | Description |
|---|---|---|
FOUserAgent |
DelegatingFOEventHandler.getUserAgent() |
|
FOUserAgent |
FOEventHandler.getUserAgent() |
Returns the User Agent object associated with this FOEventHandler.
|
FOUserAgent |
FONode.getUserAgent() |
Returns the user agent that is associated with the
tree's
FOEventHandler. |
| Constructor | Description |
|---|---|
FOEventHandler(FOUserAgent foUserAgent) |
Main constructor
|
FOTreeBuilder(java.lang.String outputFormat,
FOUserAgent foUserAgent,
java.io.OutputStream stream) |
FOTreeBuilder constructor |
| Modifier and Type | Method | Description |
|---|---|---|
protected FOUserAgent |
PropertyInfo.getUserAgent() |
Convenience shortcut to get a reference to the FOUserAgent
|
| Modifier and Type | Method | Description |
|---|---|---|
java.awt.Color |
NCnameProperty.getColor(FOUserAgent foUserAgent) |
If a system color, return the corresponding value.
|
java.awt.Color |
NumericProperty.getColor(FOUserAgent foUserAgent) |
This method expects to be overridden by subclasses
|
| Modifier and Type | Method | Description |
|---|---|---|
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.
|
java.awt.Color |
Property.getColor(FOUserAgent foUserAgent) |
This method expects to be overridden by subclasses
|
static ColorProperty |
ColorProperty.getInstance(FOUserAgent foUserAgent,
java.lang.String value) |
Set the color given a particular String.
|
| Modifier and Type | Field | Description |
|---|---|---|
protected FOUserAgent |
AbstractConfigurator.userAgent |
fop factory configuration
|
protected FOUserAgent |
AbstractRenderer.userAgent |
user agent
|
protected FOUserAgent |
AbstractRendererConfigurator.userAgent |
fop factory configuration
|
| Modifier and Type | Method | Description |
|---|---|---|
FOUserAgent |
AbstractRenderer.getUserAgent() |
Returns the associated user agent.
|
FOUserAgent |
AbstractRenderingContext.getUserAgent() |
Returns the user agent.
|
FOUserAgent |
Renderer.getUserAgent() |
Returns the associated user agent.
|
FOUserAgent |
RendererContext.getUserAgent() |
Returns the user agent.
|
FOUserAgent |
RendererContext.RendererContextWrapper.getUserAgent() |
|
FOUserAgent |
RenderingContext.getUserAgent() |
Returns the user agent.
|
| Modifier and Type | Method | Description |
|---|---|---|
RendererConfig |
RendererConfig.RendererConfigParser.build(FOUserAgent userAgent,
org.apache.avalon.framework.configuration.Configuration rendererConfiguration) |
Builds the object that contains the renderer configuration data.
|
protected org.apache.batik.gvt.GraphicsNode |
AbstractGenericSVGHandler.buildGraphicsNode(FOUserAgent userAgent,
org.apache.batik.bridge.BridgeContext ctx,
org.w3c.dom.Document doc) |
Builds the GVT root.
|
abstract void |
AbstractRendererMaker.configureRenderer(FOUserAgent userAgent,
Renderer renderer) |
Configures a given renderer using the appropriate configurator.
|
static PrintRendererConfigurator |
PrintRendererConfigurator.createDefaultInstance(FOUserAgent userAgent) |
|
IFDocumentHandler |
RendererFactory.createDocumentHandler(FOUserAgent userAgent,
java.lang.String outputFormat) |
Creates a
IFDocumentHandler object based on the desired output format. |
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
|
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.
|
| Constructor | Description |
|---|---|
AbstractConfigurator(FOUserAgent userAgent) |
Default constructor
|
AbstractPathOrientedRenderer(FOUserAgent userAgent) |
|
AbstractRenderer(FOUserAgent userAgent) |
|
AbstractRendererConfigurator(FOUserAgent userAgent) |
Default constructor
|
AbstractRenderingContext(FOUserAgent userAgent) |
Main constructor.
|
DefaultRendererConfigurator(FOUserAgent userAgent,
RendererConfig.RendererConfigParser rendererConfigParser) |
|
PrintRenderer(FOUserAgent userAgent) |
|
PrintRendererConfigurator(FOUserAgent userAgent,
RendererConfig.RendererConfigParser rendererConfigParser) |
Default constructor
|
PrintRendererConfigurator(FOUserAgent userAgent,
RendererConfig.RendererConfigParser rendererConfigParser,
FontConfigurator<EmbedFontInfo> fontInfoConfigurator) |
Default constructor
|
XMLHandlerConfigurator(FOUserAgent userAgent) |
Default constructor
|
| Modifier and Type | Method | Description |
|---|---|---|
AFPRendererConfig |
AFPRendererConfig.AFPRendererConfigParser.build(FOUserAgent userAgent,
org.apache.avalon.framework.configuration.Configuration cfg) |
Builds the object that contains the renderer configuration data.
|
static org.apache.batik.bridge.BridgeContext |
AFPSVGHandler.createBridgeContext(FOUserAgent userAgent,
AFPGraphics2D g2d) |
| Constructor | Description |
|---|---|
AFPRendererConfigurator(FOUserAgent userAgent,
RendererConfig.RendererConfigParser rendererConfigParser) |
Default constructor
|
AFPRenderingContext(FOUserAgent userAgent,
AFPResourceManager resourceManager,
AFPPaintingState paintingState,
FontInfo fontInfo,
java.util.Map foreignAttributes) |
Main constructor.
|
| Modifier and Type | Method | Description |
|---|---|---|
void |
AWTRendererMaker.configureRenderer(FOUserAgent userAgent,
Renderer renderer) |
|
Renderer |
AWTRendererMaker.makeRenderer(FOUserAgent ua) |
| Constructor | Description |
|---|---|
AWTRenderer(FOUserAgent userAgent) |
Creates a new AWTRenderer instance.
|
AWTRenderer(FOUserAgent userAgent,
Renderable renderable,
boolean previewAsMainWindow,
boolean show) |
Creates a new AWTRenderer instance.
|
| Modifier and Type | Field | 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 | 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 | 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 | Description |
|---|---|---|
BitmapRendererConfig |
BitmapRendererConfig.BitmapRendererConfigParser.build(FOUserAgent userAgent,
org.apache.avalon.framework.configuration.Configuration cfg) |
|
PNGRendererConfig |
PNGRendererConfig.PNGRendererConfigParser.build(FOUserAgent userAgent,
org.apache.avalon.framework.configuration.Configuration cfg) |
|
TIFFRendererConfig |
TIFFRendererConfig.TIFFRendererConfigParser.build(FOUserAgent userAgent,
org.apache.avalon.framework.configuration.Configuration cfg) |
Builds the object that contains the renderer configuration data.
|
void |
PNGRendererMaker.configureRenderer(FOUserAgent userAgent,
Renderer renderer) |
|
void |
TIFFRendererMaker.configureRenderer(FOUserAgent userAgent,
Renderer renderer) |
|
Renderer |
PNGRendererMaker.makeRenderer(FOUserAgent ua) |
|
Renderer |
TIFFRendererMaker.makeRenderer(FOUserAgent userAgent) |
| Constructor | Description |
|---|---|
BitmapRendererConfigurator(FOUserAgent userAgent,
RendererConfig.RendererConfigParser rendererConfigParser) |
Default constructor
|
PNGRenderer(FOUserAgent userAgent) |
|
TIFFRenderer(FOUserAgent userAgent) |
Creates TIFF renderer.
|
TIFFRendererConfigurator(FOUserAgent userAgent,
RendererConfig.RendererConfigParser rendererConfigParser) |
Default constructor
|
| Modifier and Type | Method | Description |
|---|---|---|
FOUserAgent |
AbstractIFDocumentHandler.getUserAgent() |
Returns the associated user agent.
|
protected FOUserAgent |
AbstractIFPainter.getUserAgent() |
Returns the user agent.
|
FOUserAgent |
IFContext.getUserAgent() |
Returns the associated user agent.
|
| Modifier and Type | Method | Description |
|---|---|---|
RendererConfig |
IFRendererConfig.IFRendererConfigParser.build(FOUserAgent userAgent,
org.apache.avalon.framework.configuration.Configuration cfg) |
Builds the object that contains the renderer configuration data.
|
org.xml.sax.ContentHandler |
IFParser.getContentHandler(IFDocumentHandler documentHandler,
FOUserAgent userAgent) |
Creates a new ContentHandler instance that you can send the area tree XML to.
|
void |
IFParser.parse(javax.xml.transform.Source src,
IFDocumentHandler documentHandler,
FOUserAgent userAgent) |
Parses an intermediate file and paints it.
|
void |
IFContext.setUserAgent(FOUserAgent ua) |
Set the user agent.
|
| Constructor | Description |
|---|---|
EventProducingFilter(IFDocumentHandler ifDocumentHandler,
FOUserAgent userAgent) |
Constructor
|
IFContext(FOUserAgent ua) |
Main constructor.
|
IFRenderer(FOUserAgent userAgent) |
Main constructor
|
| Modifier and Type | Method | Description |
|---|---|---|
FOUserAgent |
Java2DRenderer.getUserAgent() |
| Modifier and Type | Method | Description |
|---|---|---|
Java2DRendererConfig |
Java2DRendererConfig.Java2DRendererConfigParser.build(FOUserAgent userAgent,
org.apache.avalon.framework.configuration.Configuration cfg) |
Builds the object that contains the renderer configuration data.
|
static FontInfo |
Java2DUtil.buildDefaultJava2DBasedFontInfo(FontInfo fontInfo,
FOUserAgent userAgent) |
Builds a default
FontInfo object for use with output formats using the Java2D
font setup. |
| Constructor | Description |
|---|---|
Java2DRenderer(FOUserAgent userAgent) |
Default constructor
|
Java2DRendererConfigurator(FOUserAgent userAgent,
RendererConfig.RendererConfigParser rendererConfigParser) |
Default constructor
|
Java2DRenderingContext(FOUserAgent userAgent,
java.awt.Graphics2D g2d,
FontInfo fontInfo) |
Main constructor.
|
| Modifier and Type | Method | Description |
|---|---|---|
FOEventHandler |
MIFFOEventHandlerMaker.makeFOEventHandler(FOUserAgent ua,
java.io.OutputStream out) |
Instantiates a new FOEventHandler.
|
| Constructor | Description |
|---|---|
MIFHandler(FOUserAgent ua,
java.io.OutputStream os) |
Creates a new MIF handler on a given OutputStream.
|
| Modifier and Type | Method | Description |
|---|---|---|
FOUserAgent |
PCLRenderingUtil.getUserAgent() |
Returns the user agent.
|
| Modifier and Type | Method | Description |
|---|---|---|
PCLRendererConfig |
PCLRendererConfig.PCLRendererConfigParser.build(FOUserAgent userAgent,
org.apache.avalon.framework.configuration.Configuration cfg) |
Builds the object that contains the renderer configuration data.
|
| Constructor | Description |
|---|---|
PCLRendererConfigurator(FOUserAgent userAgent,
RendererConfig.RendererConfigParser rendererConfigParser) |
Default constructor
|
PCLRenderingContext(FOUserAgent userAgent,
PCLGenerator generator,
PCLRenderingUtil pclUtil) |
Main constructor.
|
| Modifier and Type | Method | Description |
|---|---|---|
PDFRendererConfig |
PDFRendererConfig.PDFRendererConfigParser.build(FOUserAgent userAgent,
org.apache.avalon.framework.configuration.Configuration cfg) |
| Constructor | Description |
|---|---|
PDFRendererConfigurator(FOUserAgent userAgent,
RendererConfig.RendererConfigParser rendererConfigParser) |
Default constructor
|
PDFRenderingContext(FOUserAgent userAgent,
PDFContentGenerator generator,
PDFPage page,
FontInfo fontInfo) |
Main constructor.
|
| Modifier and Type | Method | Description |
|---|---|---|
void |
PrintRendererMaker.configureRenderer(FOUserAgent userAgent,
Renderer renderer) |
|
Renderer |
PrintRendererMaker.makeRenderer(FOUserAgent userAgent) |
| Constructor | Description |
|---|---|
PageableRenderer(FOUserAgent userAgent) |
Creates a new PageableRenderer.
|
PrintRenderer(FOUserAgent userAgent) |
Creates a new PrintRenderer with the options set through the renderer options if a custom
PrinterJob is not given in FOUserAgent's renderer options.
|
| Modifier and Type | Method | Description |
|---|---|---|
PSRendererConfig |
PSRendererConfig.PSRendererConfigParser.build(FOUserAgent userAgent,
org.apache.avalon.framework.configuration.Configuration cfg) |
| Constructor | Description |
|---|---|
PSRendererConfigurator(FOUserAgent userAgent,
RendererConfig.RendererConfigParser rendererConfigParser) |
Default constructor
|
PSRenderingContext(FOUserAgent userAgent,
org.apache.xmlgraphics.ps.PSGenerator gen,
FontInfo fontInfo) |
Main constructor.
|
PSRenderingContext(FOUserAgent userAgent,
org.apache.xmlgraphics.ps.PSGenerator gen,
FontInfo fontInfo,
boolean createForms) |
Special constructor.
|
ResourceHandler(FOUserAgent userAgent,
PSEventProducer eventProducer,
FontInfo fontInfo,
org.apache.xmlgraphics.ps.dsc.ResourceTracker resTracker,
java.util.Map formResources) |
Main constructor.
|
| Modifier and Type | Method | Description |
|---|---|---|
FOEventHandler |
RTFFOEventHandlerMaker.makeFOEventHandler(FOUserAgent ua,
java.io.OutputStream out) |
Instantiates a new FOEventHandler.
|
| Constructor | Description |
|---|---|
RTFHandler(FOUserAgent userAgent,
java.io.OutputStream os) |
Creates a new RTF structure handler.
|
| Modifier and Type | Method | Description |
|---|---|---|
void |
SVGRendererMaker.configureRenderer(FOUserAgent userAgent,
Renderer renderer) |
|
Renderer |
SVGRendererMaker.makeRenderer(FOUserAgent ua) |
| Constructor | Description |
|---|---|
SVGRenderer(FOUserAgent userAgent) |
|
SVGRenderingContext(FOUserAgent userAgent,
org.xml.sax.ContentHandler handler) |
Main constructor.
|
| Modifier and Type | Method | Description |
|---|---|---|
TxtRendererConfig |
TxtRendererConfig.TxtRendererConfigParser.build(FOUserAgent userAgent,
org.apache.avalon.framework.configuration.Configuration cfg) |
Builds the object that contains the renderer configuration data.
|
void |
TXTRendererMaker.configureRenderer(FOUserAgent userAgent,
Renderer renderer) |
|
Renderer |
TXTRendererMaker.makeRenderer(FOUserAgent userAgent) |
| Constructor | Description |
|---|---|
TXTRenderer(FOUserAgent userAgent) |
Constructs a newly allocated
TXTRenderer object. |
TXTRendererConfigurator(FOUserAgent userAgent,
RendererConfig.RendererConfigParser rendererConfigParser) |
Default constructor
|
| Modifier and Type | Method | Description |
|---|---|---|
void |
XMLRendererMaker.configureRenderer(FOUserAgent userAgent,
Renderer renderer) |
|
Renderer |
XMLRendererMaker.makeRenderer(FOUserAgent userAgent) |
| Constructor | Description |
|---|---|
AbstractXMLRenderer(FOUserAgent userAgent) |
|
XMLRenderer(FOUserAgent userAgent) |
| Modifier and Type | Method | Description |
|---|---|---|
protected FOUserAgent |
FopServlet.getFOUserAgent() |
| Constructor | Description |
|---|---|
SVGUserAgent(FOUserAgent foUserAgent,
org.apache.batik.bridge.FontFamilyResolver fontFamilyResolver) |
Creates a new SVGUserAgent.
|
SVGUserAgent(FOUserAgent foUserAgent,
org.apache.batik.bridge.FontFamilyResolver fontFamilyResolver,
java.awt.geom.AffineTransform at) |
Creates a new SVGUserAgent.
|
| Modifier and Type | Method | 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 | Description |
|---|---|---|
static java.awt.Color |
ColorUtil.parseColorString(FOUserAgent foUserAgent,
java.lang.String value) |
Creates a color from a given string.
|
Copyright 1999-2016 The Apache Software Foundation. All Rights Reserved.
