com.qoppa.android.pdfProcess

Class PDFDocument

java.lang.Object

com.qoppa.android.pdfProcess.PDFDocument

public class PDFDocument
extends java.lang.Object

PDF Document object. This class provides methods to load, modify, print and save PDF documents.

Documents can be loaded from a file, an input stream or a URL. Use the URL constructor when loading a document from a web server or from a servlet.

Author:

Qoppa Software

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MAGNIFICATION_FIT_ACTUAL
static java.lang.String	MAGNIFICATION_FIT_HEIGHT
static java.lang.String	MAGNIFICATION_FIT_PAGE
static java.lang.String	MAGNIFICATION_FIT_VISIBLE
static java.lang.String	MAGNIFICATION_FIT_WIDTH
static java.lang.String	PAGELAYOUT_ONECOLUMN
static java.lang.String	PAGELAYOUT_SINGLEPAGE
static java.lang.String	PAGELAYOUT_TWOCOLUMNLEFT
static java.lang.String	PAGELAYOUT_TWOPAGELEFT
static java.lang.String	PAGEMODE_FULLSCREEN
static java.lang.String	PAGEMODE_USEATTACHMENTS
static java.lang.String	PAGEMODE_USENONE
static java.lang.String	PAGEMODE_USEOC
static java.lang.String	PAGEMODE_USEOUTLINES
static java.lang.String	PAGEMODE_USETHUMBS

Constructor Summary

Constructors

Constructor and Description
PDFDocument() Creates a blank PDF document.
PDFDocument(java.io.InputStream inStream, IPassword password) Creates a PDFDocument object from a PDF InputStream.
PDFDocument(PDFSource source, IPassword password) Create a PDFDocument object using a PDFSource interface.
PDFDocument(PDFSource source, IPassword password, Activity context) Create a PDFDocument from a PDFSource.
PDFDocument(java.lang.String fileName, IPassword password) Loads a PDF document from a file.
PDFDocument(java.net.URL url, IPassword password) Loads a PDF document from a URL.

Method Summary

