org.mapfish.print

Class PDFUtils

java.lang.Object

org.mapfish.print.PDFUtils

public class PDFUtils
extends java.lang.Object

Some utility functions for iText.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	LOGGER

Constructor Summary

Constructors

Constructor and Description
PDFUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static com.itextpdf.text.pdf.PdfPTable	buildTable(java.util.List<Block> items, PJsonObject params, RenderingContext context, int nbColumns, TableConfig tableConfig) Creates a PDF table with the given items.
static com.itextpdf.text.pdf.PdfPCell	createCell(PJsonObject params, RenderingContext context, Block block, int row, int col, int nbRows, int nbCols, TableConfig tableConfig) Create a PDF table cell with support for styling using the CellConfig stuff.
static com.itextpdf.text.Image	createImage(RenderingContext context, double maxWidth, double maxHeight, float scale, java.net.URI url, float rotation)
static com.itextpdf.text.Image	createImage(RenderingContext context, double maxWidth, double maxHeight, java.net.URI url, float rotation)
static com.itextpdf.text.Chunk	createImageChunk(RenderingContext context, double maxWidth, double maxHeight, float scale, java.net.URI url, float rotation)
static com.itextpdf.text.Chunk	createImageChunk(RenderingContext context, double maxWidth, double maxHeight, java.net.URI url, float rotation)
static com.itextpdf.text.Chunk	createImageChunkFromSVG(RenderingContext context, java.lang.String iconItem, double maxIconWidth, double maxIconHeight, double scale)
static com.itextpdf.text.Image	createImageFromSVG(RenderingContext context, java.lang.String iconItem, double maxIconWidth, double maxIconHeight, double scale)
static com.itextpdf.text.pdf.PdfPTable	createPlaceholderTable(double width, double height, double spacingAfter, ChunkDrawer drawer, HorizontalAlign align, PDFCustomBlocks customBlocks) When we have to do some custom drawing in a block that is layed out by iText, we first give an empty table with the good dimensions to iText, then iText will call a callback with the actual position.
static java.lang.String	evalString(RenderingContext context, PJsonObject params, java.lang.String val, java.lang.String mapName) Evaluates stuff like "toto ${titi}"
static com.itextpdf.text.pdf.BaseFont	getBaseFont(java.lang.String fontFamily, java.lang.String fontSize, java.lang.String fontWeight)
static int	getHorizontalAlignment(java.lang.String labelAlign)
static com.itextpdf.text.Image	getImage(RenderingContext context, java.net.URI uri, float w, float h) Gets an iText image with a cache that uses PdfTemplates to re-use the same bitmap content multiple times in order to reduce the file size.
static com.itextpdf.text.Image	getImage(RenderingContext context, java.net.URI uri, float w, float h, float scale) Gets an iText image with a cache that uses PdfTemplates to re-use the same bitmap content multiple times in order to reduce the file size.
protected static com.itextpdf.text.Image	getImageDirect(RenderingContext context, java.net.URI uri) Gets an iText image.
static java.lang.String	getValueFromString(java.lang.String val)
static float	getVerticalOffset(java.lang.String labelAlign, float fontHeight)
static com.itextpdf.text.Image	handleImageLoadError(RenderingContext context, java.lang.String errorMessage) In the case url fails to load an image this method should be called to handle the issue.
static com.itextpdf.text.Phrase	renderString(RenderingContext context, PJsonObject params, java.lang.String val, com.itextpdf.text.Font font, java.lang.String mapName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

public static final org.apache.log4j.Logger LOGGER

Constructor Detail

PDFUtils

public PDFUtils()

Method Detail

getImage

public static com.itextpdf.text.Image getImage(RenderingContext context,
                               java.net.URI uri,
                               float w,
                               float h)
                                        throws java.io.IOException,
                                               com.itextpdf.text.DocumentException

Gets an iText image with a cache that uses PdfTemplates to re-use the same bitmap content multiple times in order to reduce the file size.

Throws:

java.io.IOException

com.itextpdf.text.DocumentException

getImage

public static com.itextpdf.text.Image getImage(RenderingContext context,
                               java.net.URI uri,
                               float w,
                               float h,
                               float scale)
                                        throws java.io.IOException,
                                               com.itextpdf.text.DocumentException

Gets an iText image with a cache that uses PdfTemplates to re-use the same bitmap content multiple times in order to reduce the file size.

Throws:

java.io.IOException

com.itextpdf.text.DocumentException

getImageDirect

protected static com.itextpdf.text.Image getImageDirect(RenderingContext context,
                                     java.net.URI uri)
                                                 throws java.io.IOException,
                                                        com.itextpdf.text.DocumentException

Gets an iText image. Avoids doing the query twice.

Throws:

java.io.IOException

com.itextpdf.text.DocumentException

handleImageLoadError

public static com.itextpdf.text.Image handleImageLoadError(RenderingContext context,
                                           java.lang.String errorMessage)
                                                    throws java.io.IOException,
                                                           com.itextpdf.text.DocumentException

In the case url fails to load an image this method should be called to handle the issue. If the configuration has a default image for broken image urls then it will be returned otherwise an error will be thrown.

Parameters:

context - the context.

errorMessage - the message of the error to throw in the case the configuration requires it.

Throws:

java.io.IOException

com.itextpdf.text.DocumentException

createPlaceholderTable

public static com.itextpdf.text.pdf.PdfPTable createPlaceholderTable(double width,
                                                     double height,
                                                     double spacingAfter,
                                                     ChunkDrawer drawer,
                                                     HorizontalAlign align,
                                                     PDFCustomBlocks customBlocks)

When we have to do some custom drawing in a block that is layed out by iText, we first give an empty table with the good dimensions to iText, then iText will call a callback with the actual position. When that happens, we use the given drawer to do the actual drawing.

renderString

public static com.itextpdf.text.Phrase renderString(RenderingContext context,
                                    PJsonObject params,
                                    java.lang.String val,
                                    com.itextpdf.text.Font font,
                                    java.lang.String mapName)
                                             throws com.itextpdf.text.BadElementException

Throws:

com.itextpdf.text.BadElementException

evalString

public static java.lang.String evalString(RenderingContext context,
                          PJsonObject params,
                          java.lang.String val,
                          java.lang.String mapName)

Evaluates stuff like "toto ${titi}"

getValueFromString

public static java.lang.String getValueFromString(java.lang.String val)

buildTable

public static com.itextpdf.text.pdf.PdfPTable buildTable(java.util.List<Block> items,
                                         PJsonObject params,
                                         RenderingContext context,
                                         int nbColumns,
                                         TableConfig tableConfig)
                                                  throws com.itextpdf.text.DocumentException

Creates a PDF table with the given items. Returns null if the table is empty

Throws:

com.itextpdf.text.DocumentException

createCell

public static com.itextpdf.text.pdf.PdfPCell createCell(PJsonObject params,
                                        RenderingContext context,
                                        Block block,
                                        int row,
                                        int col,
                                        int nbRows,
                                        int nbCols,
                                        TableConfig tableConfig)
                                                 throws com.itextpdf.text.DocumentException

Create a PDF table cell with support for styling using the CellConfig stuff.

Throws:

com.itextpdf.text.DocumentException

createImageChunk

public static com.itextpdf.text.Chunk createImageChunk(RenderingContext context,
                                       double maxWidth,
                                       double maxHeight,
                                       java.net.URI url,
                                       float rotation)
                                                throws com.itextpdf.text.DocumentException

Throws:

com.itextpdf.text.DocumentException

createImageChunk

public static com.itextpdf.text.Chunk createImageChunk(RenderingContext context,
                                       double maxWidth,
                                       double maxHeight,
                                       float scale,
                                       java.net.URI url,
                                       float rotation)
                                                throws com.itextpdf.text.DocumentException

Throws:

com.itextpdf.text.DocumentException

createImage

public static com.itextpdf.text.Image createImage(RenderingContext context,
                                  double maxWidth,
                                  double maxHeight,
                                  java.net.URI url,
                                  float rotation)
                                           throws com.itextpdf.text.DocumentException

Throws:

com.itextpdf.text.DocumentException

createImage

public static com.itextpdf.text.Image createImage(RenderingContext context,
                                  double maxWidth,
                                  double maxHeight,
                                  float scale,
                                  java.net.URI url,
                                  float rotation)
                                           throws com.itextpdf.text.DocumentException

Throws:

com.itextpdf.text.DocumentException

getBaseFont

public static com.itextpdf.text.pdf.BaseFont getBaseFont(java.lang.String fontFamily,
                                         java.lang.String fontSize,
                                         java.lang.String fontWeight)

getHorizontalAlignment

public static int getHorizontalAlignment(java.lang.String labelAlign)

getVerticalOffset

public static float getVerticalOffset(java.lang.String labelAlign,
                      float fontHeight)

createImageChunkFromSVG

public static com.itextpdf.text.Chunk createImageChunkFromSVG(RenderingContext context,
                                              java.lang.String iconItem,
                                              double maxIconWidth,
                                              double maxIconHeight,
                                              double scale)
                                                       throws java.io.IOException

Throws:

java.io.IOException

createImageFromSVG

public static com.itextpdf.text.Image createImageFromSVG(RenderingContext context,
                                         java.lang.String iconItem,
                                         double maxIconWidth,
                                         double maxIconHeight,
                                         double scale)
                                                  throws java.io.IOException

Throws:

java.io.IOException