com.reportmill.pdf.writer

Class RMPDFWriter

java.lang.Object

PDFFile

com.reportmill.pdf.writer.RMPDFWriter

public class RMPDFWriter
extends PDFFile

This class generates PDF from an RMDocument (report) instance.

There are several conveniences in RMDocument that are more commonly used:

    byte[] pdfBytes = report.getBytesPDF(); or
    report.writePDF("/tmp/MyReport.pdf");
 

However, this can also easily be done directly with this class, allowing for additional API calls:

          RMPDFWriter pdfWriter = new RMPDFWriter();
          pdfWriter.setAuthor("User Name");
          pdfWriter.setCreator("Custom App Name");
          byte[] pdfBytes = pdfWriter.getBytes(report);
 

Constructor Summary

Constructors

Constructor and Description
RMPDFWriter()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthor() Returns the author.
PDFBuffer	getBuffer() Returns the current pdf buffer.
byte[]	getBytes(RMDocument aDoc) Returns a PDF byte array for a given RMDocument.
byte[]	getBytesPDF(RMDocument aDoc) Deprecated.
boolean	getCompress() Returns whether to compress or not.
java.lang.String	getCreator() Returns the creator.
java.util.zip.Deflater	getDeflater() Returns a shared deflater.
PDFEncryptor	getEncryptor() Returns the current PDF encryptor.
boolean	getIncludeNewlines() Returns whether to include newline and tab characters characters.
static boolean	getIncludeNewlinesDefault() Returns whether to include newline and tab characters characters.
PDFPage	getPDFPage() Returns the current PDF page.
static java.util.Map<java.lang.String,java.lang.String>	getViewerPreferencesDefault() Returns default viewer preferences map.
void	setAccessPermissions(java.lang.String ownerPwd, java.lang.String userPwd, int accessFlags) Sets pdf user access restrictions.
void	setAuthor(java.lang.String aValue) Sets the author.
void	setCompress(boolean aValue) Sets whether to compress or not.
void	setCreator(java.lang.String aValue) Sets the creator.
void	setIncludeNewlines(boolean aValue) Sets whether to include newline and tab characters.
static void	setIncludeNewlinesDefault(boolean aValue) Sets whether to include newline and tab characters.
void	setUnmodifiable(java.lang.String ownerPwd) Set the access permissions on the file such that the document can be opened by anyone, but the user cannot modify the document in any way.
static void	setViewerPreferencesDefault(java.util.Map<java.lang.String,java.lang.String> aMap) Sets default viewer preferences map.
void	writeXRefEntry(java.lang.Object anObj) Writes any kind of object to the PDF buffer.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RMPDFWriter

public RMPDFWriter()

Method Detail

getAuthor

public java.lang.String getAuthor()

Returns the author.

setAuthor

public void setAuthor(java.lang.String aValue)

Sets the author.

getCreator

public java.lang.String getCreator()

Returns the creator.

setCreator

public void setCreator(java.lang.String aValue)

Sets the creator.

getBytes

public byte[] getBytes(RMDocument aDoc)

Returns a PDF byte array for a given RMDocument.

getPDFPage

public PDFPage getPDFPage()

Returns the current PDF page.

getBuffer

public PDFBuffer getBuffer()

Returns the current pdf buffer.

getCompress

public boolean getCompress()

Returns whether to compress or not.

setCompress

public void setCompress(boolean aValue)

Sets whether to compress or not.

getDeflater

public java.util.zip.Deflater getDeflater()

Returns a shared deflater.

getEncryptor

public PDFEncryptor getEncryptor()

Returns the current PDF encryptor.

setUnmodifiable

public void setUnmodifiable(java.lang.String ownerPwd)

Set the access permissions on the file such that the document can be opened by anyone, but the user cannot modify the document in any way. To modify these settings in Acrobat, the owner password would have to be provided.

setAccessPermissions

public void setAccessPermissions(java.lang.String ownerPwd,
                                 java.lang.String userPwd,
                                 int accessFlags)

Sets pdf user access restrictions. The user password is the password that will be required to open the file. The owner password is the password that will be required to make future changes to the security settings, such as the passwords. Either of the passwords may be null. If both passwords are null, the file will not be password protected, but it will still be encrypted. Fine-grained access can be limited by setting accessFlags, to limit such things as printing or editing the file. See com.ribs.pdf.PDFSecurityHandler for a list of the access flag constants. (or the pdf spec v1.6, pp. 99-100)

getViewerPreferencesDefault

public static java.util.Map<java.lang.String,java.lang.String> getViewerPreferencesDefault()

Returns default viewer preferences map.

setViewerPreferencesDefault

public static void setViewerPreferencesDefault(java.util.Map<java.lang.String,java.lang.String> aMap)

Sets default viewer preferences map.

getIncludeNewlines

public boolean getIncludeNewlines()

Returns whether to include newline and tab characters characters.

setIncludeNewlines

public void setIncludeNewlines(boolean aValue)

Sets whether to include newline and tab characters.

getIncludeNewlinesDefault

public static boolean getIncludeNewlinesDefault()

Returns whether to include newline and tab characters characters.

setIncludeNewlinesDefault

public static void setIncludeNewlinesDefault(boolean aValue)

Sets whether to include newline and tab characters.

writeXRefEntry

public void writeXRefEntry(java.lang.Object anObj)

Writes any kind of object to the PDF buffer.

getBytesPDF

@Deprecated
public byte[] getBytesPDF(RMDocument aDoc)

Deprecated.

Obsolete