Modifier and Type	Method and Description
void	addDocumentListener(DocumentChangeListener listener) Internal method to keep track of document events.
boolean	addEmbeddedFile(java.io.File file) Embeds a file into this PDF document.
Layer	addLayer(java.lang.String name, int initialState) Creates and returns a PDF layer (Optional Content Group).
void	appendDocument(PDFDocument appendDoc) Appends a PDF document to this document.
PDFPage	appendNewPage(float pageWidth, float pageHeight) Creates and appends a new PDFPage to this document.
void	appendPage(PDFPage page) Appends a page to this document.
void	calculateNow(FormField source)
void	clearSecurity(java.lang.String currentPermissionsPwd) Clears the security for this document.
boolean	containsJavaScript()
Bookmark	createRootBookmark() Creates a new root bookmark and saves it in the document catalog.
void	deletePage(int pageIndex) Deletes a page from this document.
void	exportAnnotsAsFDF(java.io.OutputStream outStream) Export annotations comments to an output stream in FDF format.
void	exportAnnotsAsFDF(java.io.OutputStream outStream, java.lang.String pathToPDFFile, java.util.Set<Annotation> annotSet) Export the set of annotation comments to an output stream in FDF format.
void	exportAnnotsAsFDF(java.lang.String fileName) Exports annotations comments in FDF format.
void	exportAnnotsAsXFDF(java.io.OutputStream outStream, java.lang.String pathToPDFFile) Export annotations comments to an output stream in XFDF format.
void	exportAnnotsAsXFDF(java.io.OutputStream outStream, java.lang.String pathToPDFFile, java.util.Set<Annotation> annotSet)
void	exportAnnotsAsXFDF(java.lang.String fileName) Exports annotations comments in XFDF format.
void	fireDocumentEvent(DocumentEvent de)
void	flattenFields(boolean paintButtons, boolean paintNonPrintableFields) Flattens the pdf form fields.
AcroForm	getAcroForm() Returns the AcroForm in this document.
Destinations	getDestinations()
DocumentInfo	getDocumentInfo() Returns an object representing the document metadata information (author, title, etc.).
static DocumentInfo	getDocumentInfo(java.io.InputStream inStream, IPassword password) Returns an object representing the document metadata information (author, title, etc.).
java.util.Vector<IEmbeddedFile>	getEmbeddedFiles() Returns the list of embedded files in the document (annotations attachments are not part of the list).
java.lang.String	getEncryptionAlgorithm() Returns the name of the encryption algorithm used to encrypt the document.
int	getEncryptionLength() Returns an int representing the number of bits used in the encryption technique.
java.io.File	getFile() Convenience method that returns the file that the PDF document was loaded from.
java.lang.String	getFileModifiedID() Returns the file modified ID.
java.lang.String	getFileOriginalID() Returns the file original ID.
com.qoppa.notes.javascript.obfusc.QJavaScriptHandler	getJSHandler()
Layer	getLayer(int layerIndex) Returns a particular PDF layer given its index.
int	getLayerCount() Returns the number of PDF layers in this document.
com.qoppa.android.pdfViewer.hiObjects.LayerManager	getLayerManager()
java.lang.String	getName()
com.qoppa.android.pdf.objectStore.PDFObjectStore	getObjectStore() Internal method.
PDFPage	getPage(int pageIndex) Returns a page in this document.
int	getPageCount() Returns the number of pages in this document.
java.lang.String	getPDFFileVersion() Return the PDF file version for the current document.
PDFSource	getPDFSource() Returns an object representing the source of the PDF content.
PDFPermissions	getPermissions() Returns the permission object for this document.
PrintSettings	getPrintSettings() Get the current PrintSettings object.
Bookmark	getRootBookmark() Returns the 'root' bookmark.
java.lang.String	getText() Returns the text in the pdf document as a String.
java.lang.String	getText(int pageIndex) Returns text contained in the specified page of the pdf document as a String.
static java.lang.String	getVersion() Returns version string for jPDFProcess.
java.util.Vector	getWords() Returns all words in the pdf document as a Vector of Strings.
java.util.Vector	getWords(int pageIndex) Returns all words contained in the specified page of the pdf document as a Vector of Strings.
boolean	hasBookmarks()
boolean	hasEmptyMandatoryField() Returns true if the document contains one or more unfilled mandatory fields.
boolean	hasOpenPassword() Returns a flag indicating whether this document is encrypted with a 'user' password.
boolean	hasPermissionsPassword() Returns a flag indicating whether this document is encrypted with a 'owner' password.
void	importAnnotsFDF(java.io.InputStream inStream) Import annotations comments from an input stream in FDF format.
void	importAnnotsFDF(java.lang.String fileName) Import annotations comments from a file in FDF Format.
void	importAnnotsXFDF(java.io.InputStream inStream) Import AcroForm field data from an input stream in XML format.
void	importAnnotsXFDF(java.lang.String fileName) Import Acroform fields data from a file in XML Format.
PDFPage	insertNewPage(float pageWidth, float pageHeight, int index) Creates a new PDFPage and inserts it into the document at the given position.
void	insertPage(PDFPage page, int index) Inserts a page into this document at the given index.
boolean	isCalculate() Return true if javascript calculations are enabled, false otherwise.
boolean	isDocumentModified() Returns true if the document has been modified, false otherwise.
boolean	isEncrypted() Returns a flag indicating whether this document is encrypted.
boolean	isPortfolio() Returns a flag indicating whether this document is a PDF Portfolio.
void	jsPrompt(Activity context, boolean runOpenActions)
void	movePage(int currentIndex, int newIndex) moves an existing page to a new location.
void	removeDocumentListener(DocumentChangeListener listener) Internal method to keep track of document events.
boolean	removeEmbeddedFile(IEmbeddedFile ef) Remove a file embedded in this document.
void	saveCopy(java.io.OutputStream outStream) Saves a copy of this document to an output stream.
void	saveCopy(java.lang.String fileName) Saves a copy of this document to a file.
void	saveDocument() Saves this document back to its source, if possible.
void	saveDocument(java.lang.String fileName) Deprecated. Please use saveCopy()
void	setCalculate(boolean calculate) Turn javascript calculations on or off.
void	setContainsJavaScript(boolean containsJs)
void	setInitialPage(int pageNumber) Sets the initial page to display.
void	setIsDocumentModified(boolean isModified) Sets the document's isModifed flag
void	setJavaScriptHandler(com.qoppa.notes.javascript.obfusc.QJavaScriptHandler handler) Set the JavaScriptHandler to enable javascript execution.
static boolean	setKey(java.lang.String key) Deprecated. This method is deprecated and will be removed in a future version.
static boolean	setKey(java.lang.String key, Context context) Method to unlock the production version of the library.
void	setMagnification(java.lang.String magnification) Sets the magnification at which to display the initial view.
void	setPageLayout(java.lang.String pageLayout) Changes the value of the page layout key for this document.
void	setPageMode(java.lang.String pageMode) Changes the value of the page mode viewer preference in the document.
void	setPrintSettings(PrintSettings printSettings) Set the PrintSettings to be used on the next printout.
void	setSecurity(java.lang.String newPermissionsPwd, java.lang.String newOpenPwd, PDFPermissions permissions, java.lang.String currentPermissionsPwd, int encryptType) Sets the security for this document.
void	signDocument(SignatureField signField, SigningInformation signingInfo, java.lang.String signedPDF) Signs this document using the given signature field.
boolean	usePermissionsPassword(java.lang.String password) Tells the PDFDocument object that the permissions password is known, so all permissions are granted.

