net.windward.xmlreport

Interface ProcessPdfAPI

All Superinterfaces:

ProcessReportAPI, ProcessReportAPIBase

All Known Implementing Classes:

ProcessPdf

Deprecated.

Use ProcessPdf instead.

public interface ProcessPdfAPI
extends ProcessReportAPI

This class is a subclass of ProcessReportAPI specifically for creating an output in the pdf format.

Version:

2.0 2 January 2004

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALLOW_ALL Deprecated. Allow everything.
static int	ALLOW_ASSEMBLY Deprecated. Allow assembly of the pdf report.
static int	ALLOW_COPY Deprecated. Allow copy (cut & paste) of the pdf report.
static int	ALLOW_DEGRADED_PRINTING Deprecated. Allow degraded printing of the pdf report.
static int	ALLOW_FILL_IN Deprecated. Allow fill-in of the pdf report.
static int	ALLOW_MOD_ANNOTATIONS Deprecated. Allow modifications of annotations in the pdf report.
static int	ALLOW_MOD_CONTENTS Deprecated. Allow modification of contents in the pdf report.
static int	ALLOW_NONE Deprecated. Allow nothing.
static int	ALLOW_PRINTING Deprecated. Allow printing the pdf report.
static int	ALLOW_SCREEN_READERS Deprecated. Allow screen capture of the pdf report.
static int	COMP_FAST Deprecated. Fast compression.
static int	COMP_MAX Deprecated. Maximum compression.
static int	COMP_NONE Deprecated. No compression.
static int	FONT_EMBEDED Deprecated. Will use the font specified in the template and will embed the font in the final pdf file.
static int	FONT_INTERNAL Deprecated. Will only use the Acrobat internal fonts which are Helvetica (Arial), Times-Roman, Courier, Symbol, and Zapfdingbats.
static int	FONT_NO_EMBED Deprecated. Will use the font specified in the template but will not embed the font itself in the pdf file.
static java.lang.String	VERSION_1_2 Deprecated. Create a PDF version 1.2 report.
static java.lang.String	VERSION_1_3 Deprecated. Create a PDF version 1.3 report.
static java.lang.String	VERSION_1_4 Deprecated. Create a PDF version 1.4 report.
static java.lang.String	VERSION_1_5 Deprecated. Create a PDF version 1.5 report.
static java.lang.String	VERSION_1_6 Deprecated. Create a PDF version 1.6 report.
static java.lang.String	VERSION_1_7 Deprecated. Create a PDF version 1.7 report.

Fields inherited from interface net.windward.xmlreport.ProcessReportAPI

CHARSET_DEFAULT, CHARSET_RTF, CHARSET_UNICODE, COPY_METADATA_ALWAYS, COPY_METADATA_IF_NO_DATASOURCE, COPY_METADATA_NEVER, DATA_MODE_ALL_ATTRIBUTES, DATA_MODE_DATA, DATA_MODE_EMBED, DATA_MODE_INCLUDE_BITMAPS, DATA_MODE_SELECT, ERROR_HANDLING_ALL, ERROR_HANDLING_NONE, ERROR_HANDLING_ONLY, ERROR_HANDLING_TRACK_ERRORS, ERROR_HANDLING_VERIFY, HIDDEN_IGNORE_PRINT_RANGE, HIDDEN_SHOW_ALL_ROWS_COLUMNS, HIDDEN_SHOW_HIDDEN_SHEETS, HIDDEN_SHOW_NO_PRINT, HYPHENATE_OFF, HYPHENATE_ON, HYPHENATE_TEMPLATE, LOCALE_DEFAULT, LOCALE_SYSTEM, MODE_PROCESS_EMBEDDED_ALWAYS, MODE_PROCESS_EMBEDDED_COPY, MODE_PROCESS_EMBEDDED_DROP, MODE_PROCESS_EMBEDDED_IF_DATA_APPLIED, MODE_PROCESS_EMBEDDED_KEEP_ORIGINAL_SCREENSHOT, RENDER_EXTENT_ALL, RENDER_EXTENT_CROP_EVERYTHING, RENDER_EXTENT_CROP_HEADER_AND_FOOTER, RENDER_EXTENT_CROP_MARGINS, RENDER_EXTENT_CROP_TO_CONTENT, TAG_STYLE_FIELD, TAG_STYLE_FIELD_2007, TAG_STYLE_TEXT, TYP_CSV, TYP_DOCX, TYP_HTML, TYP_IMAGE, TYP_PDF, TYP_PPTX, TYP_PRINTER, TYP_PS, TYP_RTF, TYP_TXT, TYP_XLSX

