net.sf.jasperreports.engine.export
Class JRPdfExporterParameter

java.lang.Object
  extended by net.sf.jasperreports.engine.JRExporterParameter
      extended by 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 1509 2006-11-29 16:38:57 +0200 (Wed, 29 Nov 2006) shertage $
Author:
Teodor Danciu (teodord@users.sourceforge.net)

Field Summary
static JRPdfExporterParameter FORCE_LINEBREAK_POLICY
          Flag that decides whether the PDF exporter should use a SplitCharacter implementation which ensures that report texts are broken into lines by iText in the same manner as done by the fill process.
static JRPdfExporterParameter FORCE_SVG_SHAPES
          Flag to force the rendering of SVG images using shapes, on the PDF Graphics2D context.
static JRPdfExporterParameter HYPERLINK_PRODUCER_FACTORY
          A JRHyperlinkProducerFactory which should be used for custom hyperlink types during export.
static JRPdfExporterParameter IS_128_BIT_KEY
          A boolean value specifying whether the encryption key is 128 bits.
static JRPdfExporterParameter IS_COMPRESSED
          A boolean value specifying whether the PDF document should be compressed.
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 METADATA_AUTHOR
          The Author of the PDF document, as String.
static JRPdfExporterParameter METADATA_CREATOR
          The Creator or Application for the PDF document, as String, defaults to JasperReports.
static JRPdfExporterParameter METADATA_KEYWORDS
          The Keywords of the PDF document, as comma-separated String.
static JRPdfExporterParameter METADATA_SUBJECT
          The Subject of the PDF document, as String.
static JRPdfExporterParameter METADATA_TITLE
          The Title of the PDF document, as String.
static JRPdfExporterParameter OWNER_PASSWORD
          The password belonging to the owner of the document, if it is encrypted.
static JRPdfExporterParameter PDF_JAVASCRIPT
          The user defined JavaScript piece of code to be inserted in the generated PDF document
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, URL_HANDLER_FACTORY
 
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_COMPRESSED

public static final JRPdfExporterParameter IS_COMPRESSED
A boolean value specifying whether the PDF document should be compressed.


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.


METADATA_TITLE

public static final JRPdfExporterParameter METADATA_TITLE
The Title of the PDF document, as String.


METADATA_AUTHOR

public static final JRPdfExporterParameter METADATA_AUTHOR
The Author of the PDF document, as String.


METADATA_SUBJECT

public static final JRPdfExporterParameter METADATA_SUBJECT
The Subject of the PDF document, as String.


METADATA_KEYWORDS

public static final JRPdfExporterParameter METADATA_KEYWORDS
The Keywords of the PDF document, as comma-separated String.


METADATA_CREATOR

public static final JRPdfExporterParameter METADATA_CREATOR
The Creator or Application for the PDF document, as String, defaults to JasperReports.


FORCE_LINEBREAK_POLICY

public static final JRPdfExporterParameter FORCE_LINEBREAK_POLICY
Flag that decides whether the PDF exporter should use a SplitCharacter implementation which ensures that report texts are broken into lines by iText in the same manner as done by the fill process.

The default line-breaking logic differs from AWT (which is used during the report fill) to iText (used by the PDF exporter). By setting this flag, the logic used by AWT is imposed to iText. The drawback is that the PDF export performance would drop. Because of this, the flag is not set by default.

This flag can be set system-wide using the PDF_FORCE_LINEBREAK_POLICY property. This export parameter overrides the property value.

See Also:
JRProperties.PDF_FORCE_LINEBREAK_POLICY, BreakIteratorSplitCharacter

FORCE_SVG_SHAPES

public static final JRPdfExporterParameter FORCE_SVG_SHAPES
Flag to force the rendering of SVG images using shapes, on the PDF Graphics2D context. This allows rendering fonts as shapes and avoid font mapping issues that might cause Unicode text not to show up properly, but has the disadvantage of producing larger PDF files. By default, the flag is set to true, mainly due to backward compatibility reasons. To reduce PDF file size for documents containing SVG images such as charts, the flag should be turned to false, and the PDF exporter font mappings should be correctly configured using the FONT_MAP exporter parameter to ensure proper rendering of text in the SVG. This flag can be set system-wide using the PDF_FORCE_SVG_SHAPES property. This export parameter overrides the property value.

See Also:
JRPdfExporter.PDF_FORCE_SVG_SHAPES, JRExporterParameter.FONT_MAP

HYPERLINK_PRODUCER_FACTORY

public static final JRPdfExporterParameter HYPERLINK_PRODUCER_FACTORY
A JRHyperlinkProducerFactory which should be used for custom hyperlink types during export.


PDF_JAVASCRIPT

public static final JRPdfExporterParameter PDF_JAVASCRIPT
The user defined JavaScript piece of code to be inserted in the generated PDF document

Constructor Detail

JRPdfExporterParameter

protected JRPdfExporterParameter(java.lang.String name)


© 2001-2006 JasperSoft Corporation www.jaspersoft.com