net.sf.jasperreports.engine.export
Class JRPdfExporterParameter

java.lang.Object
  net.sf.jasperreports.engine.JRExporterParameter
      net.sf.jasperreports.engine.export.JRPdfExporterParameter

public class JRPdfExporterParameter
extends JRExporterParameter

Contains parameters useful for export in PDF format.

The PDF exporter can send data to an output stream or a file on disk. The engine looks among the export parameters in order to find the selected output type in this order: OUTPUT_STREAM, OUTPUT_FILE, OUTPUT_FILE_NAME.

Version:

$Id: JRPdfExporterParameter.java,v 1.13 2005/07/13 09:40:10 flavius_sana Exp $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Field Summary

static JRPdfExporterParameter	IS_128_BIT_KEY A boolean value specifying whether the encryption key is 128 bits.
static JRPdfExporterParameter	IS_CREATING_BATCH_MODE_BOOKMARKS A boolean value specifying whether the PDF document should contain an outline section
static JRPdfExporterParameter	IS_ENCRYPTED A boolean value specifying whether the final PDF document should be encrypted.
static JRPdfExporterParameter	OWNER_PASSWORD The password belonging to the owner of the document, if it is encrypted.
static JRPdfExporterParameter	PDF_VERSION A Character instance representing the version of the generated PDF.
static java.lang.Character	PDF_VERSION_1_2
static java.lang.Character	PDF_VERSION_1_3
static java.lang.Character	PDF_VERSION_1_4
static java.lang.Character	PDF_VERSION_1_5
static java.lang.Character	PDF_VERSION_1_6
static JRPdfExporterParameter	PERMISSIONS An integer value representing the PDF permissions for the generated document.
static JRPdfExporterParameter	USER_PASSWORD The user password needed to open the document, if it is encrypted.

Fields inherited from class net.sf.jasperreports.engine.JRExporterParameter

CHARACTER_ENCODING, CLASS_LOADER, END_PAGE_INDEX, FONT_MAP, INPUT_FILE, INPUT_FILE_NAME, INPUT_STREAM, INPUT_URL, JASPER_PRINT, JASPER_PRINT_LIST, OFFSET_X, OFFSET_Y, OUTPUT_FILE, OUTPUT_FILE_NAME, OUTPUT_STREAM, OUTPUT_STRING_BUFFER, OUTPUT_WRITER, PAGE_INDEX, PROGRESS_MONITOR, START_PAGE_INDEX

Constructor Summary

protected

JRPdfExporterParameter(java.lang.String name)

Method Summary

Methods inherited from class net.sf.jasperreports.engine.JRExporterParameter

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PDF_VERSION_1_2

public static java.lang.Character PDF_VERSION_1_2

PDF_VERSION_1_3

public static java.lang.Character PDF_VERSION_1_3

PDF_VERSION_1_4

public static java.lang.Character PDF_VERSION_1_4

PDF_VERSION_1_5

public static java.lang.Character PDF_VERSION_1_5

PDF_VERSION_1_6

public static java.lang.Character PDF_VERSION_1_6

IS_CREATING_BATCH_MODE_BOOKMARKS

public static final JRPdfExporterParameter IS_CREATING_BATCH_MODE_BOOKMARKS

A boolean value specifying whether the PDF document should contain an outline section

IS_ENCRYPTED

public static final JRPdfExporterParameter IS_ENCRYPTED

A boolean value specifying whether the final PDF document should be encrypted.

IS_128_BIT_KEY

public static final JRPdfExporterParameter IS_128_BIT_KEY

A boolean value specifying whether the encryption key is 128 bits.

USER_PASSWORD

public static final JRPdfExporterParameter USER_PASSWORD

The user password needed to open the document, if it is encrypted.

OWNER_PASSWORD

public static final JRPdfExporterParameter OWNER_PASSWORD

The password belonging to the owner of the document, if it is encrypted. If the password is null, it will be replaced by a random string.

PERMISSIONS

public static final JRPdfExporterParameter PERMISSIONS

An integer value representing the PDF permissions for the generated document. The open permissions for the document can be AllowPrinting, AllowModifyContents, AllowCopy, AllowModifyAnnotations, AllowFillIn, AllowScreenReaders, AllowAssembly and AllowDegradedPrinting (these can all be found in the PdfWriter class of iText library). The permissions can be combined by applying bitwise OR to them.

PDF_VERSION

public static final JRPdfExporterParameter PDF_VERSION

A Character instance representing the version of the generated PDF. This class contains predefined constants that can be passed as parameters directly.

Constructor Detail

JRPdfExporterParameter

protected JRPdfExporterParameter(java.lang.String name)