com.cete.dynamicpdf
Class Document

java.lang.Object
  |
  +--com.cete.dynamicpdf.Document

Direct Known Subclasses:

MergeDocument

public class Document

extends java.lang.Object

Represents a PDF Document. This is the primary class used to generate the Dynamic PDF document. It represents a single PDF Document and is made up of Pages and Outlines. The document can have a Security object associated with it to control document security and encryption. The document can be output to any object derived from the java.io.OutputStream class that supports writing and can easily be integrated with JSP/SERVLET to stream the document to any Web Server's HTTP output stream.

View Example

See Also:

Security, OutputStream

Constructor Summary

Document()
Initializes a new instance of the Document class.

Method Summary

static boolean	addLicense(java.lang.String licenseKey)
void	append(Document document) Append a Document to the end of the Document.
byte[]	draw() Outputs the generated Document to a byte array.
void	draw(java.io.OutputStream outStream) Outputs the generated Document to the given OutputStream object.
void	draw(java.lang.String filePath) Outputs the generated Document to a file.
void	drawToWeb(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.io.OutputStream sOut) Outputs the generated Document to the given HttpServletResponse object.
void	drawToWeb(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.io.OutputStream sOut, boolean allowBrowserCaching) Outputs the generated Document to the given HttpServletResponse object.
void	drawToWeb(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.io.OutputStream sOut, java.lang.String downloadAsFileName) Outputs the generated Document to the given HttpServletResponse object.
void	drawToWeb(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.io.OutputStream sOut, java.lang.String downloadAsFileName, boolean forceDownload) Outputs the generated Document to the given HttpServletResponse object.
void	drawToWebPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.io.OutputStream sOut) Deprecated. As of DynamicPDF Generator v3.0.2 Beta1, replaced by Document.drawToWeb(HttpServletRequest, HttpServletResponse, OutputStream)
void	drawToWebPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.io.OutputStream sOut, boolean allowBrowserCaching) Deprecated. As of DynamicPDF Generator v3.0.2 Beta1, replaced by Document.drawToWeb(HttpServletRequest, HttpServletResponse, OutputStream, boolean)
void	drawToWebPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.io.OutputStream sOut, java.lang.String downloadAsFileName) Deprecated. As of DynamicPDF Generator v3.0.2 Beta1, replaced by Document.drawToWeb(HttpServletRequest, HttpServletResponse, OutputStream, String)
void	drawToWebPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.io.OutputStream sOut, java.lang.String downloadAsFileName, boolean forceDownload) Deprecated. As of DynamicPDF Generator v3.0.2 Beta1, replaced by Document.drawToWeb(HttpServletRequest, HttpServletResponse, OutputStream, String, boolean)
java.lang.String	getAuthor() Gets a value indicating the author of the Document.
int	getCompressionLevel() Gets a value indicating the compression level of the Document.
java.lang.String	getCreator()
Form	getForm() Gets a form object for the PDF document.
int	getInitialPage() Gets a value indicating the initial page of the Document.
PageMode	getInitialPageMode() Gets a value indicating the initial page mode of the Document.
PageZoom	getInitialPageZoom() Gets a value indicating the initial zoom of the Document.
java.lang.String	getKeywords() Gets a value indicating the keywords of the Document.
OutlineList	getOutlines() Gets an OutlineList object that represents the top level outlines of the Document.
PageList	getPages() Gets a PageList object that represent the pages of the Document.
PdfVersion	getPdfVersion() Gets the PDF version of the PDF document.
SectionList	getSections() Gets a SectionList object for the Document.
Security	getSecurity() Gets an object to control the security and encryption of the Document.
java.lang.String	getSubject() Gets a value indicating the subject of the Document.
Template	getTemplate() Gets a Template object for the Document.
java.lang.String	getTitle() Gets a value indicating the title of the Document.
ViewerPreferences	getViewerPreferences() Gets a ViewerPreferences object that represent the viewer preferences of the Document.
void	requireLicense() Causes the evaluation watermark to display if product is not adequately licensed.
void	requireLicense(int level) Causes the evaluation watermark to display if product is not adequately licensed.
void	setAuthor(java.lang.String author) Sets a value indicating the author of the Document.
void	setCompressionLevel(int compressionLevel) Sets a value indicating the compression level of the Document.
void	setCreator(java.lang.String creator) Sets a value indicating the creator of the Document.
void	setForm(Form form) Sets a form object for the PDF document.
void	setInitialPage(int initialPage) Sets a value indicating the initial page of the Document.
void	setInitialPageMode(PageMode initialPageMode) Sets a value indicating the initial page mode of the Document.
void	setInitialPageZoom(PageZoom initialPageZoom) Sets a value indicating the initial zoom of the Document.
void	setKeywords(java.lang.String keywords) Sets a value indicating the keywords of the Document.
void	setPdfVersion(PdfVersion ver) Sets the PDF version of the PDF document.
void	setProducer(byte[] producer, int value) Only users who have a password will be able to use this method.
void	setProducer(java.lang.String producer, int value) Only users who have a password will be able to use this method.
void	setSecurity(Security security) Sets an object to control the security and encryption of the Document.
void	setSubject(java.lang.String subject) Sets a value indicating the subject of the Document.
void	setTemplate(Template template) Sets a Template object for the Document.
void	setTitle(java.lang.String title) Sets a value indicating the title of the Document.

