Windward Reports 6.1 API: Interface ProcessPdfAPI

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.windward.xmlreport
Interface ProcessPdfAPI

All Superinterfaces:: ProcessReportAPI, ProcessReportAPIBase

All Known Implementing Classes:: ProcessPdf

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

static int ALLOW_ALL
          Allow everything.

static int ALLOW_ASSEMBLY
          Allow assembly of the pdf report.

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

static int ALLOW_DEGRADED_PRINTING
          Allow degraded printing of the pdf report.

static int ALLOW_FILL_IN
          Allow fill-in of the pdf report.

static int ALLOW_MOD_ANNOTATIONS
          Allow modifications of annotations in the pdf report.

static int ALLOW_MOD_CONTENTS
          Allow modification of contents in the pdf report.

static int ALLOW_PRINTING
          Allow printing the pdf report.

static int ALLOW_SCREEN_READERS
          Allow screen capture of the pdf report.

static int COMP_FAST
          Fast compression.

static int COMP_MAX
          Maximum compression.

static int COMP_NONE
          No compression.

static int FONT_EMBEDED
          Will use the font specified in the template and will embed the font in the final pdf file.

static int FONT_INTERNAL
          Will only use the Acrobat internal fonts which are Helvetica (Arial), Times-Roman, Courier, Symbol, and Zapfdingbats.

static int FONT_NO_EMBED
          Will use the font specified in the template but will not embed the font itself in the pdf file.

Fields inherited from interface net.windward.xmlreport.ProcessReportAPI

CHARSET_DEFAULT, CHARSET_RTF, CHARSET_UNICODE, LOCALE_DEFAULT, LOCALE_SYSTEM, TYP_DOCX, TYP_EXCEL_ML, TYP_HTML, TYP_PDF, TYP_RTF, TYP_TXT, TYP_WORD_ML, TYP_XLS, TYP_XLSX

Method Summary

int getCompressionLevel()
          Get the compression level.

int getFontLevel()
          Get the font level.

int getKeyLength()
          Get the password licenseKey length.

java.lang.String getOwnerPassword()
          Get the owner password for the report.

int getReportType()
          Get the report format of the output stream.

int getSecurity()
          Get the security for the created pdf report.

java.lang.String getUserPassword()
          Get the user password for the report.

void setCompressionLevel(int level)
          Set the compression level.

void setFontLevel(int level)
          Set the font level.

void setKeyLength(int keyLength)
          Set the password licenseKey length.

void setOwnerPassword(java.lang.String password)
          Set the owner password for the report.

void setSecurity(int security)
          Set the security for the created pdf report.

void setUserPassword(java.lang.String password)
          Set the user password for the report.

Methods inherited from interface net.windward.xmlreport.ProcessReportAPI

setChartProvider

Methods inherited from interface net.windward.xmlreport.ProcessReportAPIBase

addBean, close, duplicate, getBaseDirectory, getCharset, getInfo, getKeywords, getLocale, getNumPages, getReport, getSubject, getTitle, isDebugMode, process, processComplete, processData, processSetup, processSetup, setBaseDirectory, setCharset, setDebugMode, setKeywords, setLocale, setSubject, setTitle

Field Detail

FONT_INTERNAL

public static final int FONT_INTERNAL

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.

FONT_NO_EMBED

public static final int FONT_NO_EMBED

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.

FONT_EMBEDED

public static final int FONT_EMBEDED

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.)

COMP_NONE

public static final int COMP_NONE

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

COMP_FAST

public static final int COMP_FAST

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.

COMP_MAX

public static final int COMP_MAX

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.

ALLOW_ASSEMBLY

public static final int ALLOW_ASSEMBLY

Allow assembly of the pdf report.

ALLOW_COPY

public static final int ALLOW_COPY

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

ALLOW_DEGRADED_PRINTING

public static final int ALLOW_DEGRADED_PRINTING

Allow degraded printing of the pdf report.

ALLOW_FILL_IN

public static final int ALLOW_FILL_IN

Allow fill-in of the pdf report.

ALLOW_MOD_ANNOTATIONS

public static final int ALLOW_MOD_ANNOTATIONS

Allow modifications of annotations in the pdf report.

ALLOW_MOD_CONTENTS

public static final int ALLOW_MOD_CONTENTS

Allow modification of contents in the pdf report.

ALLOW_PRINTING

public static final int ALLOW_PRINTING

Allow printing the pdf report.

ALLOW_SCREEN_READERS

public static final int ALLOW_SCREEN_READERS

Allow screen capture of the pdf report.

ALLOW_ALL

public static final int ALLOW_ALL

Allow everything.

Method Detail

getReportType

public int getReportType()

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

public void setFontLevel(int level)

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

public int getFontLevel()

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

public void setCompressionLevel(int level)

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

public int getCompressionLevel()

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

public void setOwnerPassword(java.lang.String password)

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

public java.lang.String getOwnerPassword()

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

Returns:: The owner password. "" if no password.

setUserPassword

public void setUserPassword(java.lang.String password)

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

Parameters:: password - The new user password.

getUserPassword

public java.lang.String getUserPassword()

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

Returns:: The user password. "" if no password.

setSecurity

public void setSecurity(int security)

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

public int getSecurity()

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

Returns:: A bitmask of the ALLOW_* final ints.

setKeyLength

public void setKeyLength(int keyLength)

Set the password licenseKey length.

Parameters:: keyLength - Must be set to 40 or 128.

getKeyLength

public int getKeyLength()

Get the password licenseKey length.

Returns:: Will be 40 or 128.