| Package | Description | 
|---|---|
| com.qoppa.pdf | 
 General classes used by different objects throughout the library. 
 | 
| com.qoppa.pdf.form | 
 Classes related to PDF Acroform and its form fields. 
 | 
| com.qoppa.pdfFields | 
 jPDFFields main classes, used to work with PDF interactive forms and fields. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
PDFPasswordException
Exception thrown when an invalid password is entered. 
 | 
class  | 
PDFPermissionException
Exception thrown when there is any permission error. 
 | 
class  | 
PDFSecurityException
Exceptions related to security problems. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
Bookmark.addAction(com.qoppa.pdf.actions.Action action)
Adds an Action to this Bookmark 
 | 
Bookmark | 
Bookmark.addChildBookmark(String title)
Add a child bookmark. 
 | 
byte[] | 
IEmbeddedFile.getCheckSum()
Get the 16-byte string that is the checksum of the bytes of the uncompressed embedded file. 
 | 
org.bouncycastle.operator.ContentSigner | 
SigningInformation.getContentSigner(String pdfVersion)
Get the content signer based on the PDF file version. 
 | 
byte[] | 
IEmbeddedFile.getDeflatedContents()
Get the content of the embedded file, deflated. 
 | 
static DocumentInfo | 
DocumentInfo.getDocumentInfo(InputStream inStream,
               IPassword password)
Static method to get the document information from a document from an InputStream. 
 | 
static DocumentInfo | 
DocumentInfo.getDocumentInfo(String fileName,
               IPassword passwords)
Static method to get the document information from a document in a file. 
 | 
static DocumentInfo | 
DocumentInfo.getDocumentInfo(URL url,
               IPassword password)
Static method to get the document information from a document from a URL. 
 | 
InputStream | 
IEmbeddedFile.getInputStream()
Returns an input stream from which the file contents can be read. 
 | 
static List<LocalFont> | 
FontSettings.getLocalFonts()
Returns a list of fonts found in the local environment that can be used for 
 adding text content to a PDF. 
 | 
int | 
IEmbeddedFile.getSize()
Get the size of the file content in bytes. 
 | 
Bookmark | 
Bookmark.insertChildBookmark(String title,
                   int index)
Insert a child bookmark at the given index in the node's children. 
 | 
void | 
IWindowHandler.openDoc(com.qoppa.pdf.source.PDFSource source)
Open the PDF source. 
 | 
void | 
Bookmark.removeChildBookmark(int index)
Removes a child bookmark from the bookmark 
 | 
void | 
IEmbeddedFile.saveFile(File outFile)
Saves the content of the embedded file to the given output file. 
 | 
void | 
Bookmark.setActions(Vector<com.qoppa.pdf.actions.Action> actions)
Sets the list of actions for this Bookmark. 
 | 
abstract void | 
DocumentInfo.setAuthor(String author)
Set the document's author. 
 | 
void | 
DocumentViewPrefs.setCenterWindow(boolean value)
Sets the Center Window viewer preference in the document. 
 | 
abstract void | 
DocumentInfo.setCreationDate(Date creationDate)
Set the document's creation date. 
 | 
abstract void | 
DocumentInfo.setCreator(String creator)
Set the document's creator. 
 | 
abstract void | 
DocumentInfo.setCustomProperty(String key,
                 String value)
Sets a custom application property in the document info for the document. 
 | 
void | 
SigningInformation.setCustomProperty(String key,
                 String value)
This method can be used to add additional custom properties to the signature dictionary. 
 | 
void | 
DocumentViewPrefs.setDirection(String value)
Sets the Direction viewer preference in the document. 
 | 
void | 
DocumentViewPrefs.setDisplayDocTitle(boolean value)
Sets the Display Doc Title viewer preference in the document. 
 | 
void | 
DocumentViewPrefs.setDuplex(String value)
Sets the Duplex viewer preference in the document. 
 | 
void | 
DocumentViewPrefs.setFitWindow(boolean value)
Sets the Fit Window viewer preference in the document. 
 | 
void | 
DocumentViewPrefs.setHideMenubar(boolean value)
Sets the Hide Menubar viewer preference in the document. 
 | 
void | 
DocumentViewPrefs.setHideToolbar(boolean value)
Sets the Hide Toolbar viewer preference in the document. 
 | 
void | 
DocumentViewPrefs.setHideWindowUI(boolean value)
Sets the Hide Window UI viewer preference in the document. 
 | 
abstract void | 
DocumentInfo.setKeywords(String keywords)
Set the document's keywords. 
 | 
abstract void | 
DocumentInfo.setModifiedDate(Date modDate)
Deprecated. 
 
The document's modified date will be set by the library at the time the document is saved. 
 | 
void | 
DocumentViewPrefs.setNonFullScreenPageMode(String value)
Sets the NonFullScreen Page Mode viewer preference in the document. 
 | 
void | 
DocumentViewPrefs.setNumCopies(int value)
Sets the NumCopies viewer preference in the document. 
 | 
void | 
Bookmark.setOpen(boolean isOpen)
Sets the item as either open or closed when the document is opened. 
 | 
void | 
SigningInformation.setPermissions(int permissions)
This property is meaningful only if this is a certifying signature. 
 | 
void | 
DocumentViewPrefs.setPickTrayByPDFSize(boolean value)
Sets the Pick Tray by PDF Size viewer preference in the document. 
 | 
void | 
DocumentViewPrefs.setPrintScaling(String value)
Sets the Print Scaling viewer preference in the document. 
 | 
abstract void | 
DocumentInfo.setProducer(String producer)
Set the document's producer. 
 | 
abstract void | 
DocumentInfo.setSubject(String subject)
Set the document's subject. 
 | 
abstract void | 
DocumentInfo.setTitle(String title)
Sets the document's title. 
 | 
abstract void | 
DocumentInfo.setXMPMetadata(byte[] xmpData)
Sets the XMP metadata block in the document. 
 | 
abstract void | 
DocumentInfo.setXMPMetadata(String xmpString,
              String charsetName)
Sets the XMP metadata block in the document. 
 | 
void | 
IEmbeddedFile.write(OutputStream outStream)
Write the file content to an output stream. 
 | 
| Constructor and Description | 
|---|
SigningInformation(KeyStore ks,
                  String entryAlias,
                  String aliasPWD)
Constructs a SigningInformation object and gets the digital ID from a Java KeyStore object. 
 | 
SigningInformation(PrivateKey pk,
                  Certificate signerCert,
                  Certificate[] certChain,
                  String provider)
Constructs a SigningInformation object given a private key, signer certificate and certificate chain. 
 | 
SigningInformation(String pkcs12File,
                  String ksPWD,
                  String entryAlias,
                  String aliasPWD)
Constructs a SigningInformation object and gets the digital ID from a named PKCS#12 file. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
boolean | 
SignatureField.addVerificationInformation()
Add verification information related to this signature. 
 | 
void | 
AcroForm.exportAsFDF(OutputStream outStream,
           String pathToPDFFile,
           boolean exportEmptyFields)
Exports AcroForm field data to an output stream in FDF format. 
 | 
void | 
AcroForm.exportAsFDF(String fileName,
           boolean exportEmptyFields)
Exports AcroForm field data to a file in FDF format. 
 | 
void | 
AcroForm.exportAsXDP(OutputStream outStream,
           String pdfReference,
           boolean exportEmptyFields)
Exports XFA field data to an OutputStream. 
 | 
void | 
AcroForm.exportAsXDP(String fileName,
           boolean exportEmptyFields)
Exports XFA field data to a file in XDP format. 
 | 
void | 
AcroForm.exportAsXFDF(OutputStream outStream,
            String pathToPDFFile,
            boolean exportEmptyFields)
Exports AcroForm field data to an output stream in XML format. 
 | 
void | 
AcroForm.exportAsXFDF(String fileName,
            boolean exportEmptyFields)
Exports AcroForm field data to a file in XFDF format. 
 | 
void | 
AcroForm.exportAsXML(OutputStream outStream,
           boolean useHierarchy,
           boolean exportEmptyFields)
Export field values in a simple XML format. 
 | 
void | 
AcroForm.exportAsXML(String fileName,
           boolean useHierarchy,
           boolean exportEmptyFields)
Export field values in a simple XML format. 
 | 
void | 
FormField.flattenField()
Flattens the field into the document's content layer. 
 | 
String | 
SignatureField.getCustomProperty(String key)
This method can be used to retrieve the values of custom properties in the signature field dictionary. 
 | 
String | 
SignatureField.getSignCustomProperty(String key)
This method can be used to retrieve the values of custom properties in the signature dictionary. 
 | 
void | 
AcroForm.importFDF(InputStream inStream)
Imports AcroForm field data from an input stream in FDF format. 
 | 
void | 
AcroForm.importFDF(String fileName)
Import AcroForm field data from a file in FDF Format. 
 | 
void | 
AcroForm.importXDP(InputStream inStream)
Imports XFA field data from an InputStream in XDP format. 
 | 
void | 
AcroForm.importXDP(String fileName)
Imports XFA field data from a file in XDP format. 
 | 
void | 
AcroForm.importXFDF(InputStream inStream)
Imports AcroForm field data from an input stream in XFDF format. 
 | 
void | 
AcroForm.importXFDF(String fileName)
Imports AcroForm fields data from a file in XFDF Format. 
 | 
void | 
AcroForm.importXFDF(com.qoppa.nanoxml.XMLElement topElement)
Import AcroForm field data from an xml element representing the top element of an fdf file. 
 | 
void | 
FormField.reset()
Resets the field to its default value. 
 | 
void | 
AcroForm.resetFields()
Reset the form fields to their default value. 
 | 
void | 
SignatureField.setCustomProperty(String key,
                 String value)
This method can be used to add additional custom properties to the signature field dictionary. 
 | 
void | 
TextField.setHorzTextAlign(int justify)
Sets the text alignment for this field. 
 | 
void | 
PushButtonField.setImage(BufferedImage bi)
Set an image to display in the button fields. 
 | 
void | 
TextField.setRichValue(String richValue)
Sets the rich value for this text field if rich text is enabled. 
 | 
void | 
CheckBoxField.setValue(String value)
Sets the value for the check box field. 
 | 
void | 
ChoiceField.setValue(String value)
Sets the selected export value for this choice field. 
 | 
void | 
RadioButtonGroupField.setValue(String value)
Sets the value for this radio button group field. 
 | 
void | 
TextField.setValue(String value)
Sets the value for this text field. 
 | 
void | 
RadioButtonGroupField.setValueFromOptions(String value)
Sets the value from the options for this radio button group field if the options exist. 
 | 
void | 
ChoiceField.setValues(Vector<String> values)
Sets the list of currently selected values for this choice field. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
PDFFields.exportAsFDF(OutputStream outStream,
           String pathToPDFFile,
           boolean exportEmptyFields)
Export AcroForm field data to an output stream in FDF format. 
 | 
void | 
PDFFields.exportAsFDF(String fileName,
           boolean exportEmptyFields)
Exports AcroForm field data to a file in FDF format. 
 | 
void | 
PDFFields.exportAsXDP(OutputStream outStream,
           String pathToPDFFile,
           boolean exportEmptyFields)
Export XFA field data to an output stream in XDP format. 
 | 
void | 
PDFFields.exportAsXDP(String fileName,
           boolean exportEmptyFields)
Exports XFA field data to a file in XDP format. 
 | 
void | 
PDFFields.exportAsXFDF(OutputStream outStream,
            String pathToPDFFile,
            boolean exportEmptyFields)
Export AcroForm field data to an output stream in XFDF format. 
 | 
void | 
PDFFields.exportAsXFDF(String fileName,
            boolean exportEmptyFields)
Exports AcroForm field data to a file in XML format. 
 | 
void | 
PDFFields.flattenFields(boolean paintButtons,
             boolean paintNonPrintableFields)
Flattens the form fields in the current PDF document. 
 | 
void | 
PDFFields.flattenFields(boolean paintButtons,
             boolean paintOnlyImageButtons,
             boolean paintNonPrintableFields)
Flattens the form fields in the current PDF document. 
 | 
void | 
PDFFields.importFDF(InputStream inStream)
Import AcroForm field data from an input stream in FDF format. 
 | 
void | 
PDFFields.importFDF(String fileName)
Import AcroForm field data from a file in FDF Format. 
 | 
void | 
PDFFields.importXDP(InputStream inStream)
Import XFA field data from an input stream in XDP format. 
 | 
void | 
PDFFields.importXDP(String fileName)
Import XFA field data from a file in XDP Format. 
 | 
void | 
PDFFields.importXFDF(InputStream inStream)
Import AcroForm field data from an input stream in XML format. 
 | 
void | 
PDFFields.importXFDF(String fileName)
Import AcroForm fields data from a file in XML Format. 
 | 
void | 
PDFFields.resetFields()
Reset fields values to their default value. 
 | 
void | 
PDFFields.saveDocument(OutputStream outStream)
Saves this document to an output stream. 
 | 
void | 
PDFFields.saveDocument(String fileName)
Saves this document to a file. 
 | 
boolean | 
PDFFields.usePermissionsPassword(String ownerPassword)
Tells the PDFFields object that the permissions password is known, so all
 permissions are granted. 
 | 
| Constructor and Description | 
|---|
PDFFields(InputStream inStream,
         IPassword password)
Loads a PDF document from an InputStream. 
 | 
PDFFields(String fileName,
         IPassword password)
Loads a PDF document from a file. 
 | 
PDFFields(URL url,
         IPassword password)
Loads a PDF document from a URL. 
 |