Flying Saucer PDF Engine

This document provides information about the new PDF engine, Flying Saucer (FS) in Lucee 5.3

Flying saucer is a new PDF engine in Lucee. PDF engines are mainly used to convert HTML to PDF format.

Benefits of moving to Flying Saucer from the old engine (PD4ML)

  • Full support for CSS 2.1
  • On average the generated PDFs are smaller
  • Consume less Memory and CPU
  • Engine in active development,
  • Better Results

Downsides to Flying Saucer compared to the old engine (PD4ML)

  • The generated PDF does not always look exactly the same when generated with the new FC compared to files generated with the PD4ML.

If it's important that the PDF output remains exactly the same as the old PD4ML-generated file, you will need to check it manually.

If you don't have time to check all PDF outputs, or you really don't care about the fancy new engine, simply add the following code to use the old PDF engine.

via Application.cfc,

luceescript this.pdf.type = "classic";

or if you are using an Application.cfm,

lucee <cfapplication pdf="#{type:'classic'}#">

Alas, this syntax isn't currently implemented

Features of Flying Saucer

You can define a font directory where you have the fonts(.ttf,.otf) you are using in your PDF.

Define the font directory

<cfdocument fontDirectory = "path/to/my/font">

Define the font directory Application itself:

via Application.cfc

luceescript this.pdf.fontDirectory = "path/to/my/font";

or via application.cfm

<cfapplication pdf="#{fontDirectory :'path/to/my/font'}#"> 

If the font directory isn't specified, Lucee will look for fonts in /WEB_INF/lucee/fonts and uses them if they match.

Simplify Attributes

Attributes with cfdocument are a mess. You can make it clearer using the following syntax:

Example:

<cfdocument marginTop="5" marginBottom="5" marginLeft="5" marginRight="5" pageWidth="5" pageHeight="5" pageType="A4"> 

In Lucee you can do the following:

<cfdocument margin="#{top:5,bottom:5,left:5,right:5}#" page="#{width:5,height:5,type:'A4'}#">

Or even simpler

<cfdocument margin="5" page="#{width:5,height:5,type:'A4'}#">

Additional Units

In addition to "inch" and "cm", the attribute unit now supports "pixel" and "points".

<cfdocument unit="in|cm|px|pt"> 

If you find any issues while using the new PDF engine, please ask a question on the mailing list

Footnotes

You can see the details in this video: Flying saucer

See also