Apache FOP

XSL-FO -> PDF formatter. Can be used as standalone utility.

Embedding FOP in Java

https://xmlgraphics.apache.org/fop/2.2/embedding.html

See "Basic Usage Pattern"

1. Construct FopFactory from configuration
2. Setup output stream
3. Construct Fop object with output format
4. Setup JAXP using identical transformer (if no XSLT desired)
5. Setup input / output for XSLT transformation
6. Run

fop.getDefaultHandler() is the key, its a SAX event handler to receive parsed XSL-FO events

Configuration

https://xmlgraphics.apache.org/fop/2.2/configuration.html

Can use either a configuration file or programmatically.

Configuration programmatically

Two Levels to customise FOP: FopFactory (reuse) and user agent

FopFactory:

FopFactoryBuilder builder = new FopFactoryBuilder(baseURI);

// or

// myResourceResolver is a org.apache.xmlgraphics.io.ResourceResolver

FopFactoryBuilder builder = new FopFactoryBuilder(baseURI, myResourceResolver);

• BaseURI
  • provide BaseURI
  • provide BaseURI and a JAXP URI Resolver
• setStrictFOValidation - enable/disable strict validation
• setBreakIndentInheritanceOnReferenceAreaBoundary - make indent behaviour per specification or per alternative behaviour like many commercial implementations
• setSourceResolution - (default 72) the dpi for images / bitmap without resolution information
• addElementMapping - supply a special FOP extension that to give to the FOUserAgent. Normally extensions are automatically detected.

User agent:

FopFactory fopFactory = FopFactory.newInstance(new File(".").toURI()); // Reuse the FopFactory if possible!

// do the following for each new rendering run

FOUserAgent userAgent = fopFactory.newFOUserAgent();

// customize userAgent

Fop fop = fopFactory.newFop(MimeConstants.MIME_POSTSCRIPT, userAgent, out);

User agent allows interaction with a single rendering run (processing a single document).

• set meta information
  • setProducer
  • ... (see document)
• setTargetResolution - specify the output resolution for bitmap images generated by bitmap renderers and bitmaps generated by Apache Batik etc, default 72 dpi
• setDocumentHandlerOverride - advanced: