| Package | Description | 
|---|---|
| com.qoppa.ocr | 
 OCR bridge integration. 
 | 
| com.qoppa.pdf | 
 General classes used by different objects throughout the library. 
 | 
| com.qoppa.pdf.actions | 
 Classes that represent user actions. 
 | 
| com.qoppa.pdf.annotations | 
 Classes representing PDF annotations. 
 | 
| com.qoppa.pdf.dom | 
 Classes representing the PDF document object model. 
 | 
| com.qoppa.pdf.form | 
 Classes related to PDF Acroform and its form fields. 
 | 
| com.qoppa.pdf.permissions | 
 This package contains classes related to document permissions. 
 | 
| com.qoppa.pdf.resources | 
 Classes that represent resources in a PDF document. 
 | 
| com.qoppa.pdf.source | 
 PDFSource interface and implementations. 
 | 
| com.qoppa.pdfEditor | 
 PDFEditorBean, toolbar and related classes. 
 | 
| com.qoppa.pdfNotes | 
 PDFNotesBean, toolbar and related classes. 
 | 
| com.qoppa.pdfProcess | 
 jPDFProcess main classes, used to manipulate PDF documents and pages. 
 | 
| com.qoppa.pdfProcess.content | 
 jPDFProcess content classes used to manipulate attributes of text on pages. 
 | 
| com.qoppa.pdfViewer | 
 PDFViewerBean and related classes. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
String | 
TessJNI.getOCRText(String language,
          PDFPage pdfPage,
          int dpi,
          OCROptions options)
Performs OCR on a PDF page and returns a plain text result string. 
 | 
String | 
TessJNI.performOCR(String language,
          PDFPage pdfPage,
          int dpi)
Performs OCR on a PDF page and returns an hOCR result string. 
 | 
String | 
TessJNI.performOCR(String language,
          PDFPage pdfPage,
          int dpi,
          OCROptions options)
Performs OCR on a PDF page and returns an hOCR result string. 
 | 
OCRPageResults | 
TessJNI.performOCRandOSD(String language,
                PDFPage pdfPage,
                int dpi,
                OCROptions options)
Convert a PDF page to an image and run OCR on it, to return the OCR text in hOCR format, and page orientation information. 
 | 
