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

## Uses of Interface
org.apache.fop.render.intermediate.IFDocumentHandler

- Packages that use IFDocumentHandler
  Package | Description
  --- | ---
  org.apache.fop.apps | Application classes used for running FOP embedded in other applications.
  org.apache.fop.render | Generic renderer interface.
  org.apache.fop.render.afp | An AFP Renderer implementation and supporting classes.
  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.intermediate.util |
  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

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

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

    Methods in org.apache.fop.apps with parameters of type IFDocumentHandler
    Modifier and Type | Method and Description
    --- | ---
    `void` | FOUserAgent.`setDocumentHandlerOverride(IFDocumentHandler documentHandler)` Sets an explicit document handler to use which overrides the one that would be selected by default.

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

    Methods in org.apache.fop.render that return IFDocumentHandler
    Modifier and Type | Method and Description
    --- | ---
    `IFDocumentHandler` | RendererFactory.`createDocumentHandler(FOUserAgent userAgent, java.lang.String outputFormat)` Creates a `IFDocumentHandler` object based on the desired output format.

    Methods in org.apache.fop.render with parameters of type IFDocumentHandler
    Modifier and Type | Method and Description
    --- | ---
    `void` | PrintRendererConfigurator.`configure(IFDocumentHandler documentHandler)` Configures a intermediate format document handler.
    `protected RendererConfig` | PrintRendererConfigurator.`getRendererConfig(IFDocumentHandler documentHandler)` Returns the renderer configuration data for a specific renderer.

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

    Classes in org.apache.fop.render.afp that implement IFDocumentHandler
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AFPDocumentHandler` `IFDocumentHandler` implementation that produces AFP (MO:DCA).

    Methods in org.apache.fop.render.afp that return IFDocumentHandler
    Modifier and Type | Method and Description
    --- | ---
    `IFDocumentHandler` | AFPDocumentHandlerMaker.`makeIFDocumentHandler(IFContext ifContext)` Instantiates a new `IFDocumentHandler`.

    Methods in org.apache.fop.render.afp with parameters of type IFDocumentHandler
    Modifier and Type | Method and Description
    --- | ---
    `void` | AFPRendererConfigurator.`configure(IFDocumentHandler documentHandler)`

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

    Classes in org.apache.fop.render.bitmap that implement IFDocumentHandler
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractBitmapDocumentHandler` Abstract `IFDocumentHandler` implementation for producing bitmap images.
    `class` | `PNGDocumentHandler` `IFDocumentHandler` implementation that produces PNG files.
    `class` | `TIFFDocumentHandler` `IFDocumentHandler` implementation that produces TIFF files.

    Methods in org.apache.fop.render.bitmap that return IFDocumentHandler
    Modifier and Type | Method and Description
    --- | ---
    `IFDocumentHandler` | TIFFDocumentHandlerMaker.`makeIFDocumentHandler(IFContext ifContext)` Instantiates a new `IFDocumentHandler`.
    `IFDocumentHandler` | PNGDocumentHandlerMaker.`makeIFDocumentHandler(IFContext ifContext)` Instantiates a new `IFDocumentHandler`.

    Methods in org.apache.fop.render.bitmap with parameters of type IFDocumentHandler
    Modifier and Type | Method and Description
    --- | ---
    `void` | BitmapRendererConfigurator.`configure(IFDocumentHandler documentHandler)` Configures a intermediate format document handler.
    `void` | TIFFRendererConfigurator.`configure(IFDocumentHandler documentHandler)`

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

    Classes in org.apache.fop.render.intermediate with type parameters of type IFDocumentHandler
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractIFPainter<T extends IFDocumentHandler>` Abstract base class for IFPainter implementations.

    Classes in org.apache.fop.render.intermediate that implement IFDocumentHandler
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractBinaryWritingIFDocumentHandler` Abstract base class for binary-writing `IFDocumentHandler` implementations.
    `class` | `AbstractIFDocumentHandler` Abstract base class for `IFDocumentHandler` implementations.
    `class` | `AbstractXMLWritingIFDocumentHandler` Abstract base class for XML-writing `IFDocumentHandler` implementations.
    `class` | `EventProducingFilter` A filter that uses the Event Notification System to broadcast IF events.
    `class` | `IFSerializer` IFPainter implementation that serializes the intermediate format to XML.

    Methods in org.apache.fop.render.intermediate that return IFDocumentHandler
    Modifier and Type | Method and Description
    --- | ---
    `protected IFDocumentHandler` | IFRenderer.`createDefaultDocumentHandler()` Creates a default `IFDocumentHandler` when none has been set.
    `IFDocumentHandler` | IFSerializer.`getMimickedDocumentHandler()` Returns the document handler that is being mimicked by this serializer.
    `IFDocumentHandler` | IFSerializerMaker.`makeIFDocumentHandler(IFContext ifContext)` Instantiates a new `IFDocumentHandler`.
    `abstract IFDocumentHandler` | AbstractIFDocumentHandlerMaker.`makeIFDocumentHandler(IFContext ifContext)` Instantiates a new `IFDocumentHandler`.

    Methods in org.apache.fop.render.intermediate with parameters of type IFDocumentHandler
    Modifier and Type | Method and Description
    --- | ---
    `void` | IFDocumentHandlerConfigurator.`configure(IFDocumentHandler documentHandler)` Configures a intermediate format document handler.
    `org.xml.sax.ContentHandler` | IFParser.`getContentHandler(IFDocumentHandler documentHandler, FOUserAgent userAgent)` Creates a new ContentHandler instance that you can send the area tree XML to.
    `static java.lang.String` | IFUtil.`getEffectiveMIMEType(IFDocumentHandler documentHandler)` Returns the MIME type of the output format that the given document handler is supposed to handle.
    `void` | IFSerializer.`mimicDocumentHandler(IFDocumentHandler targetHandler)` Tells this serializer to mimic the given document handler (mostly applies to the font set that is used during layout).
    `void` | IFParser.`parse(javax.xml.transform.Source src, IFDocumentHandler documentHandler, FOUserAgent userAgent)` Parses an intermediate file and paints it.
    `void` | IFRenderer.`setDocumentHandler(IFDocumentHandler documentHandler)` Sets the `IFDocumentHandler` to be used by the `IFRenderer`.
    `static void` | IFUtil.`setupFonts(IFDocumentHandler documentHandler)` Sets up the fonts on a document handler.
    `static void` | IFUtil.`setupFonts(IFDocumentHandler documentHandler, FontInfo fontInfo)` Sets up the fonts on a document handler.

    Constructors in org.apache.fop.render.intermediate with parameters of type IFDocumentHandler
    Constructor and Description
    `EventProducingFilter(IFDocumentHandler ifDocumentHandler, FOUserAgent userAgent)` Constructor

  - ### Uses of IFDocumentHandler in org.apache.fop.render.intermediate.util

    Classes in org.apache.fop.render.intermediate.util that implement IFDocumentHandler
    Modifier and Type | Class and Description
    --- | ---
    `class` | `IFDocumentHandlerProxy` This class is a simple proxy that delegates all method calls to another `IFDocumentHandler` instance.

    Fields in org.apache.fop.render.intermediate.util declared as IFDocumentHandler
    Modifier and Type | Field and Description
    --- | ---
    `protected IFDocumentHandler` | IFDocumentHandlerProxy.`delegate` the delegate IFDocumentHandler

    Methods in org.apache.fop.render.intermediate.util that return IFDocumentHandler
    Modifier and Type | Method and Description
    --- | ---
    `protected IFDocumentHandler` | IFConcatenator.`getTargetHandler()` Returns the target document handler.

    Constructors in org.apache.fop.render.intermediate.util with parameters of type IFDocumentHandler
    Constructor and Description
    `IFConcatenator(IFDocumentHandler targetHandler, org.apache.xmlgraphics.xmp.Metadata metadata)` Creates a new IF concatenator.
    `IFDocumentHandlerProxy(IFDocumentHandler delegate)` Creates a new proxy instance.

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

    Classes in org.apache.fop.render.java2d that implement IFDocumentHandler
    Modifier and Type | Class and Description
    --- | ---
    `class` | `Java2DDocumentHandler` `IFDocumentHandler` implementation that produces Graphics2D instance.

    Constructors in org.apache.fop.render.java2d with parameters of type IFDocumentHandler
    Constructor and Description
    `Java2DPainter(java.awt.Graphics2D g2d, IFContext context, FontInfo fontInfo, IFDocumentHandler documentHandler)`
    `Java2DPainter(java.awt.Graphics2D g2d, IFContext context, FontInfo fontInfo, IFState state, IFDocumentHandler documentHandler)`

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

    Classes in org.apache.fop.render.pcl that implement IFDocumentHandler
    Modifier and Type | Class and Description
    --- | ---
    `class` | `PCLDocumentHandler` `IFDocumentHandler` implementation that produces PCL 5.

    Methods in org.apache.fop.render.pcl that return IFDocumentHandler
    Modifier and Type | Method and Description
    --- | ---
    `IFDocumentHandler` | PCLDocumentHandlerMaker.`makeIFDocumentHandler(IFContext ifContext)` Instantiates a new `IFDocumentHandler`.

    Methods in org.apache.fop.render.pcl with parameters of type IFDocumentHandler
    Modifier and Type | Method and Description
    --- | ---
    `void` | PCLRendererConfigurator.`configure(IFDocumentHandler documentHandler)` Configures a intermediate format document handler.

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

    Classes in org.apache.fop.render.pdf that implement IFDocumentHandler
    Modifier and Type | Class and Description
    --- | ---
    `class` | `PDFDocumentHandler` `IFDocumentHandler` implementation that produces PDF.

    Methods in org.apache.fop.render.pdf that return IFDocumentHandler
    Modifier and Type | Method and Description
    --- | ---
    `IFDocumentHandler` | PDFDocumentHandlerMaker.`makeIFDocumentHandler(IFContext ifContext)`

    Methods in org.apache.fop.render.pdf with parameters of type IFDocumentHandler
    Modifier and Type | Method and Description
    --- | ---
    `void` | PDFRendererConfigurator.`configure(IFDocumentHandler documentHandler)` Configures a intermediate format document handler.

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

    Classes in org.apache.fop.render.ps that implement IFDocumentHandler
    Modifier and Type | Class and Description
    --- | ---
    `class` | `PSDocumentHandler` `IFDocumentHandler` implementation that produces PostScript.

    Methods in org.apache.fop.render.ps that return IFDocumentHandler
    Modifier and Type | Method and Description
    --- | ---
    `IFDocumentHandler` | PSDocumentHandlerMaker.`makeIFDocumentHandler(IFContext ifContext)`

    Methods in org.apache.fop.render.ps with parameters of type IFDocumentHandler
    Modifier and Type | Method and Description
    --- | ---
    `void` | PSRendererConfigurator.`configure(IFDocumentHandler documentHandler)`

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