Methods inherited from class java.lang.Object

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

Field Detail

MAGNIFICATION_FIT_WIDTH

public static final java.lang.String MAGNIFICATION_FIT_WIDTH

See Also:

Constant Field Values

MAGNIFICATION_FIT_VISIBLE

public static final java.lang.String MAGNIFICATION_FIT_VISIBLE

See Also:

Constant Field Values

MAGNIFICATION_FIT_HEIGHT

public static final java.lang.String MAGNIFICATION_FIT_HEIGHT

See Also:

Constant Field Values

MAGNIFICATION_FIT_PAGE

public static final java.lang.String MAGNIFICATION_FIT_PAGE

See Also:

Constant Field Values

MAGNIFICATION_FIT_ACTUAL

public static final java.lang.String MAGNIFICATION_FIT_ACTUAL

See Also:

Constant Field Values

PAGEMODE_USENONE

public static final java.lang.String PAGEMODE_USENONE

See Also:

Constant Field Values

PAGEMODE_USEOUTLINES

public static final java.lang.String PAGEMODE_USEOUTLINES

See Also:

Constant Field Values

PAGEMODE_USETHUMBS

public static final java.lang.String PAGEMODE_USETHUMBS

See Also:

Constant Field Values

PAGEMODE_FULLSCREEN

public static final java.lang.String PAGEMODE_FULLSCREEN

See Also:

Constant Field Values

PAGEMODE_USEOC

public static final java.lang.String PAGEMODE_USEOC

See Also:

Constant Field Values

PAGEMODE_USEATTACHMENTS

public static final java.lang.String PAGEMODE_USEATTACHMENTS

See Also:

Constant Field Values

PAGELAYOUT_SINGLEPAGE

public static final java.lang.String PAGELAYOUT_SINGLEPAGE

See Also:

Constant Field Values

PAGELAYOUT_ONECOLUMN

public static final java.lang.String PAGELAYOUT_ONECOLUMN

See Also:

Constant Field Values

PAGELAYOUT_TWOCOLUMNLEFT

public static final java.lang.String PAGELAYOUT_TWOCOLUMNLEFT

See Also:

Constant Field Values

PAGELAYOUT_TWOPAGELEFT

public static final java.lang.String PAGELAYOUT_TWOPAGELEFT

See Also:

Constant Field Values

Constructor Detail

PDFDocument

public PDFDocument(java.net.URL url,
                   IPassword password)
            throws PDFException

Loads a PDF document from a URL.

Parameters:

url - URL pointint to the location of the PDF file.

password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.

Throws:

PDFException

PDFDocument

public PDFDocument(java.io.InputStream inStream,
                   IPassword password)
            throws PDFException

Creates a PDFDocument object from a PDF InputStream.

Parameters:

inStream - InputStream to read the pdf document from.

password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.

Throws:

PDFException

PDFDocument

public PDFDocument(java.lang.String fileName,
                   IPassword password)
            throws PDFException

Loads a PDF document from a file.

Parameters:

fileName - Name of the PDF file.

password - An object that provides passwords to open the document, leave null if not needed. When working with documents that have no passwords, the host application should pass null for the value of this parameter. When documents are known to have passwords, the host application should pass an instance of the PDFPassword class that can hold a single password or a list of passwords.

Throws:

PDFException

PDFDocument

public PDFDocument()
            throws PDFException

Creates a blank PDF document. Pages can then be added to this document from other documents or by creating blank pages and drawing to them.

Throws:

PDFException

PDFDocument

public PDFDocument(PDFSource source,
                   IPassword password)
            throws PDFException

Create a PDFDocument object using a PDFSource interface. A PDFSource interface is responsible for providing the PDF binary content to the PDFDocument object. There are default implementations in the com.qoppa.pdf.source package to load PDF documents from files, input streams, byte arrays and URLs. An application can create its own object that implements PDFSource to load a document from a custom source.

Parameters:

source - The source of the PDF content.

password - The password, if any, used to open the document. Set to null if there is no password needed.

Throws:

PDFException

PDFDocument