Methods inherited from class java.lang.Object

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

Constructor Detail

Document

public Document()

Initializes a new instance of the Document class.

Method Detail

setProducer

public void setProducer(java.lang.String producer,
                        int value)

Only users who have a password will be able to use this method.

Parameters:

producer - Name of the producer

value -

setProducer

public void setProducer(byte[] producer,
                        int value)

Only users who have a password will be able to use this method.

Parameters:

producer - Name of the producer

value -

addLicense

public static boolean addLicense(java.lang.String licenseKey)

Parameters:

licenseKey - A string representing license key provided to you by ceTe Software.

Returns:

boolean

draw

public byte[] draw()

Outputs the generated Document to a byte array. View Example

Returns:

byte array containing the document data.

draw

public void draw(java.lang.String filePath)

Outputs the generated Document to a file. View Example

Throws:

GeneratorException - If specified path is incorrect.

Parameters:

filePath - the String representing the file path to store the Document.

draw

public void draw(java.io.OutputStream outStream)

Outputs the generated Document to the given OutputStream object. View Example

Throws:

GeneratorException - If specified stream is incorrect.

Parameters:

outStream - the OutputStream object that receive the Document output.

drawToWeb

public void drawToWeb(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      java.io.OutputStream sOut)

Outputs the generated Document to the given HttpServletResponse object. View Example

Throws:

GeneratorException - If generated PDF can't be write to specified stream.

Parameters:

request - the HttpServletRequest object that contains the client request information.

response - the HttpServletResponse object that receive the Document output.

sOut - the OutputStream object that receive the Document output.

drawToWeb

public void drawToWeb(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      java.io.OutputStream sOut,
                      boolean allowBrowserCaching)

Outputs the generated Document to the given HttpServletResponse object. View Example

Throws:

GeneratorException - If generated PDF can't be write to specified stream.

Parameters:

request - the HttpServletRequest object that contains the client request information.

response - the HttpServletResponse object that receive the Document output.

sOut - the OutputStream object that receive the Document output.

allowBrowserCaching - the boolean value which specifies if the browser should be allowed to cache the Document.

drawToWeb

public void drawToWeb(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      java.io.OutputStream sOut,
                      java.lang.String downloadAsFileName)

Outputs the generated Document to the given HttpServletResponse object. View Example

Throws:

GeneratorException - If generated PDF can't be write to specified stream.

Parameters:

request - the HttpServletRequest object that contains the client request information.

response - the HttpServletResponse object that receive the Document output.

sOut - the OutputStream object that receive the Document output.

downloadAsFileName - the String which specifies the file name of the document if it is downloaded.

drawToWeb

public void drawToWeb(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      java.io.OutputStream sOut,
                      java.lang.String downloadAsFileName,
                      boolean forceDownload)

Outputs the generated Document to the given HttpServletResponse object. View Example

Throws:

GeneratorException - If generated PDF can't be write to specified stream.

Parameters:

request - the HttpServletRequest object that contains the client request information.

response - the HttpServletResponse object that receive the Document output.

sOut - the OutputStream object that receive the Document output.

downloadAsFileName - the String which specifies the file name of the document if it is downloaded.

