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

## Uses of Class
org.apache.fop.fo.FOEventHandler

- Packages that use FOEventHandler
  Package | Description
  --- | ---
  org.apache.fop.accessibility.fo |
  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.fo | Classes, constants and basic infrastructure for the FO tree.
  org.apache.fop.fo.pagination | All the pagination and declaration formatting objects.
  org.apache.fop.render | Generic renderer interface.
  org.apache.fop.render.rtf | RTF (Rich Text Format) Output Support

- - ### Uses of FOEventHandler in org.apache.fop.accessibility.fo

    Subclasses of FOEventHandler in org.apache.fop.accessibility.fo
    Modifier and Type | Class and Description
    --- | ---
    `class` | `FO2StructureTreeConverter` Allows to create the structure tree of an FO document, by converting FO events into appropriate structure tree events.

    Fields in org.apache.fop.accessibility.fo declared as FOEventHandler
    Modifier and Type | Field and Description
    --- | ---
    `protected FOEventHandler` | FO2StructureTreeConverter.`converter` The top of the `converters` stack.

    Constructors in org.apache.fop.accessibility.fo with parameters of type FOEventHandler
    Constructor and Description
    `FO2StructureTreeConverter(StructureTreeEventHandler structureTreeEventHandler, FOEventHandler delegate)` Creates a new instance.

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

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

    Methods in org.apache.fop.apps with parameters of type FOEventHandler
    Modifier and Type | Method and Description
    --- | ---
    `void` | FOUserAgent.`setFOEventHandlerOverride(FOEventHandler handler)` Sets an explicit FOEventHandler instance which overrides the one defined by the render type setting.

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

    Subclasses of FOEventHandler in org.apache.fop.area
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AreaTreeHandler` Area tree handler for formatting objects.

  - ### Uses of FOEventHandler in org.apache.fop.fo

    Subclasses of FOEventHandler in org.apache.fop.fo
    Modifier and Type | Class and Description
    --- | ---
    `class` | `DelegatingFOEventHandler` This class delegates all FO events to another FOEventHandler instance.

    Methods in org.apache.fop.fo that return FOEventHandler
    Modifier and Type | Method and Description
    --- | ---
    `FOEventHandler` | FOTreeBuilder.`getEventHandler()` Provides access to the underlying `FOEventHandler` object.
    `FOEventHandler` | FONode.`getFOEventHandler()` Recursively goes up the FOTree hierarchy until the `fo:root` is found, which returns the parent `FOEventHandler`.

    Methods in org.apache.fop.fo with parameters of type FOEventHandler
    Modifier and Type | Method and Description
    --- | ---
    `protected PropertyList` | FObj.`createPropertyList(PropertyList parent, FOEventHandler foEventHandler)` Create a default property list for this element.
    `protected PropertyList` | FONode.`createPropertyList(PropertyList pList, FOEventHandler foEventHandler)` Create a property list for this node.

    Constructors in org.apache.fop.fo with parameters of type FOEventHandler
    Constructor and Description
    `DelegatingFOEventHandler(FOEventHandler delegate)` Creates a new instance that delegates events to the given object.

  - ### Uses of FOEventHandler in org.apache.fop.fo.pagination

    Methods in org.apache.fop.fo.pagination that return FOEventHandler
    Modifier and Type | Method and Description
    --- | ---
    `FOEventHandler` | Root.`getFOEventHandler()` This method overrides the FONode version.

    Methods in org.apache.fop.fo.pagination with parameters of type FOEventHandler
    Modifier and Type | Method and Description
    --- | ---
    `void` | Root.`setFOEventHandler(FOEventHandler foEventHandler)` Sets the FOEventHandler object that this Root is attached to

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

    Methods in org.apache.fop.render that return FOEventHandler
    Modifier and Type | Method and Description
    --- | ---
    `FOEventHandler` | RendererFactory.`createFOEventHandler(FOUserAgent userAgent, String outputFormat, OutputStream out)` Creates FOEventHandler instances based on the desired output.
    `abstract FOEventHandler` | AbstractFOEventHandlerMaker.`makeFOEventHandler(FOUserAgent ua, OutputStream out)` Instantiates a new FOEventHandler.

  - ### Uses of FOEventHandler in org.apache.fop.render.rtf

    Subclasses of FOEventHandler in org.apache.fop.render.rtf
    Modifier and Type | Class and Description
    --- | ---
    `class` | `RTFHandler` RTF Handler: generates RTF output using the structure events from the FO Tree sent to this structure handler.

    Methods in org.apache.fop.render.rtf that return FOEventHandler
    Modifier and Type | Method and Description
    --- | ---
    `FOEventHandler` | RTFFOEventHandlerMaker.`makeFOEventHandler(FOUserAgent ua, OutputStream out)` Instantiates a new FOEventHandler.

Copyright © 2025 Apache Software Foundation. All rights reserved.