Method Summary

Modifier and Type	Method and Description
int	getCompressionLevel() Deprecated. Get the compression level.
int	getFontLevel() Deprecated. Get the font level.
int	getKeyLength() Deprecated. Get the password licenseKey length.
java.lang.String	getOwnerPassword() Deprecated. Get the owner password for the report.
java.lang.String	getPdfVersion() Deprecated. Gets the PDF version number used to create the file.
int	getReportType() Deprecated. Get the report format of the output stream.
int	getSecurity() Deprecated. Get the security for the created pdf report.
java.lang.String	getUserPassword() Deprecated. Get the user password for the report.
boolean	isPdfA() Deprecated. true if build a PDF/A-1b file.
void	setCompressionLevel(int level) Deprecated. Set the compression level.
void	setFontLevel(int level) Deprecated. Set the font level.
void	setKeyLength(int keyLength) Deprecated. Set the password licenseKey length.
void	setOwnerPassword(java.lang.String password) Deprecated. Set the owner password for the report.
void	setPdfA(boolean pdfaMode) Deprecated. true if build a PDF/A-1b file.
void	setPdfVersion(java.lang.String version) Deprecated. Gets the PDF version number used to create the file.
void	setSecurity(int security) Deprecated. Set the security for the created pdf report.
void	setUserPassword(java.lang.String password) Deprecated. Set the user password for the report.

Methods inherited from interface net.windward.xmlreport.ProcessReportAPIBase

batchNext, batchSetup, buildSchema, close, duplicate, findPodsUsed, getBaseDirectory, getCharset, getCopyMetadata, getDataMode, getDataStream, getDescription, getDrillDownInfo, getErrorInfo, getEventHandler, getHiddenMode, getHyphenate, getImportInfo, getKeywords, getLocale, getModeProcessEmbedded, getNumPages, getOutputBuilder, getOutputBuilderData, getParameters, getProperties, getRenderExtent, getRenderPages, getReport, getReportTypeString, getSubject, getTemplateVersion, getTimeout, getTitle, getWriteTags, hasProcessedTags, isDebugMode, isLayoutDocument, isPageBasedReport, isPreservePodFraming, isRemoveUnusedFormats, isReportTypeExcel, isReportTypeWord, isTrackImports, isUseExternalOutputBuilder, process, processComplete, processData, processData, processSetup, processSetup, setBaseDirectory, setCharset, setCopyMetadata, setDataMode, setDataStream, setDebugMode, setDescription, setDrillDownInfo, setEventHandler, setHiddenMode, setHyphenate, setKeywords, setLayoutDocument, setLicense, setLocale, setModeProcessEmbedded, setOutputBuilder, setOutputBuilderData, setParameters, setPreservePodFraming, setRemoveUnusedFormats, setRenderExtent, setRenderPages, setSubject, setTemplateVersion, setTimeout, setTitle, setTrackErrors, setTrackImports, setUseExternalOutputBuilder, setWriteTags

Field Detail

FONT_INTERNAL

static final int FONT_INTERNAL

Deprecated.

Will only use the Acrobat internal fonts which are Helvetica (Arial), Times-Roman, Courier, Symbol, and Zapfdingbats. All fonts will be mapped to one of these five fonts.

See Also:

Constant Field Values

FONT_NO_EMBED

static final int FONT_NO_EMBED

Deprecated.

Will use the font specified in the template but will not embed the font itself in the pdf file. This adds very little to the size of the final file. However, if Acrobat cannot create a font for the filename specified, it will not display the final file.

See Also:

Constant Field Values

FONT_EMBEDED

static final int FONT_EMBEDED

Deprecated.

Will use the font specified in the template and will embed the font in the final pdf file. This will provide the most accurate final pdf file and all fonts can be rendered. However, it makes the final file a lot larger. (This is the default.)

See Also:

Constant Field Values

COMP_NONE

static final int COMP_NONE

Deprecated.

No compression. Fine for small files and where bandwidth is not an issue and processing time is.

See Also:

Constant Field Values

COMP_FAST

