com.dpslink.base.util

Class HtmlToPdf

java.lang.Object

com.dpslink.base.util.HtmlToPdf

All Implemented Interfaces:

java.io.Serializable

public class HtmlToPdf
extends java.lang.Object
implements java.io.Serializable

Translates an HTML document into a PDF document.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	HtmlToPdf.HeaderFooter Inner class that adds a header and a footer to PDF document pages.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	FMT_FOOT The formatter for page footer information.
protected static com.itextpdf.text.Font	FONT_FOOT The font used for page footers.
protected static com.itextpdf.text.Font	FONT_HEAD The font used for page headers.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
HtmlToPdf() Constructs a new HTML-to-PDF translator.

Method Summary

Modifier and Type	Method and Description
java.io.ByteArrayOutputStream	getPdfStream(java.lang.String html, boolean rotate) Performs HTML-to-PDF translation and returns the results.
java.io.ByteArrayOutputStream	getPdfStream(java.lang.String template, org.apache.velocity.VelocityContext data, boolean rotate) Performs HTML-to-PDF translation and returns the results.
protected java.io.ByteArrayOutputStream	translate(java.io.ByteArrayOutputStream xhtml, boolean rotate) Performs XHTML-to-PDF translation and returns the results.
void	writeToResponse(java.io.ByteArrayOutputStream pdf, javax.servlet.http.HttpServletResponse response) Writes a PDF document to a servlet's outgoing response.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

FONT_HEAD

protected static final com.itextpdf.text.Font FONT_HEAD

The font used for page headers.

FONT_FOOT

protected static final com.itextpdf.text.Font FONT_FOOT

The font used for page footers.

FMT_FOOT

protected static final java.lang.String FMT_FOOT

The formatter for page footer information.

See Also:

Constant Field Values

Constructor Detail

HtmlToPdf

public HtmlToPdf()

Constructs a new HTML-to-PDF translator.

Method Detail

getPdfStream

public java.io.ByteArrayOutputStream getPdfStream(java.lang.String html,
                                                  boolean rotate)
                                           throws java.lang.Exception

Performs HTML-to-PDF translation and returns the results.

Parameters:

html - (String) The HTML to process.

rotate - (boolean) true to create the PDF document with landscape orientation (rotated) or false to create the PDF document with portrait orientation (not rotated).

Returns:

ByteArrayOutputStream - The processed results.

Throws:

java.lang.Exception - - if an error occurs during translation.

getPdfStream

public java.io.ByteArrayOutputStream getPdfStream(java.lang.String template,
                                                  org.apache.velocity.VelocityContext data,
                                                  boolean rotate)
                                           throws java.lang.Exception

Performs HTML-to-PDF translation and returns the results.

Parameters:

template - (String) The name of the HTML template file to process.

data - (VelocityContext) The data to use for substitutions or null if no data is to be substituted.

rotate - (boolean) true to create the PDF document with landscape orientation (rotated) or false to create the PDF document with portrait orientation (not rotated).

Returns:

ByteArrayOutputStream - The processed results.

Throws:

java.lang.Exception - - if an error occurs during translation.

translate

protected java.io.ByteArrayOutputStream translate(java.io.ByteArrayOutputStream xhtml,
                                                  boolean rotate)
                                           throws java.lang.Exception

Performs XHTML-to-PDF translation and returns the results.

Parameters:

xhtml - (ByteArrayOutputStream) The XHTML to process.

rotate - (boolean) true to create the PDF document with landscape orientation (rotated) or false to create the PDF document with portrait orientation (not rotated).

Returns:

ByteArrayOutputStream - The processed results.

Throws:

java.lang.Exception - - if an error occurs during translation.

writeToResponse

public void writeToResponse(java.io.ByteArrayOutputStream pdf,
                            javax.servlet.http.HttpServletResponse response)
                     throws java.lang.Exception

Writes a PDF document to a servlet's outgoing response.

Parameters:

pdf - (ByteArrayOutputStream) The PDF document to write.

response - (HttpServletResponse) The servlet response to write to.

Throws:

java.lang.Exception - - if an error occurs during the writing.