Index
All Classes and Interfaces|All Packages|Serialized Form
A
- a0landscape - Static variable in class com.coherentpdf.Jcpdf
-
Paper size: A0 Landscape
- a0portrait - Static variable in class com.coherentpdf.Jcpdf
-
Paper size: A0 Portrait
- a1landscape - Static variable in class com.coherentpdf.Jcpdf
-
Paper size: A1 Landscape
- a1portrait - Static variable in class com.coherentpdf.Jcpdf
-
Paper size: A1 Portrait
- a2landscape - Static variable in class com.coherentpdf.Jcpdf
-
Paper size: A2 Landscape
- a2portrait - Static variable in class com.coherentpdf.Jcpdf
-
Paper size: A2 Portrait
- a3landscape - Static variable in class com.coherentpdf.Jcpdf
-
Paper size: A3 Landscape
- a3portrait - Static variable in class com.coherentpdf.Jcpdf
-
Paper size: A3 Portrait
- a4landscape - Static variable in class com.coherentpdf.Jcpdf
-
Paper size: A4 Landscape
- a4portrait - Static variable in class com.coherentpdf.Jcpdf
-
Paper size: A4 Portrait
- a5landscape - Static variable in class com.coherentpdf.Jcpdf
-
Paper size: A5 Landscape
- a5portrait - Static variable in class com.coherentpdf.Jcpdf
-
Paper size: A5 Portrait
- addContent(String, boolean, Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Adds page content before or after the existing content to pages in the given range in the given PDF.
- addPageLabels(Jcpdf.Pdf, int, String, int, Jcpdf.Range, boolean) - Method in class com.coherentpdf.Jcpdf
-
Adds page labels to a document.
- addText(boolean, Jcpdf.Pdf, Jcpdf.Range, String, int, double, double, double, int, int, double, double, double, double, boolean, boolean, boolean, double, int, boolean, boolean, String, double, boolean) - Method in class com.coherentpdf.Jcpdf
-
Adds text to the pages in the given range.
- addTextSimple(Jcpdf.Pdf, Jcpdf.Range, String, int, double, double, int, double) - Method in class com.coherentpdf.Jcpdf
-
Adds text with most parameters default.
- aes128bitfalse - Static variable in class com.coherentpdf.Jcpdf
-
Encryption method: 128 bit AES encryption, do not encrypt metadata
- aes128bittrue - Static variable in class com.coherentpdf.Jcpdf
-
Encryption method: 128 bit AES encryption, encrypt metadata
- aes256bitfalse - Static variable in class com.coherentpdf.Jcpdf
-
Encryption method: Deprecated.
- aes256bitisofalse - Static variable in class com.coherentpdf.Jcpdf
-
Encryption method: 256 bit AES encryption, do not encrypt metadata
- aes256bitisotrue - Static variable in class com.coherentpdf.Jcpdf
-
Encryption method: 256 bit AES encryption, encrypt metadata
- aes256bittrue - Static variable in class com.coherentpdf.Jcpdf
-
Encryption method: Deprecated.
- all(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
The page range contaning all pages in a given document.
- annotationsJSON(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the annotations from a PDF in JSON format.
- attachFile(String, Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Attaches a file to the PDF.
- attachFileFromMemory(byte[], String, Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Attaches data from memory to a document.
- attachFileToPage(String, Jcpdf.Pdf, int) - Method in class com.coherentpdf.Jcpdf
-
Attaches a file to a page of the PDF.
- attachFileToPageFromMemory(byte[], String, Jcpdf.Pdf, int) - Method in class com.coherentpdf.Jcpdf
-
Attaches data to a page from memory.
B
- blackFills(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Blackens all fills on the given pages.
- blackLines(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Blackens all lines on the given pages.
- blackText(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Blackens all text on the given pages.
- blankDocument(double, double, int) - Method in class com.coherentpdf.Jcpdf
-
Creates a blank document with pages of the given width (in points), height (in points), and number of pages.
- blankDocumentPaper(int, int) - Method in class com.coherentpdf.Jcpdf
-
Makes a blank document given a page size and number of pages.
- blankRange() - Method in class com.coherentpdf.Jcpdf
-
The range containing no pages.
- bottom - Static variable in class com.coherentpdf.Jcpdf
-
Position anchor: the bottom middle of the page.
- bottomLeft - Static variable in class com.coherentpdf.Jcpdf
-
Position anchor: the bottom left of the page.
- bottomRight - Static variable in class com.coherentpdf.Jcpdf
-
Position anchor: the bottomm right of the page.
C
- centerWindow(Jcpdf.Pdf, boolean) - Method in class com.coherentpdf.Jcpdf
-
Sets the center window flag.
- centreJustify - Static variable in class com.coherentpdf.Jcpdf
-
Justification: centre
- close() - Method in class com.coherentpdf.Jcpdf.Pdf
- close() - Method in class com.coherentpdf.Jcpdf.Range
- cmOfPt(double) - Method in class com.coherentpdf.Jcpdf
-
Converts a figure in points to centimetres.
- com.coherentpdf - package com.coherentpdf
-
Jcpdf is a Java interface to the cpdf pdf tools.
- combinePages(Jcpdf.Pdf, Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Combines the two PDFs page-by-page, putting each page of 'over' over each page of 'under'.
- compress(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Compresses any uncompressed streams in the given PDF using the Flate algorithm.
- copyFont(Jcpdf.Pdf, Jcpdf.Pdf, Jcpdf.Range, int, String) - Method in class com.coherentpdf.Jcpdf
-
Copies the given font from the given page in the 'from' PDF to every page in the 'to' PDF.
- copyId(Jcpdf.Pdf, Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Copies the
/ID
from one document to another. - courier - Static variable in class com.coherentpdf.Jcpdf
-
Standard font: Courier
- courierBold - Static variable in class com.coherentpdf.Jcpdf
-
Standard font: Courier Bold
- courierBoldOblique - Static variable in class com.coherentpdf.Jcpdf
-
Standard font: Courier Bold Oblique
- courierOblique - Static variable in class com.coherentpdf.Jcpdf
-
Standard font: Courier Oblique
- CpdfError(String) - Constructor for exception com.coherentpdf.Jcpdf.CpdfError
- createMetadata(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Builds fresh XMP metadata as best it can from existing metadata in the document.
- crop(Jcpdf.Pdf, Jcpdf.Range, double, double, double, double) - Method in class com.coherentpdf.Jcpdf
-
Crops a page, replacing any existing crop box.
D
- dateStringOfComponents(int, int, int, int, int, int, int, int) - Method in class com.coherentpdf.Jcpdf
-
Builds a PDF date string from individual components.
- decimalArabic - Static variable in class com.coherentpdf.Jcpdf
-
Page label style: 1, 2, 3...
- decompress(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Decompresses any streams in the given PDF, so long as the compression method is supported.
- decryptPdf(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Attempts to decrypt a PDF using the given user password.
- decryptPdfOwner(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Attempts to decrypt a PDF using the given owner password.
- diagonal - Static variable in class com.coherentpdf.Jcpdf
-
Position anchor: diagonal, bottom left to top right.
- difference(Jcpdf.Range, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
The range containing all pages in the first given range which are not in the second.
- displayDocTitle(Jcpdf.Pdf, boolean) - Method in class com.coherentpdf.Jcpdf
-
Sets the display document title flag.
- draft(Jcpdf.Pdf, Jcpdf.Range, boolean) - Method in class com.coherentpdf.Jcpdf
-
Removes images on the given pages, replacing them with crossed boxes if
boxes
istrue
.
E
- encryptionKind(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the encryption method currently in use on a document, such as
aes256bitisofalse
. - endEnumeratePDFs() - Method in class com.coherentpdf.Jcpdf
-
Ends enumeration of currently allocated PDFs.
- endGetAttachments() - Method in class com.coherentpdf.Jcpdf
-
Lists information about attachments.
- endGetBookmarkInfo() - Method in class com.coherentpdf.Jcpdf
-
Ends the bookmark retrieval process, cleaning up.
- endGetFontInfo() - Method in class com.coherentpdf.Jcpdf
-
Retrieves font information.
- endGetImageResolution() - Method in class com.coherentpdf.Jcpdf
-
Gets image data, including resolution at all points of use.
- endGetOCGList() - Method in class com.coherentpdf.Jcpdf
-
Ends retrieval of optional content group names.
- endGetPageLabels() - Method in class com.coherentpdf.Jcpdf
-
Gets page label data.
- endSetBookmarkInfo(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Ends the bookmark setting process, writing the bookmarks to the given PDF.
- enumeratePDFsInfo(int) - Method in class com.coherentpdf.Jcpdf
-
Returns the info for a given PDF number.
- enumeratePDFsKey(int) - Method in class com.coherentpdf.Jcpdf
-
Returns the key for a given PDF number.
- even(Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
The page range containing all even-numbered pages from an existing range.
F
- fitWindow(Jcpdf.Pdf, boolean) - Method in class com.coherentpdf.Jcpdf
-
Sets the fit window flag.
- fromFile(String, String) - Method in class com.coherentpdf.Jcpdf
-
Loads a PDF document from a file.
- fromFileLazy(String, String) - Method in class com.coherentpdf.Jcpdf
-
Loads a PDF document from a file, doing only minimal parsing.
- fromJSON(String) - Method in class com.coherentpdf.Jcpdf
-
Loads a PDF from a JSON file given its filename.
- fromJSONMemory(byte[]) - Method in class com.coherentpdf.Jcpdf
-
Loads a PDF from a JSON file in memory.
- fromMemory(byte[], String) - Method in class com.coherentpdf.Jcpdf
-
Loads a PDF document from memory.
- fromMemoryLazy(byte[], String) - Method in class com.coherentpdf.Jcpdf
-
Loads a file from memory and the user password, but lazily like
fromFileLazy
. - fromMemoryLazyRelease(byte[]) - Method in class com.coherentpdf.Jcpdf
-
Releases memory returned from
fromMemoryLazy
G
- getArtBox(Jcpdf.Pdf, int, double[]) - Method in class com.coherentpdf.Jcpdf
-
These functions get a box given the document.
- getAttachmentData(int) - Method in class com.coherentpdf.Jcpdf
-
Gets the attachment data itself, given a serial number.
- getAttachmentName(int) - Method in class com.coherentpdf.Jcpdf
-
Gets the name of an attachment, given a serial number.
- getAttachmentPage(int) - Method in class com.coherentpdf.Jcpdf
-
Gets the page number, given a serial number.
- getAuthor(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the author of a document.
- getAuthorXMP(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the XMP author of a document.
- getBleedBox(Jcpdf.Pdf, int, double[]) - Method in class com.coherentpdf.Jcpdf
-
These functions get a box given the document.
- getBookmarkLevel(int) - Method in class com.coherentpdf.Jcpdf
-
Gets the bookmark level for the given bookmark
0...(n - 1)
. - getBookmarkOpenStatus(int) - Method in class com.coherentpdf.Jcpdf
-
Returns
true
if the bookmark is open. - getBookmarkPage(Jcpdf.Pdf, int) - Method in class com.coherentpdf.Jcpdf
-
Gets the bookmark target page for the given PDF (which must be the same as the PDF passed to
startGetBookmarkInfo
) and bookmark0...(n - 1)
. - getBookmarksJSON(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the bookmark data in JSON format.
- getBookmarkText(int) - Method in class com.coherentpdf.Jcpdf
-
Returns the text of bookmark
0...(n - 1))
- getCreationDate(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the creation date of a document.
- getCreationDateXMP(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the XMP creation date of a document.
- getCreator(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the creator of a document.
- getCreatorXMP(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the XMP creator of a document.
- getCropBox(Jcpdf.Pdf, int, double[]) - Method in class com.coherentpdf.Jcpdf
-
These functions get a box given the document.
- getDateComponents(String, int[]) - Method in class com.coherentpdf.Jcpdf
-
Returns the components from a PDF date string in an array of length 8.
- getDictEntries(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Returns a JSON array containing any and all values associated with the given key, and fills in its length.
- getFontEncoding(int) - Method in class com.coherentpdf.Jcpdf
-
Retrieves font information.
- getFontName(int) - Method in class com.coherentpdf.Jcpdf
-
Retrieves font information.
- getFontPage(int) - Method in class com.coherentpdf.Jcpdf
-
Retrieves font information.
- getFontType(int) - Method in class com.coherentpdf.Jcpdf
-
Retrieves font information.
- getImageResolutionImageName(int) - Method in class com.coherentpdf.Jcpdf
-
Gets image data, including resolution at all points of use.
- getImageResolutionPageNumber(int) - Method in class com.coherentpdf.Jcpdf
-
Gets image data, including resolution at all points of use.
- getImageResolutionXPixels(int) - Method in class com.coherentpdf.Jcpdf
-
Gets image data, including resolution at all points of use.
- getImageResolutionXRes(int) - Method in class com.coherentpdf.Jcpdf
-
Gets image data, including resolution at all points of use.
- getImageResolutionYPixels(int) - Method in class com.coherentpdf.Jcpdf
-
Gets image data, including resolution at all points of use.
- getImageResolutionYRes(int) - Method in class com.coherentpdf.Jcpdf
-
Gets image data, including resolution at all points of use.
- getKeywords(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the keywords of a document.
- getKeywordsXMP(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the XMP keywords of a document.
- getMajorVersion(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the major version number of a document.
- getMediaBox(Jcpdf.Pdf, int, double[]) - Method in class com.coherentpdf.Jcpdf
-
These functions get a box given the document.
- getMetadata(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the XMP metadata from a document.
- getModificationDate(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the modification date of a document.
- getModificationDateXMP(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the XMP modification date of a document.
- getPageLabelOffset(int) - Method in class com.coherentpdf.Jcpdf
-
Gets page label data.
- getPageLabelPrefix(int) - Method in class com.coherentpdf.Jcpdf
-
Gets page label data.
- getPageLabelRange(int) - Method in class com.coherentpdf.Jcpdf
-
Gets page label data.
- getPageLabelStringForPage(Jcpdf.Pdf, int) - Method in class com.coherentpdf.Jcpdf
-
Calculates the full label string for a given page, and returns it.
- getPageLabelStyle(int) - Method in class com.coherentpdf.Jcpdf
-
Gets page label data.
- getPageRotation(Jcpdf.Pdf, int) - Method in class com.coherentpdf.Jcpdf
-
Gets the viewing rotation for a given page.
- getProducer(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the producer of a document.
- getProducerXMP(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the XMP producer of a document.
- getSubject(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the subject of a document.
- getSubjectXMP(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the XMP subject of a document.
- getTitle(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the title of a document.
- getTitleXMP(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the XMP title of a document.
- getTrimBox(Jcpdf.Pdf, int, double[]) - Method in class com.coherentpdf.Jcpdf
-
These functions get a box given the document.
- getVersion(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the minor version number of a document.
H
- hardBox(Jcpdf.Pdf, Jcpdf.Range, String) - Method in class com.coherentpdf.Jcpdf
-
Makes a given box a 'hard box' i.e clips it explicitly.
- hasBox(Jcpdf.Pdf, int, String) - Method in class com.coherentpdf.Jcpdf
-
Returns
true
if the given page has the given box. - hasPermission(Jcpdf.Pdf, int) - Method in class com.coherentpdf.Jcpdf
-
Returns
true
if the given permission (restriction) such asnoEdit
is present. - helvetica - Static variable in class com.coherentpdf.Jcpdf
-
Standard font: Helvetica
- helveticaBold - Static variable in class com.coherentpdf.Jcpdf
-
Standard font: Helvetica Bold
- helveticaBoldOblique - Static variable in class com.coherentpdf.Jcpdf
-
Standard font: Helvetica Bold Oblique
- helveticaOblique - Static variable in class com.coherentpdf.Jcpdf
-
Standard font: Helvetica Oblique
- hFlip(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Flips horizontally the pages in the range.
- hideMenubar(Jcpdf.Pdf, boolean) - Method in class com.coherentpdf.Jcpdf
-
Sets the hide menubar flag.
- hideToolbar(Jcpdf.Pdf, boolean) - Method in class com.coherentpdf.Jcpdf
-
Sets the hide toolbar flag.
- hideWindowUi(Jcpdf.Pdf, boolean) - Method in class com.coherentpdf.Jcpdf
-
Sets the hide window UI flag.
I
- impose(Jcpdf.Pdf, double, double, boolean, boolean, boolean, boolean, boolean, double, double, double) - Method in class com.coherentpdf.Jcpdf
-
Imposes a PDF.
- inOfPt(double) - Method in class com.coherentpdf.Jcpdf
-
Converts a figure in points to millimetres.
- isEncrypted(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns
true
if a document is encrypted,false
otherwise. - isInRange(Jcpdf.Range, int) - Method in class com.coherentpdf.Jcpdf
-
Tests to see if a given number is in a page range.
- isLinearized(String) - Method in class com.coherentpdf.Jcpdf
-
Finds out if a document is linearized as quickly as possible without loading it.
J
- Jcpdf - Class in com.coherentpdf
-
The Coherent PDF Library for Java
- Jcpdf() - Constructor for class com.coherentpdf.Jcpdf
-
Create a new instance of the Jcpdf library.
- Jcpdf.CpdfError - Exception in com.coherentpdf
-
Any function in this library may raise the
CpdfError
exception, which carries a string describing the nature of the problem. - Jcpdf.Pdf - Class in com.coherentpdf
-
A PDF document
- Jcpdf.Range - Class in com.coherentpdf
-
A page range, which represents an ordered list of page numbers.
L
- left - Static variable in class com.coherentpdf.Jcpdf
-
Position anchor: the left hand side of the page, halfway down.
- leftJustify - Static variable in class com.coherentpdf.Jcpdf
-
Justification: left
- lowercaseLetters - Static variable in class com.coherentpdf.Jcpdf
-
Page label style: a, b, c...
- lowercaseRoman - Static variable in class com.coherentpdf.Jcpdf
-
Page label style: i, ii, iii...
M
- markTrapped(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Marks a document as trapped.
- markTrappedXMP(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Marks a document as trapped in XMP metadata.
- markUntrapped(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Marks a document as untrapped.
- markUntrappedXMP(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Marks a document as untrapped in XMP metadata.
- merge(Jcpdf.Pdf[], boolean, boolean) - Method in class com.coherentpdf.Jcpdf
-
Merges the PDFs.
- mergeSame(Jcpdf.Pdf[], boolean, boolean, Jcpdf.Range[]) - Method in class com.coherentpdf.Jcpdf
-
Merges PDFs when one or more are drawn from the same document.
- mergeSimple(Jcpdf.Pdf[]) - Method in class com.coherentpdf.Jcpdf
-
Given an array of PDFs, merges the documents into a new one, which is returned.
- mmOfPt(double) - Method in class com.coherentpdf.Jcpdf
-
Converts a figure in points to millimetres.
N
- noAnnot - Static variable in class com.coherentpdf.Jcpdf
-
Permission: cannot annotate the document
- noAssemble - Static variable in class com.coherentpdf.Jcpdf
-
Permission: cannot assemble into a bigger document
- noCopy - Static variable in class com.coherentpdf.Jcpdf
-
Permission: cannot copy the document
- noEdit - Static variable in class com.coherentpdf.Jcpdf
-
Permission: cannot edit the document
- noExtract - Static variable in class com.coherentpdf.Jcpdf
-
Permission: cannot extract information
- noForms - Static variable in class com.coherentpdf.Jcpdf
-
Permission: cannot edit forms in the document
- noHqPrint - Static variable in class com.coherentpdf.Jcpdf
-
Permission: cannot print high quality
- noPrint - Static variable in class com.coherentpdf.Jcpdf
-
Permission: cannot print the document
- numberBookmarks() - Method in class com.coherentpdf.Jcpdf
-
Gets the number of bookmarks for the PDF given to
startGetBookmarkInfo
. - numberFonts() - Method in class com.coherentpdf.Jcpdf
-
Retrieves font information.
- numberGetAttachments() - Method in class com.coherentpdf.Jcpdf
-
Lists information about attachments.
O
- OCGCoalesce(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Coalesces optional content groups.
- OCGListEntry(int) - Method in class com.coherentpdf.Jcpdf
-
Retrieves an entry in the optional content group list, given the serial number
0..n - 1
. - OCGOrderAll(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Ensures that every optional content group appears in the OCG order list.
- OCGRename(Jcpdf.Pdf, String, String) - Method in class com.coherentpdf.Jcpdf
-
Renames an optional content group.
- odd(Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
The page range containing all odd-numbered pages from an existing range.
- oneColumn - Static variable in class com.coherentpdf.Jcpdf
-
Layout: one column
- onExit() - Method in class com.coherentpdf.Jcpdf
-
Prints some information about resource usage.
- openAtPage(Jcpdf.Pdf, boolean, int) - Method in class com.coherentpdf.Jcpdf
-
Sets the PDF to open, possibly with zoom-to-fit, at the given page number.
- outputJSON(String, boolean, boolean, boolean, Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Outputs a PDF in JSON format to the given filename.
- outputJSONMemory(Jcpdf.Pdf, boolean, boolean, boolean) - Method in class com.coherentpdf.Jcpdf
-
Like outputJSON, but it writes to a byte array in memory.
P
- padAfter(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Adds a blank page after each page in the given range.
- padBefore(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Adds a blank page before each page in the given range.
- padEvery(Jcpdf.Pdf, int) - Method in class com.coherentpdf.Jcpdf
-
Adds a blank page after every n pages.
- padMultiple(Jcpdf.Pdf, int) - Method in class com.coherentpdf.Jcpdf
-
Adds pages at the end to pad the file to a multiple of n pages in length.
- padMultipleBefore(Jcpdf.Pdf, int) - Method in class com.coherentpdf.Jcpdf
-
Adds pages at the beginning to pad the file to a multiple of n pages in length.
- pages(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Returns the number of pages in a PDF.
- pagesFast(String, String) - Method in class com.coherentpdf.Jcpdf
-
Returns the number of pages in a given PDF, with given user password.
- parsePagespec(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Parses a page specification such as
1,2,6-end
with reference to a given PDF. - pdf128bit - Static variable in class com.coherentpdf.Jcpdf
-
Encryption method: 128 bit RC4 encryption
- pdf40bit - Static variable in class com.coherentpdf.Jcpdf
-
Encryption method: 40 bit RC4 encryption
- posCentre - Static variable in class com.coherentpdf.Jcpdf
-
Position anchor: absolute centre.
- posLeft - Static variable in class com.coherentpdf.Jcpdf
-
Position anchor: absolute left.
- posRight - Static variable in class com.coherentpdf.Jcpdf
-
Position anchor: absolute right.
- ptOfCm(double) - Method in class com.coherentpdf.Jcpdf
-
Converts a figure in centimetres to points.
- ptOfIn(double) - Method in class com.coherentpdf.Jcpdf
-
Converts a figure in inches to points (72.
- ptOfMm(double) - Method in class com.coherentpdf.Jcpdf
-
Converts a figure in millimetres to points.
R
- range(int, int) - Method in class com.coherentpdf.Jcpdf
-
The page range containing all page numbers from one page number to another.
- rangeAdd(Jcpdf.Range, int) - Method in class com.coherentpdf.Jcpdf
-
Adds a page number to a range, returning a new one.
- rangeGet(Jcpdf.Range, int) - Method in class com.coherentpdf.Jcpdf
-
Gets a page number from a range at the given offset.
- rangeLength(Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
The length of a range.
- rangeUnion(Jcpdf.Range, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
The union of two ranges - all those pages in either.
- removeAllText(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Removes all text from the given pages in a given document.
- removeArt(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Removes any art box from pages in the range.
- removeAttachedFiles(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Removes all page- and document-level attachments from a document.
- removeBleed(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Removes any bleed box from pages in the range.
- removeClipping(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Removes all clipping from pages in the given range.
- removeCrop(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Removes any crop box from pages in the range.
- removeDictEntry(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Removes any dictionary entry with the given key anywhere in the document.
- removeDictEntrySearch(Jcpdf.Pdf, String, String) - Method in class com.coherentpdf.Jcpdf
-
Removes any dictionary entry with the given key whose value matches the given search term.
- removeDuplicates(Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Remove duplicates from a range, returning a new one.
- removeFonts(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Removes all font data from a file.
- removeId(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Removes a document's
/ID
. - removeMetadata(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Removes the XMP metadata from a document.
- removePageLabels(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Removes the page labels from the document.
- removeText(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Removes any text added by Jcpdf from the given pages.
- removeTrim(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Removes any trim box from pages in the range.
- replaceDictEntry(Jcpdf.Pdf, String, String) - Method in class com.coherentpdf.Jcpdf
-
Replaces the value associated with the given key.
- replaceDictEntrySearch(Jcpdf.Pdf, String, String, String) - Method in class com.coherentpdf.Jcpdf
-
Replaces the value associated with the given key if the existing value matches the search term.
- reverseDiagonal - Static variable in class com.coherentpdf.Jcpdf
-
Position anchor: diagonal, top left to bottom right.
- right - Static variable in class com.coherentpdf.Jcpdf
-
Position anchor: the right hand side of the page, halfway down.
- rightJusitfy - Static variable in class com.coherentpdf.Jcpdf
-
Justification: right
- rotate(Jcpdf.Pdf, Jcpdf.Range, int) - Method in class com.coherentpdf.Jcpdf
-
Changes the viewing rotation to an absolute value.
- rotateBy(Jcpdf.Pdf, Jcpdf.Range, int) - Method in class com.coherentpdf.Jcpdf
-
Changes the viewing rotation by a relative value.
- rotateContents(Jcpdf.Pdf, Jcpdf.Range, double) - Method in class com.coherentpdf.Jcpdf
-
Rotates the content about the centre of the page by the given number of degrees, in a clockwise direction.
S
- scaleContents(Jcpdf.Pdf, Jcpdf.Range, int, double, double, double) - Method in class com.coherentpdf.Jcpdf
-
Scales the contents of the pages in the range about the point given by the
anchor
,p1
andp2
by the scale given. - scalePages(Jcpdf.Pdf, Jcpdf.Range, double, double) - Method in class com.coherentpdf.Jcpdf
-
Scales the page dimensions and content by the given scale, about (0, 0).
- scaleToFit(Jcpdf.Pdf, Jcpdf.Range, double, double, double) - Method in class com.coherentpdf.Jcpdf
-
Scales the content to fit new page dimensions (width x height) multiplied by scale (typically 1.0).
- scaleToFitPaper(Jcpdf.Pdf, Jcpdf.Range, int, double) - Method in class com.coherentpdf.Jcpdf
-
Scales the page content to fit the given page size, possibly multiplied by scale (typically 1.0).
- selectPages(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Returns a new document with just those pages in the page range.
- setArtBox(Jcpdf.Pdf, Jcpdf.Range, double, double, double, double) - Method in class com.coherentpdf.Jcpdf
-
These functions set a box given the document, page range, min x, max x, min y, max y in points.
- setAuthor(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the author of a document.
- setAuthorXMP(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the XMP author of a document.
- setBleedBox(Jcpdf.Pdf, Jcpdf.Range, double, double, double, double) - Method in class com.coherentpdf.Jcpdf
-
These functions set a box given the document, page range, min x, max x, min y, max y in points.
- setBookmarkLevel(int, int) - Method in class com.coherentpdf.Jcpdf
-
Set bookmark level for the given bookmark
0...(n - 1)
. - setBookmarkOpenStatus(int, boolean) - Method in class com.coherentpdf.Jcpdf
-
Sets the open status of bookmark
0...(n - 1)
. - setBookmarkPage(Jcpdf.Pdf, int, int) - Method in class com.coherentpdf.Jcpdf
-
Sets the bookmark target page for the given PDF (which must be the same as the PDF to be passed to
endSetBookmarkInfo
) and bookmark0...(n - 1)
. - setBookmarksJSON(Jcpdf.Pdf, byte[]) - Method in class com.coherentpdf.Jcpdf
-
Sets the bookmarks from JSON bookmark data.
- setBookmarkText(int, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the text of bookmark
0...(n - 1)
. - setCreationDate(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the creation date of a document.
- setCreationDateXMP(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the XMP creation date of a document.
- setCreator(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the creator of a document.
- setCreatorXMP(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the XMP creator of a document.
- setCropBox(Jcpdf.Pdf, Jcpdf.Range, double, double, double, double) - Method in class com.coherentpdf.Jcpdf
-
These functions set a box given the document, page range, min x, max x, min y, max y in points.
- setFast() - Method in class com.coherentpdf.Jcpdf
-
Sets fast mode.
- setFullVersion(Jcpdf.Pdf, int, int) - Method in class com.coherentpdf.Jcpdf
-
Sets the full version number of a document.
- setKeywords(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the keywords of a document.
- setKeywordsXMP(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the XMP keywords of a document.
- setMediabox(Jcpdf.Pdf, Jcpdf.Range, double, double, double, double) - Method in class com.coherentpdf.Jcpdf
-
These functions set a box given the document page range, min x, max x, min y, max y in points.
- setMetadataDate(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the metadata date for a PDF.
- setMetadataFromByteArray(Jcpdf.Pdf, byte[]) - Method in class com.coherentpdf.Jcpdf
-
Sets the XMP metadata from an array of bytes.
- setMetadataFromFile(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the XMP metadata of a document, given a file name.
- setModificationDate(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the modification date of a document.
- setModificationDateXMP(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the XMP modification date of a document.
- setPageLayout(Jcpdf.Pdf, int) - Method in class com.coherentpdf.Jcpdf
-
Sets the page layout for a document, such as
singlePage
- setPageMode(Jcpdf.Pdf, int) - Method in class com.coherentpdf.Jcpdf
-
Sets the page mode for a document, such as
useNone
- setProducer(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the producer of a document.
- setProducerXMP(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the XMP producer of a document.
- setSlow() - Method in class com.coherentpdf.Jcpdf
-
Sets slow mode.
- setSubject(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the subject of a document.
- setSubjectXMP(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the XMP subject of a document.
- setTitle(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the title of a document.
- setTitleXMP(Jcpdf.Pdf, String) - Method in class com.coherentpdf.Jcpdf
-
Sets the XMP title of a document.
- setTrimBox(Jcpdf.Pdf, Jcpdf.Range, double, double, double, double) - Method in class com.coherentpdf.Jcpdf
-
These functions set a box given the document, page range, min x, max x, min y, max y in points.
- setVersion(Jcpdf.Pdf, int) - Method in class com.coherentpdf.Jcpdf
-
Sets the minor version number of a document.
- shiftContents(Jcpdf.Pdf, Jcpdf.Range, double, double) - Method in class com.coherentpdf.Jcpdf
-
Shifts the content of the pages in the range.
- showBoxes(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Shows the boxes on the given pages, for debug.
- singlePage - Static variable in class com.coherentpdf.Jcpdf
-
Layout: single page
- squeezeInMemory(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Squeezes a pdf in memory.
- stampAsXObject(Jcpdf.Pdf, Jcpdf.Range, Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Stamps a PDF onto the pages in the given range in pdf as a shared Form XObject.
- stampExtended(Jcpdf.Pdf, Jcpdf.Pdf, Jcpdf.Range, boolean, boolean, int, double, double, boolean) - Method in class com.coherentpdf.Jcpdf
-
A stamping function with extra features.
- stampOn(Jcpdf.Pdf, Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Stamps another PDF on top of all the pages in the document which are in the range.
- stampUnder(Jcpdf.Pdf, Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Stamps another PDF under all the pages in the document which are in the range.
- startEnumeratePDFs() - Method in class com.coherentpdf.Jcpdf
-
Begins enumerating currently allocated PDFs.
- startGetAttachments(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Lists information about attachments.
- startGetBookmarkInfo(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Starts the bookmark retrieval process for a given PDF.
- startGetFontInfo(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Retrieves font information.
- startGetImageResolution(Jcpdf.Pdf, double) - Method in class com.coherentpdf.Jcpdf
-
Gets image data, including resolution at all points of use.
- startGetOCGList(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Begins retrieving optional content group names.
- startGetPageLabels(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Gets page label data.
- startSetBookmarkInfo(int) - Method in class com.coherentpdf.Jcpdf
-
Starts the bookmark setting process for n bookmarks.
- startup() - Method in class com.coherentpdf.Jcpdf
-
Initialises the library.
- stringOfPagespec(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Builds a page specification from a page range.
T
- tableOfContents(Jcpdf.Pdf, int, double, String, boolean) - Method in class com.coherentpdf.Jcpdf
-
Typesets a table of contents from existing bookmarks and prepends it to the document.
- textToPDF(double, double, int, double, String) - Method in class com.coherentpdf.Jcpdf
-
Typesets a UTF8 text file ragged right on a page of size w * h in points in the given font and font size.
- textToPDFPaper(int, int, double, String) - Method in class com.coherentpdf.Jcpdf
-
Typesets a UTF8 text file ragged right on a page of the given size in the given font and font size.
- textWidth(int, String) - Method in class com.coherentpdf.Jcpdf
-
Returns the width of a given string in the given font in thousandths of a point.
- thinLines(Jcpdf.Pdf, Jcpdf.Range, double) - Method in class com.coherentpdf.Jcpdf
-
Thickens every line less than
min_thickness
tomin_thickness
. - timesBold - Static variable in class com.coherentpdf.Jcpdf
-
Standard font: Times Bold
- timesBoldItalic - Static variable in class com.coherentpdf.Jcpdf
-
Standard font: Times Bold Italic
- timesItalic - Static variable in class com.coherentpdf.Jcpdf
-
Standard font: Times Italic
- timesRoman - Static variable in class com.coherentpdf.Jcpdf
-
Standard font: Times Roman
- toFile(Jcpdf.Pdf, String, boolean, boolean) - Method in class com.coherentpdf.Jcpdf
-
Writes the PDF document to a given filename.
- toFileEncrypted(Jcpdf.Pdf, int, int[], String, String, boolean, boolean, String) - Method in class com.coherentpdf.Jcpdf
-
Writes a PDF document as encrypted.
- toFileEncryptedExt(Jcpdf.Pdf, int, int[], String, String, boolean, boolean, boolean, boolean, boolean, String) - Method in class com.coherentpdf.Jcpdf
-
Writes a file as encrypted with extra parameters.
- toFileExt(Jcpdf.Pdf, String, boolean, boolean, boolean, boolean, boolean) - Method in class com.coherentpdf.Jcpdf
-
Writes the PDF document to a given filename, with extra parameters.
- toMemory(Jcpdf.Pdf, boolean, boolean) - Method in class com.coherentpdf.Jcpdf
-
Writes a PDF document and returns it as an array of bytes.
- top - Static variable in class com.coherentpdf.Jcpdf
-
Position anchor: the top centre of the page.
- topLeft - Static variable in class com.coherentpdf.Jcpdf
-
Position anchor: the top left of the page.
- topRight - Static variable in class com.coherentpdf.Jcpdf
-
Position anchor: the top right of the page.
- trimMarks(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Adds trim marks to the given pages, if the trimbox exists.
- twoColumnLeft - Static variable in class com.coherentpdf.Jcpdf
-
Layout: two column left
- twoColumnRight - Static variable in class com.coherentpdf.Jcpdf
-
Layout: two column right
- twoPageLeft - Static variable in class com.coherentpdf.Jcpdf
-
Layout: two page left
- twoPageRight - Static variable in class com.coherentpdf.Jcpdf
-
Layout: two page right
- twoUp(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Imposes a document two up.
- twoUpStack(Jcpdf.Pdf) - Method in class com.coherentpdf.Jcpdf
-
Imposes a document two up.
U
- uppercaseLetters - Static variable in class com.coherentpdf.Jcpdf
-
Page label style: A, B, C...
- uppercaseRoman - Static variable in class com.coherentpdf.Jcpdf
-
Page label style: I, II, III...
- upright(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Changes the viewing rotation of the pages in the range, counter-rotating the dimensions and content such that there is no visual change.
- useAttachments - Static variable in class com.coherentpdf.Jcpdf
-
Page mode: use Attachments
- useNone - Static variable in class com.coherentpdf.Jcpdf
-
Page mode: use none
- useOC - Static variable in class com.coherentpdf.Jcpdf
-
Page mode: use OC
- useOutlines - Static variable in class com.coherentpdf.Jcpdf
-
Page mode: use outlines
- useThumbs - Static variable in class com.coherentpdf.Jcpdf
-
Page mode: use thumbs
- uslegallandscape - Static variable in class com.coherentpdf.Jcpdf
-
Paper size: US Legal Landscape
- uslegalportrait - Static variable in class com.coherentpdf.Jcpdf
-
Paper size: US Legal Portrait
- usletterlandscape - Static variable in class com.coherentpdf.Jcpdf
-
Paper size: US Letter Landscape
- usletterportrait - Static variable in class com.coherentpdf.Jcpdf
-
Paper size: US Letter Portrait
V
- validatePagespec(String) - Method in class com.coherentpdf.Jcpdf
-
Validates a page specification so far as is possible in the absence of the actual document.
- version() - Method in class com.coherentpdf.Jcpdf
-
Returns a string giving the version number of the Jcpdf library.
- vFlip(Jcpdf.Pdf, Jcpdf.Range) - Method in class com.coherentpdf.Jcpdf
-
Flips vertically the pages in the range.
All Classes and Interfaces|All Packages|Serialized Form