Uses of Class org.apache.fop.render.RendererContext (Apache FOP Core 2.11 API)
Date: 2025-04-24

## Uses of Class
org.apache.fop.render.RendererContext

- Packages that use RendererContext
  Package | Description
  --- | ---
  org.apache.fop.render | Generic renderer interface.
  org.apache.fop.render.afp | An AFP Renderer implementation and supporting classes.
  org.apache.fop.render.java2d | Java2D Renderer which paints rendered pages on Graphics2D instances.
  org.apache.fop.render.pcl | PCL Renderer (Supports PCL5 and HP GL/2)
  org.apache.fop.render.pdf | PDF Renderer
  org.apache.fop.render.ps | PostScript Renderer
  org.apache.fop.render.xml | Area Tree XML Renderer.

- - ### Uses of RendererContext in org.apache.fop.render

    Fields in org.apache.fop.render declared as RendererContext
    Modifier and Type | Field and Description
    --- | ---
    `protected RendererContext` | RendererContext.RendererContextWrapper.`context` The wrapped RendererContext

    Methods in org.apache.fop.render that return RendererContext
    Modifier and Type | Method and Description
    --- | ---
    `protected RendererContext` | PrintRenderer.`createRendererContext(int x, int y, int width, int height, Map foreignAttributes)` Creates a RendererContext for an image.
    `protected RendererContext` | PrintRenderer.`instantiateRendererContext()` Instantiates a RendererContext for an image

    Methods in org.apache.fop.render with parameters of type RendererContext
    Modifier and Type | Method and Description
    --- | ---
    `void` | XMLHandlerConfigurator.`configure(RendererContext context, String ns)` Configures renderer context by setting the handler configuration on it.
    `void` | XMLHandler.`handleXML(RendererContext context, Document doc, String ns)` Handle an external xml document inside a Foreign Object Area.
    `void` | AbstractGenericSVGHandler.`handleXML(RendererContext context, Document doc, String ns)` Handle an external xml document inside a Foreign Object Area.
    `void` | Graphics2DAdapter.`paintImage(org.apache.xmlgraphics.java2d.Graphics2DImagePainter painter, RendererContext context, int x, int y, int width, int height)` Paints an arbitrary images on a given Graphics2D instance.
    `void` | Graphics2DAdapter.`paintImage(Graphics2DImagePainter painter, RendererContext context, int x, int y, int width, int height)` Deprecated. Use the variant with the Graphics2DImagePainter from XML Graphics Commons instead
    `void` | AbstractGraphics2DAdapter.`paintImage(Graphics2DImagePainter painter, RendererContext context, int x, int y, int width, int height)` Deprecated.
    `void` | ImageAdapter.`paintImage(RenderedImage image, RendererContext context, int x, int y, int width, int height)` Paints an image at the given position.
    `protected void` | AbstractGenericSVGHandler.`renderSVGDocument(RendererContext rendererContext, Document doc)` Render the SVG document.
    `void` | AbstractRenderer.`renderXML(RendererContext ctx, Document doc, String namespace)` Render the xml document with the given xml namespace.
    `protected void` | AbstractGenericSVGHandler.`updateRendererContext(RendererContext context)` Override this method to update the renderer context if it needs special settings for certain conditions.
    `static RendererContext.RendererContextWrapper` | RendererContext.`wrapRendererContext(RendererContext context)` Wrap the render context to allow easier access to its values.

    Constructors in org.apache.fop.render with parameters of type RendererContext
    Constructor and Description
    `RendererContextWrapper(RendererContext context)` Main constructor

  - ### Uses of RendererContext in org.apache.fop.render.afp

    Subclasses of RendererContext in org.apache.fop.render.afp
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AFPRendererContext` AFP-specific renderer context class.

    Fields in org.apache.fop.render.afp declared as RendererContext
    Modifier and Type | Field and Description
    --- | ---
    `protected RendererContext` | AFPRendererImageInfo.`rendererContext` the renderer context

    Methods in org.apache.fop.render.afp that return RendererContext
    Modifier and Type | Method and Description
    --- | ---
    `RendererContext` | AFPRendererImageInfo.`getRendererContext()` Returns the renderer context

    Methods in org.apache.fop.render.afp with parameters of type RendererContext
    Modifier and Type | Method and Description
    --- | ---
    `void` | AFPSVGHandler.`handleXML(RendererContext context, Document doc, String ns)` Handle an external xml document inside a Foreign Object Area.
    `void` | AFPGraphics2DAdapter.`paintImage(org.apache.xmlgraphics.java2d.Graphics2DImagePainter painter, RendererContext rendererContext, int x, int y, int width, int height)` Paints an arbitrary images on a given Graphics2D instance.
    `protected void` | AFPSVGHandler.`renderSVGDocument(RendererContext rendererContext, Document doc)` Render the SVG document.
    `void` | AFPRendererImageInfo.`setRendererContext(RendererContext rendererContext)` Sets the renderer context
    `protected void` | AFPSVGHandler.`updateRendererContext(RendererContext context)` Override this method to update the renderer context if it needs special settings for certain conditions.

    Constructors in org.apache.fop.render.afp with parameters of type RendererContext
    Constructor and Description
    `AFPRendererImageInfo(String uri, Rectangle2D pos, Point origin, org.apache.xmlgraphics.image.loader.ImageInfo info, org.apache.xmlgraphics.image.loader.Image img, RendererContext rendererContext, Map foreignAttributes)` Main constructor

  - ### Uses of RendererContext in org.apache.fop.render.java2d

    Methods in org.apache.fop.render.java2d that return RendererContext
    Modifier and Type | Method and Description
    --- | ---
    `protected RendererContext` | Java2DRenderer.`createRendererContext(int x, int y, int width, int height, Map foreignAttributes)` Creates a RendererContext for an image.

    Methods in org.apache.fop.render.java2d with parameters of type RendererContext
    Modifier and Type | Method and Description
    --- | ---
    `static Java2DSVGHandler.Java2DInfo` | Java2DSVGHandler.`getJava2DInfo(RendererContext context)` Get the pdf information from the render context.
    `void` | Java2DGraphics2DAdapter.`paintImage(org.apache.xmlgraphics.java2d.Graphics2DImagePainter painter, RendererContext context, int x, int y, int width, int height)` Paints an arbitrary images on a given Graphics2D instance.
    `protected void` | Java2DSVGHandler.`renderSVGDocument(RendererContext context, Document doc)` Render the SVG document.

  - ### Uses of RendererContext in org.apache.fop.render.pcl

    Methods in org.apache.fop.render.pcl with parameters of type RendererContext
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | PCLSVGHandler.`updateRendererContext(RendererContext context)` Override this method to update the renderer context if it needs special settings for certain conditions.
    `static PCLRendererContext` | PCLRendererContext.`wrapRendererContext(RendererContext context)` Wrap the render context to allow easier access to its values.

    Constructors in org.apache.fop.render.pcl with parameters of type RendererContext
    Constructor and Description
    `PCLRendererContext(RendererContext context)` Main constructor

  - ### Uses of RendererContext in org.apache.fop.render.pdf

    Methods in org.apache.fop.render.pdf with parameters of type RendererContext
    Modifier and Type | Method and Description
    --- | ---
    `static PDFSVGHandler.PDFInfo` | PDFSVGHandler.`getPDFInfo(RendererContext context)` Get the pdf information from the render context.

  - ### Uses of RendererContext in org.apache.fop.render.ps

    Methods in org.apache.fop.render.ps with parameters of type RendererContext
    Modifier and Type | Method and Description
    --- | ---
    `static PSSVGHandler.PSInfo` | PSSVGHandler.`getPSInfo(RendererContext context)` Get the pdf information from the render context.
    `void` | PSGraphics2DAdapter.`paintImage(org.apache.xmlgraphics.java2d.Graphics2DImagePainter painter, RendererContext context, int x, int y, int width, int height)` Paints an arbitrary images on a given Graphics2D instance.
    `protected void` | PSSVGHandler.`renderSVGDocument(RendererContext context, Document doc)` Render the svg document.

  - ### Uses of RendererContext in org.apache.fop.render.xml

    Fields in org.apache.fop.render.xml declared as RendererContext
    Modifier and Type | Field and Description
    --- | ---
    `protected RendererContext` | AbstractXMLRenderer.`context` The renderer context.

    Methods in org.apache.fop.render.xml with parameters of type RendererContext
    Modifier and Type | Method and Description
    --- | ---
    `void` | XMLXMLHandler.`handleXML(RendererContext context, Document doc, String ns)` Handle an external xml document inside a Foreign Object Area.

Copyright © 2025 Apache Software Foundation. All rights reserved.