static final int COMP_FAST

Deprecated.

Fast compression. Will perform any compression that reduces the final file size significantly and does not take that much processing time. This provides a good balance between processing time and file size.

See Also:

Constant Field Values

COMP_MAX

static final int COMP_MAX

Deprecated.

Maximum compression. Will compress everything with the best compression algorithm for each block. This will take significant processing time but will produce the smallest final file. Best for situations where bandwidth is a major issue.

See Also:

Constant Field Values

ALLOW_NONE

static final int ALLOW_NONE

Deprecated.

Allow nothing.

See Also:

Constant Field Values

ALLOW_ASSEMBLY

static final int ALLOW_ASSEMBLY

Deprecated.

Allow assembly of the pdf report.

See Also:

Constant Field Values

ALLOW_COPY

static final int ALLOW_COPY

Deprecated.

Allow copy (cut & paste) of the pdf report.

See Also:

Constant Field Values

ALLOW_DEGRADED_PRINTING

static final int ALLOW_DEGRADED_PRINTING

Deprecated.

Allow degraded printing of the pdf report.

See Also:

Constant Field Values

ALLOW_FILL_IN

static final int ALLOW_FILL_IN

Deprecated.

Allow fill-in of the pdf report.

See Also:

Constant Field Values

ALLOW_MOD_ANNOTATIONS

static final int ALLOW_MOD_ANNOTATIONS

Deprecated.

Allow modifications of annotations in the pdf report.

See Also:

Constant Field Values

ALLOW_MOD_CONTENTS

static final int ALLOW_MOD_CONTENTS

Deprecated.

Allow modification of contents in the pdf report.

See Also:

Constant Field Values

ALLOW_PRINTING

static final int ALLOW_PRINTING

Deprecated.

Allow printing the pdf report.

See Also:

Constant Field Values

ALLOW_SCREEN_READERS

static final int ALLOW_SCREEN_READERS

Deprecated.

Allow screen capture of the pdf report.

See Also:

Constant Field Values

ALLOW_ALL

static final int ALLOW_ALL

Deprecated.

Allow everything.

See Also:

Constant Field Values

VERSION_1_2

static final java.lang.String VERSION_1_2

Deprecated.

Create a PDF version 1.2 report.

See Also:

Constant Field Values

VERSION_1_3

static final java.lang.String VERSION_1_3

Deprecated.

Create a PDF version 1.3 report.

See Also:

Constant Field Values

VERSION_1_4

static final java.lang.String VERSION_1_4

Deprecated.

Create a PDF version 1.4 report.

See Also:

Constant Field Values

VERSION_1_5

static final java.lang.String VERSION_1_5

Deprecated.

Create a PDF version 1.5 report.

See Also:

Constant Field Values

VERSION_1_6

static final java.lang.String VERSION_1_6

Deprecated.

Create a PDF version 1.6 report.

See Also:

Constant Field Values

VERSION_1_7

static final java.lang.String VERSION_1_7

Deprecated.

Create a PDF version 1.7 report.

See Also:

Constant Field Values

Method Detail

getReportType

int getReportType()

Deprecated.

Get the report format of the output stream.

Specified by:

getReportType in interface ProcessReportAPIBase

Returns:

The type (format) of the output report. Will be TYP_PDF.

setFontLevel

void setFontLevel(int level)

Deprecated.

Set the font level. Basically a higher font level means a more accurate final pdf file - but also a large one. The choices are:

• 0 - Will only use the Acrobat internal fonts which are Helvetica (Arial), Times-Roman, Courier, Symbol, and Zapfdingbats. All fonts will be mapped to one of these five fonts.
• 1 - (default) Will use the font specified in the template but will not embed the font itself in the pdf file. This adds very little to the size of the final file. However, if Acrobat cannot create a font for the filename specified, it will not display the final file.
• 2 - Will use the font specified in the template and will embed the font in the final pdf file. This will provide the most accurate final pdf file and all fonts can be rendered. However, it makes the final file a lot larger.

Parameters:

level - The font level. Can be 0 - 2.

getFontLevel

int getFontLevel()

Deprecated.

Get the font level. Basically a higher font level means a more accurate final pdf file - but also a large one. The choices are:

