com.konakartadmin.blif

Interface AdminPdfMgrIf

All Known Implementing Classes:

AdminPdfMgr

public interface AdminPdfMgrIf

AdminPdfMgrIf

Method Summary

Modifier and Type	Method and Description
void	createPDFFromHTML(PdfOptions options, java.lang.String html, java.lang.String pdfFileName) Created the PDF file from the specified HTML String
PdfResult	getPdf(PdfOptions options) Create the PDF document and return the URL, File name or bytes as defined by the input options.
java.lang.String	modifyHtml(java.lang.String html) A customisation point to allow for modification of the HTML prior to being converted to PDF
void	refreshConfigs() Retrieve some commonly-used properties and set the velocity log file location

Method Detail

getPdf

PdfResult getPdf(PdfOptions options)
          throws java.lang.Exception

Create the PDF document and return the URL, File name or bytes as defined by the input options.

Parameters:

options - the options that define the PDF report to be produced and what is returned from this interface. If the html attribute on PdfOptions is set this is used as the source for the PDF otherwise getHtml on the AdminHgetAdminHtmlMgr is called to produce the HTML.

Returns:

a PdfResult object containing information that is defined in the options specified on input.

Throws:

java.lang.Exception - an unexpected exception

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Retrieve some commonly-used properties and set the velocity log file location

Throws:

java.lang.Exception - an unexpected exception

modifyHtml

java.lang.String modifyHtml(java.lang.String html)
                     throws java.lang.Exception

A customisation point to allow for modification of the HTML prior to being converted to PDF

Parameters:

html - the HTML to modify

Returns:

the modified HTML

Throws:

java.lang.Exception - an unexpected exception

createPDFFromHTML

void createPDFFromHTML(PdfOptions options,
                       java.lang.String html,
                       java.lang.String pdfFileName)
                throws java.lang.Exception

Created the PDF file from the specified HTML String

Parameters:

options - the PdfOptions options object which might one day be used to affect the PDF generation if this method is overriden.

html - the HTML String to convert into a PDF file

pdfFileName - the target pdfFileName

Throws:

java.lang.Exception - an unexpected exception