Uses of Class
org.apache.fop.apps.FOUserAgent
Package
Description
Application classes used for running FOP embedded in other applications.
FOP's area tree.
This package contains the command-line client for Apache FOP.
Subsystem for reporting events inside FOP to client applications.
Classes, constants and basic infrastructure for the FO tree.
Classes for XSL expressions and functions.
Classes representing the various property types as well as supporting data structures for the FO tree.
Hyphenation support.
FOP's layout engine.
Layout managers for inline formatting objects and line building.
Generic renderer interface.
An AFP Renderer implementation and supporting classes.
AWT Renderer used for displaying rendered pages in Java applications.
AWT Viewer PreviewDialog and PreviewPanel.
Bitmap Renderer which creates TIFF and PNG images from rendered pages.
Java2D Renderer which paints rendered pages on Graphics2D instances.
PCL Renderer (Supports PCL5 and HP GL/2)
PDF Renderer
Renderer which prints rendered pages directly to a printer.
PostScript Renderer
RTF (Rich Text Format) Output Support
Plain Text Renderer
Area Tree XML Renderer.
This package contains two sample FOP servlets.
Classes that add SVG support to FOP and SVG->PDF conversion for Batik.
Trait classes and other supporting data structures.
Various utility classes (I/O, codecs, color support, service discovers etc.).
-
Uses of FOUserAgent in org.apache.fop.apps
Modifier and TypeMethodDescriptionFop.getUserAgent()
Deprecated.this getter doesn't need to exist.FopFactory.newFOUserAgent()
Returns a new FOUserAgent instance.Modifier and TypeMethodDescriptionFopFactory.newFop
(String outputFormat, FOUserAgent userAgent) Returns a newFop
instance.FopFactory.newFop
(String outputFormat, FOUserAgent userAgent, OutputStream stream) Returns a newFop
instance.FopFactory.newFop
(FOUserAgent userAgent) Returns a newFop
instance. -
Uses of FOUserAgent in org.apache.fop.area
Modifier and TypeMethodDescriptionAreaTreeParser.getContentHandler
(AreaTreeModel treeModel, FOUserAgent userAgent) Creates a new ContentHandler instance that you can send the area tree XML to.void
AreaTreeParser.parse
(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, String outputFormat, OutputStream stream) Sets up the AreaTreeModel instance for use by the AreaTreeHandler.ModifierConstructorDescriptionAreaTreeHandler
(FOUserAgent userAgent, String outputFormat, OutputStream stream) Constructor.CachedRenderPagesModel
(FOUserAgent userAgent, String outputFormat, FontInfo fontInfo, OutputStream stream) Main ConstructorRenderPagesModel
(FOUserAgent userAgent, String outputFormat, FontInfo fontInfo, OutputStream stream) Create a new render pages model with the given renderer. -
Uses of FOUserAgent in org.apache.fop.cli
Modifier and TypeMethodDescriptionprotected FOUserAgent
CommandLineOptions.getFOUserAgent()
Get the FOUserAgent for this Command-Line runModifier and TypeMethodDescriptionvoid
InputHandler.createCatalogResolver
(FOUserAgent userAgent) Creates a catalog resolver and uses it for XML parsing and XSLT URI resolution.void
AreaTreeInputHandler.renderTo
(FOUserAgent userAgent, String outputFormat, OutputStream out) Generate a document, given an initialized Fop objectvoid
IFInputHandler.renderTo
(FOUserAgent userAgent, String outputFormat, OutputStream out) Generate a document, given an initialized Fop objectvoid
InputHandler.renderTo
(FOUserAgent userAgent, String outputFormat) Renders the pre-setup document.void
InputHandler.renderTo
(FOUserAgent userAgent, String outputFormat, OutputStream out) Generate a document, given an initialized Fop object -
Uses of FOUserAgent in org.apache.fop.events
ModifierConstructorDescriptionFOPEventListenerProxy
(org.apache.fop.events.EventListener delegate, FOUserAgent userAgent) Main constructor. -
Uses of FOUserAgent in org.apache.fop.fo
Modifier and TypeFieldDescriptionprotected FOUserAgent
FOEventHandler.foUserAgent
The FOUserAgent for this processModifier and TypeMethodDescriptionDelegatingFOEventHandler.getUserAgent()
FOEventHandler.getUserAgent()
Returns the User Agent object associated with this FOEventHandler.FONode.getUserAgent()
Returns the user agent that is associated with the tree'sFOEventHandler
.ModifierConstructorDescriptionFOEventHandler
(FOUserAgent foUserAgent) Main constructorFOTreeBuilder
(String outputFormat, FOUserAgent foUserAgent, OutputStream stream) FOTreeBuilder
constructor -
Uses of FOUserAgent in org.apache.fop.fo.expr
Modifier and TypeMethodDescriptionprotected FOUserAgent
PropertyInfo.getUserAgent()
Convenience shortcut to get a reference to the FOUserAgentModifier and TypeMethodDescriptionNCnameProperty.getColor
(FOUserAgent foUserAgent) If a system color, return the corresponding value.NumericProperty.getColor
(FOUserAgent foUserAgent) This method expects to be overridden by subclasses -
Uses of FOUserAgent in org.apache.fop.fo.properties
Modifier and TypeMethodDescriptionColorProperty.getColor
(FOUserAgent foUserAgent) Returns an AWT instance of this colorNumberProperty.getColor
(FOUserAgent foUserAgent) Convert NumberProperty to a Color.Property.getColor
(FOUserAgent foUserAgent) This method expects to be overridden by subclassesstatic ColorProperty
ColorProperty.getInstance
(FOUserAgent foUserAgent, String value) Set the color given a particular String. -
Uses of FOUserAgent in org.apache.fop.hyphenation
Modifier and TypeMethodDescriptionstatic HyphenationTree
Hyphenator.getHyphenationTree
(String lang, String country, InternalResourceResolver resourceResolver, Map hyphPatNames, FOUserAgent foUserAgent) static Hyphenation
Hyphenator.hyphenate
(String lang, String country, InternalResourceResolver resourceResolver, Map hyphPatNames, String word, int leftMin, int rightMin, FOUserAgent foUserAgent) -
Uses of FOUserAgent in org.apache.fop.layoutmgr
Modifier and TypeMethodDescriptionvoid
LayoutManagerMapping.BasicLinkLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.BidiOverrideLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.BlockContainerLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.BlockLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.CharacterLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.ExternalGraphicLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.FloatLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) void
LayoutManagerMapping.FootnoteLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.FOTextLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.InlineContainerLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.InlineLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.InstreamForeignObjectLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.LeaderLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.ListBlockLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.ListItemLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.Maker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.MultiCaseLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) void
LayoutManagerMapping.MultiSwitchLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) void
LayoutManagerMapping.PageNumberCitationLastLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.PageNumberCitationLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.PageNumberLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.RetrieveMarkerLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.RetrieveTableMarkerLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) void
LayoutManagerMapping.TableLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager.void
LayoutManagerMapping.WrapperLayoutManagerMaker.make
(FONode node, List lms, FOUserAgent userAgent) Create a layout manager. -
Uses of FOUserAgent in org.apache.fop.layoutmgr.inline
ModifierConstructorDescriptionTextLayoutManager
(FOText node, FOUserAgent userAgent) Create a Text layout manager. -
Uses of FOUserAgent in org.apache.fop.render
Modifier and TypeFieldDescriptionprotected FOUserAgent
AbstractConfigurator.userAgent
fop factory configurationprotected FOUserAgent
AbstractRenderer.userAgent
user agentprotected final FOUserAgent
AbstractRendererConfigurator.userAgent
fop factory configurationModifier and TypeMethodDescriptionAbstractRenderer.getUserAgent()
Returns the associated user agent.AbstractRenderingContext.getUserAgent()
Returns the user agent.Renderer.getUserAgent()
Returns the associated user agent.RendererContext.getUserAgent()
Returns the user agent.RendererContext.RendererContextWrapper.getUserAgent()
RenderingContext.getUserAgent()
Returns the user agent.Modifier and TypeMethodDescriptionRendererConfig.RendererConfigParser.build
(FOUserAgent userAgent, 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, 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) RendererFactory.createDocumentHandler
(FOUserAgent userAgent, String outputFormat) Creates aIFDocumentHandler
object based on the desired output format.RendererFactory.createFOEventHandler
(FOUserAgent userAgent, String outputFormat, OutputStream out) Creates FOEventHandler instances based on the desired output.RendererFactory.createRenderer
(FOUserAgent userAgent, String outputFormat) Creates a Renderer object based on render-type desiredabstract FOEventHandler
AbstractFOEventHandlerMaker.makeFOEventHandler
(FOUserAgent ua, 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.ModifierConstructorDescriptionAbstractConfigurator
(FOUserAgent userAgent) Default constructorAbstractPathOrientedRenderer
(FOUserAgent userAgent) AbstractRenderer
(FOUserAgent userAgent) AbstractRendererConfigurator
(FOUserAgent userAgent) Default constructorAbstractRenderingContext
(FOUserAgent userAgent) Main constructor.DefaultRendererConfigurator
(FOUserAgent userAgent, RendererConfig.RendererConfigParser rendererConfigParser) PrintRenderer
(FOUserAgent userAgent) PrintRendererConfigurator
(FOUserAgent userAgent, RendererConfig.RendererConfigParser rendererConfigParser) Default constructorPrintRendererConfigurator
(FOUserAgent userAgent, RendererConfig.RendererConfigParser rendererConfigParser, FontConfigurator<EmbedFontInfo> fontInfoConfigurator) Default constructorXMLHandlerConfigurator
(FOUserAgent userAgent) Default constructor -
Uses of FOUserAgent in org.apache.fop.render.afp
Modifier and TypeMethodDescriptionAFPRendererConfig.AFPRendererConfigParser.build
(FOUserAgent userAgent, Configuration cfg) Builds the object that contains the renderer configuration data.static org.apache.batik.bridge.BridgeContext
AFPSVGHandler.createBridgeContext
(FOUserAgent userAgent, AFPGraphics2D g2d) ModifierConstructorDescriptionAFPRendererConfigurator
(FOUserAgent userAgent, RendererConfig.RendererConfigParser rendererConfigParser) Default constructorAFPRenderingContext
(FOUserAgent userAgent, AFPResourceManager resourceManager, AFPPaintingState paintingState, FontInfo fontInfo, Map foreignAttributes) Main constructor. -
Uses of FOUserAgent in org.apache.fop.render.awt
Modifier and TypeMethodDescriptionvoid
AWTRendererMaker.configureRenderer
(FOUserAgent userAgent, Renderer renderer) AWTRendererMaker.makeRenderer
(FOUserAgent ua) ModifierConstructorDescriptionAWTRenderer
(FOUserAgent userAgent) Creates a new AWTRenderer instance.AWTRenderer
(FOUserAgent userAgent, Renderable renderable, boolean previewAsMainWindow, boolean show) Creates a new AWTRenderer instance. -
Uses of FOUserAgent in org.apache.fop.render.awt.viewer
Modifier and TypeFieldDescriptionprotected FOUserAgent
PreviewDialog.foUserAgent
The FOUserAgent associated with this windowprotected FOUserAgent
PreviewPanel.foUserAgent
The FOUserAgent associated with this panel - often shared with PreviewDialogModifier and TypeMethodDescriptionstatic PreviewDialog
PreviewDialog.createPreviewDialog
(FOUserAgent foUserAgent, Renderable renderable, boolean asMainWindow) Creates and initialize the AWT Viewer main window.void
Renderable.renderTo
(FOUserAgent userAgent, String outputFormat) Renders the pre-setup document.ModifierConstructorDescriptionPreviewDialog
(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. -
Uses of FOUserAgent in org.apache.fop.render.bitmap
Modifier and TypeMethodDescriptionBitmapRendererConfig.BitmapRendererConfigParser.build
(FOUserAgent userAgent, Configuration cfg) PNGRendererConfig.PNGRendererConfigParser.build
(FOUserAgent userAgent, Configuration cfg) TIFFRendererConfig.TIFFRendererConfigParser.build
(FOUserAgent userAgent, 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) PNGRendererMaker.makeRenderer
(FOUserAgent ua) TIFFRendererMaker.makeRenderer
(FOUserAgent userAgent) ModifierConstructorDescriptionBitmapRendererConfigurator
(FOUserAgent userAgent, RendererConfig.RendererConfigParser rendererConfigParser) Default constructorPNGRenderer
(FOUserAgent userAgent) TIFFRenderer
(FOUserAgent userAgent) Creates TIFF renderer.TIFFRendererConfigurator
(FOUserAgent userAgent, RendererConfig.RendererConfigParser rendererConfigParser) Default constructor -
Uses of FOUserAgent in org.apache.fop.render.intermediate
Modifier and TypeMethodDescriptionAbstractIFDocumentHandler.getUserAgent()
Returns the associated user agent.protected FOUserAgent
AbstractIFPainter.getUserAgent()
Returns the user agent.IFContext.getUserAgent()
Returns the associated user agent.Modifier and TypeMethodDescriptionIFRendererConfig.IFRendererConfigParser.build
(FOUserAgent userAgent, Configuration cfg) Builds the object that contains the renderer configuration data.IFParser.getContentHandler
(IFDocumentHandler documentHandler, FOUserAgent userAgent) Creates a new ContentHandler instance that you can send the area tree XML to.void
IFParser.parse
(Source src, IFDocumentHandler documentHandler, FOUserAgent userAgent) Parses an intermediate file and paints it.void
IFContext.setUserAgent
(FOUserAgent ua) Set the user agent.ModifierConstructorDescriptionEventProducingFilter
(IFDocumentHandler ifDocumentHandler, FOUserAgent userAgent) ConstructorIFContext
(FOUserAgent ua) Main constructor.IFRenderer
(FOUserAgent userAgent) Main constructor -
Uses of FOUserAgent in org.apache.fop.render.java2d
Modifier and TypeMethodDescriptionJava2DRendererConfig.Java2DRendererConfigParser.build
(FOUserAgent userAgent, Configuration cfg) Builds the object that contains the renderer configuration data.static FontInfo
Java2DUtil.buildDefaultJava2DBasedFontInfo
(FontInfo fontInfo, FOUserAgent userAgent) Builds a defaultFontInfo
object for use with output formats using the Java2D font setup.ModifierConstructorDescriptionJava2DRenderer
(FOUserAgent userAgent) Default constructorJava2DRendererConfigurator
(FOUserAgent userAgent, RendererConfig.RendererConfigParser rendererConfigParser) Default constructorJava2DRenderingContext
(FOUserAgent userAgent, Graphics2D g2d, FontInfo fontInfo) Main constructor. -
Uses of FOUserAgent in org.apache.fop.render.pcl
Modifier and TypeMethodDescriptionPCLRendererConfig.PCLRendererConfigParser.build
(FOUserAgent userAgent, Configuration cfg) Builds the object that contains the renderer configuration data.ModifierConstructorDescriptionPCLRendererConfigurator
(FOUserAgent userAgent, RendererConfig.RendererConfigParser rendererConfigParser) Default constructorPCLRenderingContext
(FOUserAgent userAgent, PCLGenerator generator, PCLRenderingUtil pclUtil) Main constructor. -
Uses of FOUserAgent in org.apache.fop.render.pdf
Modifier and TypeMethodDescriptionPDFRendererConfig.PDFRendererConfigParser.build
(FOUserAgent userAgent, Configuration cfg) ModifierConstructorDescriptionPDFRendererConfigurator
(FOUserAgent userAgent, RendererConfig.RendererConfigParser rendererConfigParser) Default constructorPDFRenderingContext
(FOUserAgent userAgent, PDFContentGenerator generator, PDFPage page, FontInfo fontInfo) Main constructor. -
Uses of FOUserAgent in org.apache.fop.render.print
Modifier and TypeMethodDescriptionvoid
PrintRendererMaker.configureRenderer
(FOUserAgent userAgent, Renderer renderer) PrintRendererMaker.makeRenderer
(FOUserAgent userAgent) ModifierConstructorDescriptionPageableRenderer
(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. -
Uses of FOUserAgent in org.apache.fop.render.ps
Modifier and TypeMethodDescriptionPSRendererConfig.PSRendererConfigParser.build
(FOUserAgent userAgent, Configuration cfg) ModifierConstructorDescriptionPSRendererConfigurator
(FOUserAgent userAgent, RendererConfig.RendererConfigParser rendererConfigParser) Default constructorPSRenderingContext
(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, Map formResources) Main constructor. -
Uses of FOUserAgent in org.apache.fop.render.rtf
Modifier and TypeMethodDescriptionRTFFOEventHandlerMaker.makeFOEventHandler
(FOUserAgent ua, OutputStream out) Instantiates a new FOEventHandler.ModifierConstructorDescriptionRTFHandler
(FOUserAgent userAgent, OutputStream os) Creates a new RTF structure handler. -
Uses of FOUserAgent in org.apache.fop.render.txt
Modifier and TypeMethodDescriptionTxtRendererConfig.TxtRendererConfigParser.build
(FOUserAgent userAgent, Configuration cfg) Builds the object that contains the renderer configuration data.void
TXTRendererMaker.configureRenderer
(FOUserAgent userAgent, Renderer renderer) TXTRendererMaker.makeRenderer
(FOUserAgent userAgent) ModifierConstructorDescriptionTXTRenderer
(FOUserAgent userAgent) Constructs a newly allocatedTXTRenderer
object.TXTRendererConfigurator
(FOUserAgent userAgent, RendererConfig.RendererConfigParser rendererConfigParser) Default constructor -
Uses of FOUserAgent in org.apache.fop.render.xml
Modifier and TypeMethodDescriptionvoid
XMLRendererMaker.configureRenderer
(FOUserAgent userAgent, Renderer renderer) XMLRendererMaker.makeRenderer
(FOUserAgent userAgent) ModifierConstructorDescriptionAbstractXMLRenderer
(FOUserAgent userAgent) XMLRenderer
(FOUserAgent userAgent) -
Uses of FOUserAgent in org.apache.fop.servlet
-
Uses of FOUserAgent in org.apache.fop.svg
ModifierConstructorDescriptionSVGUserAgent
(FOUserAgent foUserAgent, org.apache.batik.bridge.FontFamilyResolver fontFamilyResolver) Creates a new SVGUserAgent.SVGUserAgent
(FOUserAgent foUserAgent, org.apache.batik.bridge.FontFamilyResolver fontFamilyResolver, AffineTransform at) Creates a new SVGUserAgent. -
Uses of FOUserAgent in org.apache.fop.traits
Modifier and TypeMethodDescriptionstatic BorderProps
BorderProps.valueOf
(FOUserAgent foUserAgent, String s) Returns a BorderProps represtation of a string of the format as written by BorderProps.toString(). -
Uses of FOUserAgent in org.apache.fop.util
Modifier and TypeMethodDescriptionstatic Color
ColorUtil.parseColorString
(FOUserAgent foUserAgent, String value) Creates a color from a given string.