├── screen_shot.png ├── example_of_generated_pdf.pdf ├── src └── test │ ├── resources │ ├── logo.png │ ├── Code39.ttf │ ├── footer.html │ ├── header.html │ ├── letterhead.html │ ├── style.css │ └── template.html │ └── java │ └── FlyingSaucerTest.java ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── .gitignore ├── README.md ├── pom.xml ├── gradlew.bat └── gradlew /screen_shot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tuhrig/Flying_Saucer_PDF_Generation/HEAD/screen_shot.png -------------------------------------------------------------------------------- /example_of_generated_pdf.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tuhrig/Flying_Saucer_PDF_Generation/HEAD/example_of_generated_pdf.pdf -------------------------------------------------------------------------------- /src/test/resources/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tuhrig/Flying_Saucer_PDF_Generation/HEAD/src/test/resources/logo.png -------------------------------------------------------------------------------- /src/test/resources/Code39.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tuhrig/Flying_Saucer_PDF_Generation/HEAD/src/test/resources/Code39.ttf -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tuhrig/Flying_Saucer_PDF_Generation/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | build/ 2 | .gradle/ 3 | 4 | # IntelliJ project files 5 | .idea/ 6 | *.ipr 7 | *.iws 8 | *.iml 9 | 10 | test.pdf 11 | out/ -------------------------------------------------------------------------------- /src/test/resources/footer.html: -------------------------------------------------------------------------------- 1 |
2 |
3 |
4 | Page of 5 |
6 |
-------------------------------------------------------------------------------- /src/test/resources/header.html: -------------------------------------------------------------------------------- 1 |
2 | 3 | 4 | 5 | 6 | 7 |
*TEST BARCODE*
8 |
-------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Tue May 22 09:45:29 AMT 2018 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-3.4.1-all.zip 7 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Flying Saucer PDF Generation 2 | ------------------------------ 3 | 4 | This demo project shows how to generate a nicely styled PDF with Flying Saucer and Thymeleaf templates. 5 | 6 | In order to generate the PDF run the JUnit test: 7 | 8 | src/test/FlyingSaucerTest.java 9 | 10 | The test will generate a PDF called: 11 | 12 | test.pdf 13 | 14 | A copy of the generated PDF is checked-in, in case you want to see what is generated: 15 | 16 | example_of_generated_pdf.pdf 17 | 18 | The project can be build with Gradle (using `build.gradle`) or Maven (using `pom.xml`). 19 | 20 | ![Image of PDF](screen_shot.png "Logo Title Text 1") 21 | -------------------------------------------------------------------------------- /src/test/resources/letterhead.html: -------------------------------------------------------------------------------- 1 |
2 | 3 | 4 | 5 | 13 | 14 | 15 | 20 | 23 | 24 |
6 | Thymeleaf Example Project
7 | Thymeleaf Street 42
8 | 12345 Thymecity
9 |
10 | Phone: 0100 1234 1111
11 | E-Mail: example@test.com
12 |
16 | [[${data.getFirstname()}]] [[${data.getLastname()}]]
17 | [[${data.getStreet()}]]
18 | [[${data.getZipCode()}]] [[${data.getCity()}]]
19 |
21 | Thymecity, 01. January 2018 22 |
25 |
26 |
-------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | de.tuhrig 6 | Flying_Saucer_PDF_Generation 7 | 0.1.0 8 | 9 | 10 | com.fasterxml.jackson.core 11 | jackson-databind 12 | 2.9.10.1 13 | compile 14 | 15 | 16 | org.thymeleaf 17 | thymeleaf 18 | 3.0.6.RELEASE 19 | compile 20 | 21 | 22 | com.github.jknack 23 | handlebars 24 | 4.0.6 25 | compile 26 | 27 | 28 | net.sf.jtidy 29 | jtidy 30 | r938 31 | compile 32 | 33 | 34 | org.xhtmlrenderer 35 | flying-saucer-core 36 | 9.1.6 37 | compile 38 | 39 | 40 | org.xhtmlrenderer 41 | flying-saucer-pdf-itext5 42 | 9.1.6 43 | compile 44 | 45 | 46 | junit 47 | junit 48 | 4.12 49 | test 50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /src/test/resources/style.css: -------------------------------------------------------------------------------- 1 | body { 2 | font-family: sans-serif; 3 | font-size: 12px; 4 | } 5 | 6 | @page { 7 | 8 | @bottom-left { 9 | content: element(footer); 10 | vertical-align: top; 11 | padding-top: 10px; 12 | } 13 | 14 | @top-right { 15 | content: element(header); 16 | vertical-align: bottom; 17 | padding-bottom: 10px; 18 | } 19 | 20 | margin-top: 3.3cm; 21 | margin-left: 2cm; 22 | margin-right: 2cm; 23 | margin-bottom: 3.3cm; 24 | 25 | size: A4 portrait; 26 | } 27 | 28 | div.header { 29 | position: running(header); 30 | } 31 | 32 | div.footer { 33 | display: block; 34 | margin-top: 0.5cm; 35 | position: running(footer); 36 | } 37 | 38 | #pagenumber:before { 39 | content: counter(page); 40 | } 41 | 42 | #pagecount:before { 43 | content: counter(pages); 44 | } 45 | 46 | .logo-container { 47 | text-align: right; 48 | } 49 | 50 | .page-count { 51 | text-align: right; 52 | } 53 | 54 | .logo { 55 | width: 275px; 56 | } 57 | 58 | h1 { 59 | font-size: 18px; 60 | margin-bottom: 40px; 61 | margin-top: 40px; 62 | } 63 | 64 | p { 65 | font-size: 12px; 66 | } 67 | 68 | .footer { 69 | text-align: center; 70 | } 71 | 72 | @font-face { 73 | font-family: "Bar-Code 39"; 74 | src: url(Code39.ttf) format('truetype'); 75 | } 76 | 77 | .barcode { 78 | font-family: "Bar-Code 39"; 79 | font-size: 26px; 80 | } 81 | 82 | .right { 83 | text-align: right; 84 | } 85 | 86 | .left { 87 | text-align: left; 88 | } 89 | 90 | .bottom { 91 | vertical-align: bottom; 92 | } 93 | 94 | .address-block { 95 | height: 100px; 96 | } 97 | 98 | table { 99 | width: 100%; 100 | } 101 | 102 | hr { 103 | background-color: #000000; 104 | border: dashed #000000 0.5px; 105 | height: 1px; 106 | } 107 | 108 | .page-break { 109 | page-break-after: always; 110 | } 111 | 112 | .next-page { 113 | page-break-before: always 114 | } -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /src/test/resources/template.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 |
11 | 12 |
13 | 14 |

