Uses of Interface org.apache.fop.render.Renderer (Apache FOP 2.7 API)
Date: 2022-01-12

## Uses of Interface
org.apache.fop.render.Renderer

- Packages that use Renderer
  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.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.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.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.txt | Plain Text Renderer
  org.apache.fop.render.xml | Area Tree XML Renderer.

- - ### Uses of Renderer in org.apache.fop.apps

    Methods in org.apache.fop.apps that return Renderer
    Modifier and Type | Method and Description
    --- | ---
    `Renderer` | FOUserAgent.`getRendererOverride()` Returns the overriding Renderer instance, if any.

    Methods in org.apache.fop.apps with parameters of type Renderer
    Modifier and Type | Method and Description
    --- | ---
    `void` | FOUserAgent.`setRendererOverride(Renderer renderer)` Sets an explicit renderer to use which overrides the one defined by the render type setting.

  - ### Uses of Renderer in org.apache.fop.area

    Fields in org.apache.fop.area declared as Renderer
    Modifier and Type | Field and Description
    --- | ---
    `protected Renderer` | RenderPagesModel.`renderer` The renderer that will render the pages.

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

    Classes in org.apache.fop.render that implement Renderer
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractPathOrientedRenderer` Abstract base class for renderers like PDF and PostScript where many painting operations follow similar patterns which makes it possible to share some code.
    `class` | `AbstractRenderer` Abstract base class for all renderers.
    `class` | `PrintRenderer` Abstract base class of "Print" type renderers.

    Methods in org.apache.fop.render that return Renderer
    Modifier and Type | Method and Description
    --- | ---
    `Renderer` | RendererFactory.`createRenderer(FOUserAgent userAgent, java.lang.String outputFormat)` Creates a Renderer object based on render-type desired
    `abstract Renderer` | AbstractRendererMaker.`makeRenderer(FOUserAgent userAgent)` Instantiates a new renderer.

    Methods in org.apache.fop.render with parameters of type Renderer
    Modifier and Type | Method and Description
    --- | ---
    `void` | PrintRendererConfigurator.`configure(Renderer renderer)` Builds a list of EmbedFontInfo objects for use with the setup() method.
    `abstract void` | AbstractRendererMaker.`configureRenderer(FOUserAgent userAgent, Renderer renderer)` Configures a given renderer using the appropriate configurator.
    `protected RendererConfig` | PrintRendererConfigurator.`getRendererConfig(Renderer renderer)` gets the renderer configuration data for a specific renderer.
    `XMLHandler` | XMLHandlerRegistry.`getXMLHandler(Renderer renderer, java.lang.String ns)` Returns an XMLHandler which handles an XML dialect of the given namespace and for a specified output format defined by its MIME type.
    `boolean` | XMLHandler.`supportsRenderer(Renderer renderer)` Checks if this XMLHandler supports handling an XML namespace for a particular renderer.

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

    Methods in org.apache.fop.render.afp with parameters of type Renderer
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | AFPSVGHandler.`supportsRenderer(Renderer renderer)` Checks if this XMLHandler supports handling an XML namespace for a particular renderer.

  - ### Uses of Renderer in org.apache.fop.render.awt

    Classes in org.apache.fop.render.awt that implement Renderer
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AWTRenderer` The AWTRender outputs the pages generated by the layout engine to a Swing window.

    Methods in org.apache.fop.render.awt that return Renderer
    Modifier and Type | Method and Description
    --- | ---
    `Renderer` | AWTRendererMaker.`makeRenderer(FOUserAgent ua)`

    Methods in org.apache.fop.render.awt with parameters of type Renderer
    Modifier and Type | Method and Description
    --- | ---
    `void` | AWTRendererMaker.`configureRenderer(FOUserAgent userAgent, Renderer renderer)`

  - ### Uses of Renderer in org.apache.fop.render.bitmap

    Classes in org.apache.fop.render.bitmap that implement Renderer
    Modifier and Type | Class and Description
    --- | ---
    `class` | `PNGRenderer` PNG Renderer This class actually does not render itself, instead it extends `org.apache.fop.render.java2D.Java2DRenderer` and just encode rendering results into PNG format using Batik's image codec
    `class` | `TIFFRenderer` This class represents renderer to TIFF (Tagged Image File Format) format.

    Methods in org.apache.fop.render.bitmap that return Renderer
    Modifier and Type | Method and Description
    --- | ---
    `Renderer` | TIFFRendererMaker.`makeRenderer(FOUserAgent userAgent)`
    `Renderer` | PNGRendererMaker.`makeRenderer(FOUserAgent ua)`

    Methods in org.apache.fop.render.bitmap with parameters of type Renderer
    Modifier and Type | Method and Description
    --- | ---
    `void` | TIFFRendererConfigurator.`configure(Renderer renderer)` Configure the TIFF renderer.
    `void` | TIFFRendererMaker.`configureRenderer(FOUserAgent userAgent, Renderer renderer)`
    `void` | PNGRendererMaker.`configureRenderer(FOUserAgent userAgent, Renderer renderer)`

  - ### Uses of Renderer in org.apache.fop.render.intermediate

    Classes in org.apache.fop.render.intermediate that implement Renderer
    Modifier and Type | Class and Description
    --- | ---
    `class` | `IFRenderer` This renderer implementation is an adapter to the `IFPainter` interface.

    Fields in org.apache.fop.render.intermediate declared as Renderer
    Modifier and Type | Field and Description
    --- | ---
    `protected Renderer` | IFRenderer.`mimic` If not null, the XMLRenderer will mimic another renderer by using its font setup.

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

    Classes in org.apache.fop.render.java2d that implement Renderer
    Modifier and Type | Class and Description
    --- | ---
    `class` | `Java2DRenderer` The `Java2DRenderer` class provides the abstract technical foundation for all rendering with the Java2D API.

    Methods in org.apache.fop.render.java2d with parameters of type Renderer
    Modifier and Type | Method and Description
    --- | ---
    `void` | Java2DRendererConfigurator.`configure(Renderer renderer)` Configure the Java 2D renderer.
    `boolean` | Java2DSVGHandler.`supportsRenderer(Renderer renderer)` Checks if this XMLHandler supports handling an XML namespace for a particular renderer.

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

    Methods in org.apache.fop.render.pcl with parameters of type Renderer
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | PCLSVGHandler.`supportsRenderer(Renderer renderer)` Checks if this XMLHandler supports handling an XML namespace for a particular renderer.

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

    Methods in org.apache.fop.render.pdf with parameters of type Renderer
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | PDFSVGHandler.`supportsRenderer(Renderer renderer)` Checks if this XMLHandler supports handling an XML namespace for a particular renderer.

  - ### Uses of Renderer in org.apache.fop.render.print

    Classes in org.apache.fop.render.print that implement Renderer
    Modifier and Type | Class and Description
    --- | ---
    `class` | `PageableRenderer` Renderer that prints through java.awt.PrintJob.

    Methods in org.apache.fop.render.print that return Renderer
    Modifier and Type | Method and Description
    --- | ---
    `Renderer` | PrintRendererMaker.`makeRenderer(FOUserAgent userAgent)`

    Methods in org.apache.fop.render.print with parameters of type Renderer
    Modifier and Type | Method and Description
    --- | ---
    `void` | PrintRendererMaker.`configureRenderer(FOUserAgent userAgent, Renderer renderer)`

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

    Methods in org.apache.fop.render.ps with parameters of type Renderer
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | PSSVGHandler.`supportsRenderer(Renderer renderer)` Checks if this XMLHandler supports handling an XML namespace for a particular renderer.

  - ### Uses of Renderer in org.apache.fop.render.txt

    Classes in org.apache.fop.render.txt that implement Renderer
    Modifier and Type | Class and Description
    --- | ---
    `class` | `TXTRenderer` Renderer that renders areas to plain text.

    Methods in org.apache.fop.render.txt that return Renderer
    Modifier and Type | Method and Description
    --- | ---
    `Renderer` | TXTRendererMaker.`makeRenderer(FOUserAgent userAgent)`

    Methods in org.apache.fop.render.txt with parameters of type Renderer
    Modifier and Type | Method and Description
    --- | ---
    `void` | TXTRendererConfigurator.`configure(Renderer renderer)` Configure the PS renderer.
    `void` | TXTRendererMaker.`configureRenderer(FOUserAgent userAgent, Renderer renderer)`

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

    Classes in org.apache.fop.render.xml that implement Renderer
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractXMLRenderer` Abstract xml renderer base class.
    `class` | `XMLRenderer` Renderer that renders areas to XML for debugging purposes.

    Fields in org.apache.fop.render.xml declared as Renderer
    Modifier and Type | Field and Description
    --- | ---
    `protected Renderer` | XMLRenderer.`mimic` If not null, the XMLRenderer will mimic another renderer by using its font setup.

    Methods in org.apache.fop.render.xml that return Renderer
    Modifier and Type | Method and Description
    --- | ---
    `Renderer` | XMLRendererMaker.`makeRenderer(FOUserAgent userAgent)`

    Methods in org.apache.fop.render.xml with parameters of type Renderer
    Modifier and Type | Method and Description
    --- | ---
    `void` | XMLRendererMaker.`configureRenderer(FOUserAgent userAgent, Renderer renderer)`
    `void` | XMLRenderer.`mimicRenderer(Renderer renderer)` Call this method to make the XMLRenderer mimic a different renderer by using its font setup.
    `boolean` | XMLXMLHandler.`supportsRenderer(Renderer renderer)` Checks if this XMLHandler supports handling an XML namespace for a particular renderer.

Copyright 1999-2022 The Apache Software Foundation. All Rights Reserved.