Docs Home

QuickstartC001CustomFopTypeHandler

version : 001

Maven dependancies :

• org.fugerit.java/fj-core
• org.fugerit.java/fj-doc-base
• org.fugerit.java/fj-doc-freemarker (for both html and pdf fop handlers)
• org.fugerit.java/fj-doc-mod-fop (for pdf fop handler)

QuickstartC001CustomTypeHandler shows how is possible to create a custom doc type handler.

In this case we will create a custom version of PdfFopTypeHandler.

The CustomPdfFopTypeHandler:

• Add the label ‘My Custom DocTypeHandler’ at the start of every generated page.
• Align to left by default header row cell (while in normal PdfFopTypeHandler, header rows are aligned to center).

Here is a summary of how this type handler has been created :

• pacakge ‘org.fugerit.java.doc.mod.fop’ from ‘fj-doc/fj-doc-mod-fop’ project had been copied an renamed to ‘org.fugerit.java.doc.qs.handler.fop’ (in src/main/java)
• template folder ‘fm_fop’ from ‘fj-doc/fj-doc-mod-fop’ project had been copied an renamed to ‘custom_fm_fop’ (in src/main/resources)
• In FreeMarkerFopProcess the ‘CONFIG_PATH = “cl://custom_fm_fop/fop-process-config.xml”;’ constant has been changed to map our custom template path
• In Process Config File the class parameter has been changed to map our new class class=”org.fugerit.java.doc.qs.handler.fop.FreeMarkerFopProcess”
• In Basic Free Marker Template we added the fo block for our first customization ‘My Custom DocTypeHandler’
• In Free Marker Macro For Table we added our second customization ‘<fo:table-${cellType} <#if cellType == ‘header’> font-weight=”bold” text-align=”left”</#if»’

DocTypeHandler customization disadvantages :

• You don’t automatically get fix and improvement on the original DocTypeHandler

DocTypeHandler customization advantages :

• You can add or change features
• You can control in detail rendering