Package com.storedobject.pdf

Class PDFReport

java.lang.Object

com.storedobject.pdf.PDF

com.storedobject.pdf.PDFReport

All Implemented Interfaces:

Executable, ContentProducer, ContentType, RequiresTransactionManager, Closeable, AutoCloseable, Runnable

Direct Known Subclasses:

AccountStatement, CombinedPDFReport, FileCirculationStatus, FileExpiryReport, ItemMovementReport, JournalReport, ObjectGridReport, ObjectList, PDFObjectReport, StockAvailability, StockMovementReport, StockReport, TrialBalance

public abstract class PDFReport
extends PDF

A PDF class used for generating reports.

Author:

Syam

Nested Class Summary

Nested classes/interfaces inherited from class com.storedobject.pdf.PDF

PDF.ObjectFormTable<T extends StoredObject>, PDF.ObjectTable<T extends StoredObject>, PDF.PDFContent, PDF.Text

Field Summary

Fields inherited from class com.storedobject.pdf.PDF

ORIENTATION_LANDSCAPE, ORIENTATION_PORTRAIT, pageSizes

Constructor Summary

Constructors

Constructor	Description
PDFReport(Device device)	Constructor.
PDFReport(Device device, boolean letterhead)	Constructor.
PDFReport(Device device, boolean letterhead, boolean printLogo)	Constructor.

Method Summary

Modifier and Type	Method	Description
PDFTable	createTitleTable(HasContacts hasContacts, Iterable<String> captions)	This is a helper method to create a "title table" from a HasContacts instance.
PDFTable	createTitleTable(HasContacts hasContacts, String... captions)	This is a helper method to create a "title table" from a HasContacts instance.
PDFTable	createTitleTable(Iterable<String> captions)	This is a helper method to create a "title table" from a list of captions.
PDFTable	createTitleTable(String... captions)	This is a helper method to create a "title table" from a list of captions.
void	execute()	The functional interface method specified by this interface.
void	execute(String caption)	Generate the content and view it on the device with a caption.
InputStream	extractContent()
Device	getDevice()	Get the device on which content will be rendered on.
PDFImage	getLogo()	Get the configured logo of the organization (could be null).
String	getLogoName()	Get the name of the configured logo of the organization.
int	getLogoPosition()	Get the position of the logo in this report.
PDFImage	getProductLogo()	Get the configured logo of the product (could be null).
String	getProductLogoName()	Get the name of the configured product logo of the organization.
Object	getTitle()	Get the "title" part of the report.
PDFTable	getTitleTable()	Get the "title table" part of the report.
Object	getTitleText()	Get the "title text" part that was set by setTitleText(Object).
SystemUser	getUser()	Get the user for which this PDF is being generated.
void	setTitleText(Object title)	Set the "title text" part of the report.
void	view()	View the content on the device.

Methods inherited from class com.storedobject.pdf.PDF

aboutToAddExternalContent, add, add, add, add, addBlankRow, addBlankRow, addBlankRow, addBlankRow, addBlankRow, addBlankRow, addCentered, addContent, addContent, addContent, addContent, addContent, addContent, addContent, addContent, addContent, addContent, addGap, addHTML, addHTML, addHTML, addHTML, addHTML, addHTML, addImage, addImage, addImage, addingExternalContent, addTitles, addTitles, addTitles, addTitles, addTitles, addTitles, addToTable, addToTable, addToTable, addToTable, addToTable, addToTable, addToTable, addToTable, addToTableCentered, addToTableCentered, chainTo, close, createCell, createCell, createCell, createCell, createCell, createCell, createCell, createCell, createCenteredCell, createCenteredCell, createGraphics, createGraphics, createImage, createImage, createImage, createImage, createImage, createImage, createImage, createImage, createImage, createImageFromHTML, createImageFromHTML, createImageFromHTML, createImageFromHTML, createImageFromSVG, createImageFromSVG, createTable, createTable, createText, createText, createText, createTitleText, createTitleText, createTitleText, drawTable, drawTable, drawTable, dumpError, generateContent, getBottomMargin, getContent, getContentType, getEntity, getEntityLocation, getEntityName, getFileExtension, getFileName, getFontSize, getFooter, getHeight, getLeftMargin, getPageNumber, getPageOrientation, getPageSize, getPageSize, getPageSizeIndex, getReportFormat, getReportStage, getRightMargin, getTopMargin, getTransactionManager, getWaterMark, getWidth, getY, getY, log, newPage, newReportStage, newReportStage, open, pageCompleted, pageStarted, printAuditTrail, printLetterHeadOnEveryPage, printLetterHeadOnEveryPage, printPageNumber, printPageNumber, printTotalPageNumber, printTotalPageNumber, produce, readContent, setDefaultCellCustomizer, setEntity, setError, setFontSize, setLanguage, setLanguage, setLogo, setLogo, setPageNumber, setPageSizeIndex, setPassword, setReportFormat, setTransactionManager, setWaterMark, showText, toCharCount

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, 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

Constructor Details

PDFReport

public PDFReport(Device device)

