Package com.storedobject.pdf

Class PDF

java.lang.Object

com.storedobject.pdf.PDF

All Implemented Interfaces:

Executable, ContentProducer, ContentType, Closeable, AutoCloseable, Runnable

Direct Known Subclasses:

PDFReport

public abstract class PDF
extends Object
implements Closeable, ContentProducer

This class is used to create PDF output. The only abstract method in this class is generateContent() and is the one where you really print the report content. In most cases, you may use PDFReport class instead of this class directly.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	PDF.ObjectFormTable<T extends StoredObject>	Define a table where StoredObject instances can be added in a "form" style (Each attribute is printed in a separate row).
class	PDF.ObjectTable<T extends StoredObject>	Define a table where StoredObject instances can be added as rows.
class	PDF.PDFContent	Representation of 'Content' from another PDF.
class	PDF.Text	Used to define text to include in the PDF document.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ORIENTATION_LANDSCAPE
static final int	ORIENTATION_PORTRAIT
static final String[]	pageSizes

Constructor Summary

Constructors

Constructor	Description
PDF()	Constructor.
PDF(boolean letterhead)	Constructor.
PDF(boolean letterhead, PDFImage logo)	Constructor.
PDF(PDFImage logo)	Constructor.
PDF(OutputStream out)	Constructor.
PDF(OutputStream out, boolean letterhead)	Constructor.
PDF(OutputStream out, boolean letterhead, PDFImage logo)	Constructor.
PDF(OutputStream out, PDFImage logo)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	aboutToAddExternalContent(int page, PDFImage pageImage)
void	add(Object any)	Adds an object to the document.
void	add(Object any, boolean rightAligned)	Add an object to the document.
void	add(Object any, int horizontalAlignment)	Add an object to the document.
void	add(Object any, int horizontalAlignment, int verticalAlignment)	Add an object to the document.
void	addBlankRow(PDFTable table)	Adds a blank row to the table.
void	addBlankRow(PDFTable table, int fromColumn)	Adds a blank row to the table.
void	addBlankRow(PDFTable table, int fromColumn, int toColumn)	Adds a blank row to the table.
void	addCentered(Object any)	Add an object to the document.
void	addContent(ContentProducer externalPDF, float scalePercentage)	Add content from another PDF content producer.
void	addContent(ContentProducer externalPDF, float scalePercentage, int startingPage, int endingPage, int... pagesToSkip)	Add content from another PDF content producer.
void	addContent(FileData externalPDF, float scalePercentage)	Add content from a PDF file.
void	addContent(FileData externalPDF, float scalePercentage, int startingPage, int endingPage, int... pagesToSkip)	Add content from a PDF file.
void	addContent(StreamData externalPDF, float scalePercentage)	Add content from a PDF stream.
void	addContent(StreamData externalPDF, float scalePercentage, int startingPage, int endingPage, int... pagesToSkip)	Add content from a PDF stream.
void	addContent(PDFImage image)	Add an image to the next page as the content.
void	addContent(PDFImage image, float scalePercentage)	Add an image to the next page as the content.
void	addContent(InputStream externalPDF, float scalePercentage)	Add content from a PDF stream.
void	addContent(InputStream externalPDF, float scalePercentage, int startingPage, int endingPage, int... pagesToSkip)	Add content from a PDF stream.
void	addGap(int verticalGap)	Add some vertical gap (Typically used to add space before adding a table).
void	addHTML(String html)	Add HTML content to the rest of the page
void	addHTML(String html, int width, int height)	Add HTML content at the current position with the given width and height
void	addHTML(String html, int positionX, int positionY, int width, int height)	Add HTML content at the given position with the given width and height
void	addHTML(String html, StringFiller filler)	Add HTML content to the rest of the page
void	addHTML(String html, StringFiller filler, int width, int height)	Add HTML content at the current position with the given width and height
void	addHTML(String html, StringFiller filler, int positionX, int positionY, int width, int height)	Add HTML content at the given position with the given width and height
void	addImage(PDFImage image)	Add an image at position (0, 0) in the current page.
void	addImage(PDFImage image, float positionX, float positionY)	Add an image at some absolute position in the current page.
void	addImage(PDFImage image, float positionX, float positionY, float width, float height)	Add an image at some absolute position in the current page.
void	addingExternalContent(int page, PDFImage content)
void	addTitles(PDFTable table, int pointSize, StringList titles)	Add title texts to table.
void	addTitles(PDFTable table, int pointSize, String... titles)	Add title texts to table.
void	addTitles(PDFTable table, int pointSize, Stream<String> titles)	Add title texts to table.
void	addTitles(PDFTable table, StringList titles)	Add title texts to table.
void	addTitles(PDFTable table, String... titles)	Add title texts to table.
void	addTitles(PDFTable table, Stream<String> titles)
void	addToTable(PDFTable table, Object any)	Adds an object to the given PDFTable as a PDFCell.
void	addToTable(PDFTable table, Object any, boolean rightAligned)	Adds an object to the given PDFTable as a PDFCell.
void	addToTable(PDFTable table, Object any, boolean rightAligned, Function<PDFCell,PDFCell> cellCustomizer)	Adds an object to the given PDFTable as a PDFCell.
void	addToTable(PDFTable table, Object any, int horizontalAlignment)	Adds an object to the given PDFTable as a PDFCell.
void	addToTable(PDFTable table, Object any, int horizontalAlignment, int verticalAlignment)	Adds an object to the given PDFTable as a PDFCell.
void	addToTable(PDFTable table, Object any, int horizontalAlignment, int verticalAlignment, Function<PDFCell,PDFCell> cellCustomizer)	Adds an object to the given PDFTable as a PDFCell.
void	addToTable(PDFTable table, Object any, int horizontalAlignment, Function<PDFCell,PDFCell> cellCustomizer)	Adds an object to the given PDFTable as a PDFCell.
void	addToTable(PDFTable table, Object any, Function<PDFCell,PDFCell> cellCustomizer)	Adds an object to the given PDFTable as a PDFCell.
void	addToTableCentered(PDFTable table, Object any)	Adds an object to the given PDFTable as a PDFCell.
void	addToTableCentered(PDFTable table, Object any, Function<PDFCell,PDFCell> cellCustomizer)	Adds an object to the given PDFTable as a PDFCell.
void	chainTo(PDF pdf)	Chain to another PDF.
void	close()	Closes the PDF for content generation process.
PDFCell	createCell(Object object)	Creates a cell that can be added to a table.
PDFCell	createCell(Object object, boolean rightAligned)	Creates a cell that can be added to a table.
PDFCell	createCell(Object object, boolean rightAligned, Function<PDFCell,PDFCell> cellCustomizer)	Creates a cell that can be added to a table.
PDFCell	createCell(Object object, int horizontalAlignment)	Creates a cell that can be added to a table.
PDFCell	createCell(Object object, int horizontalAlignment, int verticalAlignment)	Creates a cell that can be added to a table.
PDFCell	createCell(Object object, int horizontalAlignment, int verticalAlignment, Function<PDFCell,PDFCell> cellCustomizer)	Creates a cell that can be added to a table.
PDFCell	createCell(Object object, int horizontalAlignment, Function<PDFCell,PDFCell> cellCustomizer)	Creates a cell that can be added to a table.
PDFCell	createCell(Object object, Function<PDFCell,PDFCell> cellCustomizer)	Creates a cell that can be added to a table.
PDFCell	createCenteredCell(Object object)	Creates a centered cell that can be added to a table.
PDFCell	createCenteredCell(Object object, Function<PDFCell,PDFCell> cellCustomizer)	Creates a centered cell that can be added to a table.
Graphics2D	createGraphics()	Create a graphics object to draw directly to the PDF.
Graphics2D	createGraphics(float positionX, float positionY, float width, float height)	Create a graphics object to draw directly to the PDF.
static PDFImage	createImage(Barcode barcode)	Create image from barcode
static PDFImage	createImage(HTMLText html)	Create image from HTML
static PDFImage	createImage(HTMLText html, int width, int height)	Create image from HTML
static PDFImage	createImage(Signature signature)	Create image from a signature instance
static PDFImage	createImage(StreamData streamData)	Create image from stream data
static PDFImage	createImage(Image image)	Create image from Java AWT image
static PDFImage	createImage(InputStream stream)	Create image from an input stream (stream will be closed)
PDFImage	createImage(Consumer<Graphics2D> painter)	Create a PDF image where a painter decides how to paint the image.
PDFImage	createImage(Consumer<Graphics2D> painter, int width, int height)	Create a PDF image where a painter decides how to paint the image.
static PDFImage	createImageFromHTML(String html)	Create image from HTML
static PDFImage	createImageFromHTML(String html, int width, int height)	Create image from HTML
static PDFImage	createImageFromHTML(String html, StringFiller filler)	Create image from HTML
static PDFImage	createImageFromHTML(String html, StringFiller filler, int width, int height)	Create image from HTML
static PDFImage	createImageFromSVG(String svg)	Create image from SVG
static PDFImage	createImageFromSVG(String svg, int width, int height)	Create image from SVG
static PDFTable	createTable(int columnCount)	Creates a table that can fit 100% to document's width.
static PDFTable	createTable(int... relativeWidths)	Creates a table that can fit 100% to document's width.
PDFChunk	createText(String text)	Create text Chunk.
PDFChunk	createText(String text, int pointSize)	Create text Chunk.
PDFChunk	createText(String text, int pointSize, PDFColor color)	Create text Chunk.
PDFPhrase	createTitleText(String title)	Create title Phrase.
PDFPhrase	createTitleText(String title, int pointSize)	Create title Phrase.
PDFPhrase	createTitleText(String title, int pointSize, PDFColor color)	Create title Phrase.
boolean	drawTable(PDFTable table)	Draw the table at the current position till the end of the page.
boolean	drawTable(PDFTable table, float x, float y)	Draw the table at the given position till the end of the page.
boolean	drawTable(PDFTable table, float x1, float y1, float x2, float y2)	Draw the table within the given rectangular area.
final void	dumpError(Throwable error)	Dump the error that happened during reporting.
abstract void	generateContent()	Generate the content by writing stuff to the PDF.
float	getBottomMargin()	Document margin.
final InputStream	getContent()	Gets the content as a stream.
final String	getContentType()	Gets the content type for this.
Device	getDevice()
Entity	getEntity()	Get the entity (If the entity can not be identified from "Transaction Manager" or "Entity", then, null is returned.
String	getEntityLocation()	Get the location of the entity (If the entity can not be identified from "Transaction Manager" or "Entity", then, a blank String is returned.
String	getEntityName()	Get the name of the entity (If the entity can not be identified from "Transaction Manager" or "Entity", then, a blank String is returned.
final String	getFileExtension()	Gets the file name extension.
String	getFileName()	Gets the name of the file for this PDF
final int	getFontSize()	Gets default font size.
Object	getFooter()	Footer to be displayed on each page.
final float	getHeight()	Gets the printable height.
float	getLeftMargin()	Document margin.
int	getPageNumber()	Get the current page number.
int	getPageOrientation()	Page orientation - Portrait or Landscape
PDFRectangle	getPageSize()	Page size.
static PDFRectangle	getPageSize(int paperSizeIndex)
int	getPageSizeIndex()
ReportFormat	getReportFormat()	Get the 'Report Format Definition' for this report.
int	getReportStage()	Stage of the report.
float	getRightMargin()	Document margin.
Object	getTitle()	Title to be displayed on each page.
float	getTopMargin()	Document margin.
final TransactionManager	getTransactionManager()	Gets the Transaction Manager
SystemUser	getUser()	Get the user for which this PDF is being generated.
String	getWaterMark()	Gets the currently set water mark.
final float	getWidth()	Gets the printable width.
float	getY()	Get the current Y position of the PDF
float	getY(boolean ensureNewLine)	Get the current Y position of the PDF
final void	log(Object anything)	Log something via the logger associated with this report.
boolean	newPage()	Create and add a new page
void	newReportStage()	Starts a new report stage.
void	newReportStage(int reportStage)	Starts a new report stage.
void	open()	Open the PDF for creating the content.
void	pageCompleted()	This method will be called whenever a page is completed.
void	pageStarted()	This method will be called whenever a new page is started.
boolean	printAuditTrail()	Print audit trail at the bottom of the page
boolean	printLetterHeadOnEveryPage()	Print letter head on every page or not.
void	printLetterHeadOnEveryPage(boolean print)	Print letter head on every page or not.
boolean	printPageNumber()	Print page number or not.
void	printPageNumber(boolean print)	Print page number or not.
boolean	printTotalPageNumber()	Print total page number or not.
void	printTotalPageNumber(boolean print)	Print total page number or not.
void	produce()	This is the method to be invoked in order to do the content generation.
PDF.PDFContent	readContent(InputStream content)	Reads and creates a 'Content' object from the stream containing PDF data.
void	setDefaultCellCustomizer(Consumer<PDFCell> defaultCellCustomizer)	Set a cell customizer that will be called whenever a table cell is created.
final void	setEntity(Entity entity)	Sets the Entity so that the "letter head" can be printed.
final void	setError(String error)	Set additional error information such that it will be printed in the log when an error happens.
final void	setFontSize(int fontSize)	Sets the default font size.
void	setLanguage(PDFFont.Language language)	Sets the font language for this PDF.
void	setLanguage(PDFFont.Language language, int fontSize)	Sets the font language for this PDF.
void	setLogo(PDFImage image)
void	setLogo(Image image)
void	setPageNumber(int pageNumber)	Set the page number to a new value.
void	setPageSizeIndex(int pageSizeIndex)
void	setPassword(String password)	Set a password for the PDF.
void	setReportFormat(ReportFormat reportFormat)	Set the 'Report Format Definition' for this report.
final void	setTransactionManager(TransactionManager tm)	Sets the Transaction Manager so that the "letter head" can be printed.
void	setWaterMark(String waterMark)	Sets the water mark.
void	showText(String text, int x, int y, int alignment, float rotation, PDFFont font, float fontSize, PDFColor color, float opacity)	Show text at some specified position.
protected final int	toCharCount(Object any)	Return the width in number of characters for drawing the given value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.core.ContentProducer

abort, execute, extractContent, getError, getStreamData, getStreamDataProvider, getSystemEntity, saveTo, saveTo, saveTo, saveTo

Methods inherited from interface com.storedobject.core.ContentType

getLink, getMimeType, isAudio, isHTML, isImage, isLink, isMedia, isPDF, isText, isVideo

Methods inherited from interface com.storedobject.common.Executable

act, run

Field Details

pageSizes

public static final String[] pageSizes

ORIENTATION_PORTRAIT

public static final int ORIENTATION_PORTRAIT

See Also:

• Constant Field Values

ORIENTATION_LANDSCAPE

public static final int ORIENTATION_LANDSCAPE

See Also:

• Constant Field Values

Constructor Details

PDF

public PDF()

Constructor. This will generate a PDF with letterhead.

PDF

public PDF(PDFImage logo)

Constructor. This will generate a PDF with letterhead.

Parameters:

logo - Logo

PDF

public PDF(boolean letterhead)

Constructor.

Parameters:

letterhead - Whether letterhead needs to be printed or not.

PDF

public PDF(boolean letterhead,
 PDFImage logo)

Constructor.

Parameters:

letterhead - Whether letterhead needs to be printed or not.

logo - Logo

PDF

public PDF(OutputStream out)

Constructor. This will generate a PDF with letterhead.

Parameters:

out - Output stream to which content should be streamed out. Useful for storing the generated PDF to the backend.

PDF

public PDF(OutputStream out,
 PDFImage logo)

Constructor. This will generate a PDF with letterhead.

Parameters:

out - Output stream to which content should be streamed out. Useful for storing the generated PDF to the backend.

logo - Logo

PDF

public PDF(OutputStream out,
 boolean letterhead)

Constructor.

Parameters:

out - Output stream to which content should be streamed out.

letterhead - Whether letterhead needs to be printed or not.

PDF

public PDF(OutputStream out,
 boolean letterhead,
 PDFImage logo)

Constructor.

Parameters:

out - Output stream to which content should be streamed out.

letterhead - Whether letterhead needs to be printed or not.

logo - Logo

Method Details

open

public void open()

Open the PDF for creating the content. This is automatically invoked by the framework.

toCharCount

protected final int toCharCount(Object any)

Return the width in number of characters for drawing the given value.

Parameters:

any - anything.

Returns:

Width in number of characters.

getPageSize

public static PDFRectangle getPageSize(int paperSizeIndex)

getPageSizeIndex

public int getPageSizeIndex()

setPageSizeIndex

public void setPageSizeIndex(int pageSizeIndex)

setPassword

public void setPassword(String password)

Set a password for the PDF. If set, this password will be required to open the generated PDF. This method should be invoked before the actual content generation starts (so, the password must be set before generateContent() and that means, the constructor is the ideal place to set the password).

Parameters:

password - Password to set.

setFontSize

public final void setFontSize(int fontSize)

Sets the default font size.

Parameters:

fontSize - Font size

getFontSize

public final int getFontSize()

Gets default font size.

Returns:

Default font size.

setLanguage

public void setLanguage(PDFFont.Language language)

Sets the font language for this PDF.

Parameters:

language - Font language.

setLanguage

public void setLanguage(PDFFont.Language language,
 int fontSize)

Sets the font language for this PDF.

Parameters:

language - Font language.

fontSize - Font size

add

public void add(Object any)

Adds an object to the document. Object can be 'text', a PDFImage, a PDFCell, a PDFTable or anything else.

Parameters:

any - Any object

add

public void add(Object any,
 boolean rightAligned)

Add an object to the document. Object can be 'text', a PDFImage, a PDFCell, a PDFTable or anything else.

Parameters:

any - Any object

rightAligned - Right alignment

add

public void add(Object any,
 int horizontalAlignment)

Add an object to the document. Object can be 'text', a PDFImage, a PDFCell, a PDFTable or anything else.

Parameters:

any - Any object

horizontalAlignment - Alignment value from PDFElement.

add

public void add(Object any,
 int horizontalAlignment,
 int verticalAlignment)

Add an object to the document. Object can be 'text', a PDFImage, a PDFCell, a PDFTable or anything else.

Parameters:

any - Any object

horizontalAlignment - Alignment value from PDFElement.

verticalAlignment - Alignment value from PDFElement.

addToTable

public void addToTable(PDFTable table,
 Object any)

Adds an object to the given PDFTable as a PDFCell. Object can be 'text', a PDFImage, a PDFCell, a PDFTable or anything else.

Parameters:

table - Table to which the object needs to be added after converting into a PDFCell.

any - Any object to convert to a PDFCell.

addToTable

public void addToTable(PDFTable table,
 Object any,
 Function<PDFCell,PDFCell> cellCustomizer)

Adds an object to the given PDFTable as a PDFCell. Object can be 'text', a PDFImage, a PDFCell, a PDFTable or anything else.

Parameters:

table - Table to which the object needs to be added after converting into a PDFCell.

any - Any object to convert to a PDFCell.

cellCustomizer - Cell customizer. If non-null value is passed, the cell will be passed through this for further customization.

addToTable

public void addToTable(PDFTable table,
 Object any,
 boolean rightAligned)

Adds an object to the given PDFTable as a PDFCell. Object can be 'text', a PDFImage, a PDFCell, a PDFTable or anything else.

Parameters:

table - Table to which the object needs to be added after converting into a PDFCell.

any - Any object to convert to a PDFCell.

rightAligned - Right alignment.

addToTable

public void addToTable(PDFTable table,
 Object any,
 boolean rightAligned,
 Function<PDFCell,PDFCell> cellCustomizer)

Adds an object to the given PDFTable as a PDFCell. Object can be 'text', a PDFImage, a PDFCell, a PDFTable or anything else.

Parameters:

table - Table to which the object needs to be added after converting into a PDFCell.

any - Any object to convert to a PDFCell.

rightAligned - Right alignment.

cellCustomizer - Cell customizer. If non-null value is passed, the cell will be passed through this for further customization.

addToTableCentered

public void addToTableCentered(PDFTable table,
 Object any)

Adds an object to the given PDFTable as a PDFCell. Object can be 'text', a PDFImage, a PDFCell, a PDFTable or anything else.

Parameters:

table - Table to which the object needs to be added after converting into a PDFCell.

any - Any object to convert to a PDFCell.

addToTableCentered

public void addToTableCentered(PDFTable table,
 Object any,
 Function<PDFCell,PDFCell> cellCustomizer)

Adds an object to the given PDFTable as a PDFCell. Object can be 'text', a PDFImage, a PDFCell, a PDFTable or anything else.

Parameters:

table - Table to which the object needs to be added after converting into a PDFCell.

any - Any object to convert to a PDFCell.

cellCustomizer - Cell customizer. If non-null value is passed, the cell will be passed through this for further customization.

addToTable

public void addToTable(PDFTable table,
 Object any,
 int horizontalAlignment)

Adds an object to the given PDFTable as a PDFCell. Object can be 'text', a PDFImage, a PDFCell, a PDFTable or anything else.

Parameters:

table - Table to which the object needs to be added after converting into a PDFCell.

any - Any object to convert to a PDFCell.

horizontalAlignment - Alignment value from PDFElement.

addToTable

public void addToTable(PDFTable table,
 Object any,
 int horizontalAlignment,
 Function<PDFCell,PDFCell> cellCustomizer)

Adds an object to the given PDFTable as a PDFCell. Object can be 'text', a PDFImage, a PDFCell, a PDFTable or anything else.

Parameters:

table - Table to which the object needs to be added after converting into a PDFCell.

any - Any object to convert to a PDFCell.

horizontalAlignment - Alignment value from PDFElement.

cellCustomizer - Cell customizer. If non-null value is passed, the cell will be passed through this for further customization.

addToTable

public void addToTable(PDFTable table,
 Object any,
 int horizontalAlignment,
 int verticalAlignment)

Adds an object to the given PDFTable as a PDFCell. Object can be 'text', a PDFImage, a PDFCell, a PDFTable or anything else.

Parameters:

table - Table to which the object needs to be added after converting into a PDFCell.

any - Any object to convert to a PDFCell.

horizontalAlignment - Alignment value from PDFElement.

verticalAlignment - Alignment value from PDFElement.

addToTable

public void addToTable(PDFTable table,
 Object any,
 int horizontalAlignment,
 int verticalAlignment,
 Function<PDFCell,PDFCell> cellCustomizer)

Adds an object to the given PDFTable as a PDFCell. Object can be 'text', a PDFImage, a PDFCell, a PDFTable or anything else.

Parameters:

table - Table to which the object needs to be added after converting into a PDFCell.

any - Any object to convert to a PDFCell.

horizontalAlignment - Alignment value from PDFElement.

verticalAlignment - Alignment value from PDFElement.

cellCustomizer - Cell customizer. If non-null value is passed, the cell will be passed through this for further customization.

close

public void close()

Closes the PDF for content generation process. This method is generally invoked by the framework automatically.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

chainTo

public void chainTo(PDF pdf)

Chain to another PDF. Content from the PDF will be appended to the current one.

Parameters:

pdf - PDF that needs to be appended to this content.

getFileName

public String getFileName()

Gets the name of the file for this PDF

Specified by:

getFileName in interface ContentProducer

Returns:

The PDF file name

getContent

public final InputStream getContent()
                             throws Exception

Gets the content as a stream.

Specified by:

getContent in interface ContentProducer

Returns:

Content as a stream from the generated file.

Throws:

Exception

getContentType

public final String getContentType()

Gets the content type for this.

Specified by:

getContentType in interface ContentType

Returns:

"application/pdf"

produce

public void produce()

This is the method to be invoked in order to do the content generation. This method is generally not overridden but if it is overridden, make sure that the "super" is invoked.

Specified by:

produce in interface ContentProducer

newReportStage

public void newReportStage()

Starts a new report stage. Methods like getTitle(), getFooter(), getPageSize() etc. will be invoked again. A new page will be created with new page size, title and footer. Report Stage will be incremented by one and it can be obtained by calling getReportStage().

newReportStage

public void newReportStage(int reportStage)

Starts a new report stage. Methods like getTitle(), getFooter(), getPageSize() etc. will be invoked again. A new page will be created with new page size, title and footer. Report Stage will be set to the value passed as parameter so that the next call to getReportStage() returns that value.

Parameters:

reportStage - Next report stage

getReportStage

public int getReportStage()

Stage of the report. The first stage is zero and every call to newReportStage() increments the stage.

Returns:

Report stage.

getTitle

public Object getTitle()

Title to be displayed on each page. This method is invoked only once and the same title is drawn on all pages unless newReportStage() is called. This could be a String, a PDFCell or any other object from which a PDFCell can be created, including a PDFTable.

Returns:

Default return value is null, meaning nothing will be displayed as page title.

setEntity

public final void setEntity(Entity entity)

Sets the Entity so that the "letter head" can be printed. If this method or setTransaction() is not invoked in the letter head mode, letter head will not be printed. If both this method and setTransactionManager() are invoked, setTransactionManager() method will be used only for printing water marks and this method will be used for printing letter head.

Parameters:

entity - Entity to be set.

getReportFormat

public ReportFormat getReportFormat()

Get the 'Report Format Definition' for this report. It will be determined by looking at the value of 'Transaction Manager' or 'Entity'.

Returns:

Report Format Definition for this report.

setReportFormat

public void setReportFormat(ReportFormat reportFormat)

Set the 'Report Format Definition' for this report. This will override the default one.

Parameters:

reportFormat - Report Format Definition for this report.

getEntityName

public String getEntityName()

Get the name of the entity (If the entity can not be identified from "Transaction Manager" or "Entity", then, a blank String is returned.

Returns:

Name of the entity.

getEntityLocation

public String getEntityLocation()

Get the location of the entity (If the entity can not be identified from "Transaction Manager" or "Entity", then, a blank String is returned.

Returns:

Location of the entity.

getEntity

public Entity getEntity()

Get the entity (If the entity can not be identified from "Transaction Manager" or "Entity", then, null is returned.

Specified by:

getEntity in interface ContentProducer

Returns:

The entity.

generateContent

public abstract void generateContent()
                              throws Exception

Generate the content by writing stuff to the PDF.

Throws:

Exception - Any exception.

addContent

public void addContent(PDFImage image)

Add an image to the next page as the content. The image will fill the page 100%.

Parameters:

image - Image to be added.

addContent

public void addContent(PDFImage image,
 float scalePercentage)

Add an image to the next page as the content. The image will be added at the center of the page.

Parameters:

image - Image to be added.

scalePercentage - Scale percentage within the page. Use 100 for filling 100%.

addContent

public void addContent(ContentProducer externalPDF,
 float scalePercentage)
                throws Exception

Add content from another PDF content producer. The method addingExternalContent will be invoked before adding each page image.

Parameters:

externalPDF - External PDF to add.

scalePercentage - Scale percentage of each page.

Throws:

Exception - Any exception.

addContent

public void addContent(ContentProducer externalPDF,
 float scalePercentage,
 int startingPage,
 int endingPage,
 int... pagesToSkip)
                throws Exception

Add content from another PDF content producer. The method addingExternalContent will be invoked before adding each page image.

Parameters:

externalPDF - External PDF to add.

scalePercentage - Scale percentage of each page.

startingPage - Pages will be inserted from the starting page (Page number starts from 1).

endingPage - Pages will be inserted till this page. If 0 is specified, it will be interpreted as the last page of the content. Negative numbers will be subtracted from last page. So, from the content, if last 3 pages to be dropped, just pass -3 as the endingPage.

pagesToSkip - Pages to skip.

Throws:

Exception - Any exception.

addContent

public void addContent(FileData externalPDF,
 float scalePercentage)
                throws Exception

Add content from a PDF file. The method addingExternalContent will be invoked before adding each page image.

Parameters:

externalPDF - External PDF to add.

scalePercentage - Scale percentage of each page.

Throws:

Exception - Any exception.

addContent

public void addContent(FileData externalPDF,
 float scalePercentage,
 int startingPage,
 int endingPage,
 int... pagesToSkip)
                throws Exception

Add content from a PDF file. The method addingExternalContent will be invoked before adding each page image.

Parameters:

externalPDF - External PDF to add.

scalePercentage - Scale percentage of each page.

startingPage - Pages will be inserted from the starting page (Page number starts from 1).

endingPage - Pages will be inserted till this page. If 0 is specified, it will be interpreted as the last page of the content. Negative numbers will be subtracted from last page. So, from the content, if last 3 pages to be dropped, just pass -3 as the endingPage.

pagesToSkip - Pages to skip.

Throws:

Exception - Any exception.

addContent

public void addContent(StreamData externalPDF,
 float scalePercentage)
                throws Exception

Add content from a PDF stream. The method addingExternalContent will be invoked before adding each page image.

Parameters:

externalPDF - External PDF to add.

scalePercentage - Scale percentage of each page.

Throws:

Exception - Any exception.

addContent

public void addContent(StreamData externalPDF,
 float scalePercentage,
 int startingPage,
 int endingPage,
 int... pagesToSkip)
                throws Exception

Add content from a PDF stream. The method addingExternalContent will be invoked before adding each page image.

Parameters:

externalPDF - External PDF to add.

scalePercentage - Scale percentage of each page.

startingPage - Pages will be inserted from the starting page (Page number starts from 1).

endingPage - Pages will be inserted till this page. If 0 is specified, it will be interpreted as the last page of the content. Negative numbers will be subtracted from last page. So, from the content, if last 3 pages to be dropped, just pass -3 as the endingPage.

pagesToSkip - Pages to skip.

Throws:

Exception - Any exception.

addContent

public void addContent(InputStream externalPDF,
 float scalePercentage)
                throws Exception

Add content from a PDF stream. The method addingExternalContent will be invoked before adding each page image.

Parameters:

externalPDF - External PDF to add.

scalePercentage - Scale percentage of each page.

Throws:

Exception - Any exception.

addContent

public void addContent(InputStream externalPDF,
 float scalePercentage,
 int startingPage,
 int endingPage,
 int... pagesToSkip)
                throws Exception

Add content from a PDF stream. The method addingExternalContent will be invoked before adding each page image.

Parameters:

externalPDF - External PDF to add.

scalePercentage - Scale percentage of each page.

startingPage - Pages will be inserted from the starting page (Page number starts from 1).

endingPage - Pages will be inserted till this page. If 0 is specified, it will be interpreted as the last page of the content. Negative numbers will be subtracted from last page. So, from the content, if last 3 pages to be dropped, just pass -3 as the endingPage.

pagesToSkip - Pages to skip.

Throws:

Exception - Any exception.

aboutToAddExternalContent

protected void aboutToAddExternalContent(int page,
 PDFImage pageImage)

addingExternalContent

public void addingExternalContent(int page,
 PDFImage content)

createTable

public static PDFTable createTable(int columnCount)

Creates a table that can fit 100% to document's width.

Parameters:

columnCount - Number of columns in the table.

Returns:

The table

createTable

public static PDFTable createTable(int... relativeWidths)

Creates a table that can fit 100% to document's width.

Parameters:

relativeWidths - Relative (or percentage) widths of the columns to be created.

Returns:

The table

setDefaultCellCustomizer

public void setDefaultCellCustomizer(Consumer<PDFCell> defaultCellCustomizer)

Set a cell customizer that will be called whenever a table cell is created. The default customizer draws a border around the cell. So, if you don't want that, set this to null or to your own custom one.

Parameters:

defaultCellCustomizer - Default cell customizer. Could be null.

createCenteredCell

public PDFCell createCenteredCell(Object object)

Creates a centered cell that can be added to a table.

Parameters:

object - Object that provides the content of the cell - object.toString(). Object can also be either a PDFImage, PDFCell, PDFTable, PDFPhrase or PDFChunk.

Returns:

The cell that is created.

createCenteredCell

public PDFCell createCenteredCell(Object object,
 Function<PDFCell,PDFCell> cellCustomizer)

Creates a centered cell that can be added to a table.

Parameters:

object - Object that provides the content of the cell - object.toString(). Object can also be either a PDFImage, PDFCell, PDFTable, PDFPhrase, PDFChunk, Image, StreamData or Barcode.

cellCustomizer - Cell customizer. If non-null value is passed, the cell created will be passed through this for further customization.

Returns:

The cell that is created.

createCell

public PDFCell createCell(Object object)

Creates a cell that can be added to a table.

Parameters:

object - Object that provides the content of the cell - object.toString(). Object can also be either a PDFImage, PDFCell, PDFTable, PDFPhrase or PDFChunk.

Returns:

The cell that is created.

createCell

public PDFCell createCell(Object object,
 Function<PDFCell,PDFCell> cellCustomizer)

Creates a cell that can be added to a table.

Parameters:

object - Object that provides the content of the cell - object.toString(). Object can also be either a PDFImage, PDFCell, PDFTable, PDFPhrase, PDFChunk, Image, StreamData or Barcode.

cellCustomizer - Cell customizer. If non-null value is passed, the cell created will be passed through this for further customization.

Returns:

The cell that is created.

createCell

public PDFCell createCell(Object object,
 boolean rightAligned)

Creates a cell that can be added to a table.

Parameters:

object - Object that provides the content of the cell - object.toString(). Object can also be either a PDFImage, PDFCell, PDFTable, PDFPhrase or PDFChunk.

rightAligned - Whether the cell is right aligned or not.

Returns:

The cell that is created.

createCell

public PDFCell createCell(Object object,
 boolean rightAligned,
 Function<PDFCell,PDFCell> cellCustomizer)

Creates a cell that can be added to a table.

Parameters:

object - Object that provides the content of the cell - object.toString(). Object can also be either a PDFImage, PDFCell, PDFTable, PDFPhrase, PDFChunk, Image, StreamData or Barcode.

rightAligned - Whether the cell is right aligned or not.

cellCustomizer - Cell customizer. If non-null value is passed, the cell created will be passed through this for further customization.

Returns:

The cell that is created.

createCell

public PDFCell createCell(Object object,
 int horizontalAlignment)

Creates a cell that can be added to a table.

Parameters:

object - Object that provides the content of the cell - object.toString(). Object can also be either a PDFImage, PDFCell, PDFTable, PDFPhrase or PDFChunk.

horizontalAlignment - Alignment value from PDFElement.

Returns:

The cell that is created.

createCell

public PDFCell createCell(Object object,
 int horizontalAlignment,
 Function<PDFCell,PDFCell> cellCustomizer)

Creates a cell that can be added to a table.

Parameters:

object - Object that provides the content of the cell - object.toString(). Object can also be either a PDFImage, PDFCell, PDFTable, PDFPhrase, PDFChunk, Image, StreamData or Barcode.

horizontalAlignment - Alignment value from PDFElement.

cellCustomizer - Cell customizer. If non-null value is passed, the cell created will be passed through this for further customization.

Returns:

The cell that is created.

createCell

public PDFCell createCell(Object object,
 int horizontalAlignment,
 int verticalAlignment)

Creates a cell that can be added to a table.

Parameters:

object - Object that provides the content of the cell - object.toString(). Object can also be either a PDFImage, PDFCell, PDFTable, PDFPhrase or PDFChunk.

horizontalAlignment - Alignment value from PDFElement.

verticalAlignment - Alignment value from PDFElement.

Returns:

The cell that is created.

createCell

public PDFCell createCell(Object object,
 int horizontalAlignment,
 int verticalAlignment,
 Function<PDFCell,PDFCell> cellCustomizer)

Creates a cell that can be added to a table.

Parameters:

object - Object that provides the content of the cell - object.toString(). Object can also be either a PDFImage, PDFCell, PDFTable, PDFPhrase, PDFChunk, Image, StreamData or Barcode.

horizontalAlignment - Alignment value from PDFElement.

verticalAlignment - Alignment value from PDFElement.

cellCustomizer - Cell customizer. If non-null value is passed, the cell created will be passed through this for further customization.

Returns:

The cell that is created.

printPageNumber

public void printPageNumber(boolean print)

Print page number or not.

Parameters:

print - True or false

printPageNumber

public boolean printPageNumber()

Print page number or not.

Returns:

True or false

printTotalPageNumber

public void printTotalPageNumber(boolean print)

Print total page number or not.

Parameters:

print - True or false

printTotalPageNumber

public boolean printTotalPageNumber()

Print total page number or not.

Returns:

True or false

printAuditTrail

public boolean printAuditTrail()

Print audit trail at the bottom of the page

Returns:

True or false

setLogo

public void setLogo(PDFImage image)

setLogo

public void setLogo(Image image)

getLeftMargin

public float getLeftMargin()

Document margin. This is invoked only once to create the document unless newReportStage() is called. Override this to set a different margin.

Returns:

Margin. Default is 36 = 0.5 inch.

getRightMargin

public float getRightMargin()

Document margin. This is invoked only once to create the document unless newReportStage() is called. Override this to set a different margin.

Returns:

Margin. Default is 36 = 0.5 inch.

getTopMargin

public float getTopMargin()

Document margin. This is invoked only once to create the document unless newReportStage() is called. Override this to set a different margin.

Returns:

Margin. Default is 72 = 1 inch.

getBottomMargin

public float getBottomMargin()

Document margin. This is invoked only once to create the document unless newReportStage() is called. Override this to set a different margin.

Returns:

Margin. Default is 72 = 1 inch.

getWidth

public final float getWidth()

Gets the printable width.

Returns:

Width

getHeight

public final float getHeight()

Gets the printable height.

Returns:

Height

getPageSize

public PDFRectangle getPageSize()

Page size. This is invoked only once to create the document unless newReportStage() is called. This is used to control the size of the page. For example, if you want landscape A4 size, simply override this method to return super.getPageSize().rotate().

Returns:

PDFRectangle representing page size. Default is A4 size.

getPageOrientation

public int getPageOrientation()

Page orientation - Portrait or Landscape

Returns:

ORIENTATION_PORTRAIT or ORIENTATION_LANDSCAPE. Default is ORIENTATION_PORTRAIT

createTitleText

public PDFPhrase createTitleText(String title)

Create title Phrase. It will be created with (getFontSize() + 2) Point, Black, Bold, Helvetica font.

Parameters:

title - Title

Returns:

A Phrase that is suitable for drawing titles.

createTitleText

public PDFPhrase createTitleText(String title,
 int pointSize)

Create title Phrase. It will be created with in Black, Bold, Helvetica font.

Parameters:

title - Title

pointSize - Font size

Returns:

A Phrase that is suitable for drawing titles.

createTitleText

public PDFPhrase createTitleText(String title,
 int pointSize,
 PDFColor color)

Create title Phrase. It will be created with in Bold, Helvetica font.

Parameters:

title - Title

pointSize - Font size

color - Color

Returns:

A Phrase that is suitable for drawing titles.

getFooter

public Object getFooter()

Footer to be displayed on each page. This method is invoked only once and the same footer is drawn on all pages unless newReportStage() is called. This could be a String, a PDFCell or any other object from which a PDFCell can be created, including a PDFTable.

Returns:

Default return value is null, meaning nothing will be displayed as page footer.

printLetterHeadOnEveryPage

public void printLetterHeadOnEveryPage(boolean print)

Print letter head on every page or not.

Parameters:

print - True or false

printLetterHeadOnEveryPage

public boolean printLetterHeadOnEveryPage()

Print letter head on every page or not.

Returns:

True or false

createText

public PDFChunk createText(String text)

Create text Chunk. It will be created with in Helvetica font.

Parameters:

text - Text

Returns:

Chunk containing the text.

createText

public PDFChunk createText(String text,
 int pointSize)

Create text Chunk. It will be created with in Helvetica font.

Parameters:

text - Text

pointSize - Font size

Returns:

Chunk containing the text.

createText

public PDFChunk createText(String text,
 int pointSize,
 PDFColor color)

Create text Chunk. It will be created with in Helvetica font.

Parameters:

text - Text

pointSize - Font size

color - Color

Returns:

Chunk containing the text.

setTransactionManager

public final void setTransactionManager(TransactionManager tm)

Sets the Transaction Manager so that the "letter head" can be printed. If this method or setEntity() is not invoked in the letter head mode, letter head will not be printed. Also, this is needed to print water marks on the generated output.

Specified by:

setTransactionManager in interface ContentProducer

Parameters:

tm - The Transaction Manager to be set.

getTransactionManager

public final TransactionManager getTransactionManager()

Gets the Transaction Manager

Specified by:

getTransactionManager in interface ContentProducer

Returns:

Transaction Manager

getFileExtension

public final String getFileExtension()

Gets the file name extension.

Specified by:

getFileExtension in interface ContentProducer

Returns:

"pdf"

setPageNumber

public void setPageNumber(int pageNumber)

Set the page number to a new value.

Parameters:

pageNumber - Page number to be set.

getPageNumber

public int getPageNumber()

Get the current page number.

Returns:

Current page number. Returns 0 if nothing started yet.

addTitles

public void addTitles(PDFTable table,
 Stream<String> titles)

addTitles

public void addTitles(PDFTable table,
 String... titles)

Add title texts to table.

Parameters:

table - Table to which title texts to be added.

titles - Titles

addTitles

public void addTitles(PDFTable table,
 StringList titles)

Add title texts to table.

Parameters:

table - Table to which title texts to be added.

titles - Titles

addTitles

public void addTitles(PDFTable table,
 int pointSize,
 Stream<String> titles)

Add title texts to table.

Parameters:

table - Table to which title texts to be added.

pointSize - Point size of the title.

titles - Titles

addTitles

public void addTitles(PDFTable table,
 int pointSize,
 String... titles)

Add title texts to table.

Parameters:

table - Table to which title texts to be added.

pointSize - Point size of the title.

titles - Titles

addTitles

public void addTitles(PDFTable table,
 int pointSize,
 StringList titles)

Add title texts to table.

Parameters:

table - Table to which title texts to be added.

pointSize - Point size of the title.

titles - Titles

addBlankRow

public void addBlankRow(PDFTable table)

Adds a blank row to the table.

Parameters:

table - Table to which row to be added.

addBlankRow

public void addBlankRow(PDFTable table,
 int fromColumn)

Adds a blank row to the table.

Parameters:

table - Table to which row to be added.

fromColumn - Column from which blank cells to be added.

addBlankRow

public void addBlankRow(PDFTable table,
 int fromColumn,
 int toColumn)

Adds a blank row to the table.

Parameters:

table - Table to which row to be added.

fromColumn - Column from which blank cells to be added.

toColumn - Column up to which blank cells to be added.

addImage

public void addImage(PDFImage image)
              throws PDFException

Add an image at position (0, 0) in the current page.

Parameters:

image - Image to add.

Throws:

PDFException - Exception if not successful.

addImage

public void addImage(PDFImage image,
 float positionX,
 float positionY)
              throws PDFException

Add an image at some absolute position in the current page.

Parameters:

image - Image to add.

positionX - X position (from the left).

positionY - Y position (from the bottom).

Throws:

PDFException - Exception if not successful.

addImage

public void addImage(PDFImage image,
 float positionX,
 float positionY,
 float width,
 float height)
              throws PDFException

Add an image at some absolute position in the current page.

Parameters:

image - Image to add.

positionX - X position (from the left).

positionY - Y position (from the bottom).

width - Width to which image to be fit.

height - Height to which image to be fit.

Throws:

PDFException - Exception if not successful.

addCentered

public void addCentered(Object any)

Add an object to the document. Object can be 'text', a PDFImage, a PDFCell, a PDFTable or anything else.

Parameters:

any - Any object

addGap

public void addGap(int verticalGap)

Add some vertical gap (Typically used to add space before adding a table).

Parameters:

verticalGap - Amount of space to be added

getY

public float getY()

Get the current Y position of the PDF

Returns:

Current Y

getY

public float getY(boolean ensureNewLine)

Get the current Y position of the PDF

Parameters:

ensureNewLine - See whether line feed needs to be considered when computing this.

Returns:

Current Y

drawTable

public boolean drawTable(PDFTable table)

Draw the table at the current position till the end of the page. Table will be shrunk by deleting the rows drawn and the rest of the rows may be drawn again at some other position, may be in another page.

Parameters:

table - Table to be drawn

Returns:

True if all rows are drawn in the current page.

drawTable

public boolean drawTable(PDFTable table,
 float x,
 float y)

Draw the table at the given position till the end of the page. Table will be shrunk by deleting the rows drawn and the rest of the rows may be drawn again at some other position, may be in another page.

Parameters:

table - Table to be drawn

x - X position

y - Y position

Returns:

True if all rows are drawn in the current page.

drawTable

public boolean drawTable(PDFTable table,
 float x1,
 float y1,
 float x2,
 float y2)

Draw the table within the given rectangular area. Table will be shrunk by deleting the rows drawn and the rest of the rows may be drawn again at some other position, may be in another page.

Parameters:

table - Table to be drawn

x1 - Upper left X position

y1 - Upper left Y position

x2 - Lower right X position

y2 - Lower right Y position

Returns:

True if all rows are drawn within the area.

createGraphics

public Graphics2D createGraphics()

Create a graphics object to draw directly to the PDF. Once the drawing is completed, invoke the dispose method.

Returns:

Graphics2D

createGraphics

public Graphics2D createGraphics(float positionX,
 float positionY,
 float width,
 float height)

Create a graphics object to draw directly to the PDF. Once the drawing is completed, invoke the dispose method.

Parameters:

positionX - X position (from the left).

positionY - Y position (from the bottom).

width - Width of the graphics.

height - Height of the graphics.

Returns:

Graphics2D

createImageFromSVG

public static PDFImage createImageFromSVG(String svg)

Create image from SVG

Parameters:

svg - SVG source

Returns:

Image

createImageFromSVG

public static PDFImage createImageFromSVG(String svg,
 int width,
 int height)

Create image from SVG

Parameters:

svg - SVG source

width - Image width

height - Image height

Returns:

Image

createImage

public PDFImage createImage(Consumer<Graphics2D> painter)

Create a PDF image where a painter decides how to paint the image.

Parameters:

painter - The painter whose accept method is invoked with a Graphics2D object do the painting

Returns:

PDF image that covers the full page.

createImage

public PDFImage createImage(Consumer<Graphics2D> painter,
 int width,
 int height)

Create a PDF image where a painter decides how to paint the image.

Parameters:

painter - The painter whose accept method is invoked with a Graphics2D object do the painting

width - Width of the image

height - Height of the image

Returns:

PDF image.

createImage

public static PDFImage createImage(Barcode barcode)

Create image from barcode

Parameters:

barcode - Barcode

Returns:

Image

createImage

public static PDFImage createImage(Signature signature)

Create image from a signature instance

Parameters:

signature - Signature

Returns:

Image

createImage

public static PDFImage createImage(StreamData streamData)

Create image from stream data

Parameters:

streamData - Stream data

Returns:

Image

createImage

public static PDFImage createImage(InputStream stream)

Create image from an input stream (stream will be closed)

Parameters:

stream - Input stream

Returns:

Image

createImage

public static PDFImage createImage(Image image)

Create image from Java AWT image

Parameters:

image - AWT image

Returns:

Image

addHTML

public void addHTML(String html)

Add HTML content to the rest of the page

Parameters:

html - HTML content

addHTML

public void addHTML(String html,
 StringFiller filler)

Add HTML content to the rest of the page

Parameters:

html - HTML content

filler - Filler to fill up the html text

addHTML

public void addHTML(String html,
 int width,
 int height)

Add HTML content at the current position with the given width and height

Parameters:

html - HTML content

width - Width

height - Height

addHTML

public void addHTML(String html,
 int positionX,
 int positionY,
 int width,
 int height)

Add HTML content at the given position with the given width and height

Parameters:

html - HTML content

positionX - Position X

positionY - Position Y

width - Width

height - Height

addHTML

public void addHTML(String html,
 StringFiller filler,
 int width,
 int height)

Add HTML content at the current position with the given width and height

Parameters:

html - HTML content

filler - Filler to fill up the html text

width - Width

height - Height

addHTML

public void addHTML(String html,
 StringFiller filler,
 int positionX,
 int positionY,
 int width,
 int height)

Add HTML content at the given position with the given width and height

Parameters:

html - HTML content

filler - Filler to fill up the html text

positionX - Position X

positionY - Position Y

width - Width

height - Height

createImageFromHTML

public static PDFImage createImageFromHTML(String html)

Create image from HTML

Parameters:

html - HTML content

Returns:

Image

createImageFromHTML

public static PDFImage createImageFromHTML(String html,
 StringFiller filler)

Create image from HTML

Parameters:

html - HTML content

filler - Filler to fill up the html text

Returns:

Image

createImageFromHTML

public static PDFImage createImageFromHTML(String html,
 int width,
 int height)

Create image from HTML

Parameters:

html - HTML content

width - Image width

height - Image height

Returns:

Image

createImageFromHTML

public static PDFImage createImageFromHTML(String html,
 StringFiller filler,
 int width,
 int height)

Create image from HTML

Parameters:

html - HTML content

filler - Filler to fill up the html text

width - Image width

height - Image height

Returns:

Image

createImage

public static PDFImage createImage(HTMLText html)

Create image from HTML

Parameters:

html - HTML content

Returns:

Image

createImage

public static PDFImage createImage(HTMLText html,
 int width,
 int height)

Create image from HTML

Parameters:

html - HTML content

width - Image width

height - Image height

Returns:

Image

newPage

public boolean newPage()

Create and add a new page

Returns:

True if the page is created and added

getUser

public SystemUser getUser()

Get the user for which this PDF is being generated. This information will be used for formatting the money values.

Returns:

User.

pageStarted

public void pageStarted()

This method will be called whenever a new page is started. This can be overridden for customizing the page.

pageCompleted

public void pageCompleted()

This method will be called whenever a page is completed. This can be overridden for customizing the page.

getWaterMark

public String getWaterMark()

Gets the currently set water mark.

Returns:

Current water mark if any, otherwise null will be returned.

setWaterMark

public void setWaterMark(String waterMark)

Sets the water mark.

Parameters:

waterMark - Water mark text.

showText

public void showText(String text,
 int x,
 int y,
 int alignment,
 float rotation,
 PDFFont font,
 float fontSize,
 PDFColor color,
 float opacity)

Show text at some specified position.

Parameters:

text - Text to be shown.

x - X position.

y - Y position.

alignment - Alignment - Use PDFElement.ALIGN_CENTER etc.

rotation - Angle of rotation.

font - Font to be used, pass 'null' if base font to be used.

fontSize - Font size in points.

color - Color to be used for the text.

opacity - Opacity to be used. (A value between 0.0 to 1.0).

setError

public final void setError(String error)

Set additional error information such that it will be printed in the log when an error happens. Any error thrown when generating reports will be dumped to the report output and system log.

Parameters:

error - Error information.

dumpError

public final void dumpError(Throwable error)

Dump the error that happened during reporting.

Parameters:

error - Error o dump.

log

public final void log(Object anything)

Log something via the logger associated with this report.

Parameters:

anything - Anything to log.

getDevice

public Device getDevice()

readContent

public PDF.PDFContent readContent(InputStream content)
                           throws IOException

Reads and creates a 'Content' object from the stream containing PDF data.

Parameters:

content - Stream containing PDF. It could be from a PDF file or database.

Returns:

This

Throws:

IOException - The stream may raise this exception.