[JAVA] Use of Japanese fonts and external characters in JasperReport

I will introduce how to use Japanese fonts and external characters in PDF output with JasperReports.

Prerequisites

• JasperReport 6.x.x

Thing you want to do

• Depending on the environment in which the PDF is opened, if the font used changes, problems such as layout collapse and display in different glyphs will occur, so I want to embed the font in the PDF.
• The font used this time is IPA font
• ipaexg.ttf (IPAex Gothic)
• ipaexm.ttf (IPAex Mincho)
• However, the size of the PDF file with embedded fonts will be larger than the one without it.
• I want to output external characters to PDF
• Embed external characters in PDF so that they can be displayed on terminals and printers that do not have external characters installed.

Preparation

Create a Maven project and add jasperreports to dependency.

<dependency>
    <groupId>net.sf.jasperreports</groupId>
    <artifactId>jasperreports</artifactId>
    <version>6.10.0</version>
</dependency>

Use of Japanese fonts

Place the font to use in the classpath

Place the font file (* .ttf) in the project's src / main / resources / fonts. This will include the font files in the jar (or war) so you don't have to install the font files on the actual running server.

Create fontFamily definition xml

Create src / main / resources / fonts / fontsfamily-ipa.xml and write the following definition. For the font file path, enter the path from the classpath.

<?xml version="1.0" encoding="UTF-8"?>
<fontFamilies>
  <fontFamily name="IPAex Gothic">
    <normal><![CDATA[fonts/ipaexg.ttf]]></normal>
    <pdfEncoding><![CDATA[Identity-H]]></pdfEncoding>
    <pdfEmbedded><![CDATA[true]]></pdfEmbedded>
  </fontFamily>
  <fontFamily name="IPAex Mincho">
    <normal><![CDATA[fonts/ipaexm.ttf]]></normal>
    <pdfEncoding><![CDATA[Identity-H]]></pdfEncoding>
    <pdfEmbedded><![CDATA[true]]></pdfEmbedded>
  </fontFamily>
</fontFamilies>

• Identity-H in<pdfEncoding>indicates horizontal writing. Vertical writing is ʻIdentity-V`.
• By setting true to<pdf Embedded>, fonts can be embedded in PDF.

Set to read fontFamily definition xml

Create the JasperReports extension definition file src / main / resources / jasperreports_extension.properties` and describe the following definitions. The path and name of this file are fixed (JasperReports specification).

net.sf.jasperreports.extension.registry.factory.fonts=net.sf.jasperreports.engine.fonts.SimpleFontExtensionsRegistryFactory
net.sf.jasperreports.extension.simple.font.families.ipafonts=fonts/fontsfamily-ipa.xml

Specify the font in the layout definition file

fontFamily definition Specify the font name (fontFamily name) defined in xml in Text Field or Static Text.

Use of external characters

Place the external character font in the classpath

Place the external character font file in the project's src / main / resources / fonts in the same way as the IPA font. Gaiji font files are usually named ʻEUDC.tte, but rename them to .ttf` so that JasperReports will recognize them.

• There is also a file called ʻEUDC.euf`, but this is the file used by the private character editor for editing, so it is not necessary to put it in the classpath.

Added external characters to fontFamily definition xml

Add fontFamily indicating external characters to the fontFamily definition xml defined earlier

<?xml version="1.0" encoding="UTF-8"?>
<fontFamilies>
  ...
  <fontFamily name="_EUDC">
    <normal><![CDATA[fonts/EUDC.ttf]]></normal>
    <pdfEncoding><![CDATA[Identity-H]]></pdfEncoding>
    <pdfEmbedded><![CDATA[true]]></pdfEmbedded>
  </fontFamily>
</fontFamilies>

Make it possible to use with IPA font

As it is, only the font for external characters is defined, but in reality, external characters appear in normal sentences. Therefore, it is necessary to define so that other fonts can be used at the same time. Here, when ʻIPAex Gothic or ʻIPAex Mincho is specified for the font, fontSet is defined in the fontFamily definition xml so that external characters are also displayed, and the original fontFamily name is used. change.

<?xml version="1.0" encoding="UTF-8"?>
<fontFamilies>
  <fontFamily name="_IPAex Gothic"> <!--to name_Add-->
    <normal><![CDATA[fonts/ipaexg.ttf]]></normal>
    <pdfEncoding><![CDATA[Identity-H]]></pdfEncoding>
    <pdfEmbedded><![CDATA[true]]></pdfEmbedded>
  </fontFamily>
  <fontFamily name="_IPAex Mincho">
    <normal><![CDATA[fonts/ipaexm.ttf]]></normal>
    <pdfEncoding><![CDATA[Identity-H]]></pdfEncoding>
    <pdfEmbedded><![CDATA[true]]></pdfEmbedded>
  </fontFamily>
  <fontFamily name="_EUDC">
    <normal><![CDATA[fonts/EUDC.ttf]]></normal>
    <pdfEncoding><![CDATA[Identity-H]]></pdfEncoding>
    <pdfEmbedded><![CDATA[true]]></pdfEmbedded>
  </fontFamily>

  <fontSet name="IPAex Gothic">
    <family familyName="_IPAex Gothic" primary="true" />
    <family familyName="_EUDC" />
  </fontSet>
  <fontSet name="IPAex Mincho">
    <family familyName="_IPAex Mincho" primary="true" />
    <family familyName="_EUDC" />
  </fontSet>
</fontFamilies>

Characters that cannot be displayed in the IPA font will now use the Gaiji font.