• 0 - Will only use the Acrobat internal fonts which are Helvetica (Arial), Times-Roman, Courier, Symbol, and Zapfdingbats. All fonts will be mapped to one of these five fonts.
• 1 - Will use the font specified in the template but will not embed the font itself in the pdf file. This adds very little to the size of the final file. However, if Acrobat cannot create a font for the filename specified, it will not display the final file.
• 2 - Will use the font specified in the template and will embed the font in the final pdf file. This will provide the most accurate final pdf file and all fonts can be rendered. However, it makes the final file a lot larger.

Returns:

The font level. Will be 0 - 2.

setCompressionLevel

void setCompressionLevel(int level)

Deprecated.

Set the compression level. Basically a higher compression level means a smaller final pdf file - but also a longer processing time. The choices are:

• 0 - No compression. Fine for small files and where bandwidth is not an issue and processing time is.
• 1 - (default) Fast compression. Will perform any compression that reduces the final file size significantly and does not take that much processing time. This provides a good balance between processing time and file size.
• 2 - Maximum compression. Will compress everything with the best compression algorithm for each block. This will take significant processing time but will produce the smallest final file. Best for situations where bandwidth is a major issue.

Parameters:

level - The compression level. Can be 0 - 2.

getCompressionLevel

int getCompressionLevel()

Deprecated.

Get the compression level. Basically a higher compression level means a smaller final pdf file - but also a longer processing time. The choices are:

• 0 - No compression. Fine for small files and where bandwidth is not an issue and processing time is.
• 1 - (default) Fast compression. Will perform any compression that reduces the final file size significantly and does not take that much processing time. This provides a good balance between processing time and file size.
• 2 - Maximum compression. Will compress everything with the best compression algorithm for each block. This will take significant processing time but will produce the smallest final file. Best for situations where bandwidth is a major issue.

Returns:

The compression level. Will be 0 - 2.

setOwnerPassword

void setOwnerPassword(java.lang.String password)

Deprecated.

Set the owner password for the report. Set to "" for no password. If this is not set and UserPassword or Security are set - then a random OwnerPassword sill be created.

Parameters:

password - The new owner password.

getOwnerPassword

java.lang.String getOwnerPassword()

Deprecated.

Get the owner password for the report. Is "" for no password.

Returns:

The owner password. "" if no password.

setUserPassword

void setUserPassword(java.lang.String password)

Deprecated.

Set the user password for the report. Set to "" for no password.

Parameters:

password - The new user password.

getUserPassword

java.lang.String getUserPassword()

Deprecated.

Get the user password for the report. Is "" for no password.

Returns:

The user password. "" if no password.

setSecurity

void setSecurity(int security)

Deprecated.

Set the security for the created pdf report. The default is to allow everything. Warning - to turn one permission off, you need to call this setting all other permissions. An easy way to do this is ALLOW_ALL & ~ ALLOW_{the one to turn off}.

Parameters:

security - Set to a bitmask of the ALLOW_* final ints.

getSecurity

int getSecurity()

Deprecated.

Get the security for the created pdf report. The default is everything allowed.

Returns:

A bitmask of the ALLOW_* final ints.

setKeyLength

void setKeyLength(int keyLength)

Deprecated.

Set the password licenseKey length.

Parameters:

keyLength - Must be set to 40 or 128.

getKeyLength

int getKeyLength()

Deprecated.

Get the password licenseKey length.

Returns:

Will be 40 or 128.

isPdfA

boolean isPdfA()

Deprecated.

true if build a PDF/A-1b file. This will force all fonts to be embedded.

Returns:

true if build a PDF/A-1b file.

setPdfA

void setPdfA(boolean pdfaMode)

Deprecated.

true if build a PDF/A-1b file. This will force all fonts to be embedded.

Parameters:

pdfaMode - true if build a PDF/A-1b file.

getPdfVersion

java.lang.String getPdfVersion()

Deprecated.

Gets the PDF version number used to create the file. This will be one of the VERSION_* static ints. It is an integer representation of the PDF version and so 1.4 is the int 14. Divide by 10 to get the PDF version.

Returns:

the PDF version number used to create the file.

setPdfVersion

void setPdfVersion(java.lang.String version)

Deprecated.

Gets the PDF version number used to create the file. This will be one of the VERSION_* static ints. It is an integer representation of the PDF version and so 1.4 is the int 14. Divide by 10 to get the PDF version.

Parameters:

version - the PDF version number used to create the file.