| 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(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(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<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 | 
|---|---|
String | 
JSAction.getJavascript()
Returns the JavaScript of this action as a string. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
FileAttachment | 
IAnnotationFactory.createFileAttachment(byte[] fileContents,
                    String fileName,
                    Date modDate,
                    Date creationDate,
                    String popupText)
Constructs a file attachment annotation. 
 | 
FileAttachment | 
IAnnotationFactory.createFileAttachment(File attachFile,
                    String popupText)
Convenience constructor to create a file attachment from a file system file. 
 | 
FileAttachment | 
IAnnotationFactory.createFileAttachment(InputStream inStream,
                    String fileName,
                    Date modDate,
                    Date creationDate,
                    String popupText)
Creates a file attachment from an input stream. 
 | 
RubberStamp | 
IAnnotationFactory.createRubberStamp(IPDFPage page)
Constructs a rubber stamp annotation with the content stream from a PDF page. 
 | 
void | 
Widget.fieldValueChanged()  | 
void | 
IFlattener.flattenWidget(Widget w)  | 
byte[] | 
FileAttachment.getCheckSum()
Returns the CRC checksum for the file contents. 
 | 
byte[] | 
FileAttachment.getDeflatedContents()
Returns the file contents in deflated format 
 | 
int | 
FileAttachment.getFileSize()
Returns the length of the file, in bytes. 
 | 
InputStream | 
FileAttachment.getInputStream()
Returns the file contents as an input stream. 
 | 
void | 
FileAttachment.saveFile(File outFile)
Saves the content of the file to a file. 
 | 
void | 
FileAttachment.setFileContents(byte[] fileContents)
Sets the file contents for the file attachment. 
 | 
void | 
FileAttachment.setFileContents(File file)
Sets the file contents for the file attachment from a file. 
 | 
void | 
FileAttachment.setFileContents(InputStream inStream)
Sets the file contents for this file attachment from an input stream. 
 | 
void | 
Redaction.setOverlayFont(String fontName,
              float fontSize)
Sets the name and point size of the overlay text Font. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Vector<TextPosition> | 
IPDFPage.findText(String searchText,
        boolean caseSensitive,
        boolean wholeWords)
This method searches for the given text in the page. 
 | 
Vector<TextPosition> | 
IPDFPage.findTextUsingRegex(String regex)
This method searches for the given text in the page. 
 | 
Vector<TextPositionWithContext> | 
IPDFPage.findTextWithContext(String searchText,
                   boolean caseSensitive,
                   boolean wholeWords)
This method searches for the given text in the page. 
 | 
Vector<TextPositionWithContext> | 
IPDFPage.findTextWithContextUsingRegEx(String regex)
This method searches for text in the page for matches with the given regular expression. 
 | 
Vector<Annotation> | 
IPDFPage.getAnnotations()
Returns a list of PDF annotations in this page. 
 | 
Vector<String> | 
IPDFDocument.getDestinationNames()
Get a vector of strings that are the names of named destinations. 
 | 
BufferedImage | 
IPDFPage.getImage(int width,
        int height,
        boolean keepAspect)
Returns a buffered image showing the contents of this page. 
 | 
String | 
IPDFDocument.getText()
Returns the text content of the entire document, as a  
String | 
String | 
IPDFPage.getText()
Returns the text content of this page as a  
String. | 
String | 
IPDFDocument.getText(int pageIndex)
Returns the text content of this page as a  
String. | 
TextSelection | 
IPDFPage.getTextInArea(Rectangle2D selectArea)
Selects the text in an area of the page. 
 | 
TextSelection | 
IPDFPage.getTextWithCursors(Point2D startCursor,
                  Point2D endCursor)
Returns the text contained between the start and end cursors, in "reading mode". 
 | 
void | 
IPDFPage.printPage(Graphics2D g2d,
         PageFormat pf,
         PrintSettings printSettings)
Prints this page given a page format describing the printer's page and
 a PrintSettings object. 
 | 
| 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. 
 | 
| Constructor and Description | 
|---|
DocMDPPermissions(int permissionLevel)
Create a new DocMDPPermissions object. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
int | 
IImageInstance.getBitsPerComponent()
Returns the number of bits per component. 
 | 
int | 
IImageResource.getBitsPerComponent()
Returns the number of bits per component. 
 | 
String | 
IImageInstance.getColorSpace()
Returns the name of the color space used for this image. 
 | 
String | 
IImageResource.getColorSpace()
Returns the name of the color space used for this image. 
 | 
String | 
IImageInstance.getCompression()
Return the compression used for this image. 
 | 
String | 
IImageResource.getCompression()
Return the compression used for this image. 
 | 
float | 
IImageInstance.getDPI_X()
Returns the horizontal DPI value for this image instance. 
 | 
float | 
IImageInstance.getDPI_Y()
Returns the vertical DPI value for this image instance. 
 | 
String | 
IFontResource.getFontName()
Return the name of this font. 
 | 
int | 
IImageInstance.getHeight()
Return the height of the image, in pixels. 
 | 
int | 
IImageResource.getHeight()
Return the height of the image, in pixels. 
 | 
BufferedImage | 
IImageInstance.getImage()
This method returns a BufferedImage object for the image embedded in the PDF document. 
 | 
BufferedImage | 
IImageResource.getImage()
This method returns a BufferedImage object for the image embedded in the PDF document. 
 | 
int | 
IImageInstance.getNumComponents()
Returns the number of color components in the image. 
 | 
int | 
IImageResource.getNumComponents()
Returns the number of color components in the image. 
 | 
int | 
IImageInstance.getWidth()
Return the width of the image, in pixels. 
 | 
int | 
IImageResource.getWidth()
Return the width of the image, in pixels. 
 | 
boolean | 
IFontResource.isEmbedded()
Returns a flag indicating if this font is embedded in the document. 
 | 
List<IImageInstance> | 
IResourceManager.listImageInstances()
Returns a list of image instances in the document. 
 | 
| Constructor and Description | 
|---|
FilePDFSource(File source)  | 
FilePDFSource(String fileName)  | 
MBBPDFSource(File source)  | 
MBBPDFSource(String fileName)  | 
RAFilePDFSource(File source)
Creates a new  
RAFilePDFSource instance using the given
 File. | 
RAFilePDFSource(File source,
               boolean lockFile)
Creates a new  
RAFilePDFSource instance using the given
 File and boolean parameter indicating if the file should be
 locked. | 
RAFilePDFSource(String fileName)
Creates a new  
RAFilePDFSource instance using the given
 fileName. | 
RAFilePDFSource(String fileName,
               boolean lockFile)
Creates a new  
RAFilePDFSource instance using the given
 fileName and boolean parameter indicating if the file should be locked. | 
URLOnDemandPDFSource(URL url,
                    File tempFile)
Create a PDFSource to read a PDF from a URL "on demand". 
 | 
URLOnDemandPDFSource(URL url,
                    int storeType)
Create a PDFSource to read a PDF from a URL "on demand". 
 | 
URLPDFSource(URL url)  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
PDFEditorBean.applyRedactionAnnotation(Redaction redaction)
Apply the redaction annotation to the document. 
 | 
void | 
PDFEditorBean.applyRedactionAnnotations()
Apply redaction annotations to the document. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
PDFNotesBean.addAnnotation(Annotation newAnnot,
             int pageIndex)
Add an annotation to the document programmatically. 
 | 
void | 
PDFNotesBean.addAnnotation(Annotation newAnnot,
             int pageIndex,
             boolean setRotation)
Add an annotation to the document programmatically. 
 | 
SignatureField | 
PDFNotesBean.addSignatureField(String fieldName,
                 Rectangle2D bounds,
                 int pageIndex)
Add a signature field to a page in the currently loaded document. 
 | 
static JMenuItem | 
AnnotToolbar.createStampMenuItem(Image image,
                   ImageCompression imageCompression)
Creates a JMenuItem that draws a preview of the rubber stamp. 
 | 
static JMenuItem | 
AnnotToolbar.createStampMenuItem(String text,
                   Color color)
Creates a JMenuItem that draws a preview of the rubber stamp. 
 | 
void | 
MutableDocument.deletePage(int pageIndex)
Delete a page in the document. 
 | 
void | 
MutableDocument.deletePages(int startIndex,
           int endIndex)
Deletes a range of pages in the document. 
 | 
void | 
MutableDocument.exportAnnotsAsFDF(OutputStream outStream,
                 String pathToPDFFile,
                 Set<Annotation> annotSet)
Export the set of annotation comments to an output stream in FDF format. 
 | 
void | 
MutableDocument.exportAnnotsAsFDF(String fileName,
                 Set<Annotation> annotSet)
Exports annotation comments in FDF format. 
 | 
void | 
MutableDocument.exportAnnotsAsXFDF(OutputStream outStream,
                  String pathToPDFFile,
                  Set<Annotation> annotSet)
Export annotations comments to an output stream in XFDF format. 
 | 
void | 
MutableDocument.exportAnnotsAsXFDF(String fileName,
                  Set<Annotation> annotSet)
Exports annotations comments in XFDF format to a file. 
 | 
void | 
MutableDocument.extractPages(int startIndex,
            int endIndex,
            OutputStream outStream)
Creates and saves a new PDF document that contains a range of pages from this document. 
 | 
void | 
MutableDocument.extractPages(int startIndex,
            int endIndex,
            String outputFile)
Creates and saves a new PDF document that contains a range of pages from this document. 
 | 
void | 
MutableDocument.flattenAnnotation(Annotation annot,
                 int pageIndex)
Flattens a single annotation into the content layer. 
 | 
void | 
MutableDocument.flattenAnnotations()
Flatten the annotations on this document into the content layer. 
 | 
void | 
MutableDocument.flattenAnnotations(int pageIndex)
Flatten the annotations on a page into the content layer. 
 | 
void | 
MutableDocument.flattenFields(boolean paintButtons,
             boolean paintNonPrintableFields)
Flattens all the fields in a document. 
 | 
int | 
MutableDocument.getPageRotation(int pageIndex)
Gets the page rotation value, in degrees. 
 | 
void | 
MutableDocument.importAnnotsFromFDF(InputStream inStream)
Import annotations comments from an input stream in FDF format. 
 | 
void | 
MutableDocument.importAnnotsFromFDF(String fileName)
Import annotations comments from a file in XFDF Format. 
 | 
void | 
MutableDocument.importAnnotsFromXFDF(InputStream inStream)
Import annotations comments from an input stream in XFDF format. 
 | 
void | 
MutableDocument.importAnnotsFromXFDF(String fileName)
Import annotations comments from a file in FDF Format. 
 | 
void | 
MutableDocument.insertPage(String inputFile,
          int targetIndex)
Insert all pages into this document from another document. 
 | 
void | 
MutableDocument.insertPages(String inputFile,
           int srcStartIndex,
           int srcEndIndex,
           int targetIndex)
Insert pages into this document from another document. 
 | 
void | 
PDFNotesBean.loadDocument(InputStream inStream,
            String formatName)
Open a document from an input stream. 
 | 
void | 
PDFNotesBean.loadDocument(String fileName)
Method to open files of PDF, JPEG, TIFF and PNG types. 
 | 
void | 
PDFNotesBean.loadFDF(String fileName)
Load an FDF file. 
 | 
void | 
PDFNotesBean.loadPDF(InputStream inStream)
Load and display a PDF document using an InputStream. 
 | 
void | 
PDFNotesBean.loadPDF(PDFSource pdfSource)
Load and display a PDF document using a PDFSource object 
 | 
void | 
PDFNotesBean.loadPDF(String fileName)
Load and display a PDF document using a file name. 
 | 
void | 
PDFNotesBean.loadPDF(URL url)
Load and display a PDF document using a URL. 
 | 
void | 
PDFNotesBean.loadTextDocument(String fileName,
                TextToPDFSettings settings)
Method to open text files . 
 | 
void | 
PDFNotesBean.loadXFDF(String fileName)
Load an XFDF file. 
 | 
void | 
MutableDocument.movePage(int fromIndex,
        int toIndex)
Moves a page in a document. 
 | 
void | 
PDFNotesBean.openFile(PDFViewerBean viewerBean)
This method is called whenever the user presses the file open button. 
 | 
void | 
PDFNotesBean.removeAnnotation(Annotation annot,
                int pageIndex)
Remove an annotation from the document programmatically. 
 | 
void | 
PDFNotesBean.saveDocument(OutputStream outStream)
Saves a copy of this document to an output stream. 
 | 
void | 
PDFNotesBean.saveDocument(String fileName)
Saves a copy of this document to a file. 
 | 
void | 
MutableDocument.setPageRotation(int pageIndex,
               int degrees)
Sets the page rotation value for a page. 
 | 
void | 
PDFNotesBean.signDocument(SignatureField signField)
Starts the signing GUI for a given signature field. 
 | 
void | 
PDFNotesBean.signDocument(SignatureField signField,
            boolean certify)
Starts the signing GUI for a given signature field. 
 | 
void | 
PDFNotesBean.signDocument(SignatureField signField,
            SigningInformation signingInfo,
            File outputFile)
This method will sign and save the document. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
PDFPage.addAnnotation(Annotation annot)
Adds a new annotation to this page. 
 | 
void | 
PDFDocument.addAnnotations(Map<Integer,Vector<Annotation>> annotHash)
This method allows multiple annotations to be added to multiple pages. 
 | 
boolean | 
PDFDocument.addEmbeddedFile(File file)
Embeds a file into this PDF document. 
 | 
IEmbeddedFile | 
PDFDocument.addEmbeddedFile(File file,
               EmbedFileOptions options)
Embeds a file into this PDF document, with options. 
 | 
boolean | 
PDFDocument.addEmbeddedFile(InputStream inStream,
               String fileName,
               Date modDate,
               Date creationDate)
Embeds a file into this PDF document. 
 | 
IEmbeddedFile | 
PDFDocument.addEmbeddedFile(InputStream inStream,
               String fileName,
               Date modDate,
               Date creationDate,
               EmbedFileOptions options)
Embeds a file into this PDF document, with options. 
 | 
void | 
PDFPage.addJPEGImage(File jpegFile,
            int x,
            int y,
            AffineTransform xform)
Adds a JPEG image onto this page. 
 | 
Layer | 
PDFDocument.addLayer(String name,
        int initialState)
Creates and returns a PDF layer (Optional Content Group). 
 | 
Layer | 
PDFDocument.addLayer(String name,
        int initialState,
        boolean showInList)
Creates and returns a PDF layer (Optional Content Group). 
 | 
void | 
PDFDocument.addPageFromTemplate(String templateName,
                   int pageIndex)
Add a page from a template. 
 | 
SignatureField | 
PDFPage.addSignatureField(String fieldName,
                 Rectangle2D bounds)
Adds a signature field to this page. 
 | 
void | 
PDFDocument.appendDocument(PDFDocument appendDoc)
Appends a PDF document to this document. 
 | 
void | 
PDFDocument.appendGIFAsPage(InputStream gifStream,
               int dpi)
Creates a new page in the PDF document and adds the GIF image to it. 
 | 
void | 
PDFDocument.appendGIFAsPage(String gifFileName,
               int dpi)
Creates a new page in the PDF document and adds the GIF image to it. 
 | 
void | 
PDFDocument.appendGIFAsPage(String gifFileName,
               int dpi,
               int compression)
Creates a new page in the PDF document and adds the GIF image to it. 
 | 
void | 
PDFDocument.appendImage(File imageFile)
This method appends an image (or series of images) to the current document. 
 | 
void | 
PDFDocument.appendImage(InputStream inStream,
           String formatName)
This method appends an image (or series of images) to the current document. 
 | 
void | 
PDFDocument.appendImageAsPage(BufferedImage image,
                 double pageWidth,
                 double pageHeight,
                 int compressionType)
Creates a new page, with given dimensions, in the PDF document and adds the image to it. 
 | 
void | 
PDFDocument.appendImageAsPage(BufferedImage original,
                 int compressionType,
                 int colorSpace,
                 int dpi)
Creates a new page in the PDF document and adds the image to it. 
 | 
void | 
PDFDocument.appendJPEG2000AsPage(InputStream inStream,
                    int dpi)
Creates a new page in the PDF document and adds a JPEG200 image, read from an input stream, to it using the DPI specified. 
 | 
void | 
PDFDocument.appendJPEGAsPage(InputStream inStream)
Creates a new page in the PDF document and adds the JPEG image to it. 
 | 
void | 
PDFDocument.appendJPEGAsPage(String jpegFileName)
Creates a new page in the PDF document and adds the JPEG file to it. 
 | 
void | 
PDFDocument.appendJPEGAsPage(String jpegFileName,
                int dpi)
Creates a new page in the PDF document and adds the JPEG file to it. 
 | 
PDFPage | 
PDFDocument.appendNewPage(double pageWidth,
             double pageHeight)
Creates and appends a new PDFPage to this document. 
 | 
PDFPage | 
PDFDocument.appendPage(PDFPage page)
Appends a page to this document. 
 | 
void | 
PDFPage.appendPageContent(PDFPage srcPage,
                 double x,
                 double y,
                 double scaleX,
                 double scaleY,
                 Layer layer)
Adds the content of another page to this page. 
 | 
void | 
PDFDocument.appendPNGAsPage(InputStream inStream)
Creates a new page in the PDF document and adds a PNG image, read from an input stream, to it. 
 | 
void | 
PDFDocument.appendPNGAsPage(String pngFileName)
Creates a new page in the PDF document and adds the PNG file to it. 
 | 
void | 
PDFDocument.appendTextAsPages(InputStream textStream,
                 TextToPDFSettings settings)
Creates new pages in the PDF document and adds the text, read from an
 input stream, to them. 
 | 
void | 
PDFDocument.appendTextAsPages(String txtFileName,
                 TextToPDFSettings settings)
Creates new pages in the PDF document and adds the text from an text file
 to them. 
 | 
void | 
PDFDocument.appendTIFFAsPages(InputStream inStream)
Appends the pages in a TIFF image from an input stream to the end of this document. 
 | 
void | 
PDFDocument.appendTIFFAsPages(String tiffFileName)
Appends the pages in a TIFF file to the end of this document. 
 | 
boolean | 
PDFPage.applyRedactionAnnotation(Redaction redactionAnnot)
This method will apply or "burn in" the redaction annotation. 
 | 
boolean | 
PDFPage.applyRedactionAnnotations()
This method will apply or "burn in" all redaction annotations that are on
 this  
PDFPage. | 
void | 
PDFDocument.clearPasswordPermissions(String currentPermissionsPwd)
Clears the password permissions for this document. 
 | 
void | 
PDFDocument.clearUsageRights()
Remove extended permissions from the document. 
 | 
boolean | 
PDFPage.containsInvisibleText()
Checks whether the page contains text which is invisible. 
 | 
Annotation | 
PDFPage.copyAnnotation(Annotation annot)
Use this method to copy a single annotation onto this page, from this or other documents. 
 | 
void | 
PDFPage.copyAnnotations(PDFPage srcPage)
Use this method to copy annotations onto this page, from this or other
 documents. 
 | 
void | 
PDFPage.copyAnnotations(PDFPage srcPage,
               Layer layer)
Use this method to copy annotations onto this page, from this or other
 documents. 
 | 
static PDFDocument | 
PDFCompare.createCompare(PDFDocument doc1,
             CompareOptions options1,
             PDFDocument doc2,
             CompareOptions options2)
Create a new PDFDocument with separate layers containing the PDF content
 converted to color. 
 | 
Graphics2D | 
PDFPage.createGraphics()
Creates a Graphics2D object to draw into this page. 
 | 
Graphics2D | 
PDFPage.createGraphics(Layer layer)
Creates a graphics object that encapsulates a layer in a PDF document. 
 | 
Bookmark | 
PDFDocument.createRootBookmark()
Creates a new root bookmark and saves it in the document catalog. 
 | 
void | 
PDFDocument.createTemplateFromPage(int pageIndex,
                      String templateName,
                      boolean visible)
Create a template based off an existing page in the document 
 | 
void | 
PDFDocument.deleteAnnotations()
Delete all annotations in the document. 
 | 
void | 
PDFPage.deleteAnnotations()
Deprecated. 
 
Use  
PDFPage.deleteAnnotations(List) instead. | 
int | 
PDFPage.deleteAnnotations(List<? extends Annotation> annots)
Deletes a list of annotations on the page. 
 | 
void | 
PDFDocument.deletePage(int pageIndex)
Deletes a page from this document. 
 | 
void | 
PDFDocument.deletePageRange(int startPageIx,
               int endPageIx)
Delete a set of pages from this document. 
 | 
void | 
PDFPage.drawImage(Image image,
         int dstX,
         int dstY,
         Color bgndColor,
         AffineTransform xform,
         ImageCompression imageSettings)
Draws an image onto this page. 
 | 
void | 
PDFPage.drawImage(Image image,
         int dstX,
         int dstY,
         int dstWidth,
         int dstHeight,
         Color bgndColor,
         AffineTransform xform,
         ImageCompression imageSettings)
Draws an image onto this page. 
 | 
void | 
PDFPage.drawImage(Image image,
         int dstX,
         int dstY,
         int dstWidth,
         int dstHeight,
         Color bgndColor,
         AffineTransform xform,
         ImageCompression params,
         Float alpha)
Draws an image onto this page. 
 | 
void | 
PDFPage.drawText(String str,
        Font font,
        Paint textPaint,
        double x,
        double y,
        AffineTransform xform)
Draw text to this page using Java Font 
 | 
Font | 
PDFDocument.embedFont(InputStream instream,
         int fontFormat)
Embeds a font in the PDF file. 
 | 
Font | 
PDFDocument.embedFont(String fileName,
         int fontFormat)
Embeds a font in the PDF file. 
 | 
void | 
PDFDocument.exportAnnotsAsCSV(OutputStream outStream)
Export annotations comments to an output stream in CSV format. 
 | 
void | 
PDFDocument.exportAnnotsAsCSV(String fileName)
Exports annotations comments in CSV format. 
 | 
void | 
PDFDocument.exportAnnotsAsFDF(OutputStream outStream,
                 String pathToPDFFile,
                 Set<Annotation> annotSet)
Export the set of annotation comments to an output stream in FDF format. 
 | 
void | 
PDFDocument.exportAnnotsAsFDF(String fileName,
                 Set<Annotation> annotSet)
Exports a set of annotation comments in FDF format. 
 | 
void | 
PDFDocument.exportAnnotsAsXFDF(OutputStream outStream,
                  String pathToPDFFile,
                  Set<Annotation> annotSet)
Export annotations comments to an output stream in XFDF format. 
 | 
void | 
PDFDocument.exportAnnotsAsXFDF(String fileName,
                  Set<Annotation> annotSet)
Exports annotations comments in XFDF format. 
 | 
Vector<TextPosition> | 
PDFPage.findText(String searchText,
        boolean caseSensitive,
        boolean wholeWords)
This method searches for the given text in the page. 
 | 
Vector<TextPosition> | 
PDFPage.findTextUsingRegex(String regex)
This method searches for the given text in the page. 
 | 
Vector<TextPositionWithContext> | 
PDFPage.findTextWithContext(String searchText,
                   boolean caseSensitive,
                   boolean wholeWords)
This method searches for the given text in the page. 
 | 
Vector<TextPositionWithContext> | 
PDFPage.findTextWithContextUsingRegEx(String regexString)
This method searches for text in the page for matches with the given regular expression. 
 | 
Object | 
PDFPage.flattenAnnotation(Annotation annot)
Flatten an annotation into the content. 
 | 
int | 
PDFDocument.flattenAnnotations(boolean paintNonPrintableAnnots)
Flattens the annotations. 
 | 
Object | 
PDFPage.flattenAnnotations(boolean paintNonPrintableAnnots)
Flattens the annotations. 
 | 
int | 
PDFDocument.flattenFields(boolean paintButtons,
             boolean paintNonPrintableFields)
Flattens the pdf form fields. 
 | 
int | 
PDFDocument.flattenFields(boolean paintButtons,
             boolean paintOnlyImageButtons,
             boolean paintNonPrintableFields)
Flattens the pdf form fields. 
 | 
void | 
PDFPage.flattenWidget(Widget widget)
Flatten a widget into the content layer of the page. 
 | 
Vector<Annotation> | 
PDFPage.getAnnotations()
Returns a list of PDF annotations in this page, including form fields widgets. 
 | 
Vector<String> | 
PDFDocument.getDestinationNames()
Get a vector of strings that are the names of named destinations (saved locations
 in the document used for links, bookmarks, buttons etc.). 
 | 
BufferedImage | 
PDFPage.getImage()
Returns a BufferedImage containing a rendering
 of the page at the default PDF resolution: 72 DPI. 
 | 
BufferedImage | 
PDFPage.getImage(int dpi)
Returns a BufferedImage containing a rendering
 of the page at the given resolution in DPI. 
 | 
BufferedImage | 
PDFPage.getImage(int width,
        int height,
        boolean keepAspect)
Returns a buffered image showing the contents of this page. 
 | 
BufferedImage | 
PDFPage.getImageCS(int dpi,
          ColorSpace imageCS)
Returns a BufferedImage, created in the given color space, containing a rendering of the page at the given resolution in DPI. 
 | 
BufferedImage | 
PDFPage.getImageCS(int dpi,
          ColorSpace imageCS,
          boolean simOverprint)
Returns a BufferedImage, created in the given color space, containing a rendering of the page at the given resolution in DPI. 
 | 
String | 
PDFPage.getPageLabel()
Returns the page label for this page. 
 | 
BufferedImage | 
PDFPage.getSubImage(Rectangle2D pageArea,
           int dpi)
Returns an image for part of the page. 
 | 
Vector<String> | 
PDFDocument.getTemplateNames()
Get a vector of strings that are the names of templates. 
 | 
String | 
PDFDocument.getText()
Returns the text in the pdf document as a  
String. | 
String | 
PDFPage.getText()
Returns the text content of this page as a  
String. | 
String | 
PDFDocument.getText(int pageIndex)
Returns text contained in the specified page of the pdf document 
 as a String. 
 | 
TextContent | 
PDFPage.getTextContent()
This method returns a TextContent object that represents the text content in a page. 
 | 
TextSelection | 
PDFPage.getTextInArea(Rectangle2D selectArea)
Selects the text in an area of the page. 
 | 
TextSelection | 
PDFPage.getTextWithCursors(Point2D startCursor,
                  Point2D endCursor)
Returns the text contained between the start and end cursors, in "reading mode". 
 | 
Vector<String> | 
PDFDocument.getWords()
Returns all words in the pdf document as a  
Vector of Strings. | 
Vector<String> | 
PDFDocument.getWords(int pageIndex)
Returns all words contained in the specified page of the pdf document 
 as a Vector of Strings. 
 | 
Object | 
PDFDocument.importAnnotsFDF(InputStream inStream)
Import annotations comments from an input stream in FDF format. 
 | 
Object | 
PDFDocument.importAnnotsFDF(String fileName)
Import annotations comments from a file in FDF Format. 
 | 
Object | 
PDFDocument.importAnnotsPDF(PDFDocument sourcePDF)
Import annotations from another PDFDocument. 
 | 
Object | 
PDFDocument.importAnnotsXFDF(InputStream inStream)
Import annotations from an input stream in XFDF Format. 
 | 
Object | 
PDFDocument.importAnnotsXFDF(String fileName)
Import annotations from a file in XFDF Format. 
 | 
void | 
PDFPage.insert_hOCR(String hocrText,
           boolean renderText)
This methods inserts hOCR text into this page. 
 | 
PDFPage | 
PDFDocument.insertNewPage(double pageWidth,
             double pageHeight,
             int index)
Creates a new PDFPage and inserts it into the document at the given position. 
 | 
PDFPage | 
PDFDocument.insertPage(PDFPage page,
          int index)
Inserts a page into this document at the given index. 
 | 
boolean | 
PDFPage.isEmpty()
Check whether the page is empty. 
 | 
static PDFDocument | 
PDFDocument.loadRTF(String rtfFile,
       PageFormat pf)
Creates a PDFDocument from an RTF file. 
 | 
void | 
PDFDocument.movePage(int currentIndex,
        int newIndex)
moves an existing page to a new location. 
 | 
void | 
PDFPage.prependPageContent(PDFPage srcPage,
                  double x,
                  double y,
                  double scaleX,
                  double scaleY,
                  Layer layer)
Prepend the contents of another page to this page. 
 | 
void | 
PDFPage.printPage(Graphics2D g2d,
         PageFormat pf,
         PrintSettings printSettings)
Prints this page given a page format describing the printer's page and
 a PrintSettings object. 
 | 
void | 
PDFPage.removeAnnotation(Annotation annot)
Removes an annotation from this page. 
 | 
boolean | 
PDFDocument.removeEmbeddedFile(IEmbeddedFile ef)
Remove a file embedded in this document. 
 | 
void | 
PDFDocument.removeTemplate(String templateName)
Remove an existing template. 
 | 
void | 
PDFPage.resizePage(ResizePageOptions options)
Sets this page's Media Box. 
 | 
void | 
PDFDocument.saveDocument(OutputStream outStream)
Saves this document to an output stream. 
 | 
void | 
PDFDocument.saveDocument(String fileName)
Saves this document to a file. 
 | 
void | 
PDFDocument.saveDocumentAsTIFF(OutputStream outStream,
                  double resDPI,
                  String tiffCompression)
Save the entire document as a multi-page TIFF image to the given OutputStream. 
 | 
void | 
PDFDocument.saveDocumentAsTIFF(OutputStream outStream,
                  TIFFOptions options)
Save the entire document as a multi-page TIFF image to an OutputStream. 
 | 
void | 
PDFDocument.saveDocumentLinearized(OutputStream outputStream)
Saves this document as a linearized PDF document, for faster web viewing. 
 | 
void | 
PDFPage.savePageAsGIF(OutputStream outStream,
             int dpi)
Render the page as an image and save it to the output stream in GIF format. 
 | 
void | 
PDFPage.savePageAsJPEG(OutputStream outStream,
              int dpi,
              float quality)
Render the page as an image and save it to the output stream in JPEG format. 
 | 
void | 
PDFPage.savePageAsJPEG2000(OutputStream outStream,
                  int dpi,
                  float quality)
Render the page as an image and save it to the output stream in JPEG2000 format. 
 | 
void | 
PDFPage.savePageAsPNG(OutputStream outStream,
             int dpi)
Render the page as an image and save it to the output stream in PNG format. 
 | 
void | 
PDFPage.savePageAsTIFF(OutputStream outStream,
              double resDPI,
              String tiffCompression)
Save the rendering image of the page to the given OutputStream
 in TIFF format. 
 | 
void | 
PDFPage.savePageAsTIFF(OutputStream outStream,
              TIFFOptions options)
Render the page to an image and save it in TIFF format to the given OutputStream. 
 | 
void | 
PDFGraphics.setBlendMode(String blendMode)  | 
void | 
PDFPage.setClip(Area newClip)
Sets the clip area in the page's content stream when drawing to the page. 
 | 
void | 
PDFPage.setCropBox(Rectangle2D rect)
Sets the PDF page's 'CropBox'. 
 | 
void | 
PDFDocument.setInitialPage(int pageIndex,
              String scale)
Sets the initial page and scale to use when this document is opened with a PDF viewer. 
 | 
void | 
PDFDocument.setJSOpenAction(JSAction jsAction)
Sets the open action for this document. 
 | 
void | 
PDFDocument.setPageLabels(int[] indices,
             String prefix,
             String style,
             int offset)
Sets a page label to identify each page visually on the screen or in
 print. 
 | 
void | 
PDFDocument.setPageLayout(String pageLayout)
Changes the value of the page layout key for this document. 
 | 
void | 
PDFDocument.setPageMode(String pageMode)
Changes the value of the page mode viewer preference in the document. 
 | 
void | 
PDFPage.setPageRotation(int degrees)
Changes this page's rotation. 
 | 
void | 
PDFDocument.setPasswordPermissions(String newPermissionsPwd,
                      String newOpenPwd,
                      PasswordPermissions permissions,
                      String currentPermissionsPwd,
                      int encryptType)
Sets the security for this document. 
 | 
void | 
PDFDocument.signDocument(SignatureField signField,
            SigningInformation signingInfo)
Signs this document using the given signature field. 
 | 
String | 
PDFPage.useGradientPaint(GradientPaint paint)  | 
String | 
PDFPage.useGState(double strokeAlpha,
         double fillAlpha,
         String blendName)  | 
boolean | 
PDFDocument.usePermissionsPassword(String password)
Tells the PDFDocument object that the permissions password is known, so all permissions are granted. 
 | 
| Constructor and Description | 
|---|
PDFDocument()
Creates a blank PDF document. 
 | 
PDFDocument(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(String fileName,
           IPassword password)
Loads a PDF document from a file. 
 | 
PDFDocument(URL url,
           IPassword password)
Loads a PDF document from a URL. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Rectangle2D | 
Span.getBounds(int beginIndex,
         int endIndex)  | 
void | 
Span.setColor(Color color)
Change the text fill color of the entire Span. 
 | 
void | 
Span.setColor(Color color,
        int beginIndex,
        int endIndex)
Change the text fill color of a subset of the Span. 
 | 
| Constructor and Description | 
|---|
TextContent(PDFPage page)
Create a new TextContent object from a PDFPage. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
PDFViewerBean.loadPDF(InputStream inStream)
Load and display a PDF document using an InputStream. 
 | 
void | 
PDFViewerBean.loadPDF(PDFSource source)
Load and display a PDF document using an object that implements PDFSource. 
 | 
void | 
PDFViewerBean.loadPDF(String fileName)
Load and display a PDF document using a file name. 
 | 
void | 
PDFViewerBean.loadPDF(URL url)
Load and display a PDF document using a URL. 
 | 
void | 
PDFViewerBean.openFile()
Initiates the file open process. 
 | 
void | 
IPDFOpener.openFile(PDFViewerBean viewerBean)
This method gets called by the PDFViewerBean whenever the user presses the folder open button on the toolbar. 
 | 
void | 
PDFViewerBean.openFile(PDFViewerBean viewerBean)
Initiates the file open process. 
 | 
TextSelection | 
IPDFPageView.selectTextInArea(Rectangle2D selectRect)
Selects the text in an area of the page. 
 | 
TextSelection | 
IPDFPageView.selectTextWithCursors(Point2D startCursor,
                     Point2D endCursor)
Selects the text in the page from the start cursor to the end cursor, in reading mode. 
 |