public PDFDocument(PDFSource source,
                   IPassword password,
                   Activity context)
            throws PDFException

Create a PDFDocument from a PDFSource. For the document to execute javascript, provide an Activity

Parameters:

source -

password -

context -

Throws:

PDFException

Method Detail

isDocumentModified

public boolean isDocumentModified()

Returns true if the document has been modified, false otherwise.

Returns:

true if modified, false otherwise

getDocumentInfo

public static DocumentInfo getDocumentInfo(java.io.InputStream inStream,
                                           IPassword password)
                                    throws PDFException

Returns an object representing the document metadata information (author, title, etc.).

Parameters:

inStream - InputStream from which to read the PDF content.

password - Password interface, used in case the document is password protected. If the document is known not to have a password, this argument can be left null.

Returns:

DocumentInfo Object containing metadata information for the document.

Throws:

PDFException

getPDFSource

public PDFSource getPDFSource()

Returns an object representing the source of the PDF content. The object can be one of the standard implementations in the com.qoppa.pdf.source package or it can be a custom implementation of the interface.

Returns:

The object that has information about the source of the PDF content.

jsPrompt

public void jsPrompt(Activity context,
                     boolean runOpenActions)

getAcroForm

public AcroForm getAcroForm()

Returns the AcroForm in this document. Returns null if the document has no fields.

Returns:

AcroForm The AcroForm object for this document.

appendDocument

public void appendDocument(PDFDocument appendDoc)
                    throws PDFException

Appends a PDF document to this document. All the pages in appendDoc will be added at the end of this document.

Parameters:

appendDoc - Document to be appended.

Throws:

PDFException

appendPage

public void appendPage(PDFPage page)
                throws PDFException

Appends a page to this document.

Parameters:

page - The page to add to the document.

Throws:

PDFException

movePage

public void movePage(int currentIndex,
                     int newIndex)
              throws PDFException

moves an existing page to a new location.

Parameters:

currentIndex - The current index of the page to move.

newIndex - The location to move the page.

Throws:

PDFException

insertPage

public void insertPage(PDFPage page,
                       int index)
                throws PDFException

Inserts a page into this document at the given index. If the index is less than 0, the page is inserted as the first page. If the index is greater than the number of pages in the document, the page is appended to the document.

Parameters:

page - The page to add to the document.

index - Location where to insert the new page.

Throws:

PDFException

deletePage

public void deletePage(int pageIndex)
                throws PDFException

Deletes a page from this document. If the index is out of bounds, (index < 0 or index >= number of pages) this method has no effect on the document.

Parameters:

pageIndex - Index of the page to remove.

Throws:

PDFException

appendNewPage

public PDFPage appendNewPage(float pageWidth,
                             float pageHeight)
                      throws PDFException

Creates and appends a new PDFPage to this document. The pageWidth and pageHeight are specified in 72DPI. The page object can be drawn to by getting a graphics object from it and then drawing to that.

Parameters:

pageWidth - Width of the page in 72DPI.

pageHeight - Height of the page in 72DPI.

Throws:

PDFException

insertNewPage

public PDFPage insertNewPage(float pageWidth,
                             float pageHeight,
                             int index)
                      throws PDFException

Creates a new PDFPage and inserts it into the document at the given position. The pageWidth and pageHeight are specified in 72DPI. The page object can be drawn to by getting a graphics object from it and then drawing to that.

Parameters:

pageWidth - Width of the page in 72DPI.

pageHeight - Height of the page in 72DPI.

Throws:

PDFException

importAnnotsFDF

public void importAnnotsFDF(java.io.InputStream inStream)
                     throws PDFException

Import annotations comments from an input stream in FDF format.

Parameters:

inStream - The input stream in FDF format to read the data from.

Throws:

PDFException

importAnnotsFDF

public void importAnnotsFDF(java.lang.String fileName)
                     throws PDFException

Import annotations comments from a file in FDF Format.

Parameters:

fileName - The name of the FDF file to import the data from.

Throws:

PDFException

saveDocument

public void saveDocument()
                  throws java.io.IOException,
                         PDFException,
                         EncryptionChangedException

Saves this document back to its source, if possible. If the PDFSource does not support saving, this method will throw an exception.

The EncryptionChangedException is called if this method is called on a after changing the encryption on the document. Following a change in encryption, the document cannot be saved using the this method, it can be saved using one of the saveCopy methods. In this case the document can be saved to its original location using a temporary file: http://www.qoppa.com/android/pdfsdk/guide/sourcesamples/SetSecurityAndOverwrite.java

Throws:

java.io.IOException

PDFException

EncryptionChangedException