YOUR EXAMPLE THYMELEAF PDF

15 | 16 |

Dear [[${data.getFirstname()}]] [[${data.getLastname()}]],

17 | 18 |

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam eu erat quis urna fringilla faucibus. Fusce vitae est 19 | sed sapien laoreet lacinia maximus quis turpis. Aliquam auctor diam a felis sodales gravida.

20 | 21 |

Quisque mauris magna, vulputate eget feugiat ut, molestie posuere urna. Etiam volutpat hendrerit efficitur. 22 | Vestibulum condimentum volutpat arcu porttitor condimentum. Aliquam vestibulum pulvinar enim sit amet fermentum. 23 | Vivamus vulputate, enim id rutrum dictum, enim nibh fermentum mi, vel varius tortor risus at enim. Aliquam 24 | scelerisque mi metus, non imperdiet risus interdum eu. Nullam pretium nulla ante, vitae tincidunt neque suscipit in. 25 | Nam dapibus iaculis nisl, eget dictum lectus dictum vitae. Ut malesuada justo ligula, sed rhoncus nisl gravida eu. 26 | Fusce nulla mi, suscipit at elit ullamcorper, aliquet vehicula odio. Ut molestie ac purus vitae porttitor. Curabitur 27 | eget euismod enim, venenatis posuere eros. Ut vel erat in odio varius eleifend. Quisque aliquam odio turpis, sed 28 | posuere purus ullamcorper eu.

29 | 30 |

Best regards,

31 | 32 |

Thymeleaf Example Project

33 | 34 |

You find more information on the second page.

35 | 36 | 37 | 38 |
39 | 40 |

More Information

41 | 42 |

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et 43 | dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet 44 | clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, 45 | consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed 46 | diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea 47 | takimata sanctus est Lorem ipsum dolor sit amet.

48 |

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et 49 | dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet 50 | clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, 51 | consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed 52 | diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea 53 | takimata sanctus est Lorem ipsum dolor sit amet.

54 |

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et 55 | dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet 56 | clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, 57 | consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed 58 | diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea 59 | takimata sanctus est Lorem ipsum dolor sit amet.

60 |

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et 61 | dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet 62 | clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, 63 | consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed 64 | diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea 65 | takimata sanctus est Lorem ipsum dolor sit amet.