forceDownload - the boolean value which specifies if the Save As dialog should appear.

drawToWebPage

public void drawToWebPage(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response,
                          java.io.OutputStream sOut)

Deprecated. As of DynamicPDF Generator v3.0.2 Beta1, replaced by Document.drawToWeb(HttpServletRequest, HttpServletResponse, OutputStream)

Outputs the generated Document to the given HttpServletResponse object.

Throws:

GeneratorException - If generated PDF can't be write to specified stream.

Parameters:

request - the HttpServletRequest object that contains the client request information.

response - the HttpServletResponse object that receive the Document output.

sOut - the OutputStream object that receive the Document output.

drawToWebPage

public void drawToWebPage(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response,
                          java.io.OutputStream sOut,
                          boolean allowBrowserCaching)

Deprecated. As of DynamicPDF Generator v3.0.2 Beta1, replaced by Document.drawToWeb(HttpServletRequest, HttpServletResponse, OutputStream, boolean)

Outputs the generated Document to the given HttpServletResponse object.

Throws:

GeneratorException - If generated PDF can't be write to specified stream.

Parameters:

request - the HttpServletRequest object that contains the client request information.

response - the HttpServletResponse object that receive the Document output.

sOut - the OutputStream object that receive the Document output.

allowBrowserCaching - the boolean value which specifies if the browser should be allowed to cache the Document.

drawToWebPage

public void drawToWebPage(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response,
                          java.io.OutputStream sOut,
                          java.lang.String downloadAsFileName)

Deprecated. As of DynamicPDF Generator v3.0.2 Beta1, replaced by Document.drawToWeb(HttpServletRequest, HttpServletResponse, OutputStream, String)

Outputs the generated Document to the given HttpServletResponse object.

Throws:

GeneratorException - If generated PDF can't be write to specified stream.

Parameters:

request - the HttpServletRequest object that contains the client request information.

response - the HttpServletResponse object that receive the Document output.

sOut - the OutputStream object that receive the Document output.

downloadAsFileName - the String which specifies the file name of the document if it is downloaded.

drawToWebPage

public void drawToWebPage(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response,
                          java.io.OutputStream sOut,
                          java.lang.String downloadAsFileName,
                          boolean forceDownload)

Deprecated. As of DynamicPDF Generator v3.0.2 Beta1, replaced by Document.drawToWeb(HttpServletRequest, HttpServletResponse, OutputStream, String, boolean)

Outputs the generated Document to the given HttpServletResponse object.

Throws:

GeneratorException - If generated PDF can't be write to specified stream.

Parameters:

request - the HttpServletRequest object that contains the client request information.

response - the HttpServletResponse object that receive the Document output.

sOut - the OutputStream object that receive the Document output.

downloadAsFileName - the String which specifies the file name of the document if it is downloaded.

forceDownload - the boolean value which specifies if the Save As dialog should appear.

requireLicense

public void requireLicense(int level)

Causes the evaluation watermark to display if product is not adequately licensed.

requireLicense

public void requireLicense()

Causes the evaluation watermark to display if product is not adequately licensed.

append

public void append(Document document)

Append a Document to the end of the Document.

Parameters:

document - the Document to be appended to the end of the Document.

getViewerPreferences

public ViewerPreferences getViewerPreferences()

Gets a ViewerPreferences object that represent the viewer preferences of the Document.

Returns:

the ViewerPreferences of the documents object.

See Also:

ViewerPreferences

setTemplate

public void setTemplate(Template template)

Sets a Template object for the Document.

Parameters:

template - the documents Template object.

See Also:

Template

getTemplate

public Template getTemplate()

Gets a Template object for the Document.

Returns:

the documents Template object.

See Also:

Template

getSections

public SectionList getSections()

Gets a SectionList object for the Document. Used to break a document into section.

Returns:

the documents SectionList object.

See Also:

SectionList

getPages

public PageList getPages()

Gets a PageList object that represent the pages of the Document.

Returns:

the collection of pages for the Document.

See Also:

PageList

getOutlines

public OutlineList getOutlines()

Gets an OutlineList object that represents the top level outlines of the Document.

Returns:

the documents OutlineList object.

See Also:

OutlineList

setInitialPageZoom

