Package | Description |
---|---|
com.qoppa.pdf |
General classes used by different objects throughout the library.
|
com.qoppa.pdf.source |
PDFSource interface and implementations.
|
com.qoppa.pdfPreflight |
Main package for the jPDFPreflight product.
|
com.qoppa.pdfPreflight.results |
This package holds classes that hold the results from PDF verification.
|
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.
|
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<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 |
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 |
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 |
---|
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 |
PDFPreflight.addResultAnnotations(PreflightResults results)
Adds the ResultRecords as Annotations to the document that was preflighted.
|
void |
PDFPreflight.appendPreflightReport(PreflightResults results,
int pageWidth,
int pageHeight)
Deprecated.
- use PDFPreflight.appendPreflightReport(PreflightResults, int, int, PreflightReportOptions)
|
void |
PDFPreflight.appendPreflightReport(PreflightResults results,
int pageWidth,
int pageHeight,
PreflightReportOptions reportOptions)
Appends the Preflight report to the document that was preflighted.
|
PreflightResults |
PDFPreflight.convertDocument(ConversionProfile profile,
ProgressListener progress)
This method converts this document to make it compliant with the given profile.
|
void |
PDFPreflight.saveDocument(OutputStream outStream)
Saves this document to an output stream.
|
void |
PDFPreflight.saveDocument(String fileName)
Saves this document to a file.
|
PreflightResults |
PDFPreflight.verifyDocument(VerificationProfile profile,
ProgressListener progress)
This method runs this document through a preflight profile and returns the results.
|
Constructor and Description |
---|
PDFPreflight(InputStream inStream,
IPassword password)
Loads a PDF document from an InputStream.
|
PDFPreflight(PDFSource source,
IPassword password)
Loads a PDF document from a PDFSource object.
|
PDFPreflight(String fileName,
IPassword password)
Loads a PDF document from a file.
|
PDFPreflight(URL url,
IPassword password)
Loads a PDF document from a URL.
|
Modifier and Type | Method and Description |
---|---|
void |
PreflightResults.addResultAnnotations()
Deprecated.
- use PDFPreflight.addResultAnnotations(PreflightResults)
|
void |
PreflightResults.appendPreflightReport(int pageWidth,
int pageHeight)
Deprecated.
- use PDFPreflight.appendPreflightReport(PreflightResults, int, int, PreflightReportOptions)
|
void |
PreflightResults.savePreflightReport(OutputStream outStream,
int pageWidth,
int pageHeight)
Deprecated.
- use PreflightResults.savePreflightReport(OutputStream, int, int, PreflightReportOptions)
|
void |
PreflightResults.savePreflightReport(OutputStream outStream,
int pageWidth,
int pageHeight,
PreflightReportOptions reportOptions)
Saves a Preflight report as a PDF document to an OutputStream.
|
void |
PreflightResults.savePreflightReport(String fileName,
int pageWidth,
int pageHeight)
Deprecated.
- use PreflightResults.savePreflightReport(String, int, int, PreflightReportOptions)
|
void |
PreflightResults.savePreflightReport(String fileName,
int pageWidth,
int pageHeight,
PreflightReportOptions reportOptions)
Saves a Preflight report as a PDF document to a file.
|