66 |
67 | 68 | 69 | 70 | 71 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn ( ) { 37 | echo "$*" 38 | } 39 | 40 | die ( ) { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:applicationId=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save ( ) { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /src/test/java/FlyingSaucerTest.java: -------------------------------------------------------------------------------- 1 | import org.junit.Test; 2 | import org.thymeleaf.TemplateEngine; 3 | import org.thymeleaf.context.Context; 4 | import org.thymeleaf.templateresolver.ClassLoaderTemplateResolver; 5 | import org.w3c.tidy.Tidy; 6 | import org.xhtmlrenderer.pdf.ITextRenderer; 7 | 8 | import java.io.*; 9 | import java.nio.file.FileSystems; 10 | 11 | import static com.itextpdf.text.pdf.BaseFont.EMBEDDED; 12 | import static com.itextpdf.text.pdf.BaseFont.IDENTITY_H; 13 | import static org.thymeleaf.templatemode.TemplateMode.HTML; 14 | 15 | /** 16 | * This is a JUnit test which will generate a PDF using Flying Saucer 17 | * and Thymeleaf templates. The PDF will display a letter styled with 18 | * CSS. The letter has two pages and will contain text and images. 19 | *

20 | * Simply run this test to generate the PDF. The file is called: 21 | *

22 | * /test.pdf 23 | */ 24 | public class FlyingSaucerTest { 25 | 26 | private static final String OUTPUT_FILE = "test.pdf"; 27 | private static final String UTF_8 = "UTF-8"; 28 | 29 | @Test 30 | public void generatePdf() throws Exception { 31 | 32 | // We set-up a Thymeleaf rendering engine. All Thymeleaf templates 33 | // are HTML-based files located under "src/test/resources". Beside 34 | // of the main HTML file, we also have partials like a footer or 35 | // a header. We can re-use those partials in different documents. 36 | ClassLoaderTemplateResolver templateResolver = new ClassLoaderTemplateResolver(); 37 | templateResolver.setPrefix("/"); 38 | templateResolver.setSuffix(".html"); 39 | templateResolver.setTemplateMode(HTML); 40 | templateResolver.setCharacterEncoding(UTF_8); 41 | 42 | TemplateEngine templateEngine = new TemplateEngine(); 43 | templateEngine.setTemplateResolver(templateResolver); 44 | 45 | // The data in our Thymeleaf templates is not hard-coded. Instead, 46 | // we use placeholders in our templates. We fill these placeholders 47 | // with actual data by passing in an object. In this example, we will 48 | // write a letter to "John Doe". 49 | // 50 | // Note that we could also read this data from a JSON file, a database 51 | // a web service or whatever. 52 | Data data = exampleDataForJohnDoe(); 53 | 54 | Context context = new Context(); 55 | context.setVariable("data", data); 56 | 57 | // Flying Saucer needs XHTML - not just normal HTML. To make our life 58 | // easy, we use JTidy to convert the rendered Thymeleaf template to 59 | // XHTML. Note that this might not work for very complicated HTML. But 60 | // it's good enough for a simple letter. 61 | String renderedHtmlContent = templateEngine.process("template", context); 62 | String xHtml = convertToXhtml(renderedHtmlContent); 63 | 64 | ITextRenderer renderer = new ITextRenderer(); 65 | renderer.getFontResolver().addFont("Code39.ttf", IDENTITY_H, EMBEDDED); 66 | 67 | // FlyingSaucer has a working directory. If you run this test, the working directory 68 | // will be the root folder of your project. However, all files (HTML, CSS, etc.) are 69 | // located under "/src/test/resources". So we want to use this folder as the working 70 | // directory. 71 | String baseUrl = FileSystems 72 | .getDefault() 73 | .getPath("src", "test", "resources") 74 | .toUri() 75 | .toURL() 76 | .toString(); 77 | renderer.setDocumentFromString(xHtml, baseUrl); 78 | renderer.layout(); 79 | 80 | // And finally, we create the PDF: 81 | OutputStream outputStream = new FileOutputStream(OUTPUT_FILE); 82 | renderer.createPDF(outputStream); 83 | outputStream.close(); 84 | } 85 | 86 | private Data exampleDataForJohnDoe() { 87 | Data data = new Data(); 88 | data.setFirstname("John"); 89 | data.setLastname("Doe"); 90 | data.setStreet("Example Street 1"); 91 | data.setZipCode("12345"); 92 | data.setCity("Example City"); 93 | return data; 94 | } 95 | 96 | static class Data { 97 | private String firstname; 98 | private String lastname; 99 | private String street; 100 | private String zipCode; 101 | private String city; 102 | 103 | public String getFirstname() { 104 | return firstname; 105 | } 106 | 107 | public void setFirstname(String firstname) { 108 | this.firstname = firstname; 109 | } 110 | 111 | public String getLastname() { 112 | return lastname; 113 | } 114 | 115 | public void setLastname(String lastname) { 116 | this.lastname = lastname; 117 | } 118 | 119 | public String getStreet() { 120 | return street; 121 | } 122 | 123 | public void setStreet(String street) { 124 | this.street = street; 125 | } 126 | 127 | public String getZipCode() { 128 | return zipCode; 129 | } 130 | 131 | public void setZipCode(String zipCode) { 132 | this.zipCode = zipCode; 133 | } 134 | 135 | public String getCity() { 136 | return city; 137 | } 138 | 139 | public void setCity(String city) { 140 | this.city = city; 141 | } 142 | } 143 | 144 | private String convertToXhtml(String html) throws UnsupportedEncodingException { 145 | Tidy tidy = new Tidy(); 146 | tidy.setInputEncoding(UTF_8); 147 | tidy.setOutputEncoding(UTF_8); 148 | tidy.setXHTML(true); 149 | ByteArrayInputStream inputStream = new ByteArrayInputStream(html.getBytes(UTF_8)); 150 | ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); 151 | tidy.parseDOM(inputStream, outputStream); 152 | return outputStream.toString(UTF_8); 153 | } 154 | 155 | } 156 | --------------------------------------------------------------------------------