public void setInitialPageZoom(PageZoom initialPageZoom)

Sets a value indicating the initial zoom of the Document.

Parameters:

initialPageZoom - the PageZoom of the document.

See Also:

PageZoom

getInitialPageZoom

public PageZoom getInitialPageZoom()

Gets a value indicating the initial zoom of the Document.

Returns:

the PageZoom of the document

See Also:

PageZoom

setInitialPageMode

public void setInitialPageMode(PageMode initialPageMode)

Sets a value indicating the initial page mode of the Document.

Parameters:

initialPageMode - the PageMode of the document.

See Also:

PageMode

getInitialPageMode

public PageMode getInitialPageMode()

Gets a value indicating the initial page mode of the Document.

Returns:

the PageMode of the document

See Also:

PageMode

setInitialPage

public void setInitialPage(int initialPage)

Sets a value indicating the initial page of the Document.

Parameters:

initialPage - the integer value indicating the documents initial page.

getInitialPage

public int getInitialPage()

Gets a value indicating the initial page of the Document.

Returns:

the integer value indicating the documents initial page.

setAuthor

public void setAuthor(java.lang.String author)

Sets a value indicating the author of the Document. This value appears as a property of the generated PDF document.

Parameters:

author - the String value indicating the documents author.

getAuthor

public java.lang.String getAuthor()

Gets a value indicating the author of the Document. This value appears as a property of the generated PDF document.

Returns:

the String value indicating the documents author.

setCreator

public void setCreator(java.lang.String creator)

Sets a value indicating the creator of the Document. This value appears as a property of the generated PDF document.

Parameters:

creator - the String value indicating the documents creator.

getCreator

public java.lang.String getCreator()

setKeywords

public void setKeywords(java.lang.String keywords)

Sets a value indicating the keywords of the Document. This value appears as a property of the generated PDF document.

Parameters:

keywords - A comma seperated string value indicating the document's keywords. Each keyword should be seperated by a comma.

getKeywords

public java.lang.String getKeywords()

Gets a value indicating the keywords of the Document. This value appears as a property of the generated PDF document.

Returns:

the String value indicating the document's keywords.

setSubject

public void setSubject(java.lang.String subject)

Sets a value indicating the subject of the Document. This value appears as a property of the generated PDF document.

Parameters:

subject - the String value indicating the documents subject.

getSubject

public java.lang.String getSubject()

Gets a value indicating the subject of the Document. This value appears as a property of the generated PDF document.

Returns:

the String value indicating the documents subject.

setTitle

public void setTitle(java.lang.String title)

Sets a value indicating the title of the Document. This value appears as a property of the generated PDF document.

Parameters:

title - the String value indicating the documents title.

getTitle

public java.lang.String getTitle()

Gets a value indicating the title of the Document. This value appears as a property of the generated PDF document.

Returns:

the String value indicating the documents title.

setCompressionLevel

public void setCompressionLevel(int compressionLevel)

Sets a value indicating the compression level of the Document. A value from 0 to 9 indicating the compression level of the document. Six (6) is the default. Zero (0) represents no compression and nine (9) represents the best compression. This value will only affect the compression of the content streams of the documents pages. Depending on the type of document you are creating, it may not affect the size significantly.

Throws:

java.lang.IllegalArgumentException - Compression level should be 0-9

Parameters:

compressionLevel - the int value used to set the compression level of the Document

getCompressionLevel

public int getCompressionLevel()

Gets a value indicating the compression level of the Document.

Returns:

integer value indicating the compression level of the Document.

setSecurity

public void setSecurity(Security security)

Sets an object to control the security and encryption of the Document.

Parameters:

security - Security object which controls the encryption and security of the generated PDF document.

getSecurity

public Security getSecurity()

Gets an object to control the security and encryption of the Document.

Returns:

Security object which controls the encryption and security of the generated PDF document.

setForm

public void setForm(Form form)

Sets a form object for the PDF document.

Parameters:

form - A form object for the PDF document.

getForm

public Form getForm()

Gets a form object for the PDF document.

Returns:

A form object for the PDF document.

getPdfVersion

public PdfVersion getPdfVersion()

Gets the PDF version of the PDF document.

setPdfVersion

public void setPdfVersion(PdfVersion ver)

Sets the PDF version of the PDF document.