Constructor.

Parameters:

device - Device on which the output will be rendered when viewing.

PDFReport

public PDFReport(Device device,
 boolean letterhead)

Constructor.

Parameters:

device - Device on which the output will be rendered when viewing.

letterhead - Whether default letterhead needs to be printed or not.

PDFReport

public PDFReport(Device device,
 boolean letterhead,
 boolean printLogo)

Constructor.

Parameters:

device - Device on which the output will be rendered when viewing.

letterhead - Whether default letterhead needs to be printed or not.

printLogo - Whether default logo needs to be printed or not.

Method Details

extractContent

public InputStream extractContent()
                           throws Exception

Throws:

Exception

execute

public void execute()

Description copied from interface: Executable

The functional interface method specified by this interface.

execute

public void execute(String caption)

Generate the content and view it on the device with a caption.

Parameters:

caption - Caption.

view

public void view()

View the content on the device.

getUser

public SystemUser getUser()

Description copied from class: PDF

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

Overrides:

getUser in class PDF

Returns:

User.

getDevice

public Device getDevice()

Get the device on which content will be rendered on.

Overrides:

getDevice in class PDF

Returns:

The device.

getLogo

public PDFImage getLogo()

Get the configured logo of the organization (could be null).

Returns:

The configured logo.

getLogoName

public String getLogoName()

Get the name of the configured logo of the organization.

Returns:

Name of the logo. You may override this to print another logo.

getProductLogo

public PDFImage getProductLogo()

Get the configured logo of the product (could be null).

Returns:

The configured product logo.

getProductLogoName

public String getProductLogoName()

Get the name of the configured product logo of the organization.

Returns:

Name of the product logo. You may override this to print another logo.

getLogoPosition

public int getLogoPosition()

Get the position of the logo in this report. By default, it looks for the "report format" configuration from which this value can be obtained. See ReportFormat.

Returns:

Position.

getTitle

public Object getTitle()

Get the "title" part of the report. By default, title part is a PDFTable created from the configured logos (customer logo and product logo) and the "title table" part returned by the getTitleTable() method. However, this method is usually not overridden unless you want to create a report that doesn't include printing of logos etc. So, if you override this method, then, the getTitleTable() is never used (unless you use it within your overridden method).

Overrides:

getTitle in class PDF

Returns:

You can return anything and that will be converted appropriately to create the title part of the report.

setTitleText

public void setTitleText(Object title)

Set the "title text" part of the report. The value set by this method is returned by the getTitleText() method and used by the getTitleTable() method.

Note: Please make sure that this method is invoked from within the constructor itself because it will not have any effect if invoked from any other position.

Parameters:

title - Title text part of the report. Can be anything and will be converted appropriately.

getTitleText

public Object getTitleText()

Get the "title text" part that was set by setTitleText(Object). (If nothing was ever set, null will be returned.

Returns:

"Title text" part of the report. (This is used by getTitleTable() method).

getTitleTable

public PDFTable getTitleTable()

Get the "title table" part of the report. It builds a PDFTable from the "title text" part returned by the getTitleText() method. The getTitle() method uses the return value of this to build the "title" part of the report.

Typically, you may override this method and return one of the createTitleTable methods

Example:

   public PDFTable getTitleTable() {
       return createTitleTable("Stock Report", "Dated: Nov 15, 2021", "Store: Main Store");
   }
 

Returns:

"Title table" part of the report.

createTitleTable

public PDFTable createTitleTable(Iterable<String> captions)

This is a helper method to create a "title table" from a list of captions. The getTitleTable() can use this to create a "title table" quickly with no HasContacts details because the address part of the "letter head" is already in the header-image.

Parameters:

captions - Caption to be printed. The fist caption will be more highlighted than the subsequent ones.

Returns:

A table instance that can be used as a "title table".

createTitleTable

public PDFTable createTitleTable(String... captions)

This is a helper method to create a "title table" from a list of captions. The getTitleTable() can use this to create a "title table" quickly with no HasContacts details because the address part of the "letter head" is already in the header-image.

Parameters:

captions - Caption to be printed. The fist caption will be more highlighted than the subsequent ones.

Returns:

A table instance that can be used as a "title table".

createTitleTable

public PDFTable createTitleTable(HasContacts hasContacts,
 Iterable<String> captions)

This is a helper method to create a "title table" from a HasContacts instance. The getTitleTable() can use this to create a "title table" quickly.

Parameters:

hasContacts - Contact instance. The name and address will be printed from this.

captions - Caption to be printed. The fist caption will be more highlighted than the subsequent ones.

Returns:

A table instance that can be used as a "title table".

createTitleTable

public PDFTable createTitleTable(HasContacts hasContacts,
 String... captions)

This is a helper method to create a "title table" from a HasContacts instance. The getTitleTable() can use this to create a "title table" quickly.

Parameters:

hasContacts - Contact instance. The name and address will be printed from this.

captions - Caption to be printed. The fist caption will be more highlighted than the subsequent ones.

Returns:

A table instance that can be used as a "title table".