setIsDocumentModified

public void setIsDocumentModified(boolean isModified)

Sets the document's isModifed flag

Parameters:

isModified - The boolan value to set the isModified flag to.

saveCopy

public void saveCopy(java.lang.String fileName)
              throws java.io.IOException,
                     PDFException

Saves a copy of this document to a file. The PDF source is not reset when calling this method.

Parameters:

fileName - Name of the file to save the document.

Throws:

java.io.IOException

PDFException

saveDocument

public void saveDocument(java.lang.String fileName)
                  throws java.io.IOException,
                         PDFException

Deprecated. Please use saveCopy()

Throws:

java.io.IOException

PDFException

saveCopy

public void saveCopy(java.io.OutputStream outStream)
              throws java.io.IOException,
                     PDFException

Saves a copy of this document to an output stream. Makes no changes to current document

Parameters:

outStream - OutputStream where the document will be written to.

Throws:

java.io.IOException

PDFException

getVersion

public static java.lang.String getVersion()

Returns version string for jPDFProcess. If this is the demo version, the return string will contain 'Demo Version' at the end.

getPage

public PDFPage getPage(int pageIndex)

Returns a page in this document.

Parameters:

pageIndex - Index of the page to return.

getPageCount

public int getPageCount()

Returns the number of pages in this document.

getFile

public java.io.File getFile()

Convenience method that returns the file that the PDF document was loaded from. If the document was not loaded from a file, the method return snull.

Returns:

The file for the pdf document, null if the document was not opened from a file.

getName

public java.lang.String getName()

getFileOriginalID

public java.lang.String getFileOriginalID()

Returns the file original ID. A PDF document contains 2 IDs, an original ID and a modified ID generated by the application that created or modified the document.

Returns:

The PDF document "original" ID.

getFileModifiedID

public java.lang.String getFileModifiedID()

Returns the file modified ID. A PDF document contains 2 IDs, an original ID and a modified ID generated by the application that created or modified the document.

Returns:

The PDF document "modified" ID.

addLayer

public Layer addLayer(java.lang.String name,
                      int initialState)
               throws PDFException

Creates and returns a PDF layer (Optional Content Group). This layer can then be used to add optional content sections to the document by passing it as a parameter to the createGraphics method in PDFPage.

Parameters:

name - The name of the layer. This name will show up on a PDF viewer to turn the layer on or off.

initialState - The initial visibility state of the layer. This determines whether the layer will be visible or not when the PDF document is opened. Valid values for this are Layer.STATE_ON or Layer.STATE_OFF.

Throws:

PDFException

setPrintSettings

public void setPrintSettings(PrintSettings printSettings)

Set the PrintSettings to be used on the next printout.

Parameters:

printSettings - Settings to use on the next printout.

setSecurity

public void setSecurity(java.lang.String newPermissionsPwd,
                        java.lang.String newOpenPwd,
                        PDFPermissions permissions,
                        java.lang.String currentPermissionsPwd,
                        int encryptType)
                 throws PDFException

Sets the security for this document. If the open password is null, the user won't have to enter a password to open the document. If the permissions password is null, any user can change the permissions on the document. The document will be encrypted regardless. To clear the encryption, call the clearSecurity method.

Parameters:

newPermissionsPwd - The document's permissions password.

newOpenPwd - The document's open password.

permissions - Permission object.

currentPermissionsPwd - The current permissions password in the document, if any. This password is needed to be able to change the passwords and permissions in a document.

encryptType - - The encryption type to use, this value can be either PDFPermissions.ENCRYPTION_RC4 or PDFPermissions.ENCRYPTION_AES.

Throws:

PDFPermissionException - If currentPermissionsPwd is invalid.

PDFException

clearSecurity

public void clearSecurity(java.lang.String currentPermissionsPwd)
                   throws PDFException

Clears the security for this document. Calling this method will clear user password, owner password, permissions and encryption.

Parameters:

currentPermissionsPwd - The current permissions password in the document, if any. This password is needed to be able to change the passwords and permissions in a document.

Throws:

PDFPermissionException - If currentPermissionsPwd is invalid.

PDFException

hasOpenPassword

public boolean hasOpenPassword()

Returns a flag indicating whether this document is encrypted with a 'user' password.

Returns:

boolean true if the document is encrypted with an open password, false otherwise.

isEncrypted

public boolean isEncrypted()

Returns a flag indicating whether this document is encrypted.

Returns:

boolean true if the document is encrypted with a user password, false otherwise.

getEncryptionLength

public int getEncryptionLength()

