com.pega.pegarules.pub.util

Interface PDFUtils

public interface PDFUtils

Utilities for PDF generation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static java.lang.String	PARAM_CLEARCACHE isClearCache: enable clearing the conversion cache
static java.lang.String	PARAM_EMBEDFONT pyPDFEmbedFont: true/false.
static java.lang.String	PARAM_ENABLEHYPERLINKS pyPDFEnableHyperlinks: true/false.
static java.lang.String	PARAM_ENABLESMARTTABLEBREAKS pyEnableSmartTableBreaks: enable smart table breaks
static java.lang.String	PARAM_FONTSDIR pyPDFFontsDirectory: The fonts directory
static java.lang.String	PARAM_FOOTER footer: page number template for footer
static java.lang.String	PARAM_FOOTERHTML pyPDFFooterHTMLTemplate: optional HTML template for footer in PDF
static java.lang.String	PARAM_GENTOOLTIPS pyGenerateToolTips: generate tooltips
static java.lang.String	PARAM_HALT_ERR HaltOnHTMLError: throw exception if we detect an error during html processing
static java.lang.String	PARAM_HALT_WARN HaltOnHTMLWarning: throw an exception if we detect a warning during html processing
static java.lang.String	PARAM_HEADER header: page number template for header
static java.lang.String	PARAM_HEADERHTML pyPDFHeaderHTMLTemplate: optional HTML template for header in PDF
static java.lang.String	PARAM_HTML_WIDTH html width is used to increase decrease the font size
static java.lang.String	PARAM_HTMLDISABLEPROCESSING pyHTMLDisableProcessing: true/false.
static java.lang.String	PARAM_KEEPPROPS pyKeepPropsFile: optionally keep pd4ml properties after processing
static java.lang.String	PARAM_ORIENTATION pyPDFPageOrientation : landscape/portrait default is landscape
static java.lang.String	PARAM_OUTLINES pyEnableOutlines: enable support for PDF Bookmarks and Outlines
static java.lang.String	PARAM_PAGESIZE pyPDFPageSize :A4/LETTER/LEGAL default is A4
static java.lang.String	PARAM_PDFA pyPDFGeneratePDFA: true/false.
static java.lang.String	PARAM_PROPSDIR pyPDFPropsDirectory: optional directory for pd4ml properties file
static java.lang.String	PARAM_SHOWWARNING pyShowTidyWarmnngs : optionally show tidy warning while processing
static java.lang.String	PARAM_START_PAGE startPage: starting number (offset) for page numbering
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
byte[]	generatePDF(java.lang.String htmlStream) Returns an byte array using the export data
byte[]	generatePDF(java.lang.String aHtmlStream, StringMap options) Generates the PDF given the HTML Stream and formatting options Formatting options are declared as constants with the "PARAM_" prefix in this interface.

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

PARAM_PAGESIZE

static final java.lang.String PARAM_PAGESIZE

pyPDFPageSize :A4/LETTER/LEGAL default is A4

See Also:

Constant Field Values

PARAM_ORIENTATION

static final java.lang.String PARAM_ORIENTATION

pyPDFPageOrientation : landscape/portrait default is landscape

See Also:

Constant Field Values

PARAM_FONTSDIR

static final java.lang.String PARAM_FONTSDIR

pyPDFFontsDirectory: The fonts directory

See Also:

Constant Field Values

PARAM_EMBEDFONT

static final java.lang.String PARAM_EMBEDFONT

pyPDFEmbedFont: true/false. Default is false

See Also:

Constant Field Values

PARAM_ENABLEHYPERLINKS

static final java.lang.String PARAM_ENABLEHYPERLINKS

pyPDFEnableHyperlinks: true/false. Default is false

See Also:

Constant Field Values

PARAM_PDFA

static final java.lang.String PARAM_PDFA

pyPDFGeneratePDFA: true/false. Default is false

See Also:

Constant Field Values

PARAM_HTMLDISABLEPROCESSING

static final java.lang.String PARAM_HTMLDISABLEPROCESSING

pyHTMLDisableProcessing: true/false. Default is false

See Also:

Constant Field Values

PARAM_PROPSDIR

static final java.lang.String PARAM_PROPSDIR

pyPDFPropsDirectory: optional directory for pd4ml properties file

See Also:

Constant Field Values

PARAM_KEEPPROPS

static final java.lang.String PARAM_KEEPPROPS

pyKeepPropsFile: optionally keep pd4ml properties after processing

See Also:

Constant Field Values

PARAM_HEADERHTML

static final java.lang.String PARAM_HEADERHTML

pyPDFHeaderHTMLTemplate: optional HTML template for header in PDF

See Also:

Constant Field Values

PARAM_FOOTERHTML

static final java.lang.String PARAM_FOOTERHTML

pyPDFFooterHTMLTemplate: optional HTML template for footer in PDF

See Also:

Constant Field Values

PARAM_HALT_ERR

static final java.lang.String PARAM_HALT_ERR

HaltOnHTMLError: throw exception if we detect an error during html processing

See Also:

Constant Field Values

PARAM_HALT_WARN

static final java.lang.String PARAM_HALT_WARN

HaltOnHTMLWarning: throw an exception if we detect a warning during html processing

See Also:

Constant Field Values

PARAM_GENTOOLTIPS

static final java.lang.String PARAM_GENTOOLTIPS

pyGenerateToolTips: generate tooltips

See Also:

Constant Field Values

PARAM_ENABLESMARTTABLEBREAKS

static final java.lang.String PARAM_ENABLESMARTTABLEBREAKS

pyEnableSmartTableBreaks: enable smart table breaks

See Also:

Constant Field Values

PARAM_CLEARCACHE

static final java.lang.String PARAM_CLEARCACHE

isClearCache: enable clearing the conversion cache

See Also:

Constant Field Values

PARAM_FOOTER

static final java.lang.String PARAM_FOOTER

footer: page number template for footer

See Also:

Constant Field Values

PARAM_HEADER

static final java.lang.String PARAM_HEADER

header: page number template for header

See Also:

Constant Field Values

PARAM_START_PAGE

static final java.lang.String PARAM_START_PAGE

startPage: starting number (offset) for page numbering

See Also:

Constant Field Values

PARAM_OUTLINES

static final java.lang.String PARAM_OUTLINES

pyEnableOutlines: enable support for PDF Bookmarks and Outlines

See Also:

Constant Field Values

PARAM_HTML_WIDTH

static final java.lang.String PARAM_HTML_WIDTH

html width is used to increase decrease the font size

See Also:

Constant Field Values

PARAM_SHOWWARNING

static final java.lang.String PARAM_SHOWWARNING

pyShowTidyWarmnngs : optionally show tidy warning while processing

See Also:

Constant Field Values

Method Detail

generatePDF

byte[] generatePDF(java.lang.String htmlStream)

Returns an byte array using the export data

Parameters:

htmlStream -

Returns:

byte array[]

generatePDF

byte[] generatePDF(java.lang.String aHtmlStream,
                   StringMap options)

Generates the PDF given the HTML Stream and formatting options Formatting options are declared as constants with the "PARAM_" prefix in this interface. Some example constants are: PARAM_ORIENTATION, PARAM_PAGESIZE

Parameters:

aHtmlStream - the html stream

options - the rendering options

Returns:

a byte array containing the PDF data