Package | Description |
---|---|
com.qoppa.pdf |
General classes used by different objects throughout the library.
|
com.qoppa.pdf.actions |
Classes that represent user actions.
|
com.qoppa.pdf.permissions |
This package contains classes related to document permissions.
|
com.qoppa.pdfAssemble |
jPDFAssemble main classes, used to assemble PDF documents.
|
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(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<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.
|
Constructor and Description |
---|
DocMDPPermissions(int permissionLevel)
Create a new DocMDPPermissions object.
|
Modifier and Type | Method and Description |
---|---|
void |
PDFAssemble.addGoToPage(Bookmark bookmark,
int pageNum)
Adds a GoToPage action to the Bookmark Parameter.
|
void |
PDFAssemble.addGoToPage(Bookmark bookmark,
int pageNum,
int zoomMode)
Adds a GoToPage action to the Bookmark Parameter with a zoom mode.
|
void |
PDFAssemble.addGoToPage(Bookmark bookmark,
int pageNum,
int x,
int y,
double scale)
Adds a GoToPage action to the Bookmark Parameter that uses x and y coordinates and a zoom scale.
|
void |
PDFAssemble.appendDocument(PDFAssemble appendDoc)
Appends a PDF document to this document.
|
void |
PDFAssemble.appendPage(PDFAssemble source,
int pageIndex)
Appends a page to this document.
|
Bookmark |
PDFAssemble.createBookmark(Bookmark parent,
int pageNum)
Creates a Bookmark with a GoToPage action, and Add it as a child to the parent Bookmark parameter
|
Bookmark |
PDFAssemble.createBookmark(Bookmark parent,
int pageNum,
int zoomMode)
Creates a Bookmark with a GoToPage action with a zoom mode, and Add it as a child to the parent Bookmark parameter
|
Bookmark |
PDFAssemble.createBookmark(Bookmark parent,
int pageNum,
int x,
int y,
double scale)
Creates a Bookmark with a GoToPage action that uses x and y coordinates and a zoom scale.
|
Bookmark |
PDFAssemble.createRootBookmark()
Creates a new root bookmark and saves it in the document catalog.
|
void |
PDFAssemble.deletePage(int pageIndex)
Deletes a page from this document.
|
void |
PDFAssemble.deletePages(int startIndex,
int endIndex)
Deletes a range of pages in the document.
|
PDFAssemble |
PDFAssemble.extractPages(int startIndex,
int endIndex,
OutputStream outStream)
Creates and saves a new PDF document that contains a range of pages from this document.
|
PDFAssemble |
PDFAssemble.extractPages(int startIndex,
int endIndex,
String outputFile)
Creates and saves a new PDF document that contains a range of pages from this document.
|
void |
PDFAssemble.insertPage(PDFAssemble sourceDoc,
int srcPageIndex,
int dstPageIndex)
Inserts a page into this document at the given index.
|
void |
PDFAssemble.saveDocument(OutputStream outStream)
Saves this document to an output stream.
|
void |
PDFAssemble.saveDocument(String fileName)
Saves this document to a file.
|
void |
PDFAssemble.setInitialPage(int pageIndex,
String scale)
Sets the initial page and scale to use when this document is opened with a PDF viewer.
|
void |
PDFAssemble.setInitialPageLayout(String pageLayout)
Changes the value of the page layout key for this document.
|
void |
PDFAssemble.setInitialPageMode(String pageMode)
Changes the value of the page mode viewer preference in the document.
|
boolean |
PDFAssemble.usePermissionsPassword(String ownerPassword)
Tells the PDFAssemble object that the permissions password is known, so
all permissions are granted.
|
Constructor and Description |
---|
PDFAssemble()
Creates a blank PDFAssemble object.
|
PDFAssemble(InputStream inStream,
IPassword password)
Loads a PDF document from an InputStream.
|
PDFAssemble(String fileName,
IPassword password)
Loads a PDF document from a file.
|
PDFAssemble(URL url,
IPassword password)
Loads a PDF document from a URL.
|