Returns an int representing the number of bits used in the encryption technique. The integer is the length of the encryption key. It can be 40 for the 40 bits encryption or 128 for 128 bits encryption. -1 indicates that the documents is not encrypted.

Returns:

int The number of bits used in the encryption algorithm.

getEncryptionAlgorithm

public java.lang.String getEncryptionAlgorithm()

Returns the name of the encryption algorithm used to encrypt the document. If the document is not encrypted, the method returns null. Encryptions supported are RC4 and AES.

Returns:

The name of the encryption algorithm.

hasPermissionsPassword

public boolean hasPermissionsPassword()

Returns a flag indicating whether this document is encrypted with a 'owner' password.

Returns:

boolean true if the document is encrypted with a permissions password, false otherwise.

getPermissions

public final PDFPermissions getPermissions()

Returns the permission object for this document. A new permissions object with all permissions is returned if the document is not encrypted.

Returns:

The permission object.

getPrintSettings

public PrintSettings getPrintSettings()

Get the current PrintSettings object.

getDestinations

public Destinations getDestinations()

getText

public java.lang.String getText()
                         throws PDFException

Returns the text in the pdf document as a String. Pages are separated with a return char.

Returns:

Text contained in the pdf document as String.

Throws:

PDFException

getText

public java.lang.String getText(int pageIndex)
                         throws PDFException

Returns text contained in the specified page of the pdf document as a String.

Parameters:

pageIndex - is the 0 based page number. pageIndex = 0 is the first page of the document.

Returns:

Text contained in the specified page as a String.

Throws:

PDFException

getWords

public java.util.Vector getWords()
                          throws PDFException

Returns all words in the pdf document as a Vector of Strings.

Returns:

Words contained in the pdf document as a Vector of Strings.

Throws:

PDFException

getWords

public java.util.Vector getWords(int pageIndex)
                          throws PDFException

Returns all words contained in the specified page of the pdf document as a Vector of Strings.

Parameters:

pageIndex - is the 0 based page number. pageIndex = 0 is the first page of the document.

Returns:

Words contained in the specified page as a Vector of Strings.

Throws:

PDFException

getLayerCount

public int getLayerCount()

Returns the number of PDF layers in this document.

Returns:

Number of layers in the document.

getLayer

public Layer getLayer(int layerIndex)

Returns a particular PDF layer given its index.

Returns:

A reference to the PDF layer.

getLayerManager

public com.qoppa.android.pdfViewer.hiObjects.LayerManager getLayerManager()

addDocumentListener

public void addDocumentListener(DocumentChangeListener listener)

Internal method to keep track of document events.

removeDocumentListener

public void removeDocumentListener(DocumentChangeListener listener)

Internal method to keep track of document events.

fireDocumentEvent

public void fireDocumentEvent(DocumentEvent de)

getDocumentInfo

public DocumentInfo getDocumentInfo()

Returns an object representing the document metadata information (author, title, etc.). This is a mutable object, so any changes to this object will be saved with the document.

Returns:

DocumentInfo Object containing metadata information for the document.

getPDFFileVersion

public java.lang.String getPDFFileVersion()

Return the PDF file version for the current document.

Returns:

The version of the PDF document.

setPageMode

public void setPageMode(java.lang.String pageMode)
                 throws PDFException

Changes the value of the page mode viewer preference in the document. The page mode is used when the document is opened in a PDF Viewer.

Parameters:

pageMode - The new page mode. This value has to be one of:
PAGEMODE_USENONE: Neither document outline nor thumbnail images are visible.
PAGEMODE_USEOUTLINES: Document outline visible.
PAGEMODE_USETHUMBS: Thumbnail images visible.
PAGEMODE_FULLSCREEN: Full screen mode, with no menu bar, window controls, or any other window visible.

Throws:

PDFException

setPageLayout

public void setPageLayout(java.lang.String pageLayout)
                   throws PDFException

Changes the value of the page layout key for this document. This determines the layout of the page when initially opened.

Parameters:

pageLayout - The new page mode. This value has to be one of:
IPDFDocument.PAGELAYOUT_SINGLEPAGE: Display one page at a time.
IPDFDocument.PAGELAYOUT_ONECOLUMN: Display the page in one column (single page continuous).
IPDFDocument.PAGELAYOUT_TWOCOLUMNLEFT: Display the page in two columns (two facing continuous).
IPDFDocuemnt.PAGELAYOUT_TWOPAGELEFT: Display two pages at a time (two facing).

Throws:

PDFException

setInitialPage

public void setInitialPage(int pageNumber)
                    throws PDFException

Sets the initial page to display.

Parameters:

pageNumber - The page number. Use 0 for first page.

Throws:

PDFException

setMagnification

public void setMagnification(java.lang.String magnification)
                      throws PDFException

Sets the magnification at which to display the initial view.

Parameters:

magnification - A string magnification. This value has to be one of:
IPDFDocument.MAGNIFICATION_FIT_WIDTH: Display wtih the page magnified just enough to fit the entire width of the page within the window.
IPDFDocument.MAGNIFICATION_FIT_VISIBLE: Display with the page magnified just enoguh to fit the entire width of its bouding box within the window.
IPDFDocument.MAGNIFICATION_FIT_HEIGHT: Display with the page magnified just enough to fit the entire height of the page within the window.
IPDFDocument.MAGNIFICATION_FIT_PAGE: Display with the page magnified just enough to fit the entire page within the window both horizontally and vertically .
IPDFDocument.MAGNIFICATION_FIT_ACTUAL: Display the page with 100% magnification.

A String value of a number, ex. "125"
A null value to clear the magnification

Throws:

PDFException

usePermissionsPassword

public boolean usePermissionsPassword(java.lang.String password)
                               throws PDFException

Tells the PDFDocument object that the permissions password is known, so all permissions are granted. This method is here as a convenience so that if the owner password is known, the host application does not have to clear the security, make changes to the document, and then restore the security.

Parameters:

password - The permissions password

Returns:

true if the password was validated or the document is not encrypted

Throws:

PDFException

getObjectStore

public com.qoppa.android.pdf.objectStore.PDFObjectStore getObjectStore()

Internal method. Do not use.

isPortfolio

public boolean isPortfolio()
                    throws PDFException

Returns a flag indicating whether this document is a PDF Portfolio.

Returns:

true if the PDF is a portfolio, false otherwise.

Throws:

PDFException

flattenFields

public void flattenFields(boolean paintButtons,
                          boolean paintNonPrintableFields)
                   throws PDFException

Flattens the pdf form fields. This method paints the content of the fields directly into the pages and remove the fields themselves from the document.

Parameters:

paintButtons - Flag to indicate whether push buttons should be painted or not.

paintNonPrintableFields - Flag to indicate whether non-printable fields should be painted or not.

Throws:

PDFException

setKey

public static boolean setKey(java.lang.String key)

Deprecated. This method is deprecated and will be removed in a future version.

Method to unlock the production version of the library.

Parameters:

key - Production key.

setKey

public static boolean setKey(java.lang.String key,
                             Context context)

Method to unlock the production version of the library.

Parameters:

key - Production key.

context - An application context may be necessary to validate the key

hasBookmarks

public boolean hasBookmarks()
                     throws PDFException

Throws:

PDFException

getRootBookmark

public Bookmark getRootBookmark()
                         throws PDFException

Returns the 'root' bookmark. Bookmarks form a tree structure in a document.

Returns:

Bookmark The root bookmark for this document.

Throws:

PDFException

createRootBookmark

public Bookmark createRootBookmark()
                            throws PDFException

Creates a new root bookmark and saves it in the document catalog. When this method is called, any existing bookmarks will be discarded and the new root bookmark will be put in place. Initially, the new root bookmark will have no children (no entries will be displayed in the bookmarks pane when viewing the document).

Returns:

The new root bookmark.

Throws:

PDFException

signDocument

public void signDocument(SignatureField signField,
                         SigningInformation signingInfo,
                         java.lang.String signedPDF)
                  throws java.io.IOException,
                         PDFException

Signs this document using the given signature field.

Parameters:

signField - The field to use to sign the document.

signingInfo - Information required to sign the document.

Throws:

java.io.IOException

PDFException

See Also:

SignatureAppearance

addEmbeddedFile

public boolean addEmbeddedFile(java.io.File file)
                        throws java.io.IOException,
                               PDFException

Embeds a file into this PDF document. The file is not embedded as an annotation, it simply gets embedded, so it will be visible in the attachments pane.

Parameters:

file - The file to embed in the document

Returns:

true if the file is embedded successfully

Throws:

java.io.IOException

PDFException

removeEmbeddedFile

public boolean removeEmbeddedFile(IEmbeddedFile ef)
                           throws java.io.IOException,
                                  PDFException

Remove a file embedded in this document. The list of embedded files can be obtained through the getEmbeddedFiles() method.

Parameters:

ef - the embedded file to remove

Returns:

true if the embedded file was removed, false if not

Throws:

java.io.IOException

PDFException

getEmbeddedFiles

public java.util.Vector<IEmbeddedFile> getEmbeddedFiles()

Returns the list of embedded files in the document (annotations attachments are not part of the list). The list is a vector of @see com.qoppa.pdf.IEmbeddedFile.

Returns:

Vector a vector of IEmbbededFile

setJavaScriptHandler

public void setJavaScriptHandler(com.qoppa.notes.javascript.obfusc.QJavaScriptHandler handler)

Set the JavaScriptHandler to enable javascript execution. To disable it, set it to null.

Parameters:

handler -

getJSHandler

public com.qoppa.notes.javascript.obfusc.QJavaScriptHandler getJSHandler()

hasEmptyMandatoryField

public boolean hasEmptyMandatoryField()

Returns true if the document contains one or more unfilled mandatory fields. Returns false otherwise

Returns:

One or more empty mandatory fields

setContainsJavaScript

public void setContainsJavaScript(boolean containsJs)

containsJavaScript

public boolean containsJavaScript()

exportAnnotsAsFDF

public void exportAnnotsAsFDF(java.io.OutputStream outStream)
                       throws PDFException,
                              java.io.IOException

Export annotations comments to an output stream in FDF format.

Parameters:

outStream - The output stream to write the data to.

pathToPDFFile - is the relative path from the fdf file to the pdf file name. This parameter can be left null. This parameter is used to fill the pdf file name entry in the FDF file, the file entry will be set to pathToPDFFile + fileNa The file entry is used when you open an fdf file to be able to locate the corresponding pdf file. Example of pathToPDFFile ../qoppa/mydir

Throws:

PDFException

java.io.IOException

exportAnnotsAsFDF

public void exportAnnotsAsFDF(java.lang.String fileName)
                       throws PDFException

Exports annotations comments in FDF format.

Parameters:

fileName - The name of the file to export the data to.

Throws:

PDFException

exportAnnotsAsFDF

public void exportAnnotsAsFDF(java.io.OutputStream outStream,
                              java.lang.String pathToPDFFile,
                              java.util.Set<Annotation> annotSet)
                       throws PDFException,
                              java.io.IOException

Export the set of annotation comments to an output stream in FDF format.

Parameters:

outStream - The output stream to write the data to.

pathToPDFFile - is the relative path from the FDF file to the PDF file name. This parameter can be left null. This parameter is used to fill the PDF file name entry in the FDF file, the file entry will be set to pathToPDFFile + fileName. The file entry is used when you open an FDF file to be able to locate the corresponding PDF file. Example of pathToPDFFile ../qoppa/mydir

annotSet - The list of annotations to export. If annotList is not null, only the annotations contained in the set will be exported. Otherwise, all annotations will be exported.

Throws:

PDFException

java.io.IOException

calculateNow

public void calculateNow(FormField source)

setCalculate

public void setCalculate(boolean calculate)

Turn javascript calculations on or off.

isCalculate

public boolean isCalculate()

Return true if javascript calculations are enabled, false otherwise.

exportAnnotsAsXFDF

public void exportAnnotsAsXFDF(java.lang.String fileName)
                        throws PDFException

Exports annotations comments in XFDF format.

Parameters:

fileName - The name of the file to export the data to.

Throws:

PDFException

exportAnnotsAsXFDF

public void exportAnnotsAsXFDF(java.io.OutputStream outStream,
                               java.lang.String pathToPDFFile,
                               java.util.Set<Annotation> annotSet)
                        throws PDFException,
                               java.io.IOException

Throws:

PDFException

java.io.IOException

exportAnnotsAsXFDF

public void exportAnnotsAsXFDF(java.io.OutputStream outStream,
                               java.lang.String pathToPDFFile)
                        throws PDFException

Export annotations comments to an output stream in XFDF format.

Parameters:

outStream - The output stream to write the data to.

pathToPDFFile - is the relative path from the fdf file to the pdf file name. This parameter can be left null. This parameter is used to fill the pdf file name entry in the FDF file, the file entry will be set to pathToPDFFile + fileNa The file entry is used when you open an fdf file to be able to locate the corresponding pdf file. Example of pathToPDFFile ../qoppa/mydir

Throws:

java.io.IOException

PDFException

importAnnotsXFDF

public void importAnnotsXFDF(java.io.InputStream inStream)
                      throws PDFException

Import AcroForm field data from an input stream in XML format.

Parameters:

inStream - The input stream in XML format to read the data from.

Throws:

PDFException

importAnnotsXFDF

public void importAnnotsXFDF(java.lang.String fileName)
                      throws PDFException

Import Acroform fields data from a file in XML Format.

Parameters:

fileName - The name of the XML file to import the data from.

Throws:

PDFException