A B C D E F G H I J K L M N O P R S T U V W X Z
All Classes All Packages

A

A0 - Static variable in class com.pd4ml.PageSize

ISO A0: 2384 x 3370 points (841 x 1189 mm).

A1 - Static variable in class com.pd4ml.PageSize

ISO A1: 1684 x 2384 points (594 x 841 mm).

A10 - Static variable in class com.pd4ml.PageSize

ISO A10: 74 x 105 points (26 x 37 mm).

A2 - Static variable in class com.pd4ml.PageSize

ISO A2: 1190 x 1684 points (420 x 594 mm).

A3 - Static variable in class com.pd4ml.PageSize

ISO A3: 842 x 1190 points (297 x 420 mm).

A4 - Static variable in class com.pd4ml.PageSize

ISO A4: 595 x 842 points (210 x 297 mm).

A5 - Static variable in class com.pd4ml.PageSize

ISO A5: 421 x 595 points (148 x 210 mm).

A6 - Static variable in class com.pd4ml.PageSize

ISO A6: 297 x 421 points (105 x 148 mm).

A7 - Static variable in class com.pd4ml.PageSize

ISO A7: 210 x 297 points (74 x 105 mm).

A8 - Static variable in class com.pd4ml.PageSize

ISO A8: 148 x 210 points (52 x 74 mm).

A9 - Static variable in class com.pd4ml.PageSize

ISO A9: 105 x 148 points (37 x 52 mm).

accept(ICOSVisitor<T>) - Method in class com.pd4ml.pdf.cos.COSArray

accept(ICOSVisitor<T>) - Method in class com.pd4ml.pdf.cos.COSBase

accept(ICOSVisitor<T>) - Method in class com.pd4ml.pdf.cos.COSBoolean

accept(ICOSVisitor<T>) - Method in class com.pd4ml.pdf.cos.COSDictionary

accept(ICOSVisitor<T>) - Method in class com.pd4ml.pdf.cos.COSFloat

accept(ICOSVisitor<T>) - Method in class com.pd4ml.pdf.cos.COSInteger

accept(ICOSVisitor<T>) - Method in class com.pd4ml.pdf.cos.COSName

accept(ICOSVisitor<T>) - Method in class com.pd4ml.pdf.cos.COSNull

accept(ICOSVisitor<T>) - Method in class com.pd4ml.pdf.cos.COSObject

accept(ICOSVisitor<T>) - Method in class com.pd4ml.pdf.cos.COSStream

accept(ICOSVisitor<T>) - Method in class com.pd4ml.pdf.cos.COSString

AccessPermission - Class in com.pd4ml.pdf.encryption

This class represents the access permissions to a document.

AccessPermission() - Constructor for class com.pd4ml.pdf.encryption.AccessPermission

Create a new access permission object.

AccessPermission(byte[]) - Constructor for class com.pd4ml.pdf.encryption.AccessPermission

Create a new access permission object from a byte array.

AccessPermission(int) - Constructor for class com.pd4ml.pdf.encryption.AccessPermission

Creates a new access permission object from a single integer.

add(int, COSBase) - Method in class com.pd4ml.pdf.cos.COSArray

add(COSBase) - Method in class com.pd4ml.pdf.cos.COSArray

addCustomResourceProvider(String) - Method in class com.pd4ml.PD4ML

Adds a custom resource loader, for example to load resources over a proprietary protocol or from a database.

addCustomTagHandler(String, CustomTag) - Method in class com.pd4ml.PD4ML

Registers a handler that renders a custom HTML tag, for example <chart>...</chart>.

addDocumentActionHandler(String, String) - Method in class com.pd4ml.PD4ML

Adds JavaScript that the PDF viewer runs on a document event.

addGesture(float[]) - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Appends one <gesture> stroke (a flat [x1, y1, x2, y2, ...] point list) to the ink list, creating it if this is the first.

addLtv(byte[], byte[], Certificate[], LtvOptions) - Static method in class com.pd4ml.pdf.sign.ltv.LtvUpdater

Fetches OCSP/CRL for certificateChain (via RevocationFetcher) and embeds it, plus the chain itself, as LTV information for the signature whose CMS bytes are cmsSignature.

addMetadata(String, String, boolean) - Method in class com.pd4ml.PD4ML

Adds a custom property to the XMP metadata of the resulting PDF, for example a document ID for a document management system.

addRecipient(PublicKeyRecipient) - Method in class com.pd4ml.pdf.encryption.PublicKeyProtectionPolicy

Adds a new recipient to the recipients list.

addSource(byte[]) - Method in class com.pd4ml.pdf.merge.PdfMerger

addSource(byte[], String) - Method in class com.pd4ml.pdf.merge.PdfMerger

addSource(File) - Method in class com.pd4ml.pdf.merge.PdfMerger

addSource(File, String) - Method in class com.pd4ml.pdf.merge.PdfMerger

addSource(InputStream) - Method in class com.pd4ml.pdf.merge.PdfMerger

addSource(InputStream, String) - Method in class com.pd4ml.pdf.merge.PdfMerger

addStyle(String, boolean) - Method in class com.pd4ml.PD4ML

Applies additional CSS rules to the document.

addStyle(URL, boolean) - Method in class com.pd4ml.PD4ML

Applies an additional CSS stylesheet, loaded from a URL, to the document.

addUniqueMessage(Vector<StatusMessage>, StatusMessage) - Static method in class com.pd4ml.StatusMessage

Adds a message to a list unless a message with the same number is already in it.

addValue(String) - Method in class com.pd4ml.pdf.xfdf.XfdfField

Appends one <value> -- normal usage is one call per field, except for a multi-select choice field.

adjustHtmlWidth(boolean) - Method in class com.pd4ml.PD4ML

Fits the HTML width to the actual width of the content.

AES_128 - com.pd4ml.pdf.cos.security.PdfEncryptor.Algorithm

/V 4 /R 4, AES-128 via a /StdCF crypt filter.

AES_128BIT - Static variable in class com.pd4ml.Constants

AES encryption with a 128-bit key (PDF 1.6 and later).

AES_256 - com.pd4ml.pdf.cos.security.PdfEncryptor.Algorithm

/V 5 /R 6, AES-256, ISO 32000-2 hardened-hash key derivation.

AES_256BIT - Static variable in class com.pd4ml.Constants

AES encryption with a 256-bit key (PDF 1.7 extension level 3 and later).

algorithm(PdfEncryptor.Algorithm) - Method in class com.pd4ml.pdf.cos.security.PdfEncryptor.Options

allocate(COSBase) - Method in class com.pd4ml.pdf.cos.util.COSObjectImporter

Allocates a brand-new indirect object in the target document for a value that has no source-document counterpart (e.g.

allocateKey() - Method in class com.pd4ml.pdf.cos.writer.IncrementalUpdateWriter

Allocates the next free object number (generation 0) for a new indirect object.

AllowAnnotate - Static variable in class com.pd4ml.Constants

Permission (bit 6, value 32): add or modify annotations and fill in form fields; together with Constants.AllowModify, also create or modify form fields.

AllowAssembly - Static variable in class com.pd4ml.Constants

Permission (bit 11, value 1024): assemble the document (insert, rotate or delete pages, create bookmarks or thumbnails), even if Constants.AllowModify is not set.

AllowContentExtraction - Static variable in class com.pd4ml.Constants

Permission (bit 10, value 512): extract text and graphics for accessibility, for example for screen readers.

AllowCopy - Static variable in class com.pd4ml.Constants

Permission (bit 5, value 16): copy or otherwise extract text and graphics from the document.

AllowDegradedPrint - Static variable in class com.pd4ml.Constants

Permission (bit 3, value 4): print the document, possibly at a degraded quality unless Constants.AllowPrint is also set.

AllowFillingForms - Static variable in class com.pd4ml.Constants

Permission (bit 9, value 256): fill in existing form fields, including signature fields, even if Constants.AllowAnnotate is not set.

AllowModify - Static variable in class com.pd4ml.Constants

Permission (bit 4, value 8): modify the document content by operations other than those controlled by Constants.AllowAnnotate, Constants.AllowFillingForms and Constants.AllowAssembly.

AllowPrint - Static variable in class com.pd4ml.Constants

Permission (bits 3 and 12, value 2052): print the document at full quality, so that a faithful digital copy of it could be generated from the print.

allowsAttachments() - Method in class com.pd4ml.PdfSpec

Tells whether the specification allows embedded files attached to the content (not allowed by PDF/A-1 and PDF/A-2).

allowsDocLevelAttachments() - Method in class com.pd4ml.PdfSpec

Tells whether the specification allows files embedded at document level, as used by e-invoices (allowed by PDF/A-3 and PDF 2.0).

allowsEncryption() - Method in class com.pd4ml.PdfSpec

Tells whether the specification allows encryption (not allowed by PDF/A).

allowsExternalHyperlinking() - Method in class com.pd4ml.PdfSpec

Tells whether the specification allows links to external resources.

allowsPdfForms() - Method in class com.pd4ml.PdfSpec

Tells whether PD4ML generates interactive form fields for this specification (not for PDF/A).

allowsTransparency() - Method in class com.pd4ml.PdfSpec

Tells whether the specification allows transparency (not allowed by PDF/A-1).

AnnotationMapper - Class in com.pd4ml.pdf.xfdf.internal

Maps one PDF annotation dictionary to and from its XfdfAnnotation form (ISO 19444-1 §6.4), covering every markup annotation subtype XFDF has an element for: Text, Link, FreeText, Line, Square, Circle, Polygon, PolyLine, Highlight, Underline, Squiggly, StrikeOut, Stamp, Caret, Ink, Popup, FileAttachment, Sound and Redact.

append(PdfDocumentBase) - Method in class com.pd4ml.pdf.PdfDocumentBase

Appends the pages of another document after the pages of this one.

apply(COSDocument, COSDocument, boolean[], boolean[], int, boolean) - Static method in class com.pd4ml.pdf.overlay.PdfOverlay

applyFields(COSDocument, List<XfdfField>, SelectionFilter) - Static method in class com.pd4ml.pdf.xfdf.internal.FieldMapper

Applies every field in fields that matches an existing terminal field (by fully-qualified name) in document's /AcroForm and passes filter.

applyKerning(boolean) - Method in class com.pd4ml.PD4ML

Applies the kerning information of TrueType/OpenType fonts, which adjusts the spacing of specific character pairs (such as "AV") for more even-looking text.

applyLicense(String) - Method in class com.pd4ml.PD4ML

Applies a license to this instance, replacing the one applied before.

applyToCOS(XfdfAnnotation, COSDictionary, COSDocument) - Static method in class com.pd4ml.pdf.xfdf.internal.AnnotationMapper

Populates (or, for an already-populated target passed in by the caller's "update if exists" handling -- see XfdfImporter -- re-populates) target from x.

ArchA - Static variable in class com.pd4ml.PageSize

Architectural A: 648 x 864 points (9 x 12 in).

ArchB - Static variable in class com.pd4ml.PageSize

Architectural B: 864 x 1296 points (12 x 18 in).

ArchC - Static variable in class com.pd4ml.PageSize

Architectural C: 1296 x 1728 points (18 x 24 in).

ArchD - Static variable in class com.pd4ml.PageSize

Architectural D: 1728 x 2592 points (24 x 36 in).

ArchE - Static variable in class com.pd4ml.PageSize

Architectural E: 2592 x 3456 points (36 x 48 in).

ArchE1 - Static variable in class com.pd4ml.PageSize

Architectural E1: 2160 x 3024 points (30 x 42 in).

areCompatible(PdfSpec, PdfSpec, PdfSpec) - Static method in class com.pd4ml.PdfSpec

Checks whether a PDF version and up to two PDF/A or PDF/UA standards can be combined: PDF/A-4 needs PDF 1.7 or later, and PDF/UA-2 cannot be combined with PDF/A-1 to PDF/A-3.

ARRAY_CLOSE - com.pd4ml.pdf.cos.parser.TokenType

ARRAY_OPEN - com.pd4ml.pdf.cos.parser.TokenType

ASCII_HEX_DECODE - Static variable in class com.pd4ml.pdf.cos.COSName

ASCII85_DECODE - Static variable in class com.pd4ml.pdf.cos.COSName

ASCII85DecodeFilter - Class in com.pd4ml.pdf.cos.filter

/ASCII85Decode: base-85 text encoding, terminated by ~>.

ASCII85DecodeFilter() - Constructor for class com.pd4ml.pdf.cos.filter.ASCII85DecodeFilter

ASCIIHexDecodeFilter - Class in com.pd4ml.pdf.cos.filter

/ASCIIHexDecode: pairs of hex digits, terminated by >.

ASCIIHexDecodeFilter() - Constructor for class com.pd4ml.pdf.cos.filter.ASCIIHexDecodeFilter

assignNewKey(COSBase) - Method in class com.pd4ml.pdf.cos.writer.IncrementalUpdateWriter

Allocates a key and assigns it to obj in one step -- obj is now a new indirect object.

asyncResourceLoader(int) - Method in class com.pd4ml.PD4ML

Loads external resources (images, attachments and so on) in parallel, which can speed up documents that reference many remote resources.

B

B4 - Static variable in class com.pd4ml.PageSize

ISO B4: 250 x 353 mm.

B5 - Static variable in class com.pd4ml.PageSize

ISO B5: 176 x 250 mm.

BatikSvgCustomTag - Class in com.pd4ml.plugins

BatikSvgCustomTag() - Constructor for class com.pd4ml.plugins.BatikSvgCustomTag

BatikSvgCustomTag(String, FontCache, CustomTag) - Constructor for class com.pd4ml.plugins.BatikSvgCustomTag

bottom - Variable in class com.pd4ml.PageMargins

The bottom margin in points.

buildXmpPacket(PdfConformance.Level, PdfConformance.Level, String) - Static method in class com.pd4ml.pdf.merge.internal.PdfConformance

Builds a fresh, minimal XMP packet declaring the given conformance level(s) (either may be null to omit that schema) and, if given, a dc:title, following the exact pdfaid/pdfuaid schema com.pd4ml.pdf.builder itself emits elsewhere in this project.

ByteRangeSigner - Interface in com.pd4ml.pdf.sign.pdf

Callback IncrementalPdfSigner invokes with exactly the bytes that must be cryptographically signed (the file's /ByteRange-selected ranges), once those ranges are known.

C

canAssembleDocument() - Method in class com.pd4ml.pdf.encryption.AccessPermission

This will tell if the user can insert/rotate/delete pages.

canExtractContent() - Method in class com.pd4ml.pdf.encryption.AccessPermission

This will tell if the user can extract text and images from the PDF document.

canExtractForAccessibility() - Method in class com.pd4ml.pdf.encryption.AccessPermission

This will tell if the user can extract text and images from the PDF document for accessibility purposes.

canFillInForm() - Method in class com.pd4ml.pdf.encryption.AccessPermission

This will tell if the user can fill in interactive form fields (including signature fields) even if canModifyAnnotations() returns false.

canLoad(String, FileCache) - Method in class com.pd4ml.ResourceProvider

Tells whether this loader handles the given resource address, typically by checking its protocol or prefix.

canModify() - Method in class com.pd4ml.pdf.encryption.AccessPermission

This will tell if the user can modify contents of the document.

canModifyAnnotations() - Method in class com.pd4ml.pdf.encryption.AccessPermission

This will tell if the user can add or modify text annotations and fill in interactive forms fields and, if canModify() returns true, create or modify interactive form fields (including signature fields).

canPrint() - Method in class com.pd4ml.pdf.encryption.AccessPermission

This will tell if the user can print.

canPrintDegraded() - Method in class com.pd4ml.pdf.encryption.AccessPermission

This will tell if the user can print the document in a degraded format.

CENTER_ALIGN - Static variable in class com.pd4ml.Constants

Center alignment.

CertificateUtils - Class in com.pd4ml.pdf.sign

Loads the signing identity (private key + certificate chain) used by PdfSigner.sign(java.io.File, java.io.File, com.pd4ml.pdf.sign.CertificateUtils.SigningIdentity, com.pd4ml.pdf.sign.SigningOptions), from any of three sources: a PKCS#12 (.p12/.pfx) keystore file (the private key lives in this process, in the clear, for the duration of the JVM), a PKCS#11 token/HSM (the private key never leaves the token -- every RSA/EC operation is delegated to it via the JDK's SunPKCS11 security provider), or a remote key held by a cloud KMS (AWS KMS, Azure Key Vault, GCP Cloud KMS, ...) reached through a user-supplied RemoteSigner -- see CertificateUtils.forRemoteKey(java.security.cert.Certificate[], com.pd4ml.pdf.sign.RemoteSigner).

CertificateUtils.SigningIdentity - Class in com.pd4ml.pdf.sign

Holds the certificate chain to sign with, plus however this identity's private key operations actually get performed: an in-process PrivateKey (PKCS#12; CertificateUtils.SigningIdentity.getProvider() is null, any JCA provider -- normally BouncyCastle -- may perform the RSA/EC operation), an opaque PrivateKey handle tied to one specific Provider (PKCS#11; that exact provider instance must perform the operation, since the key material never leaves the token), or no local key at all, only a RemoteSigner (cloud KMS).

charWidth(char) - Static method in class com.pd4ml.pdf.cos.writer.HelveticaMetrics

Width of one character, in 1000ths of the font size (multiply by fontSize/1000 to get points).

clear() - Method in class com.pd4ml.pdf.cos.COSArray

clone() - Method in class com.pd4ml.StatusMessage

close() - Method in class com.pd4ml.pdf.cos.COSDocument

closeResourceStream() - Method in class com.pd4ml.ResourceProvider

Releases the resources of the last ResourceProvider.getResourceAsStream(String, FileCache) call, for example closes a connection.

ColorUtil - Class in com.pd4ml.pdf.xfdf.internal

Converts between a PDF colour array (/C//IC: 0, 1, 3 or 4 numeric components -- ISO 32000-1 Table 164/170) and the "#RRGGBB" hex string XFDF's color/interior-color attributes use.

com.pd4ml - package com.pd4ml

com.pd4ml.pdf - package com.pd4ml.pdf

com.pd4ml.pdf.cos - package com.pd4ml.pdf.cos

com.pd4ml.pdf.cos.cli - package com.pd4ml.pdf.cos.cli

com.pd4ml.pdf.cos.filter - package com.pd4ml.pdf.cos.filter

com.pd4ml.pdf.cos.parser - package com.pd4ml.pdf.cos.parser

com.pd4ml.pdf.cos.path - package com.pd4ml.pdf.cos.path

com.pd4ml.pdf.cos.security - package com.pd4ml.pdf.cos.security

com.pd4ml.pdf.cos.util - package com.pd4ml.pdf.cos.util

com.pd4ml.pdf.cos.writer - package com.pd4ml.pdf.cos.writer

com.pd4ml.pdf.encryption - package com.pd4ml.pdf.encryption

com.pd4ml.pdf.merge - package com.pd4ml.pdf.merge

com.pd4ml.pdf.merge.cli - package com.pd4ml.pdf.merge.cli

com.pd4ml.pdf.merge.internal - package com.pd4ml.pdf.merge.internal

com.pd4ml.pdf.optimizer - package com.pd4ml.pdf.optimizer

com.pd4ml.pdf.optimizer.cli - package com.pd4ml.pdf.optimizer.cli

com.pd4ml.pdf.optimizer.internal - package com.pd4ml.pdf.optimizer.internal

com.pd4ml.pdf.overlay - package com.pd4ml.pdf.overlay

com.pd4ml.pdf.sign - package com.pd4ml.pdf.sign

com.pd4ml.pdf.sign.cli - package com.pd4ml.pdf.sign.cli

com.pd4ml.pdf.sign.ltv - package com.pd4ml.pdf.sign.ltv

com.pd4ml.pdf.sign.pdf - package com.pd4ml.pdf.sign.pdf

com.pd4ml.pdf.xfdf - package com.pd4ml.pdf.xfdf

com.pd4ml.pdf.xfdf.cli - package com.pd4ml.pdf.xfdf.cli

com.pd4ml.pdf.xfdf.internal - package com.pd4ml.pdf.xfdf.internal

com.pd4ml.plugins - package com.pd4ml.plugins

com.pd4ml.tools - package com.pd4ml.tools

combine(PdfSpec) - Method in class com.pd4ml.PdfSpec

Returns a new specification that adds a PDF/A or PDF/UA standard to this one.

compareTo(COSName) - Method in class com.pd4ml.pdf.cos.COSName

compareTo(COSObjectKey) - Method in class com.pd4ml.pdf.cos.COSObjectKey

computeEncryptedKey(byte[], byte[], byte[], byte[], byte[], int, byte[], int, int, boolean, boolean) - Method in class com.pd4ml.pdf.encryption.StandardSecurityHandler

Compute the encryption key.

computeOwnerPassword(byte[], byte[], int, int) - Method in class com.pd4ml.pdf.encryption.StandardSecurityHandler

Compute the owner entry in the encryption dictionary.

computeScope(String, int) - Static method in class com.pd4ml.pdf.PdfDocumentBase

Evaluates a page scope: tells for each page of a document whether the scope selects it.

computeUserPassword(byte[], byte[], int, byte[], int, int, boolean) - Method in class com.pd4ml.pdf.encryption.StandardSecurityHandler

This will compute the user password hash.

ConflictingParametersException - Exception in com.pd4ml

Signals that conversion parameters were set that cannot be used together.

ConflictingParametersException(String) - Constructor for exception com.pd4ml.ConflictingParametersException

Creates the exception.

conformance - Variable in class com.pd4ml.pdf.merge.internal.PdfConformance.Level

Constants - Class in com.pd4ml

Constants of the PD4ML API: PDF permission flags, PD4ML.setParam(String, String) parameter keys, PD4ML.getLastRenderInfo(String) keys, output formats, encryption methods and error policies.

Constants() - Constructor for class com.pd4ml.Constants

Constants.ErrorPolicy - Enum in com.pd4ml

How strictly problems found during a conversion are treated.

containsKey(COSName) - Method in class com.pd4ml.pdf.cos.COSDictionary

containsKey(String) - Method in class com.pd4ml.pdf.cos.COSDictionary

ContentDeduplicator - Class in com.pd4ml.pdf.optimizer.internal

Finds indirect objects reachable from a COSDocument's trailer that are byte-for-byte duplicates of another object -- most commonly the same font, image, or color space embedded twice under two different object numbers -- and rewrites every reference to a duplicate so it points at one surviving ("canonical") copy instead.

CONTENTS - Static variable in class com.pd4ml.pdf.cos.COSName

CONVERSION_BEGIN - Static variable in interface com.pd4ml.ProgressListener

The conversion has started.

CONVERSION_END - Static variable in interface com.pd4ml.ProgressListener

The conversion is complete.

COSArray - Class in com.pd4ml.pdf.cos

A PDF array object.

COSArray() - Constructor for class com.pd4ml.pdf.cos.COSArray

COSArray(List<? extends COSBase>) - Constructor for class com.pd4ml.pdf.cos.COSArray

COSBase - Class in com.pd4ml.pdf.cos

Base class for every object that can appear in the COS (Carousel Object Structure) layer of a PDF document: booleans, numbers, strings, names, arrays, dictionaries, streams, the null object and indirect references.

COSBase() - Constructor for class com.pd4ml.pdf.cos.COSBase

COSBoolean - Class in com.pd4ml.pdf.cos

A PDF boolean object: true or false.

CosCli - Class in com.pd4ml.pdf.cos.cli

Single command-line entry point for com.pd4ml.pdf.cos alone -- the PDF COS object model, parser, and incremental-update writer -- with no dependency on com.pd4ml.pdf.sign.

COSDictionary - Class in com.pd4ml.pdf.cos

A PDF dictionary object: an unordered (here: insertion-ordered, for deterministic output) map from COSName keys to arbitrary COS values.

COSDictionary() - Constructor for class com.pd4ml.pdf.cos.COSDictionary

COSDictionary(COSDictionary) - Constructor for class com.pd4ml.pdf.cos.COSDictionary

COSDocument - Class in com.pd4ml.pdf.cos

The in-memory representation of a whole PDF file's COS layer: the table of indirect objects keyed by COSObjectKey, and the trailer dictionary that names the document's root ("Catalog") and other special objects.

COSDocument() - Constructor for class com.pd4ml.pdf.cos.COSDocument

COSDocumentWriter - Class in com.pd4ml.pdf.cos.writer

Serializes a whole COSDocument built up in memory (e.g.

COSException - Exception in com.pd4ml.pdf.cos

Base checked exception for all errors originating from the COS object model, the low level PDF parser, or the COS path engine.

COSException(String) - Constructor for exception com.pd4ml.pdf.cos.COSException

COSException(String, Throwable) - Constructor for exception com.pd4ml.pdf.cos.COSException

COSException(Throwable) - Constructor for exception com.pd4ml.pdf.cos.COSException

COSFloat - Class in com.pd4ml.pdf.cos

A PDF real number object, e.g.

COSFloat(double) - Constructor for class com.pd4ml.pdf.cos.COSFloat

COSFloat(float) - Constructor for class com.pd4ml.pdf.cos.COSFloat

COSFloat(String) - Constructor for class com.pd4ml.pdf.cos.COSFloat

Parses a PDF real-number token.

COSInteger - Class in com.pd4ml.pdf.cos

A PDF integer object.

COSLexer - Class in com.pd4ml.pdf.cos.parser

Tokenizes raw PDF bytes into the Tokens consumed by COSParser, following the lexical rules of ISO 32000-1 §7.2 (character set, whitespace, delimiters, comments) and §7.3 (objects).

COSLexer(byte[]) - Constructor for class com.pd4ml.pdf.cos.parser.COSLexer

COSLexer(RandomAccessBuffer) - Constructor for class com.pd4ml.pdf.cos.parser.COSLexer

COSName - Class in com.pd4ml.pdf.cos

A PDF name object, e.g.

COSNull - Class in com.pd4ml.pdf.cos

The PDF null object.

COSNumber - Class in com.pd4ml.pdf.cos

Base class for the two PDF numeric object types, integers and reals.

COSNumber() - Constructor for class com.pd4ml.pdf.cos.COSNumber

COSObject - Class in com.pd4ml.pdf.cos

An indirect reference, i.e.

COSObject(COSDocument, COSObjectKey) - Constructor for class com.pd4ml.pdf.cos.COSObject

COSObject(COSDocument, COSObjectKey, COSBase) - Constructor for class com.pd4ml.pdf.cos.COSObject

Direct constructor for an already-known target, useful when building a document in memory rather than parsing one from disk.

COSObjectable - Interface in com.pd4ml.pdf.cos

Implemented by higher level, typed wrappers around a raw COS node (analogous to PDModel-style classes layered on top of PDFBox's COS layer).

COSObjectImporter - Class in com.pd4ml.pdf.cos.util

Deep-clones a value (and everything it transitively references) from a source COSDocument into a target one, allocating fresh indirect object numbers.

COSObjectImporter(COSDocument) - Constructor for class com.pd4ml.pdf.cos.util.COSObjectImporter

Seeds the numbering counter from target's own current highest object number (0 for a brand-new, still-empty target, exactly reproducing this class's old hardcoded start-at-1 behavior for every existing caller -- PdfMerger and the object-graph optimizer both always hand this a fresh, empty document).

COSObjectKey - Class in com.pd4ml.pdf.cos

The identity of an indirect PDF object: its object number and generation number, e.g.

COSObjectKey(long, int) - Constructor for class com.pd4ml.pdf.cos.COSObjectKey

COSParseException - Exception in com.pd4ml.pdf.cos.parser

A syntax or structural error encountered while lexing/parsing PDF COS syntax, tagged with the byte offset it occurred at to aid debugging of malformed files.

COSParseException(String, int) - Constructor for exception com.pd4ml.pdf.cos.parser.COSParseException

COSParseException(String, int, Throwable) - Constructor for exception com.pd4ml.pdf.cos.parser.COSParseException

COSParser - Class in com.pd4ml.pdf.cos.parser

A low level, recursive-descent parser that turns the raw bytes of a PDF file into a populated COSDocument: every indirect object, the cross-reference table (classic tables, cross-reference streams, hybrid files, incremental updates via /Prev, and compressed objects held in object streams), and the trailer.

COSParser(byte[]) - Constructor for class com.pd4ml.pdf.cos.parser.COSParser

COSParser(byte[], String) - Constructor for class com.pd4ml.pdf.cos.parser.COSParser

COSPath - Class in com.pd4ml.pdf.cos.path

A parsed COS path: a starting point (the document trailer, or an explicit indirect object) plus a list of navigation steps.

COSPath.RootKind - Enum in com.pd4ml.pdf.cos.path

Where a path's navigation starts.

COSPathEvaluator - Class in com.pd4ml.pdf.cos.path

Resolves a COSPath against a COSDocument (or an arbitrary starting COSBase node), auto-dereferencing indirect references at every step so callers never see a bare COSObject.

COSPathException - Exception in com.pd4ml.pdf.cos.path

Raised for a malformed COS path expression, or (only from the *Strict evaluator methods) when a path cannot be resolved against a particular document -- an intermediate step lands on a node of the wrong kind, a dictionary key is missing, or an array index is out of range.

COSPathException(String) - Constructor for exception com.pd4ml.pdf.cos.path.COSPathException

COSPathException(String, Throwable) - Constructor for exception com.pd4ml.pdf.cos.path.COSPathException

COSPathParser - Class in com.pd4ml.pdf.cos.path

Parses the textual COS path syntax documented on COSPath into a COSPath instance.

COSPathSegment - Class in com.pd4ml.pdf.cos.path

One navigation step of a COSPath: descend into a dictionary by key, into an array by index, or jump directly to an arbitrary indirect object.

COSPathSegment.Kind - Enum in com.pd4ml.pdf.cos.path

The three kinds of step a COS path can take.

COSSecurityException - Exception in com.pd4ml.pdf.cos.security

Raised when a PDF's encryption dictionary names a security handler this API doesn't implement (anything other than the Standard security handler), or when the supplied password is wrong (neither the user nor the owner password could be authenticated).

COSSecurityException(String) - Constructor for exception com.pd4ml.pdf.cos.security.COSSecurityException

COSSecurityException(String, Throwable) - Constructor for exception com.pd4ml.pdf.cos.security.COSSecurityException

COSStream - Class in com.pd4ml.pdf.cos

A PDF stream object: a COSDictionary (the "stream dictionary") together with a run of raw bytes.

COSStream() - Constructor for class com.pd4ml.pdf.cos.COSStream

COSStream(COSDictionary) - Constructor for class com.pd4ml.pdf.cos.COSStream

COSString - Class in com.pd4ml.pdf.cos

A PDF string object.

COSString(byte[]) - Constructor for class com.pd4ml.pdf.cos.COSString

COSString(String) - Constructor for class com.pd4ml.pdf.cos.COSString

Builds a COSString from a Java string, encoding as PDFDocEncoding when every character fits in Latin-1, otherwise as UTF-16BE with a leading BOM (the standard PDF "text string" convention).

COSWriteException - Exception in com.pd4ml.pdf.cos.writer

A COSException specific to writing/updating a PDF file's COS layer -- e.g.

COSWriteException(String) - Constructor for exception com.pd4ml.pdf.cos.writer.COSWriteException

COSWriteException(String, Throwable) - Constructor for exception com.pd4ml.pdf.cos.writer.COSWriteException

COSWriter - Class in com.pd4ml.pdf.cos.writer

A from-scratch PDF-syntax serializer for the pd4ml COS object model (which, being a reader, ships ICOSVisitor as an extension point for exactly this purpose but no implementation of its own -- see the project's README).

COSWriter(ByteArrayOutputStream) - Constructor for class com.pd4ml.pdf.cos.writer.COSWriter

COUNT - Static variable in class com.pd4ml.pdf.cos.COSName

countPages(COSDictionary) - Static method in class com.pd4ml.pdf.cos.util.PageTree

Total number of leaf pages under catalog's /Pages tree.

createNewIndirectObject(COSBase) - Method in class com.pd4ml.pdf.cos.COSDocument

createSvgParser() - Static method in class com.pd4ml.plugins.PD4MLSvgCustomTag

CryptographyException - Exception in com.pd4ml.pdf.encryption

An exception that indicates that something has gone wrong during a cryptography operation.

CryptographyException(Exception) - Constructor for exception com.pd4ml.pdf.encryption.CryptographyException

Constructor.

CryptographyException(String) - Constructor for exception com.pd4ml.pdf.encryption.CryptographyException

Constructor.

CustomTag - Class in com.pd4ml

Base class for handlers of custom HTML tags, which render content PD4ML does not support natively, for example charts or barcodes.

CustomTag() - Constructor for class com.pd4ml.CustomTag

Creates the handler object to register with PD4ML.addCustomTagHandler(String, CustomTag).

CustomTag(String, FontCache, CustomTag) - Constructor for class com.pd4ml.CustomTag

Creates the handler instance for one occurrence of the tag; used by CustomTag.getInstance(String, FontCache).

D

decode(byte[], int, int) - Static method in class com.pd4ml.tools.Pd4Cmd.Base64

Very low-level access to decoding ASCII characters in the form of a byte array.

decode(byte[], COSDictionary, COSDictionary) - Method in class com.pd4ml.pdf.cos.filter.ASCII85DecodeFilter

decode(byte[], COSDictionary, COSDictionary) - Method in class com.pd4ml.pdf.cos.filter.ASCIIHexDecodeFilter

decode(byte[], COSDictionary, COSDictionary) - Method in interface com.pd4ml.pdf.cos.filter.Filter

Decodes encoded using this filter's algorithm.

decode(byte[], COSDictionary, COSDictionary) - Method in class com.pd4ml.pdf.cos.filter.FlateDecodeFilter

decode(String) - Static method in class com.pd4ml.tools.Pd4Cmd.Base64

Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.

DECODE - Static variable in class com.pd4ml.tools.Pd4Cmd.Base64

Specify decoding.

DECODE_PARMS - Static variable in class com.pd4ml.pdf.cos.COSName

decryptBuffer(long, long, byte[]) - Method in class com.pd4ml.pdf.encryption.SecurityHandler

DecryptionMaterial - Class in com.pd4ml.pdf.encryption

This class represents data required to decrypt PDF documents.

DecryptionMaterial() - Constructor for class com.pd4ml.pdf.encryption.DecryptionMaterial

decryptStream(byte[], long, int) - Method in class com.pd4ml.pdf.cos.security.StandardSecurityHandler

decryptString(byte[], long, int) - Method in class com.pd4ml.pdf.cos.security.StandardSecurityHandler

deduplicate(COSDocument) - Static method in class com.pd4ml.pdf.optimizer.internal.ContentDeduplicator

Rewrites document's trailer and every indirect object's references so that every duplicate-content object is referenced only via its canonical (first-encountered) copy.

deduplicateContent(boolean) - Method in class com.pd4ml.pdf.optimizer.PdfOptimizer.Options

Whether to merge byte-identical duplicate objects (e.g.

DEFAULT_LENGTH - Static variable in class com.pd4ml.pdf.encryption.PDEncryption

The default length for the encryption key.

DEFAULT_NAME - Static variable in class com.pd4ml.pdf.encryption.PDEncryption

The default security handler.

DEFAULT_PAGE_MARGINS - Static variable in class com.pd4ml.PageMargins

The default margins for PDF, RTF and DOCX output: 10 mm on each side.

DEFAULT_SIZE - Static variable in class com.pd4ml.plugins.ORCodeCustomTag

DEFAULT_VERSION - Static variable in class com.pd4ml.pdf.encryption.PDEncryption

The default version, according to the PDF Reference.

DefaultPermissions - Static variable in class com.pd4ml.Constants

All permissions: allows every operation on the document.

deletePage(int) - Method in class com.pd4ml.pdf.PdfDocumentBase

Deletes a page.

detectPdfA(COSDocument) - Static method in class com.pd4ml.pdf.merge.internal.PdfConformance

The document's own declared PDF/A identification, or null if it doesn't declare one (or none is parseable).

detectPdfUa(COSDocument) - Static method in class com.pd4ml.pdf.merge.internal.PdfConformance

The document's own declared PDF/UA identification, or null if it doesn't declare one (or none is parseable).

detectTitle(COSDocument) - Static method in class com.pd4ml.pdf.merge.internal.PdfConformance

The document's own dc:title (Dublin Core, from its XMP /Metadata), falling back to the plain /Info dictionary's /Title when the XMP doesn't carry one (or there's no XMP at all) -- or null if neither does.

DICT_CLOSE - com.pd4ml.pdf.cos.parser.TokenType

DICT_OPEN - com.pd4ml.pdf.cos.parser.TokenType

Dimensions - Interface in com.pd4ml

Unit conversion factors and measurement units used by PageSize and PageMargins.

Dimensions.Units - Enum in com.pd4ml

Measurement units for PageSize and PageMargins values.

disable - Static variable in class com.pd4ml.plugins.BatikSvgCustomTag

disable - Static variable in class com.pd4ml.plugins.MathMLCustomTag

disable - Static variable in class com.pd4ml.plugins.ORCodeCustomTag

disableBatik - Static variable in class com.pd4ml.PD4ML

Global switch, false by default.

disableMathML - Static variable in class com.pd4ml.PD4ML

Global switch, false by default.

doc - Variable in class com.pd4ml.plugins.BatikSvgCustomTag

DOC_RENDER_IN_PROGRESS - Static variable in interface com.pd4ml.ProgressListener

Pages are being rendered; sent once per page, with the page number as the message.

DOC_WRITE_BEGIN - Static variable in interface com.pd4ml.ProgressListener

Writing the output has started.

DOCX - Static variable in class com.pd4ml.Constants

Output format "docx": a Microsoft Word document.

DOCX_PRE_RENDER_DONE - Static variable in interface com.pd4ml.ProgressListener

The preparation of DOCX output is complete.

DONT_BREAK_LINES - Static variable in class com.pd4ml.tools.Pd4Cmd.Base64

Don't break lines when encoding (violates strict Base64 specification)

dontCache() - Method in class com.pd4ml.ResourceProvider

Tells whether loaded resources must not be kept in the resource cache, for example because they change between requests.

doubleValue() - Method in class com.pd4ml.pdf.cos.COSFloat

doubleValue() - Method in class com.pd4ml.pdf.cos.COSInteger

doubleValue() - Method in class com.pd4ml.pdf.cos.COSNumber

dump(int) - Method in class com.pd4ml.PD4ML

Returns a text dump of internal structures, for diagnostics and support requests.

dump(COSDictionary) - Static method in class com.pd4ml.pdf.cos.util.OutlineTree

Pre-order dump of every node's own /Title, 2-space-indented per level -- matches the legacy PdfDoc#dumpOutlines format exactly (asserted byte-for-byte by existing tests).

dumpOutlines() - Method in class com.pd4ml.pdf.PdfDocumentBase

Returns a text dump of the bookmark (outline) tree, for diagnostics.

E

embedTTFs(boolean, boolean) - Method in class com.pd4ml.PD4ML

Controls how TrueType/OpenType fonts are stored in the resulting PDF.

embedValidationInformation(byte[], byte[], Certificate[], RevocationFetcher.Result) - Static method in class com.pd4ml.pdf.sign.ltv.LtvUpdater

Embeds already-fetched revocation data (see LtvUpdater.addLtv(byte[], byte[], java.security.cert.Certificate[], com.pd4ml.pdf.sign.ltv.LtvOptions) for the all-in-one version).

enableHyperlinks(boolean) - Method in class com.pd4ml.PD4ML

Controls whether HTML links become clickable links in the resulting PDF.

enableLigatures(boolean) - Method in class com.pd4ml.PD4ML

Enables OpenType text shaping with TrueType/OpenType fonts: glyph substitution (GSUB tables) for ligatures such as "fi" and "fl", and the compound glyphs that complex scripts such as Devanagari need for correct rendering.

ENCODE - Static variable in class com.pd4ml.tools.Pd4Cmd.Base64

Specify encoding.

encrypt(COSDocument, PdfEncryptor.Options) - Static method in class com.pd4ml.pdf.cos.security.PdfEncryptor

ENCRYPT - Static variable in class com.pd4ml.pdf.cos.COSName

encryptOutput(PdfEncryptor.Options) - Method in class com.pd4ml.pdf.merge.PdfMerger

encryptOutput(PdfEncryptor.Options) - Method in class com.pd4ml.pdf.optimizer.PdfOptimizer.Options

encryptOutput(PdfEncryptor.Options) - Method in class com.pd4ml.pdf.xfdf.XfdfImporter.Options

encryptOutput(String, String) - Method in class com.pd4ml.pdf.merge.PdfMerger

Configures the merged output to be encrypted with AES-256, the modern default.

encryptOutput(String, String) - Method in class com.pd4ml.pdf.optimizer.PdfOptimizer.Options

Encrypts the optimized output with AES-256, the modern default.

encryptOutput(String, String) - Method in class com.pd4ml.pdf.xfdf.XfdfImporter.Options

Encrypts the imported output with AES-256, the modern default.

ENDOBJ - com.pd4ml.pdf.cos.parser.TokenType

ENDSTREAM - com.pd4ml.pdf.cos.parser.TokenType

entrySet() - Method in class com.pd4ml.pdf.cos.COSDictionary

EOF - com.pd4ml.pdf.cos.parser.TokenType

EOF_MARKER - com.pd4ml.pdf.cos.parser.TokenType

equals(Object) - Method in class com.pd4ml.pdf.cos.COSArray

equals(Object) - Method in class com.pd4ml.pdf.cos.COSBoolean

equals(Object) - Method in class com.pd4ml.pdf.cos.COSDictionary

equals(Object) - Method in class com.pd4ml.pdf.cos.COSFloat

equals(Object) - Method in class com.pd4ml.pdf.cos.COSInteger

equals(Object) - Method in class com.pd4ml.pdf.cos.COSName

equals(Object) - Method in class com.pd4ml.pdf.cos.COSObject

equals(Object) - Method in class com.pd4ml.pdf.cos.COSObjectKey

equals(Object) - Method in class com.pd4ml.pdf.cos.COSStream

equals(Object) - Method in class com.pd4ml.pdf.cos.COSString

equals(Object) - Method in class com.pd4ml.pdf.cos.path.COSPathSegment

equals(Object) - Method in class com.pd4ml.pdf.merge.internal.PdfConformance.Level

ERROR - Static variable in class com.pd4ml.StatusMessage

Message type: a problem that makes the output non-conforming or restricted.

evaluate(COSDocument, COSPath) - Static method in class com.pd4ml.pdf.cos.path.COSPathEvaluator

evaluate(COSDocument, String) - Static method in class com.pd4ml.pdf.cos.path.COSPathEvaluator

evaluateFrom(COSBase, List<COSPathSegment>) - Static method in class com.pd4ml.pdf.cos.path.COSPathEvaluator

evaluateFromStrict(COSBase, List<COSPathSegment>) - Static method in class com.pd4ml.pdf.cos.path.COSPathEvaluator

evaluateStrict(COSDocument, COSPath) - Static method in class com.pd4ml.pdf.cos.path.COSPathEvaluator

evaluateStrict(COSDocument, String) - Static method in class com.pd4ml.pdf.cos.path.COSPathEvaluator

export(byte[]) - Static method in class com.pd4ml.pdf.xfdf.XfdfExporter

export(byte[], XfdfExporter.Options) - Static method in class com.pd4ml.pdf.xfdf.XfdfExporter

export(byte[], XfdfExporter.Options, OutputStream) - Static method in class com.pd4ml.pdf.xfdf.XfdfExporter

Convenience for writing straight to a destination rather than handling the returned bytes yourself.

export(byte[], String) - Static method in class com.pd4ml.pdf.xfdf.XfdfExporter

Convenience for the common case of only needing a password, with no type/ID filtering.

export(File) - Static method in class com.pd4ml.pdf.xfdf.XfdfExporter

export(File, XfdfExporter.Options) - Static method in class com.pd4ml.pdf.xfdf.XfdfExporter

export(File, XfdfExporter.Options, File) - Static method in class com.pd4ml.pdf.xfdf.XfdfExporter

export(File, String) - Static method in class com.pd4ml.pdf.xfdf.XfdfExporter

export(InputStream) - Static method in class com.pd4ml.pdf.xfdf.XfdfExporter

export(InputStream, XfdfExporter.Options) - Static method in class com.pd4ml.pdf.xfdf.XfdfExporter

export(InputStream, String) - Static method in class com.pd4ml.pdf.xfdf.XfdfExporter

exportFields(COSDocument, SelectionFilter) - Static method in class com.pd4ml.pdf.xfdf.internal.FieldMapper

extractAttachments(String, short) - Static method in class com.pd4ml.tools.Pd4Cmd

F

FacturX - Static variable in class com.pd4ml.PdfSpec

Factur-X electronic invoice profile: PDF 1.7 and PDF/A-3b.

FacturX_a - Static variable in class com.pd4ml.PdfSpec

Factur-X electronic invoice profile, tagged: PDF 1.7 and PDF/A-3a.

FALSE - com.pd4ml.pdf.cos.parser.TokenType

FALSE - Static variable in class com.pd4ml.pdf.cos.COSBoolean

fetch(Certificate[], LtvOptions) - Static method in class com.pd4ml.pdf.sign.ltv.RevocationFetcher

Fetches revocation evidence for every certificate in chain (index 0 = the signing certificate, each subsequent entry its issuer), per options.

FieldMapper - Class in com.pd4ml.pdf.xfdf.internal

Maps the /Root/AcroForm/Fields tree to and from XFDF's flat <fields> list (ISO 19444-1 §6.3).

FieldMapper.ApplyResult - Class in com.pd4ml.pdf.xfdf.internal

FieldMapper.applyFields(com.pd4ml.pdf.cos.COSDocument, java.util.List<com.pd4ml.pdf.xfdf.XfdfField>, com.pd4ml.pdf.xfdf.internal.SelectionFilter)'s outcome: how many fields were actually updated, and which requested names had no match.

Filter - Interface in com.pd4ml.pdf.cos.filter

A single PDF stream filter (the algorithms named by /Filter entries, e.g.

FILTER - Static variable in class com.pd4ml.pdf.cos.COSName

FILTER - Static variable in class com.pd4ml.pdf.encryption.PublicKeySecurityHandler

The filter name.

FILTER - Static variable in class com.pd4ml.pdf.encryption.StandardSecurityHandler

Type of security handler.

FilterFactory - Class in com.pd4ml.pdf.cos.filter

Resolves a /Filter name to its Filter implementation.

findPage(COSDictionary, int) - Static method in class com.pd4ml.pdf.cos.util.PageTree

Returns the zero-based index-th page dictionary under catalog's /Pages tree, or null if the catalog has no (usable) page tree or index is out of range.

finish() - Method in class com.pd4ml.pdf.cos.writer.IncrementalUpdateWriter

Finishes the update: writes the cross-reference table for every object written so far, then a trailer (/Size, /Root from the parsed document's catalog, /Info if the original had one, a fresh /ID, and /Prev chained back to the base file's own startxref), and returns the complete file (original bytes + this update).

finish() - Method in class com.pd4ml.pdf.merge.internal.OutlineMerger

finish() - Method in class com.pd4ml.pdf.merge.internal.StructureTreeMerger

Finalizes the merged tree: prunes any structure that ended up referencing pages that were never actually selected/cloned (e.g.

finish() - Method in class com.pd4ml.pdf.xfdf.internal.StructureTreeUpdater

Finalizes bookkeeping once every annotation in this import batch has been processed: closes off a /Kids-based leaf's /Limits, and restates /StructTreeRoot/ParentTreeNextKey.

fitPageVertically(int) - Method in class com.pd4ml.PD4ML

Scales the whole document down so that it fits on a single page vertically, including the page header and footer.

FlagsUtil - Class in com.pd4ml.pdf.xfdf.internal

Converts between a PDF annotation's /F flags integer (ISO 32000-1 Table 165) and XFDF's flags attribute, a comma-separated list of the flag names that are set (e.g.

FLATE_DECODE - Static variable in class com.pd4ml.pdf.cos.COSName

FlateDecodeFilter - Class in com.pd4ml.pdf.cos.filter

/FlateDecode: standard zlib/deflate compression (RFC 1950), by far the most common PDF stream filter.

FlateDecodeFilter() - Constructor for class com.pd4ml.pdf.cos.filter.FlateDecodeFilter

flipHorizontal() - Method in class com.pd4ml.PageMargins

Returns a copy with the left and right margins swapped, for example for the facing pages of a book.

flipVertical() - Method in class com.pd4ml.PageMargins

Returns a copy with the top and bottom margins swapped.

floatValue() - Method in class com.pd4ml.pdf.cos.COSFloat

floatValue() - Method in class com.pd4ml.pdf.cos.COSInteger

floatValue() - Method in class com.pd4ml.pdf.cos.COSNumber

ForcedTerminationException - Exception in com.pd4ml

Thrown on the conversion thread when the conversion has been cancelled with PD4ML.terminate().

ForcedTerminationException() - Constructor for exception com.pd4ml.ForcedTerminationException

forDocument(COSDocument) - Static method in class com.pd4ml.pdf.xfdf.internal.StructureTreeUpdater

Returns a new updater for document, or null if it isn't tagged (no /StructTreeRoot) -- the caller's cue to skip structure-tree work for this import entirely, exactly as if this class didn't exist.

FORM_FILLING_ALLOWED - com.pd4ml.pdf.sign.SigningOptions.CertificationLevel

FORM_FILLING_AND_ANNOTATIONS_ALLOWED - com.pd4ml.pdf.sign.SigningOptions.CertificationLevel

format(Calendar) - Static method in class com.pd4ml.pdf.cos.util.PdfDates

formatFloat(float) - Static method in class com.pd4ml.pdf.cos.writer.COSWriter

Formats a PDF real number without scientific notation, keeping at least one fractional digit.

formatFloat(float) - Static method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Trims a clean integer-valued float down to "100" rather than "100.0", matching real producers' output.

formatFloatList(float[], String) - Static method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

The inverse of XfdfAnnotation.parseFloatList(String, int): joins values with separator, or returns null if values is null.

forRemoteKey(Certificate[], RemoteSigner) - Static method in class com.pd4ml.pdf.sign.CertificateUtils

Builds a signing identity for a key that lives entirely in a remote KMS (AWS KMS, Azure Key Vault, GCP Cloud KMS, or any signing service reachable over the network) -- there is no local PrivateKey; every signature is produced by calling remoteSigner.

G

generateBookmarksFromAnchors(boolean) - Method in class com.pd4ml.PD4ML

Generates the PDF bookmarks (outline) from named anchors, that is from <a name="destination">Label</a> tags.

generateBookmarksFromHeadings(boolean) - Method in class com.pd4ml.PD4ML

Generates the PDF bookmarks (outline) from the document headings: each <h1> to <h6> becomes a bookmark, nested by heading level.

generateForms(boolean, String) - Method in class com.pd4ml.PD4ML

Converts HTML form controls (<input>, <textarea>, <select>) to interactive PDF form fields (AcroForm) instead of static images of them.

generateForms(boolean, String, String) - Method in class com.pd4ml.PD4ML

Converts HTML form controls to interactive PDF form fields, like PD4ML.generateForms(boolean, String), and embeds the glyphs for the characters users may type into the fields.

generateMulticolumn(int, int, boolean) - Method in class com.pd4ml.PD4ML

Intended to lay out the document in several columns per page.

get(int) - Method in class com.pd4ml.pdf.cos.COSArray

Raw entry at index, without resolving indirect references.

get(long) - Static method in class com.pd4ml.pdf.cos.COSInteger

get(COSName) - Static method in class com.pd4ml.pdf.cos.filter.FilterFactory

get(String) - Static method in class com.pd4ml.pdf.cos.COSNumber

Parses a numeric token exactly as it would appear in PDF content, e.g.

getAnnotations() - Method in class com.pd4ml.pdf.xfdf.XfdfDocument

Every top-level annotation from <annots> (a nested <popup> is reachable via XfdfAnnotation.getPopup(), not listed here separately).

getAnnotationsAdded() - Method in class com.pd4ml.pdf.xfdf.XfdfImporter.Result

How many <annots> entries became brand-new PDF annotations (counting a nested <popup> as its own annotation).

getAnnotationsUpdated() - Method in class com.pd4ml.pdf.xfdf.XfdfImporter.Result

How many <annots> entries updated an annotation already in the PDF (XfdfImporter.Options.updateIfExists(boolean)).

getArray(String) - Method in class com.pd4ml.pdf.cos.COSDictionary

getAttribute(String) - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

The raw string value of attribute name, or null if this annotation doesn't carry it.

getAttributes() - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Every XFDF attribute this annotation carries (raw attribute name, e.g.

getAuthor() - Method in class com.pd4ml.pdf.PdfDocumentBase

Returns the author from the document properties.

getBoolean(String, boolean) - Method in class com.pd4ml.pdf.cos.COSDictionary

getBuffer() - Method in class com.pd4ml.pdf.cos.parser.COSLexer

getByID(int) - Static method in class com.pd4ml.PdfSpec

Finds a PDF/A or PDF/UA constant by its PdfSpec.id.

getByLabel(String) - Static method in class com.pd4ml.PdfSpec

Finds a PDF version by its version number.

getBytes() - Method in class com.pd4ml.pdf.cos.COSString

getBytes() - Method in class com.pd4ml.pdf.cos.parser.Token

Raw payload for string tokens (already escape/hex decoded).

getCache() - Method in class com.pd4ml.PD4ML

Returns the font and resource cache of this instance, so later conversions can reuse it with PD4ML.setCache(Object) instead of loading the same fonts and resources again.

getCatalog() - Method in class com.pd4ml.pdf.cos.COSDocument

The document catalog, i.e.

getCertificate() - Method in class com.pd4ml.pdf.encryption.PublicKeyDecryptionMaterial

Returns the certificate contained in the keystore.

getCertificateChain() - Method in class com.pd4ml.pdf.sign.CertificateUtils.SigningIdentity

A defensive copy of the certificate chain -- mutating the returned array never affects this identity.

getCertificationLevel() - Method in class com.pd4ml.pdf.sign.SigningOptions

getCmsSignature() - Method in class com.pd4ml.pdf.sign.pdf.SignResult

getConnectTimeoutMillis() - Method in class com.pd4ml.pdf.sign.ltv.LtvOptions

getContactInfo() - Method in class com.pd4ml.pdf.sign.SigningOptions

getContents() - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Plain-text <contents> body, or null.

getContentsRichText() - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Raw inner XML of <contents-richtext> (the /RC rich text string), or null.

getCOSName(COSName) - Method in class com.pd4ml.pdf.cos.COSDictionary

getCOSObject() - Method in class com.pd4ml.pdf.cos.COSBase

COSObjectable identity: a raw COS node is its own COS representation.

getCOSObject() - Method in class com.pd4ml.pdf.cos.COSObject

getCOSObject() - Method in interface com.pd4ml.pdf.cos.COSObjectable

getCreationDate() - Method in class com.pd4ml.pdf.PdfDocumentBase

Returns the creation date from the document properties.

getCreator() - Method in class com.pd4ml.pdf.PdfDocumentBase

Returns the creator from the document properties: the application the original document was created with.

getCrls() - Method in class com.pd4ml.pdf.sign.ltv.RevocationFetcher.Result

Each entry is one complete DER-encoded CertificateList (RFC 5280).

getCryptFilterDictionary(String) - Method in class com.pd4ml.pdf.encryption.PDEncryption

Returns the crypt filter with the given name.

getCryptFilterMethod() - Method in class com.pd4ml.pdf.encryption.PDCryptFilterDictionary

This will return the crypt filter method.

getCurrentAccessPermission() - Method in class com.pd4ml.pdf.encryption.SecurityHandler

Returns the access permissions that were computed during document decryption.

getData() - Method in class com.pd4ml.pdf.cos.parser.RandomAccessBuffer

getDecodedBytes() - Method in class com.pd4ml.pdf.cos.COSStream

Applies every filter in the /Filter chain (in order, feeding each filter's output to the next) and returns the fully decoded bytes.

getDecryptionCertificate() - Method in class com.pd4ml.pdf.encryption.PublicKeyProtectionPolicy

Returns the decryption certificate.

getDefaultAppearance() - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Raw <defaultappearance> text (the /DA string), or null.

getDefaultCryptFilterDictionary() - Method in class com.pd4ml.pdf.encryption.PDEncryption

Returns the default crypt filter (for public-key security handler).

getDetails() - Method in class com.pd4ml.StatusMessage

Returns additional details about the problem, for example the requested output format.

getDictionary(String) - Method in class com.pd4ml.pdf.cos.COSDictionary

getDictionaryObject(COSName) - Method in class com.pd4ml.pdf.cos.COSDictionary

Value for key with any indirect reference resolved, or null.

getDictionaryObject(COSName...) - Method in class com.pd4ml.pdf.cos.COSDictionary

Resolves the first of several keys that is present, e.g.

getDictionaryObject(String) - Method in class com.pd4ml.pdf.cos.COSDictionary

getDigestAlgorithm() - Method in class com.pd4ml.pdf.sign.SigningOptions

getDocument() - Method in class com.pd4ml.pdf.cos.COSObject

getDocument() - Method in class com.pd4ml.pdf.sign.pdf.IncrementalPdfSigner

The parsed input document, e.g.

getDocumentTitle() - Method in class com.pd4ml.PD4ML

Returns the document title: the one set with PD4ML.setDocumentTitle(String), or else the <title> of the HTML document.

getDuplicateObjectCount() - Method in class com.pd4ml.pdf.optimizer.PdfOptimizeResult

Of PdfOptimizeResult.getRemovedObjectCount(), how many were removed specifically because they were byte-for-byte duplicates of another reachable object (e.g.

getEmbedded() - Method in exception com.pd4ml.pdf.encryption.CryptographyException

This will get the exception that caused this exception.

getEncoding() - Method in class com.pd4ml.ResourceProvider

Returns the character encoding of the loaded resource, as set by the implementation in ResourceProvider.encoding.

getEncryptionError() - Method in class com.pd4ml.pdf.cos.COSDocument

Non-null when this document is encrypted but the password given to COSParser could not be authenticated as either the user or the owner password -- in that case, strings and streams throughout the document are still in their encrypted form.

getEncryptionKey() - Method in class com.pd4ml.pdf.encryption.SecurityHandler

Returns the current encryption key data.

getEncryptionKeyLength() - Method in class com.pd4ml.pdf.encryption.ProtectionPolicy

Get the length of the secrete key that will be used to encrypt document data.

getFieldName() - Method in class com.pd4ml.pdf.sign.SigningOptions

getFields() - Method in class com.pd4ml.pdf.xfdf.XfdfDocument

Every resolved leaf field (<field> elements that carry a value, however deeply nested).

getFieldsNotFound() - Method in class com.pd4ml.pdf.xfdf.XfdfImporter.Result

Fully-qualified names from <fields> that matched no existing AcroForm field -- see class docs.

getFieldsUpdated() - Method in class com.pd4ml.pdf.xfdf.XfdfImporter.Result

How many <fields> entries matched and updated an existing AcroForm field.

getFilter() - Method in class com.pd4ml.pdf.encryption.PDEncryption

Get the name of the filter.

getFilterNames() - Method in class com.pd4ml.pdf.cos.COSStream

getFitPageVertically() - Method in class com.pd4ml.PD4ML

Returns the alignment set by PD4ML.fitPageVertically(int).

getFloat(int, float) - Method in class com.pd4ml.pdf.cos.COSArray

getFloat(String, float) - Method in class com.pd4ml.pdf.cos.COSDictionary

getGeneration() - Method in class com.pd4ml.pdf.cos.COSObjectKey

getGenerationNumber() - Method in class com.pd4ml.pdf.cos.COSBase

getHeight() - Method in class com.pd4ml.pdf.sign.VisibleSignatureOptions

getHeight(int) - Method in class com.pd4ml.CustomTag

Returns the natural height of the element.

getHeight(int) - Method in class com.pd4ml.PD4ML

Calculates the height of the whole document laid out at the given width, ignoring page breaks.

getHeight(int) - Method in class com.pd4ml.plugins.BatikSvgCustomTag

getHeight(int) - Method in class com.pd4ml.plugins.MathMLCustomTag

getHeight(int) - Method in class com.pd4ml.plugins.ORCodeCustomTag

getHeight(int) - Method in class com.pd4ml.plugins.PD4MLSvgCustomTag

getHighestObjectNumber() - Method in class com.pd4ml.pdf.cos.COSDocument

Allocates the next free object number, for building new indirect objects programmatically.

getImported(COSDocument, COSObjectKey) - Method in class com.pd4ml.pdf.cos.util.COSObjectImporter

The already-imported target-document reference for sourceKey, or null if not imported yet.

getIndex() - Method in class com.pd4ml.pdf.cos.path.COSPathSegment

getIndirectKey() - Method in class com.pd4ml.pdf.cos.COSObject

getInherited(COSDictionary, String) - Static method in class com.pd4ml.pdf.cos.util.PageAttributes

getInheritedArray(COSDictionary, String) - Static method in class com.pd4ml.pdf.cos.util.PageAttributes

Convenience for array-valued attributes (/MediaBox, /CropBox).

getInheritedResources(COSDictionary) - Static method in class com.pd4ml.pdf.cos.util.PageAttributes

Convenience for /Resources specifically (dictionary-valued).

getInkList() - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Ink <inklist>: one flat [x1, y1, x2, y2, ...] array per <gesture> stroke, or null.

getInnerCode() - Method in class com.pd4ml.CustomTag

Returns the source code of the tag occurrence: the complete element as it appears in the document, including the opening tag with its attributes, the content and the closing tag, for example <chart type="pie">...</chart>.

getInnerCode() - Method in class com.pd4ml.plugins.BatikSvgCustomTag

getInputByteCount() - Method in class com.pd4ml.pdf.optimizer.PdfOptimizeResult

getInputObjectCount() - Method in class com.pd4ml.pdf.optimizer.PdfOptimizeResult

Total indirect objects in the input's object table -- includes ones no longer reachable, e.g.

getInstance(String) - Static method in class com.pd4ml.PageSize

Returns a page size by name or by dimensions.

getInstance(String) - Static method in class com.pd4ml.PdfSpec

Finds a specification constant by its name, as returned by PdfSpec.toString(), ignoring case: for example "1.4", "1.7ext3", "PDF/A-3b", "PDF/UA-1" or "Factur-X".

getInstance(String, FontCache) - Method in class com.pd4ml.CustomTag

Creates the handler instance for one occurrence of the tag.

getInstance(String, FontCache) - Method in class com.pd4ml.plugins.BatikSvgCustomTag

getInstance(String, FontCache) - Method in class com.pd4ml.plugins.MathMLCustomTag

getInstance(String, FontCache) - Method in class com.pd4ml.plugins.ORCodeCustomTag

getInstance(String, FontCache) - Method in class com.pd4ml.plugins.PD4MLSvgCustomTag

getInt(int, int) - Method in class com.pd4ml.pdf.cos.COSArray

getInt(String, int) - Method in class com.pd4ml.pdf.cos.COSDictionary

getItem(COSName) - Method in class com.pd4ml.pdf.cos.COSDictionary

Raw value for key, without resolving an indirect reference.

getItem(String) - Method in class com.pd4ml.pdf.cos.COSDictionary

getKey() - Method in class com.pd4ml.pdf.cos.COSBase

getKeyLength() - Method in class com.pd4ml.pdf.encryption.SecurityHandler

Getter of the property keyLength.

getKeywords() - Method in class com.pd4ml.pdf.PdfDocumentBase

Returns the keywords from the document properties.

getKind() - Method in class com.pd4ml.pdf.cos.path.COSPathSegment

getLang() - Method in class com.pd4ml.plugins.MathMLCustomTag

getLastRenderInfo(String) - Method in class com.pd4ml.PD4ML

Returns information about the last conversion, after a write... or renderAsImages(...) call.

getLength() - Method in class com.pd4ml.pdf.encryption.PDCryptFilterDictionary

This will return the Length entry of the crypt filter dictionary.

The length in bits for the crypt filter algorithm.

getLength() - Method in class com.pd4ml.pdf.encryption.PDEncryption

This will return the Length entry of the encryption dictionary.

The length in bits for the encryption algorithm.

getLocation() - Method in class com.pd4ml.pdf.sign.SigningOptions

getLong(String, long) - Method in class com.pd4ml.pdf.cos.COSDictionary

getLowerLeftX() - Method in class com.pd4ml.pdf.sign.VisibleSignatureOptions

getLowerLeftY() - Method in class com.pd4ml.pdf.sign.VisibleSignatureOptions

getMessage() - Method in class com.pd4ml.StatusMessage

Returns the message text.

getMessage(int, String) - Static method in class com.pd4ml.StatusMessage

Creates a copy of a predefined message.

getMetadata() - Method in class com.pd4ml.pdf.PdfDocumentBase

Returns the XMP metadata of the document, for example to check its PDF/A conformance declaration.

getMime() - Method in class com.pd4ml.ResourceProvider

Returns the MIME type of the loaded resource, as set by the implementation in ResourceProvider.mime.

getModDate() - Method in class com.pd4ml.pdf.PdfDocumentBase

Returns the modification date from the document properties.

getName() - Method in class com.pd4ml.pdf.cos.COSName

getName() - Method in class com.pd4ml.pdf.cos.path.COSPathSegment

getName() - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

The name attribute -- the annotation's PDF /NM unique identifier.

getName() - Method in class com.pd4ml.pdf.xfdf.XfdfField

This field's own name segment (not qualified by its ancestors).

getName(int) - Method in class com.pd4ml.pdf.cos.COSArray

getNameAsString(String) - Method in class com.pd4ml.pdf.cos.COSDictionary

getNotFound() - Method in class com.pd4ml.pdf.xfdf.internal.FieldMapper.ApplyResult

Qualified names that had no matching existing field -- excludes any that matched but were filtered out (see FieldMapper.applyFields(com.pd4ml.pdf.cos.COSDocument, java.util.List<com.pd4ml.pdf.xfdf.XfdfField>, com.pd4ml.pdf.xfdf.internal.SelectionFilter)).

getNumber() - Method in class com.pd4ml.pdf.cos.COSObjectKey

getNumberOfPages() - Method in class com.pd4ml.pdf.PdfDocumentBase

Returns the number of pages, including the pages of an appended document.

getNumberOfRecipients() - Method in class com.pd4ml.pdf.encryption.PublicKeyProtectionPolicy

Returns the number of recipients

getObject() - Method in class com.pd4ml.pdf.cos.COSObject

Resolves and returns the referenced object, never null (an unresolvable reference yields COSNull.NULL, matching the PDF spec's treatment of dangling references).

getObject(int) - Method in class com.pd4ml.pdf.cos.COSArray

Entry at index with any indirect reference resolved.

getObject(COSObjectKey) - Method in class com.pd4ml.pdf.cos.COSDocument

Looks up an already-registered object.

getObjectKeys() - Method in class com.pd4ml.pdf.cos.COSDocument

getObjectNumber() - Method in class com.pd4ml.pdf.cos.COSBase

getObjects() - Method in class com.pd4ml.pdf.cos.COSDocument

getOcspResponses() - Method in class com.pd4ml.pdf.sign.ltv.RevocationFetcher.Result

Each entry is one complete DER-encoded OCSPResponse (RFC 6960), as returned by the responder.

getOffset() - Method in exception com.pd4ml.pdf.cos.parser.COSParseException

getOffset() - Method in class com.pd4ml.pdf.cos.parser.Token

getOptimizedPdf() - Method in class com.pd4ml.pdf.optimizer.PdfOptimizeResult

getOutputByteCount() - Method in class com.pd4ml.pdf.optimizer.PdfOptimizeResult

getOutputObjectCount() - Method in class com.pd4ml.pdf.optimizer.PdfOptimizeResult

Indirect objects in the optimized output -- always exactly those reachable from /Root and /Info.

getOwnerAccessPermission() - Static method in class com.pd4ml.pdf.encryption.AccessPermission

returns an access permission object for a document owner.

getOwnerEncryptionKey() - Method in class com.pd4ml.pdf.encryption.PDEncryption

This will get the OE entry in the standard encryption dictionary.

getOwnerKey() - Method in class com.pd4ml.pdf.encryption.PDEncryption

This will get the O entry in the standard encryption dictionary.

getOwnerPassword() - Method in class com.pd4ml.pdf.encryption.StandardProtectionPolicy

Returns the owner password.

getPage() - Method in class com.pd4ml.pdf.sign.VisibleSignatureOptions

getPage() - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Zero-based page index (the page attribute), or -1 if absent/unparseable.

getPageBox(int, String) - Method in class com.pd4ml.pdf.PdfDocumentBase

Returns a page boundary box.

getPageContent(int) - Method in class com.pd4ml.pdf.PdfDocumentBase

Returns the decoded content stream of a page: the PDF drawing operators, for diagnostics or simple text checks.

getPageMargins(int, boolean) - Method in class com.pd4ml.PD4ML

Returns the margins of a page, as determined by the defaults, setPageMargins(...) calls and, after readHTML(...), CSS @page rules of the document.

getPageSize(int) - Method in class com.pd4ml.PD4ML

Returns the size of a page, as determined by the default page size, setPageSize(...) calls and, after readHTML(...), CSS @page rules of the document.

getPageSize(int) - Method in class com.pd4ml.pdf.PdfDocumentBase

Returns the size of a page: the size of its crop box (the area viewers show), or of its media box if it has no crop box.

getParent() - Method in class com.pd4ml.pdf.xfdf.XfdfField

The enclosing <field> this one is nested under, or null for a top-level field.

getPassword() - Method in class com.pd4ml.pdf.encryption.PublicKeyDecryptionMaterial

Returns the password given by the user and that will be used to open the private key.

getPassword() - Method in class com.pd4ml.pdf.encryption.StandardDecryptionMaterial

Returns the password.

getPdf() - Method in class com.pd4ml.pdf.xfdf.XfdfImporter.Result

The imported PDF's bytes -- optimized and/or encrypted already, if XfdfImporter.Options.optimizeOutput/XfdfImporter.Options.encryptOutput(java.lang.String, java.lang.String) was used.

getPdfaVersion() - Method in class com.pd4ml.PdfSpec

Returns the PDF/A part the specification includes.

getPdfExtLevel() - Method in class com.pd4ml.PdfSpec

Returns the Adobe extension level of a PDF 1.7 specification.

getPdfFormatVersion() - Method in class com.pd4ml.pdf.PdfDocumentBase

Returns the PDF version of the document, from its file header.

getPdfHref() - Method in class com.pd4ml.pdf.xfdf.XfdfDocument

The <f href="..."/> element's target -- the PDF this XFDF was originally exported against, if stated.

getPDFName(String) - Static method in class com.pd4ml.pdf.cos.COSName

Returns the shared, interned instance for name, creating it on first use.

getPdfuaVersion() - Method in class com.pd4ml.PdfSpec

Returns the PDF/UA part of a PDF/UA constant (PdfSpec.PDFUA_1 or PdfSpec.PDFUA_2).

getPdfVersionLabel() - Method in class com.pd4ml.PdfSpec

Returns the PDF version of a version specification, without the extension level.

getPermission() - Method in class com.pd4ml.pdf.encryption.PublicKeyRecipient

Returns the access permission granted to the recipient.

getPermissionBytes() - Method in class com.pd4ml.pdf.encryption.AccessPermission

The returns an integer representing the access permissions.

getPermissionBytesForPublicKey() - Method in class com.pd4ml.pdf.encryption.AccessPermission

This returns an integer representing the access permissions.

getPermissions() - Method in class com.pd4ml.pdf.encryption.PDEncryption

This will get the permissions bit mask.

getPermissions() - Method in class com.pd4ml.pdf.encryption.StandardProtectionPolicy

Returns the access permissions

getPermissions() - Method in class com.pd4ml.pdf.PdfDocumentBase

Returns the access permissions of the document, as a combination of the Constants.Allow* flags.

getPerms() - Method in class com.pd4ml.pdf.encryption.PDEncryption

Get the Perms entry in the encryption dictionary.

getPopup() - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

The nested <popup> child, if this annotation has its own popup window, or null.

getPrivateKey() - Method in class com.pd4ml.pdf.encryption.PublicKeyDecryptionMaterial

returns The private key that will be used to open the document protection.

getPrivateKey() - Method in class com.pd4ml.pdf.sign.CertificateUtils.SigningIdentity

The local private key handle, or null for a CertificateUtils.SigningIdentity.getRemoteSigner()-backed (KMS) identity.

getProducer() - Method in class com.pd4ml.pdf.PdfDocumentBase

Returns the producer from the document properties: the software that wrote the PDF.

getProvider() - Static method in class com.pd4ml.pdf.encryption.SecurityProvider

Returns the provider to be used for advanced encrypting/decrypting.

getProvider() - Method in class com.pd4ml.pdf.sign.CertificateUtils.SigningIdentity

The JCA Provider that MUST perform any Signature operation with CertificateUtils.SigningIdentity.getPrivateKey() (set for a PKCS#11-backed identity, whose key is non-extractable and only usable through the exact provider instance that opened the token session), or null if the key has no such constraint (PKCS#12).

getQuadPoints() - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Highlight/Underline/Squiggly/StrikeOut/Redact/Link quad points, flat 8-per-quad, or null.

getQualifiedName() - Method in class com.pd4ml.pdf.xfdf.XfdfField

The fully-qualified, dot-joined field name, resolved through every ancestor XfdfField.getParent().

getRawData() - Method in class com.pd4ml.pdf.cos.COSStream

getReadTimeoutMillis() - Method in class com.pd4ml.pdf.sign.ltv.LtvOptions

getReason() - Method in class com.pd4ml.pdf.sign.SigningOptions

getRecipientsIterator() - Method in class com.pd4ml.pdf.encryption.PublicKeyProtectionPolicy

Returns an iterator to browse the list of recipients.

getRecipientsLength() - Method in class com.pd4ml.pdf.encryption.PDEncryption

Returns the number of recipients contained in the Recipients field of the dictionary.

getRecipientStringAt(int) - Method in class com.pd4ml.pdf.encryption.PDEncryption

returns the COSString contained in the Recipients field at position i.

getRect() - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

The rect attribute as [llx, lly, urx, ury], or null if absent/unparseable.

getRef() - Method in class com.pd4ml.pdf.cos.path.COSPathSegment

getRemoteSigner() - Method in class com.pd4ml.pdf.sign.CertificateUtils.SigningIdentity

The remote signing callback for a KMS-backed identity, or null for a local (PKCS#12/PKCS#11) key.

getRemovedObjectCount() - Method in class com.pd4ml.pdf.optimizer.PdfOptimizeResult

Objects that were dropped, whether because nothing reachable from /Root//Info referenced them, or because they were merged as duplicate content (see PdfOptimizeResult.getDuplicateObjectCount()).

getResourceAsBytes(String, FileCache) - Method in class com.pd4ml.ResourceProvider

Loads the resource completely.

getResourceAsStream(String, FileCache) - Method in class com.pd4ml.ResourceProvider

Opens the resource for reading.

getRevision() - Method in class com.pd4ml.pdf.encryption.PDEncryption

This will return the R entry of the encryption dictionary.

See PDF Reference 1.4 Table 3.14.

getRootKind() - Method in class com.pd4ml.pdf.cos.path.COSPath

getRootRef() - Method in class com.pd4ml.pdf.cos.path.COSPath

Non-null only when COSPath.getRootKind() is COSPath.RootKind.OBJECT_REF.

getSegments() - Method in class com.pd4ml.pdf.cos.path.COSPath

getSignatureImage() - Method in class com.pd4ml.pdf.sign.VisibleSignatureOptions

getSignaturePlaceholderSize() - Method in class com.pd4ml.pdf.sign.SigningOptions

getSignedPdf() - Method in class com.pd4ml.pdf.sign.pdf.SignResult

getSignerName() - Method in class com.pd4ml.pdf.sign.SigningOptions

getSigningCertificate() - Method in class com.pd4ml.pdf.sign.CertificateUtils.SigningIdentity

getSingleValue() - Method in class com.pd4ml.pdf.xfdf.XfdfField

The single value, if there's exactly one -- the common case -- or null if there are zero or several.

getStdCryptFilterDictionary() - Method in class com.pd4ml.pdf.encryption.PDEncryption

Returns the standard crypt filter.

getStream(String) - Method in class com.pd4ml.pdf.cos.COSDictionary

getStreamFilterName() - Method in class com.pd4ml.pdf.encryption.PDEncryption

Returns the name of the filter which is used for de/encrypting streams.

getString() - Method in class com.pd4ml.pdf.cos.COSString

Decodes the raw bytes as a PDF "text string": UTF-16BE if a BOM (FE FF) is present, PDFDocEncoding-as-Latin-1 otherwise.

getString(String) - Method in class com.pd4ml.pdf.cos.COSDictionary

getStringFilterName() - Method in class com.pd4ml.pdf.encryption.PDEncryption

Returns the name of the filter which is used for de/encrypting strings.

getSubFilter() - Method in class com.pd4ml.pdf.encryption.PDEncryption

Get the name of the subfilter.

getSubject() - Method in class com.pd4ml.pdf.PdfDocumentBase

Returns the subject from the document properties.

getTarget() - Method in class com.pd4ml.pdf.cos.util.COSObjectImporter

getText() - Method in class com.pd4ml.pdf.cos.parser.Token

Textual payload: the number's digits, a name's characters, a keyword, etc.

getTitle() - Method in class com.pd4ml.pdf.PdfDocumentBase

Returns the title from the document properties.

getTitle(Context) - Method in class com.pd4ml.plugins.MathMLCustomTag

getTrailer() - Method in class com.pd4ml.pdf.cos.COSDocument

getTsaPassword() - Method in class com.pd4ml.pdf.sign.SigningOptions

getTsaUrl() - Method in class com.pd4ml.pdf.sign.SigningOptions

getTsaUsername() - Method in class com.pd4ml.pdf.sign.SigningOptions

getType() - Method in class com.pd4ml.pdf.cos.parser.Token

getType() - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

The lower-case XFDF element name, e.g.

getUpdatedCount() - Method in class com.pd4ml.pdf.xfdf.internal.FieldMapper.ApplyResult

getUserEncryptionKey() - Method in class com.pd4ml.pdf.encryption.PDEncryption

This will get the UE entry in the standard encryption dictionary.

getUserKey() - Method in class com.pd4ml.pdf.encryption.PDEncryption

This will get the U entry in the standard encryption dictionary.

getUserPassword() - Method in class com.pd4ml.pdf.encryption.StandardProtectionPolicy

Returns the user password.

getUserPassword(byte[], byte[], int, int) - Method in class com.pd4ml.pdf.encryption.StandardSecurityHandler

Get the user password based on the owner password.

getValue() - Method in class com.pd4ml.pdf.cos.COSBoolean

getValues() - Method in class com.pd4ml.pdf.xfdf.XfdfField

This field's value(s) -- normally exactly one, but a multi-select Ch (choice) field can carry several <value> children.

getVersion() - Static method in class com.pd4ml.PD4ML

Returns the version of the PD4ML library.

getVersion() - Method in class com.pd4ml.pdf.cos.COSDocument

getVersion() - Method in class com.pd4ml.pdf.encryption.PDEncryption

This will return the V entry of the encryption dictionary.

See PDF Reference 1.4 Table 3.13.

getVersionBuildDate() - Static method in class com.pd4ml.PD4ML

Returns the build date of the PD4ML library.

getVertices() - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Polygon/Polyline <vertices> as a flat [x1, y1, x2, y2, ...] array, or null.

getVisibleSignatureOptions() - Method in class com.pd4ml.pdf.sign.SigningOptions

getVisibleText() - Method in class com.pd4ml.pdf.sign.VisibleSignatureOptions

getWarnings() - Method in class com.pd4ml.pdf.sign.ltv.RevocationFetcher.Result

Non-fatal problems encountered while fetching -- LTV embedding proceeds with whatever was obtained.

getWidth() - Method in class com.pd4ml.pdf.sign.VisibleSignatureOptions

getWidth(int) - Method in class com.pd4ml.CustomTag

Returns the natural width of the element.

getWidth(int) - Method in class com.pd4ml.plugins.BatikSvgCustomTag

getWidth(int) - Method in class com.pd4ml.plugins.MathMLCustomTag

getWidth(int) - Method in class com.pd4ml.plugins.ORCodeCustomTag

getWidth(int) - Method in class com.pd4ml.plugins.PD4MLSvgCustomTag

getX509() - Method in class com.pd4ml.pdf.encryption.PublicKeyRecipient

Returns the X509 certificate of the recipient.

GZIP - Static variable in class com.pd4ml.tools.Pd4Cmd.Base64

Specify that data should be gzip-compressed.

H

HALFLETTER - Static variable in class com.pd4ml.PageSize

Half Letter (Statement): 396 x 612 points (5.5 x 8.5 in).

hashCode() - Method in class com.pd4ml.pdf.cos.COSArray

hashCode() - Method in class com.pd4ml.pdf.cos.COSBoolean

hashCode() - Method in class com.pd4ml.pdf.cos.COSDictionary

hashCode() - Method in class com.pd4ml.pdf.cos.COSFloat

hashCode() - Method in class com.pd4ml.pdf.cos.COSInteger

hashCode() - Method in class com.pd4ml.pdf.cos.COSName

hashCode() - Method in class com.pd4ml.pdf.cos.COSObject

hashCode() - Method in class com.pd4ml.pdf.cos.COSObjectKey

hashCode() - Method in class com.pd4ml.pdf.cos.COSStream

hashCode() - Method in class com.pd4ml.pdf.cos.COSString

hashCode() - Method in class com.pd4ml.pdf.cos.path.COSPathSegment

hashCode() - Method in class com.pd4ml.pdf.merge.internal.PdfConformance.Level

hasIdFilter() - Method in class com.pd4ml.pdf.xfdf.internal.SelectionFilter

true if this filter restricts by ID at all.

hasObject(COSObjectKey) - Method in class com.pd4ml.pdf.cos.COSDocument

hasProtectionPolicy() - Method in class com.pd4ml.pdf.encryption.SecurityHandler

Returns whether a protection policy has been set.

hasTypeFilter() - Method in class com.pd4ml.pdf.xfdf.internal.SelectionFilter

true if this filter restricts by type at all -- lets a caller skip work it wouldn't need otherwise.

height - Variable in class com.pd4ml.PageSize

The page height in points.

HelveticaMetrics - Class in com.pd4ml.pdf.cos.writer

Character advance widths (per 1000 text-space units, i.e.

HTML_LAYOUT_DONE - Static variable in interface com.pd4ml.ProgressListener

The layout is complete.

HTML_LAYOUT_IN_PROGRESS - Static variable in interface com.pd4ml.ProgressListener

The layout is in progress; sent repeatedly.

HTML_PARSED - Static variable in interface com.pd4ml.ProgressListener

The source document has been parsed.

I

ICOSVisitor<T> - Interface in com.pd4ml.pdf.cos

Visitor over the COS object graph, e.g.

id - Variable in class com.pd4ml.PdfSpec

The internal identifier: 100 to 200 for PDF versions (PDF 1.4 is 140), 1 to 22 for PDF/A and PDF/UA.

ID - Static variable in class com.pd4ml.pdf.cos.COSName

ids(String) - Method in class com.pd4ml.pdf.xfdf.XfdfExporter.Options

Restricts export to the annotations/fields whose ID is in the given comma-separated list -- an annotation's own /NM, or a field's fully-qualified (dot-joined) name.

ids(String) - Method in class com.pd4ml.pdf.xfdf.XfdfImporter.Options

Restricts the import to the XFDF entries whose ID is in the given comma-separated list -- an annotation's own name attribute, or a field's fully-qualified name.

importIndirect(COSDocument, COSObject) - Method in class com.pd4ml.pdf.cos.util.COSObjectImporter

Like COSObjectImporter.importValue(com.pd4ml.pdf.cos.COSDocument, com.pd4ml.pdf.cos.COSBase), but always returns an indirect reference in the target document.

importInto(byte[], byte[]) - Static method in class com.pd4ml.pdf.xfdf.XfdfImporter

importInto(byte[], byte[], XfdfImporter.Options) - Static method in class com.pd4ml.pdf.xfdf.XfdfImporter

importInto(byte[], byte[], XfdfImporter.Options, OutputStream) - Static method in class com.pd4ml.pdf.xfdf.XfdfImporter

Convenience for writing the imported PDF straight to a destination rather than handling XfdfImporter.Result yourself.

importInto(File, File) - Static method in class com.pd4ml.pdf.xfdf.XfdfImporter

importInto(File, File, XfdfImporter.Options) - Static method in class com.pd4ml.pdf.xfdf.XfdfImporter

importInto(File, File, XfdfImporter.Options, File) - Static method in class com.pd4ml.pdf.xfdf.XfdfImporter

importInto(InputStream, InputStream, XfdfImporter.Options) - Static method in class com.pd4ml.pdf.xfdf.XfdfImporter

importValue(COSDocument, COSBase) - Method in class com.pd4ml.pdf.cos.util.COSObjectImporter

Imports value (which may be a direct value or an indirect COSObject reference) from sourceDoc, returning the equivalent value already registered in the target document.

includes(String, String) - Method in class com.pd4ml.pdf.xfdf.internal.SelectionFilter

IncrementalPdfSigner - Class in com.pd4ml.pdf.sign.pdf

Applies a PDF digital signature as a raw incremental update, on top of IncrementalUpdateWriter (the generic COS incremental-update mechanics -- object offsets, xref, trailer) from com.pd4ml.pdf.cos.writer.

IncrementalPdfSigner(byte[], SigningOptions) - Constructor for class com.pd4ml.pdf.sign.pdf.IncrementalPdfSigner

IncrementalUpdateWriter - Class in com.pd4ml.pdf.cos.writer

Appends a PDF incremental update (ISO 32000-1 §7.5.6) over an existing file's bytes: new and/or rewritten indirect objects, a classic cross-reference table covering just those objects, and a trailer whose /Prev chains back to the base file's own cross-reference section.

IncrementalUpdateWriter(byte[], COSDocument) - Constructor for class com.pd4ml.pdf.cos.writer.IncrementalUpdateWriter

IncrementalUpdateWriter.CustomBodyWriter - Interface in com.pd4ml.pdf.cos.writer

Callback for IncrementalUpdateWriter.writeObjectCustom(com.pd4ml.pdf.cos.COSObjectKey, com.pd4ml.pdf.cos.writer.IncrementalUpdateWriter.CustomBodyWriter): writes exactly one object's body (no header/endobj -- those are handled for you).

index(int) - Static method in class com.pd4ml.pdf.cos.path.COSPathSegment

INDEX - com.pd4ml.pdf.cos.path.COSPathSegment.Kind

[n] or a bare n -- index into the current array node.

INDEX - Static variable in class com.pd4ml.pdf.cos.COSName

indexOf(byte[], int) - Method in class com.pd4ml.pdf.cos.parser.RandomAccessBuffer

info(String, String) - Method in class com.pd4ml.pdf.merge.PdfMerger

Sets (or, if value is null, leaves unset) one /Info dictionary entry (e.g.

INFO - Static variable in class com.pd4ml.pdf.cos.COSName

injectHtml(String, boolean) - Method in class com.pd4ml.PD4ML

Inserts HTML code into the document body without changing the document source.

INSTANCE - Static variable in class com.pd4ml.pdf.encryption.SecurityHandlerFactory

Singleton instance

intValue() - Method in class com.pd4ml.pdf.cos.COSFloat

intValue() - Method in class com.pd4ml.pdf.cos.COSInteger

intValue() - Method in class com.pd4ml.pdf.cos.COSNumber

InvalidPasswordException - Exception in com.pd4ml

Thrown when an encrypted PDF document cannot be opened because the password given to the PdfDocument constructor is missing or wrong.

InvalidPasswordException - Exception in com.pd4ml.pdf.encryption

Indicates that an invalid password was supplied.

InvalidPasswordException(String) - Constructor for exception com.pd4ml.InvalidPasswordException

Creates the exception.

InvokeException - Exception in com.pd4ml

Thrown when the PD4ML API is used incorrectly: an invalid argument, or a method called at the wrong time (for example a configuration method after readHTML(...), or a write... method before it).

InvokeException(String) - Constructor for exception com.pd4ml.InvokeException

Creates the exception.

InvokeException(Throwable) - Constructor for exception com.pd4ml.InvokeException

Creates the exception for an underlying cause.

isAES() - Method in class com.pd4ml.pdf.encryption.SecurityHandler

True if AES is used for encryption and decryption.

isCrlOnlyAsFallback() - Method in class com.pd4ml.pdf.sign.ltv.LtvOptions

When both LtvOptions.isFetchOcsp() and this are true: false (default) fetches OCSP and CRL independently for every certificate, embedding both as redundant revocation evidence (the usual PAdES-LT recommendation); true only downloads a certificate's CRL when its OCSP responder was unreachable/absent, trading completeness for fewer requests.

isDecryptMetadata() - Method in class com.pd4ml.pdf.encryption.SecurityHandler

Returns true if meta data is to be decrypted.

isDemoMode() - Method in class com.pd4ml.PD4ML

Tells whether the converter runs in demo mode, that is, without a valid license.

isDirect() - Method in class com.pd4ml.pdf.cos.COSBase

isDirectory() - Method in class com.pd4ml.ResourceProvider

Tells whether the requested address is a directory rather than a resource, as set by the implementation in ResourceProvider.dir.

isEmpty() - Method in class com.pd4ml.pdf.cos.COSArray

isEmpty() - Method in class com.pd4ml.pdf.cos.COSDictionary

isEmpty() - Method in class com.pd4ml.pdf.sign.ltv.RevocationFetcher.Result

isEmptyKey() - Method in class com.pd4ml.pdf.cos.security.StandardSecurityHandler

isEmptyTag() - Method in class com.pd4ml.CustomTag

Tells the parser whether the tag is an empty element without content or closing tag, like <br>.

isEmptyTag() - Method in class com.pd4ml.plugins.BatikSvgCustomTag

isEmptyTag() - Method in class com.pd4ml.plugins.MathMLCustomTag

isEmptyTag() - Method in class com.pd4ml.plugins.ORCodeCustomTag

isEmptyTag() - Method in class com.pd4ml.plugins.PD4MLSvgCustomTag

isEncrypted() - Method in class com.pd4ml.pdf.cos.COSDocument

True if this document's trailer names an /Encrypt dictionary (regardless of whether the password supplied to the parser actually worked -- see COSDocument.getEncryptionError() to tell those apart).

isEncryptMetadata() - Method in class com.pd4ml.pdf.cos.security.StandardSecurityHandler

Whether the document's /Metadata stream is included in encryption (/EncryptMetadata, default true).

isEncryptMetaData() - Method in class com.pd4ml.pdf.encryption.PDCryptFilterDictionary

Will get the EncryptMetaData dictionary info.

isEncryptMetaData() - Method in class com.pd4ml.pdf.encryption.PDEncryption

Will get the EncryptMetaData dictionary info.

isEOF() - Method in class com.pd4ml.pdf.cos.parser.RandomAccessBuffer

isError() - Method in class com.pd4ml.StatusMessage

Tells whether this is an error: for PDF/A output, the result does not conform to the requested standard; otherwise, the output is restricted, for example by the license.

isFetchCrl() - Method in class com.pd4ml.pdf.sign.ltv.LtvOptions

Download each certificate's CRL (from its CRL Distribution Points extension).

isFetchOcsp() - Method in class com.pd4ml.pdf.sign.ltv.LtvOptions

Query each certificate's OCSP responder (from its Authority Information Access extension).

isForceHexForm() - Method in class com.pd4ml.pdf.cos.COSString

isFullyDecodable() - Method in class com.pd4ml.pdf.cos.COSStream

True if every filter named by /Filter is understood by this API's FilterFactory, i.e.

isImported(COSDocument, COSObjectKey) - Method in class com.pd4ml.pdf.cos.util.COSObjectImporter

True if sourceKey in sourceDoc has already been imported into the target document.

isIncludeRootCertificate() - Method in class com.pd4ml.pdf.sign.ltv.LtvOptions

Whether to also fetch/embed revocation info for the last (self-signed root/trust-anchor) certificate in the chain.

ISO8859_1 - Static variable in class com.pd4ml.Constants

The ISO-8859-1 (Latin-1) encoding name.

ISOB0 - Static variable in class com.pd4ml.PageSize

ISO B0: 2836 x 4008 points (1000 x 1414 mm).

ISOB1 - Static variable in class com.pd4ml.PageSize

ISO B1: 2004 x 2836 points (707 x 1000 mm).

ISOB2 - Static variable in class com.pd4ml.PageSize

ISO B2: 1418 x 2004 points (500 x 707 mm).

ISOB3 - Static variable in class com.pd4ml.PageSize

ISO B3: 1002 x 1418 points (353 x 500 mm).

ISOB4 - Static variable in class com.pd4ml.PageSize

ISO B4: 709 x 1002 points (250 x 353 mm).

ISOB5 - Static variable in class com.pd4ml.PageSize

ISO B5: 501 x 709 points (176 x 250 mm).

isOwnerPassword(byte[], byte[], byte[], int, byte[], int, int, boolean) - Method in class com.pd4ml.pdf.encryption.StandardSecurityHandler

Check for owner password.

isOwnerPassword(String, byte[], byte[], int, byte[], int, int, boolean) - Method in class com.pd4ml.pdf.encryption.StandardSecurityHandler

Check for owner password.

isOwnerPermission() - Method in class com.pd4ml.pdf.encryption.AccessPermission

This will tell if the access permission corresponds to owner access permission (no restriction).

isPdfa() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes any PDF/A part and level.

isPdfa1() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-1 (level a or b).

isPdfa12() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-1 or PDF/A-2 (any level).

isPdfa123() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-1, PDF/A-2 or PDF/A-3 (any level).

isPdfa1234() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes any PDF/A part from 1 to 4.

isPdfa123a() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-1a, PDF/A-2a or PDF/A-3a.

isPdfa123b() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-1b, PDF/A-2b or PDF/A-3b.

isPdfa12a() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-1a or PDF/A-2a.

isPdfa1a() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-1a.

isPdfa1b() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-1b.

isPdfa2() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-2 (any level).

isPdfa23() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-2 or PDF/A-3 (any level).

isPdfa234() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-2, PDF/A-3 or PDF/A-4.

isPdfa23a() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-2a or PDF/A-3a.

isPdfa23b() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-2b or PDF/A-3b.

isPdfa23u() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-2u or PDF/A-3u.

isPdfa2u() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-2u.

isPdfa3() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-3 (any level).

isPdfa4() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-4 (any variant).

isPdfa4e() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-4e.

isPdfa4f() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/A-4f (not supported yet).

isPdfua() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/UA-1 or PDF/UA-2.

isPdfua1() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/UA-1.

isPdfua2() - Method in class com.pd4ml.PdfSpec

Tells whether the specification includes PDF/UA-2.

isPreferAES() - Method in class com.pd4ml.pdf.encryption.ProtectionPolicy

Tell whether AES encryption is preferred when several encryption methods are available for the chosen key length.

isPro() - Method in class com.pd4ml.PD4ML

Tells whether the applied license enables Pro features, such as TTF font embedding (PD4ML.useTTF(String)), PDF forms, PD4ML.addStyle(String, boolean) and PD4ML.merge(PdfDocument, int, int, boolean).

isReadOnly() - Method in class com.pd4ml.pdf.encryption.AccessPermission

This will tell if the object has been set as read only.

isSupported(COSName) - Static method in class com.pd4ml.pdf.cos.filter.FilterFactory

isSupportedSubtype(String) - Static method in class com.pd4ml.pdf.xfdf.internal.AnnotationMapper

true if subtype (a PDF /Subtype name) has an XFDF representation this mapper handles.

isTaggedOutput(Context) - Method in class com.pd4ml.plugins.MathMLCustomTag

isUserPassword(byte[], byte[], byte[], int, byte[], int, int, boolean) - Method in class com.pd4ml.pdf.encryption.StandardSecurityHandler

Check if a plaintext password is the user password.

isUserPassword(String, byte[], byte[], int, byte[], int, int, boolean) - Method in class com.pd4ml.pdf.encryption.StandardSecurityHandler

Check if a plaintext password is the user password.

isWarning() - Method in class com.pd4ml.StatusMessage

Tells whether this is a warning: PD4ML worked around a problem, for example by ignoring a setting the requested standard does not allow.

iterator() - Method in class com.pd4ml.pdf.cos.COSArray

J

JIS_B4 - Static variable in class com.pd4ml.PageSize

JIS B4 (Japanese standard): 257 x 364 mm.

JIS_B5 - Static variable in class com.pd4ml.PageSize

JIS B5 (Japanese standard): 182 x 257 mm.

K

keySet() - Method in class com.pd4ml.pdf.cos.COSDictionary

KEYWORD - com.pd4ml.pdf.cos.parser.TokenType

KIDS - Static variable in class com.pd4ml.pdf.cos.COSName

L

lastIndexOf(byte[], int) - Method in class com.pd4ml.pdf.cos.parser.RandomAccessBuffer

Finds the last occurrence of pattern at or before the current end-of-buffer search window; used to locate startxref and the trailing %%EOF near the end of a file.

LEDGER - Static variable in class com.pd4ml.PageSize

Ledger: 1224 x 792 points (17 x 11 in), the landscape form of PageSize.TABLOID.

left - Variable in class com.pd4ml.PageMargins

The left margin in points.

LEFT_ALIGN - Static variable in class com.pd4ml.Constants

Left alignment.

LEGAL - Static variable in class com.pd4ml.PageSize

US Legal: 612 x 1008 points (8.5 x 14 in).

length() - Method in class com.pd4ml.pdf.cos.parser.RandomAccessBuffer

LENGTH - Static variable in class com.pd4ml.pdf.cos.COSName

LETTER - Static variable in class com.pd4ml.PageSize

US Letter: 612 x 792 points (8.5 x 11 in).

Level(String, String, String) - Constructor for class com.pd4ml.pdf.merge.internal.PdfConformance.Level

listKeywords() - Static method in class com.pd4ml.PdfSpec

Lists the names of the supported specifications from PDF 1.4 on, for help texts: PDF versions are prefixed with "PDF" (for example 'PDF1.7'), the others are listed as they are (for example 'PDF/A-3b').

load(byte[]) - Static method in class com.pd4ml.pdf.cos.parser.COSParser

load(byte[], String) - Static method in class com.pd4ml.pdf.cos.parser.COSParser

Like COSParser.load(byte[]), for a document protected by the PDF Standard security handler.

loadFromPkcs11(File, char[]) - Static method in class com.pd4ml.pdf.sign.CertificateUtils

Loads the first available private-key alias from a PKCS#11 token, configured by a standard SunPKCS11 config file (the same name=... / library=... / slot=... format documented for -Djava.security.pkcs11.SunPKCS11.provider).

loadFromPkcs11(File, char[], String) - Static method in class com.pd4ml.pdf.sign.CertificateUtils

Like CertificateUtils.loadFromPkcs11(File, char[]), for a token holding more than one key.

loadFromPkcs11(Provider, char[], String) - Static method in class com.pd4ml.pdf.sign.CertificateUtils

Like CertificateUtils.loadFromPkcs11(File, char[], String), for a caller that already has a configured SunPKCS11 Provider instance (e.g.

loadFromPkcs12(File, char[]) - Static method in class com.pd4ml.pdf.sign.CertificateUtils

Loads the first alias found in a PKCS#12 keystore (the common case for a keystore that holds exactly one signing identity).

loadFromPkcs12(InputStream, char[], String) - Static method in class com.pd4ml.pdf.sign.CertificateUtils

Loads a specific alias from a PKCS#12 keystore.

localFile() - Method in class com.pd4ml.ResourceProvider

Returns the local file that holds the resource, if any, so PD4ML can access it directly.

longValue() - Method in class com.pd4ml.pdf.cos.COSFloat

longValue() - Method in class com.pd4ml.pdf.cos.COSInteger

longValue() - Method in class com.pd4ml.pdf.cos.COSNumber

lookup(COSDictionary, int) - Static method in class com.pd4ml.pdf.cos.util.NumberTreeUtil

Returns the value stored under key in the number tree rooted at root, or null.

LtvOptions - Class in com.pd4ml.pdf.sign.ltv

Configuration for RevocationFetcher.fetch(java.security.cert.Certificate[], com.pd4ml.pdf.sign.ltv.LtvOptions): which revocation sources to try, in what order, and how patient to be with each.

LtvOptions() - Constructor for class com.pd4ml.pdf.sign.ltv.LtvOptions

LtvUpdater - Class in com.pd4ml.pdf.sign.ltv

Adds PAdES-LT ("Long Term Validation") information to an already-signed PDF: a /DSS (Document Security Store) dictionary at /Root/DSS holding the OCSP responses, CRLs and certificates needed to validate one or more signatures long after their signing certificates -- or even the TSA's -- may have expired or been revoked, plus a /VRI (Validation Related Information) entry keyed by the hex-uppercase SHA-1 of the target signature's exact /Contents bytes (ETSI TS 102 778-4 / ISO 32000-2 §12.8.4.3).

LZW_DECODE - Static variable in class com.pd4ml.pdf.cos.COSName

M

main(String[]) - Static method in class com.pd4ml.pdf.cos.cli.CosCli

main(String[]) - Static method in class com.pd4ml.pdf.cos.Main

main(String[]) - Static method in class com.pd4ml.pdf.merge.cli.Pd4MergeCli

main(String[]) - Static method in class com.pd4ml.pdf.optimizer.cli.Pd4OptimizeCli

main(String[]) - Static method in class com.pd4ml.pdf.sign.cli.PdfSignCli

main(String[]) - Static method in class com.pd4ml.pdf.xfdf.cli.Pd4XfdfCli

main(String[]) - Static method in class com.pd4ml.tools.Pd4Cmd

Main - Class in com.pd4ml.pdf.cos

Command-line demonstration of the COS API: parses a PDF file (path given as the first argument), prints a short structural summary, then evaluates every COS path expression given as subsequent arguments.

MAIN_DOC_READ - Static variable in interface com.pd4ml.ProgressListener

The source document has been loaded.

MathMLCustomTag - Class in com.pd4ml.plugins

MathMLCustomTag() - Constructor for class com.pd4ml.plugins.MathMLCustomTag

MathMLCustomTag(String, FontCache, CustomTag) - Constructor for class com.pd4ml.plugins.MathMLCustomTag

maxKey(COSDictionary) - Static method in class com.pd4ml.pdf.cos.util.NumberTreeUtil

The highest key stored anywhere in the number tree rooted at root (searching every /Kids subtree, ignoring /Limits since those are advisory and this needs the true maximum regardless), or -1 if root is null or the tree has no entries at all.

MEDIA_BOX - Static variable in class com.pd4ml.pdf.cos.COSName

merge(PdfDocument, int, int, boolean) - Method in class com.pd4ml.PD4ML

Combines the PDF produced by the next PD4ML.writePDF(OutputStream) call with pages of an existing PDF document.

merge(File) - Method in class com.pd4ml.pdf.merge.PdfMerger

merge(OutputStream) - Method in class com.pd4ml.pdf.merge.PdfMerger

mergeOutlines(boolean) - Method in class com.pd4ml.pdf.merge.PdfMerger

Opt-in (default false, so no existing caller's output changes): splice each source's own outline (bookmark) tree onto the merged output's, in source-processing order -- see OutlineMerger's own javadoc for the exact splice semantics and its one documented scope limitation (a source outline node pointing at a page that wasn't itself selected for the merge is not pruned -- only safe to enable when every page of every outline-contributing source is included in the merge).

mergePage(COSDocument, COSDictionary, COSDictionary, COSDictionary) - Method in class com.pd4ml.pdf.merge.internal.StructureTreeMerger

Merges one page's structure contribution, if any.

mergePDFs(InputStream, InputStream, OutputStream) - Static method in class com.pd4ml.PdfDocument

Concatenates two PDF documents: writes all pages of pdf1 followed by all pages of pdf2 to result.

mergeSource(COSDocument, COSDictionary) - Method in class com.pd4ml.pdf.merge.internal.OutlineMerger

Call once per source, in the same order PdfMerger itself processes sources.

mergeToBytes() - Method in class com.pd4ml.pdf.merge.PdfMerger

mime - Variable in class com.pd4ml.ResourceProvider

The MIME type of the loaded resource, for example "image/png", or null if unknown.

MM - com.pd4ml.Dimensions.Units

Millimeters.

MM_PER_INCH - Static variable in interface com.pd4ml.Dimensions

Millimeters per inch: 25.4.

mmHeight() - Method in class com.pd4ml.PageSize

Intended to return the height in millimeters.

mmWidth() - Method in class com.pd4ml.PageSize

Intended to return the width in millimeters.

monitorProgressWith(ProgressListener) - Method in class com.pd4ml.PD4ML

Registers a listener that is notified about the progress of the conversion, for example to show a progress bar.

MULTIPAGE_TIFF - Static variable in class com.pd4ml.Constants

Image format "mpagetiff": a single uncompressed TIFF image with all pages.

MULTIPAGE_TIFF_COMPRESSED - Static variable in class com.pd4ml.Constants

Image format "mpagetiffcomp": a single compressed (PackBits) TIFF image with all pages.

N

name - Variable in class com.pd4ml.PdfSpec

The name of the specification, for example "1.7" or "PDF/A-3b"; see PdfSpec.toString().

name(String) - Static method in class com.pd4ml.pdf.cos.path.COSPathSegment

NAME - com.pd4ml.pdf.cos.parser.TokenType

NAME - com.pd4ml.pdf.cos.path.COSPathSegment.Kind

/Name -- look up a key in the current dictionary (or stream) node.

newSecurityHandlerForFilter(String) - Method in class com.pd4ml.pdf.encryption.SecurityHandlerFactory

Returns a new security handler for the given Filter name, or null none is available.

newSecurityHandlerForPolicy(ProtectionPolicy) - Method in class com.pd4ml.pdf.encryption.SecurityHandlerFactory

Returns a new security handler for the given protection policy, or null none is available.

nextObjectNumber() - Method in class com.pd4ml.pdf.cos.writer.IncrementalUpdateWriter

Highest object number this writer has handed out so far (i.e.

nextToken() - Method in class com.pd4ml.pdf.cos.parser.COSLexer

Reads and returns the next token, or an EOF token at end of input.

NO_CHANGES_ALLOWED - com.pd4ml.pdf.sign.SigningOptions.CertificationLevel

NO_OPTIONS - Static variable in class com.pd4ml.tools.Pd4Cmd.Base64

No options specified.

NONE - com.pd4ml.Constants.ErrorPolicy

Never aborts the conversion; behaves like Constants.ErrorPolicy.RELAXED.

NONE - Static variable in class com.pd4ml.pdf.xfdf.internal.SelectionFilter

Matches everything -- the default when neither types nor ids is configured.

NORMAL - com.pd4ml.Constants.ErrorPolicy

Input data errors, such as a resource that cannot be loaded, abort the conversion.

NOT_CERTIFIED - com.pd4ml.pdf.sign.SigningOptions.CertificationLevel

NOTE - Static variable in class com.pd4ml.PageSize

Note: 540 x 720 points (7.5 x 10 in).

now() - Static method in class com.pd4ml.pdf.cos.util.PdfDates

NULL - com.pd4ml.pdf.cos.parser.TokenType

NULL - Static variable in class com.pd4ml.pdf.cos.COSNull

NUMBER - com.pd4ml.pdf.cos.parser.TokenType

NumberTreeUtil - Class in com.pd4ml.pdf.cos.util

Looks up a value in a PDF "number tree" (/Nums leaf array of [key1, value1, key2, value2, ...] pairs, optionally split across /Kids with /Limits ranges for large trees) -- the structure used by /StructTreeRoot/ParentTree, /PageLabels and a handful of other PDF constructs.

O

OBJ - com.pd4ml.pdf.cos.parser.TokenType

OBJECT_REF - com.pd4ml.pdf.cos.path.COSPath.RootKind

Start at a specific, explicitly named indirect object.

OBJECT_REF - com.pd4ml.pdf.cos.path.COSPathSegment.Kind

n g R -- jump directly to an indirect object, ignoring the current node.

objectRef(COSObjectKey) - Static method in class com.pd4ml.pdf.cos.path.COSPathSegment

of(String, String) - Static method in class com.pd4ml.pdf.xfdf.internal.SelectionFilter

ONE - Static variable in class com.pd4ml.pdf.cos.COSInteger

optimize(byte[]) - Static method in class com.pd4ml.pdf.optimizer.PdfOptimizer

optimize(byte[], PdfOptimizer.Options) - Static method in class com.pd4ml.pdf.optimizer.PdfOptimizer

optimize(byte[], PdfOptimizer.Options, OutputStream) - Static method in class com.pd4ml.pdf.optimizer.PdfOptimizer

Convenience for writing straight to a destination rather than handling PdfOptimizeResult yourself.

optimize(File) - Static method in class com.pd4ml.pdf.optimizer.PdfOptimizer

optimize(File, PdfOptimizer.Options) - Static method in class com.pd4ml.pdf.optimizer.PdfOptimizer

optimize(File, PdfOptimizer.Options, File) - Static method in class com.pd4ml.pdf.optimizer.PdfOptimizer

optimize(InputStream) - Static method in class com.pd4ml.pdf.optimizer.PdfOptimizer

optimize(InputStream, PdfOptimizer.Options) - Static method in class com.pd4ml.pdf.optimizer.PdfOptimizer

optimizeOutput(boolean) - Method in class com.pd4ml.pdf.xfdf.XfdfImporter.Options

Runs com.pd4ml.pdf.optimizer.PdfOptimizer (default settings: reachability cleanup plus duplicate-content merging) on the imported PDF before returning it.

Options() - Constructor for class com.pd4ml.pdf.cos.security.PdfEncryptor.Options

Options() - Constructor for class com.pd4ml.pdf.optimizer.PdfOptimizer.Options

Options() - Constructor for class com.pd4ml.pdf.xfdf.XfdfExporter.Options

Options() - Constructor for class com.pd4ml.pdf.xfdf.XfdfImporter.Options

ORCodeCustomTag - Class in com.pd4ml.plugins

ORCodeCustomTag() - Constructor for class com.pd4ml.plugins.ORCodeCustomTag

ORCodeCustomTag(String, FontCache, CustomTag) - Constructor for class com.pd4ml.plugins.ORCodeCustomTag

OutlineMerger - Class in com.pd4ml.pdf.merge.internal

Splices each merge source's own outline (bookmark) tree (/Root/Outlines, ISO 32000-1 12.3.3) onto the end of the merged target's, in the same order PdfMerger processes sources -- mirroring legacy com.pd4ml.pdf.parser.PdfDoc#mergeOutlines's own append-order splice (link the accumulated tree's last top-level node's /Next to the new source's first, re-parent the new source's top-level siblings, sum /Count).

OutlineMerger(COSObjectImporter) - Constructor for class com.pd4ml.pdf.merge.internal.OutlineMerger

OutlineTree - Class in com.pd4ml.pdf.cos.util

Reads and prunes a document's outline (bookmark) tree (/Root/Outlines, ISO 32000-1 12.3.3) via its /First//Next sibling chain (each node's own children, if any, live under its own /First//Next chain one level down).

outputRange(String) - Method in class com.pd4ml.PD4ML

Limits the output to the selected pages.

overlay(PdfDocumentBase, int) - Method in class com.pd4ml.pdf.PdfDocumentBase

Draws the pages of another document over the pages of this one, for example to stamp a watermark or a "COPY" label.

overlay(PdfDocumentBase, String, String, int) - Method in class com.pd4ml.pdf.PdfDocumentBase

Draws selected pages of another document over selected pages of this one.

OVERRIDE_PROPERTY - Static variable in class com.pd4ml.pdf.cos.util.PdfDates

"pd4ml.document.date" system property override, matching the same-named constant/feature the legacy com.pd4ml.pdf.parser.Util.generateDateString already honored -- "useful if needed a byte-to-byte document comparison" (golden-file/regression testing), so it's preserved here rather than dropped.

overrideDocumentEncoding(String) - Method in class com.pd4ml.PD4ML

Forces the encoding of the HTML document, overriding the encoding reported by the server, the byte order mark and <meta> charset declarations.

ownerPassword(String) - Method in class com.pd4ml.pdf.cos.security.PdfEncryptor.Options

Password required to change permissions/re-encrypt.

P

PAGE - Static variable in class com.pd4ml.pdf.cos.COSName

PageAttributes - Class in com.pd4ml.pdf.cos.util

Walks a page dictionary's /Parent chain for an "inheritable" page attribute -- /MediaBox, /CropBox, /Resources (ISO 32000-1 7.7.3.4, Table 30) -- that the page itself doesn't declare.

PAGEBREAKS_ALIGNED - Static variable in interface com.pd4ml.ProgressListener

The content has been distributed across pages.

PageMargins - Class in com.pd4ml

Page margins: the distances between the page edges and the page content area, in points (1/72 inch).

PageMargins(float, float, float, float) - Constructor for class com.pd4ml.PageMargins

Creates page margins in points (1/72 inch).

PageMargins(float, float, float, float, Dimensions.Units) - Constructor for class com.pd4ml.PageMargins

Creates page margins in the given units.

PAGES - Static variable in class com.pd4ml.pdf.cos.COSName

PageSize - Class in com.pd4ml

A page size in points (1/72 inch), with constants for the common ISO, JIS, North American and architectural paper formats.

PageSize(float, float) - Constructor for class com.pd4ml.PageSize

Creates a page size in points (1/72 inch).

PageSize(float, float, Dimensions.Units) - Constructor for class com.pd4ml.PageSize

Creates a page size in the given units.

PageTree - Class in com.pd4ml.pdf.cos.util

Walks a parsed document's page tree (/Root/Pages/Kids/...), resolving indirect references at every step.

paint(float, float, float, float, float, float, Graphics2D) - Method in class com.pd4ml.CustomTag

Draws the element.

paint(float, float, float, float, float, float, Graphics2D) - Method in class com.pd4ml.plugins.BatikSvgCustomTag

paint(float, float, float, float, float, float, Graphics2D) - Method in class com.pd4ml.plugins.MathMLCustomTag

paint(float, float, float, float, float, float, Graphics2D) - Method in class com.pd4ml.plugins.PD4MLSvgCustomTag

paint(float, float, Graphics2D) - Method in class com.pd4ml.CustomTag

Draws the element at the given position, at its natural size.

paint(float, float, Graphics2D) - Method in class com.pd4ml.plugins.ORCodeCustomTag

PARENT - Static variable in class com.pd4ml.pdf.cos.COSName

parse() - Method in class com.pd4ml.pdf.cos.parser.COSParser

parse(String) - Static method in class com.pd4ml.pdf.cos.path.COSPath

parse(String) - Static method in class com.pd4ml.pdf.cos.path.COSPathParser

parse(String, String) - Method in class com.pd4ml.plugins.BatikSvgCustomTag

parseFlags(String) - Static method in class com.pd4ml.pdf.xfdf.internal.FlagsUtil

0 if flagsAttribute is null/blank or names no recognized flag.

parseFloatList(String, int) - Static method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Parses a comma-separated list of floats (the shape of rect, coords, start/end, fringe, callout, ...) into an array, or returns null if it's blank, malformed, or (when expectedLength > 0) not exactly that many values.

parseHex(String) - Static method in class com.pd4ml.pdf.cos.COSString

parseLiteral(byte[]) - Static method in class com.pd4ml.pdf.cos.COSString

part - Variable in class com.pd4ml.pdf.merge.internal.PdfConformance.Level

password(String) - Method in class com.pd4ml.pdf.optimizer.PdfOptimizer.Options

Password to open the input, if encrypted (user or owner password; empty/omitted tries an empty password).

password(String) - Method in class com.pd4ml.pdf.xfdf.XfdfExporter.Options

Password to open the input, if encrypted (user or owner password; empty/omitted tries an empty password).

password(String) - Method in class com.pd4ml.pdf.xfdf.XfdfImporter.Options

Password to open the input PDF, if encrypted (user or owner password; empty/omitted tries an empty password).

Pd4Cmd - Class in com.pd4ml.tools

Pd4Cmd() - Constructor for class com.pd4ml.tools.Pd4Cmd

Pd4Cmd.Base64 - Class in com.pd4ml.tools

Encodes and decodes to and from Base64 notation.

Pd4CmdException - Exception in com.pd4ml.tools

Pd4CmdException() - Constructor for exception com.pd4ml.tools.Pd4CmdException

Pd4CmdException(String) - Constructor for exception com.pd4ml.tools.Pd4CmdException

Pd4MergeCli - Class in com.pd4ml.pdf.merge.cli

Command-line entry point for com.pd4ml.pdf.merge: combine page ranges from one or more PDFs (each with its own optional password) into one output file, optionally encrypting it.

PD4ML - Class in com.pd4ml

The main entry point of PD4ML: converts HTML/CSS documents to PDF, PDF/A, PDF/UA, RTF, DOCX or page images.

PD4ML() - Constructor for class com.pd4ml.PD4ML

Creates a converter instance with logging disabled.

PD4ML(int) - Constructor for class com.pd4ml.PD4ML

Creates a converter instance with the given log level.

PD4ML(String) - Constructor for class com.pd4ml.PD4ML

Creates a converter instance with the given license and logging disabled.

PD4ML(String, int) - Constructor for class com.pd4ml.PD4ML

Creates a converter instance with the given license and log level.

PD4ML_ALLOWED_RESOURCE_LOCATION - Static variable in class com.pd4ml.Constants

"pd4ml.allowed.resource.location": a URL prefix that restricts where external resources (stylesheets, images, attachments) may be loaded from.

PD4ML_BACKGROUND_AS_PATTERNS - Static variable in class com.pd4ml.Constants

"pd4ml.background.as.patterns": "false" switches back to the background image rendering used before v3.8.5fx3.

PD4ML_CACHE_ENABLE - Static variable in class com.pd4ml.Constants

"pd4ml.cache.enable": "false" disables the resource cache, so every resource is loaded anew.

PD4ML_CACHE_IMAGES_IN_TMP_DIR - Static variable in class com.pd4ml.Constants

"pd4ml.cache.images.in.tmp.dir": "true" makes PD4ML keep loaded images in temporary files instead of memory.

PD4ML_CONFIG_FILE - Static variable in class com.pd4ml.Constants

"pd4ml.config.file": a JVM system property with the location of a configuration file in .properties format.

PD4ML_CONFIG_HANDLER_CLASS - Static variable in class com.pd4ml.Constants

"pd4ml.config.handler.class": a JVM system property with the name of a class that reads the configuration file instead of the default PD4ConfigHandler.

PD4ML_CSS_IMPORT_DIRECTIVE - Static variable in class com.pd4ml.Constants

"pd4ml.css.import.directive": "disable" makes PD4ML ignore @import rules in stylesheets.

PD4ML_DISABLE_EXTERNAL_ATTACHMENTS - Static variable in class com.pd4ml.Constants

"pd4ml.disable.external.attachments": "true" stops PD4ML from loading <pd4ml:attachment> files from the local file system or from URLs.

PD4ML_DISABLE_WOFF - Static variable in class com.pd4ml.Constants

"pd4ml.disable.woff": "true" disables WOFF web fonts in @font-face rules, so the fallback fonts are used.

PD4ML_DISABLE_WOFF2 - Static variable in class com.pd4ml.Constants

"pd4ml.disable.woff2": "true" disables WOFF2 web fonts in @font-face rules, so the fallback fonts are used.

PD4ML_DOCUMENT_DATE - Static variable in class com.pd4ml.Constants

"pd4ml.document.date": overrides the creation date in the PDF document properties, for example to produce byte-identical output for comparisons.

PD4ML_DOCUMENT_HEIGHT_PX - Static variable in class com.pd4ml.Constants

Key for PD4ML.getLastRenderInfo(String): returns the height of the laid-out document in pixels, ignoring page breaks, as a Long.

PD4ML_DOCUMENT_VIEW_MODE - Static variable in class com.pd4ml.Constants

"pd4ml.document.view.mode": the page layout a PDF viewer initially uses to show the document: "SinglePage" (the default; one page at a time), "OneColumn" (continuous), "TwoColumnLeft", "TwoColumnRight" (two pages side by side, continuous, odd pages on the left or right), "TwoPageLeft" or "TwoPageRight" (two pages side by side, one spread at a time).

PD4ML_DOCUMENT_XMP_DATE - Static variable in class com.pd4ml.Constants

"pd4ml.document.xmp.date": overrides the dates in the XMP metadata of the PDF (written for PDF/A, PDF/UA and custom metadata), for example to produce byte-identical output.

PD4ML_DUMP_DEFAULT_STYLE - Static variable in class com.pd4ml.Constants

"pd4ml.dump.no.default.style": for debugging only.

PD4ML_ENABLE_HTTP_ERRORS - Static variable in class com.pd4ml.Constants

"pd4ml.enable.http.errors": intended to report HTTP errors when loading the main document as exceptions instead of producing an empty document.

PD4ML_EXTRA_RESOURCE_LOADERS - Static variable in class com.pd4ml.Constants

"pd4ml.extra.resource.loaders".

PD4ML_FAKE_BROWSER - Static variable in class com.pd4ml.Constants

"pd4ml.fake.browser": "true" makes PD4ML identify itself as a regular web browser in HTTP requests, for servers that reject unknown clients.

PD4ML_FIX20130116 - Static variable in class com.pd4ml.Constants

"pd4ml.fix.20130116": a workaround for table rows repeated after a page break in old versions.

PD4ML_FORCE_RTL - Static variable in class com.pd4ml.Constants

"pd4ml.force.rtl": "true" applies right-to-left word order to all text, including text in left-to-right languages.

PD4ML_GENERATE_TOOLTIPS - Static variable in class com.pd4ml.Constants

"pd4ml.generate.tooltips": "true" turns the title attributes of HTML elements into PDF annotations, which viewers show as tooltips.

PD4ML_HEADER_HEIGHT_LIMIT - Static variable in class com.pd4ml.Constants

"pd4ml.header.height.limit": "false" removed the limit of page header and footer height to one third of the page height in old versions.

PD4ML_HTML_IN_DYNAMIC_DATA - Static variable in class com.pd4ml.Constants

"pd4ml.html.in.dynamic.data": "enable" makes PD4ML parse the values set with PD4ML.setDynamicData(java.util.Map) as HTML instead of inserting them as text.

PD4ML_HTTP_REQUEST_DISPATCHER - Static variable in class com.pd4ml.Constants

"pd4ml.http.request.dispatcher".

PD4ML_IDS_AS_DESTINATIONS - Static variable in class com.pd4ml.Constants

"pd4ml.ids.as.destinations": "true" (the default) lets links address any element by its id attribute (<a href="#chapter2">), in addition to <a name="..."> anchors; "false" restricts link destinations to named anchors.

PD4ML_IMAGE_REPOSITORY - Static variable in class com.pd4ml.Constants

"pd4ml.image.repository".

PD4ML_INFO_AUTHOR - Static variable in class com.pd4ml.Constants

Intended as a PD4ML.getLastRenderInfo(String) key for the document author; not supported by this version of PD4ML (null is returned).

PD4ML_INFO_TITLE - Static variable in class com.pd4ml.Constants

Intended as a PD4ML.getLastRenderInfo(String) key for the document title; not supported by this version of PD4ML (null is returned).

PD4ML_INITIAL_PAGE_NUMBER - Static variable in class com.pd4ml.Constants

"pd4ml.initial.page.number": the number of the first page, as an integer string.

PD4ML_KEEP_TRAILING_BLANK_PAGES - Static variable in class com.pd4ml.Constants

"pd4ml.keep.trailing.blank.pages": "true" keeps blank pages at the end of the document.

PD4ML_MAX_CACHE_ENTRIES - Static variable in class com.pd4ml.Constants

"pd4ml.max.cache.entries".

PD4ML_MAX_CACHE_SIZE - Static variable in class com.pd4ml.Constants

"pd4ml.max.cache.size": the maximum number of resources (images, stylesheets and so on) kept in the resource cache; 1024 by default.

PD4ML_MAX_CACHE_VOLUME - Static variable in class com.pd4ml.Constants

"pd4ml.max.cache.volume": the maximum total size of the resource cache in bytes; unlimited by default.

PD4ML_MEDIA_TYPE_PRINT - Static variable in class com.pd4ml.Constants

"pd4ml.media.type.print": controls which CSS media types apply.

PD4ML_OMIT_DEFAULT_STYLE - Static variable in class com.pd4ml.Constants

"pd4ml.omit.default.style": for debugging only.

PD4ML_PDFA_STATUS - Static variable in class com.pd4ml.Constants

Key for PD4ML.getLastRenderInfo(String): returns the warnings and errors recorded during the last conversion, as a StatusMessage[].

PD4ML_PRINT_DIALOG_POPUP - Static variable in class com.pd4ml.Constants

"pd4ml.print.dialog.popup".

PD4ML_RIGHT_EDGE_PX - Static variable in class com.pd4ml.Constants

Key for PD4ML.getLastRenderInfo(String): returns the right edge of the content of the last conversion in pixels, as a Long.

PD4ML_SESSIONID_APPEND - Static variable in class com.pd4ml.Constants

"pd4ml.sessionid.append": "false" stops PD4ML from appending the session ID set with PD4ML.setSessionID(String) to resource URLs.

PD4ML_SESSIONID_VARNAME - Static variable in class com.pd4ml.Constants

"pd4ml.sessionid.varname": the name of the URL parameter that carries the session ID set with PD4ML.setSessionID(String); "jsessionid" by default.

PD4ML_SOCKET_TIMEOUT - Static variable in class com.pd4ml.Constants

"pd4ml.socket.timeout": the connect and read timeout for HTTP(S) resource requests, in milliseconds.

PD4ML_STYLESHEETS_TO_OMIT - Static variable in class com.pd4ml.Constants

"pd4ml.stylesheets.to.omit": a semicolon-separated list of strings; stylesheets whose URL contains one of them are not loaded, for example to skip screen-only frameworks.

PD4ML_TOTAL_PAGES - Static variable in class com.pd4ml.Constants

Key for PD4ML.getLastRenderInfo(String): returns the number of pages of the last conversion, as a Long.

PD4MLSvgCustomTag - Class in com.pd4ml.plugins

PD4MLSvgCustomTag() - Constructor for class com.pd4ml.plugins.PD4MLSvgCustomTag

PD4MLSvgCustomTag(String, FontCache, CustomTag) - Constructor for class com.pd4ml.plugins.PD4MLSvgCustomTag

Pd4OptimizeCli - Class in com.pd4ml.pdf.optimizer.cli

Command-line entry point for com.pd4ml.pdf.optimizer: drop objects no longer reachable from a PDF's /Root//Info (typically left behind by an earlier incremental update) and collapse its cross-reference/trailer history into one fresh table.

Pd4XfdfCli - Class in com.pd4ml.pdf.xfdf.cli

Command-line entry point for com.pd4ml.pdf.xfdf: export a PDF's annotations/form field values to an XFDF file, or import an XFDF file's annotations/form field values into a PDF.

PDCryptFilterDictionary - Class in com.pd4ml.pdf.encryption

This class is a specialized view of the crypt filter dictionary of a PDF document.

PDCryptFilterDictionary(DictObject) - Constructor for class com.pd4ml.pdf.encryption.PDCryptFilterDictionary

PDCryptFilterDictionary(Objects) - Constructor for class com.pd4ml.pdf.encryption.PDCryptFilterDictionary

PDEncryption - Class in com.pd4ml.pdf.encryption

This class is a specialized view of the encryption dictionary of a PDF document.

PDEncryption(DictObject) - Constructor for class com.pd4ml.pdf.encryption.PDEncryption

wraps given DictObject

PDEncryption(Objects) - Constructor for class com.pd4ml.pdf.encryption.PDEncryption

creates a new empty encryption dictionary.

PDF - Static variable in class com.pd4ml.Constants

Output format "pdf": a regular PDF document (PDF 1.7).

PDF_1_0 - Static variable in class com.pd4ml.PdfSpec

PDF 1.0 / Acrobat 1.

PDF_1_1 - Static variable in class com.pd4ml.PdfSpec

PDF 1.1 / Acrobat 2.

PDF_1_2 - Static variable in class com.pd4ml.PdfSpec

PDF 1.2 / Acrobat 3.

PDF_1_3 - Static variable in class com.pd4ml.PdfSpec

PDF 1.3 / Acrobat 4.

PDF_1_4 - Static variable in class com.pd4ml.PdfSpec

PDF 1.4 / Acrobat 5.

PDF_1_5 - Static variable in class com.pd4ml.PdfSpec

PDF 1.5 / Acrobat 6

PDF_1_6 - Static variable in class com.pd4ml.PdfSpec

PDF 1.6 / Acrobat 7

PDF_1_7 - Static variable in class com.pd4ml.PdfSpec

PDF 1.7 / Acrobat 8 / ISO 32000-1.

PDF_1_7_1 - Static variable in class com.pd4ml.PdfSpec

PDF 1.7 unofficial ext level 1

PDF_1_7_10 - Static variable in class com.pd4ml.PdfSpec

PDF 1.7 unofficial ext level 10

PDF_1_7_11 - Static variable in class com.pd4ml.PdfSpec

PDF 1.7 extension level 11 / Acrobat XI

PDF_1_7_2 - Static variable in class com.pd4ml.PdfSpec

PDF 1.7 unofficial ext level 2

PDF_1_7_3 - Static variable in class com.pd4ml.PdfSpec

PDF 1.7 extension level 3 / Acrobat 9

PDF_1_7_4 - Static variable in class com.pd4ml.PdfSpec

PDF 1.7 unofficial ext level 4

PDF_1_7_5 - Static variable in class com.pd4ml.PdfSpec

PDF 1.7 extension level 5

PDF_1_7_6 - Static variable in class com.pd4ml.PdfSpec

PDF 1.7 unofficial ext level 6

PDF_1_7_7 - Static variable in class com.pd4ml.PdfSpec

PDF 1.7 unofficial ext level 7

PDF_1_7_8 - Static variable in class com.pd4ml.PdfSpec

PDF 1.7 extension level 8 / Acrobat X

PDF_1_7_9 - Static variable in class com.pd4ml.PdfSpec

PDF 1.7 unofficial ext level 9

PDF_2_0 - Static variable in class com.pd4ml.PdfSpec

PDF 2.0 / ISO 32000-2

PDFA - Static variable in class com.pd4ml.Constants

Output format "pdfa": a PDF/A-1b document for long-term archiving.

PDFA_1A - Static variable in class com.pd4ml.PdfSpec

PDF/A-1a (ISO 19005-1, level a): archivable and accessible; tagged structure and Unicode text required; no transparency.

PDFA_1B - Static variable in class com.pd4ml.PdfSpec

PDF/A-1b (ISO 19005-1, level b): archivable with a reliable visual appearance; no transparency.

PDFA_2A - Static variable in class com.pd4ml.PdfSpec

PDF/A-2a (ISO 19005-2, level a): archivable and accessible; tagged structure and Unicode text required.

PDFA_2B - Static variable in class com.pd4ml.PdfSpec

PDF/A-2b (ISO 19005-2, level b): archivable with a reliable visual appearance.

PDFA_2U - Static variable in class com.pd4ml.PdfSpec

PDF/A-2u (ISO 19005-2, level u): like PDF/A-2b, plus Unicode text that can be extracted reliably.

PDFA_3A - Static variable in class com.pd4ml.PdfSpec

PDF/A-3a (ISO 19005-3, level a): like PDF/A-2a, and allows embedded files of any type.

PDFA_3B - Static variable in class com.pd4ml.PdfSpec

PDF/A-3b (ISO 19005-3, level b): like PDF/A-2b, and allows embedded files of any type.

PDFA_3U - Static variable in class com.pd4ml.PdfSpec

PDF/A-3u (ISO 19005-3, level u): like PDF/A-2u, and allows embedded files of any type.

PDFA_4 - Static variable in class com.pd4ml.PdfSpec

PDF/A-4 (ISO 19005-4), based on PDF 2.0.

PDFA_4E - Static variable in class com.pd4ml.PdfSpec

PDF/A-4e (ISO 19005-4), for engineering documents, based on PDF 2.0.

PdfConformance - Class in com.pd4ml.pdf.merge.internal

Detects a source document's own self-declared PDF/A or PDF/UA conformance (the pdfaid/pdfuaid identification schema in its XMP /Metadata, ISO 19005 / ISO 14289), and builds the equivalent XMP for a merged output whose sources all agree.

PdfConformance.Level - Class in com.pd4ml.pdf.merge.internal

One conformance identification: part is always present; conformance/revision may be null (PDF/UA has neither).

PdfDates - Class in com.pd4ml.pdf.cos.util

Formats a Calendar as a PDF date string (D:YYYYMMDDHHmmSSOHH'mm', ISO 32000-1 7.9.4) -- the format used for /Info's CreationDate/ ModDate entries.

PdfDocument - Class in com.pd4ml

An existing PDF document, for post-processing: reading and changing document properties, appending another document, putting the pages of another document over or under its pages, deleting pages, and saving it, optionally encrypted.

PdfDocument(byte[], String) - Constructor for class com.pd4ml.PdfDocument

Creates a document from PDF bytes.

PdfDocument(PdfDoc) - Constructor for class com.pd4ml.PdfDocument

Creates a document from a document built with PD4ML's internal PDF writer.

PdfDocument(InputStream, String) - Constructor for class com.pd4ml.PdfDocument

Creates a document from a stream.

PdfDocument(URL, String) - Constructor for class com.pd4ml.PdfDocument

Creates a document from a URL (file:, http:, https: or java: for classpath resources).

PdfDocumentBase - Class in com.pd4ml.pdf

The base class of PdfDocument: an existing PDF document that can be inspected, changed and saved.

PdfDocumentBase(byte[], String) - Constructor for class com.pd4ml.pdf.PdfDocumentBase

Creates a document from PDF bytes.

PdfDocumentBase(InputStream, String) - Constructor for class com.pd4ml.pdf.PdfDocumentBase

Creates a document from a stream.

PdfDocumentBase(URL, String) - Constructor for class com.pd4ml.pdf.PdfDocumentBase

Creates a document from a URL.

PdfEncryptor - Class in com.pd4ml.pdf.cos.security

Encrypts an in-memory COSDocument for output, using the PDF Standard security handler -- the write-side counterpart of StandardSecurityHandler (a reader, which deliberately doesn't expose a forward/encrypting direction).

PdfEncryptor.Algorithm - Enum in com.pd4ml.pdf.cos.security

PdfEncryptor.Options - Class in com.pd4ml.pdf.cos.security

PdfMergeException - Exception in com.pd4ml.pdf.merge

Checked exception wrapping any failure that occurs while loading a source PDF, selecting its pages, or assembling/writing the merged document.

PdfMergeException(String) - Constructor for exception com.pd4ml.pdf.merge.PdfMergeException

PdfMergeException(String, Throwable) - Constructor for exception com.pd4ml.pdf.merge.PdfMergeException

PdfMerger - Class in com.pd4ml.pdf.merge

Public entry point of the PD4ML PDF merge API.

PdfMerger() - Constructor for class com.pd4ml.pdf.merge.PdfMerger

PdfMergeSource - Class in com.pd4ml.pdf.merge

One source PDF added to a PdfMerger, and the page range selected from it.

PdfOptimizeException - Exception in com.pd4ml.pdf.optimizer

Checked exception wrapping any failure that occurs while loading, garbage collecting, or rewriting a PDF via PdfOptimizer.

PdfOptimizeException(String) - Constructor for exception com.pd4ml.pdf.optimizer.PdfOptimizeException

PdfOptimizeException(String, Throwable) - Constructor for exception com.pd4ml.pdf.optimizer.PdfOptimizeException

PdfOptimizer - Class in com.pd4ml.pdf.optimizer

Cleans a PDF down to exactly what's actually reachable, and collapses its cross-reference/trailer history into one fresh table -- built entirely on the pd4ml com.pd4ml.pdf.cos object model/parser (no PDFBox, no other PDF library), the same foundation com.pd4ml.pdf.sign and com.pd4ml.pdf.merge are built on.

PdfOptimizer.Options - Class in com.pd4ml.pdf.optimizer

PdfOptimizeResult - Class in com.pd4ml.pdf.optimizer

Outcome of a PdfOptimizer.optimize(byte[]) call: the rewritten PDF bytes plus before/after size and object-count stats, so a caller can tell how much (if anything) was actually cleaned up without re-parsing either file.

PdfOverlay - Class in com.pd4ml.pdf.overlay

Composites selected pages of one document (srcDoc) onto selected pages of another (destDoc) -- the engine behind com.pd4ml.pdf.PdfDocumentBase#overlay/#underlay.

PdfOverlayException - Exception in com.pd4ml.pdf.overlay

Checked exception wrapping any failure that occurs while compositing an overlay/underlay onto a destination document.

PdfOverlayException(String) - Constructor for exception com.pd4ml.pdf.overlay.PdfOverlayException

PdfOverlayException(String, Throwable) - Constructor for exception com.pd4ml.pdf.overlay.PdfOverlayException

PdfSignCli - Class in com.pd4ml.pdf.sign.cli

Single command-line entry point for the whole pdfsign-api project: COS inspection/path queries (the com.pd4ml.pdf.cos reader), listing signature fields, applying a digital signature (PKCS#12, PKCS#11/HSM, or any invisible/visible/DocMDP-certifying/timestamped combination thereof), and adding PAdES-LT (LTV) validation information to an already-signed PDF.

PdfSigner - Class in com.pd4ml.pdf.sign

Public entry point of the PD4ML PDF signing API.

PdfSigner() - Constructor for class com.pd4ml.pdf.sign.PdfSigner

PdfSigningException - Exception in com.pd4ml.pdf.sign

Checked exception wrapping any failure that occurs while loading key material or applying a digital signature to a PDF document.

PdfSigningException(String) - Constructor for exception com.pd4ml.pdf.sign.PdfSigningException

PdfSigningException(String, Throwable) - Constructor for exception com.pd4ml.pdf.sign.PdfSigningException

PdfSpec - Class in com.pd4ml

A PDF output specification: a PDF version, optionally combined with conformance to PDF/A (archiving), PDF/UA (accessibility) or an e-invoice format.

PdfSpec(PdfSpec) - Constructor for class com.pd4ml.PdfSpec

Creates the specification of the PDF version a given specification needs: a PDF version is copied; for a PDF/A or PDF/UA constant, the result is the lowest PDF version that standard allows, combined with the standard.

PdfSpec.PdfSpecUnsupportedException - Exception in com.pd4ml

Thrown when a requested PDF version or standard is not supported.

PdfSpec.PdfSpecViolationException - Exception in com.pd4ml

Thrown when standards are combined in a way the specifications do not allow.

PdfSpecUnsupportedException(String) - Constructor for exception com.pd4ml.PdfSpec.PdfSpecUnsupportedException

Creates the exception.

PdfSpecViolationException(String) - Constructor for exception com.pd4ml.PdfSpec.PdfSpecViolationException

Creates the exception.

PDFUA - Static variable in class com.pd4ml.Constants

Output format "pdfua": an accessible, tagged PDF that conforms to both PDF/UA-1 and PDF/A-2a.

PDFUA_1 - Static variable in class com.pd4ml.PdfSpec

PDF/UA-1 (ISO 14289-1): universally accessible PDF, for example for screen readers; a tagged structure is generated.

PDFUA_2 - Static variable in class com.pd4ml.PdfSpec

PDF/UA-2 (ISO 14289-2), based on PDF 2.0.

PEDANTIC - com.pd4ml.Constants.ErrorPolicy

In addition, violations of a requested standard, such as PDF/A, abort the conversion.

peek() - Method in class com.pd4ml.pdf.cos.parser.RandomAccessBuffer

Looks at the next byte without consuming it, or -1 at end of data.

peek(int) - Method in class com.pd4ml.pdf.cos.parser.RandomAccessBuffer

Looks offset bytes ahead without consuming, or -1 past the end.

permissions(int) - Method in class com.pd4ml.pdf.cos.security.PdfEncryptor.Options

Raw /P permission bits (ISO 32000-1 Table 22).

PIXELS_PER_POINT - Static variable in interface com.pd4ml.Dimensions

HTML pixels per point when no HTML width is set: 1.35.

PNG24 - Static variable in class com.pd4ml.Constants

Image format "png24": PNG images with 24-bit color and an alpha channel (transparency).

PNG8 - Static variable in class com.pd4ml.Constants

Image format "png8": PNG images with 24-bit color and no transparency.

POINTS_PER_INCH - Static variable in interface com.pd4ml.Dimensions

Points per inch: 72.

POINTS_PER_MM - Static variable in interface com.pd4ml.Dimensions

Points per millimeter: 2.835 (72 / 25.4, rounded).

position() - Method in class com.pd4ml.pdf.cos.parser.COSLexer

position() - Method in class com.pd4ml.pdf.cos.parser.RandomAccessBuffer

position() - Method in class com.pd4ml.pdf.cos.writer.COSWriter

position() - Method in class com.pd4ml.pdf.cos.writer.IncrementalUpdateWriter

Current length of the buffer being built, i.e.

predictPageHeight(PageMargins, PageSize, int) - Static method in class com.pd4ml.PD4ML

Calculates how many HTML pixels of content fit on one page for the given settings: the printable page height (page height minus top and bottom margins) divided by the scale factor from PD4ML.predictScale(PageMargins, PageSize, int).

predictScale(PageMargins, PageSize, int) - Static method in class com.pd4ml.PD4ML

Calculates the scale factor from HTML pixels to PDF points for the given settings: the printable page width (page width minus left and right margins) divided by the HTML width.

prepareDocumentForEncryption(PDEncryption, byte[]) - Method in class com.pd4ml.pdf.encryption.PublicKeySecurityHandler

Prepare the document for encryption.

prepareDocumentForEncryption(PDEncryption, byte[]) - Method in class com.pd4ml.pdf.encryption.SecurityHandler

Prepare the document for encryption.

prepareDocumentForEncryption(PDEncryption, byte[]) - Method in class com.pd4ml.pdf.encryption.StandardSecurityHandler

Prepare document for encryption.

prepareForDecryption(PDEncryption, byte[], DecryptionMaterial) - Method in class com.pd4ml.pdf.encryption.PublicKeySecurityHandler

Prepares everything to decrypt the document.

prepareForDecryption(PDEncryption, byte[], DecryptionMaterial) - Method in class com.pd4ml.pdf.encryption.SecurityHandler

Prepares everything to decrypt the document.

prepareForDecryption(PDEncryption, byte[], DecryptionMaterial) - Method in class com.pd4ml.pdf.encryption.StandardSecurityHandler

Prepares everything to decrypt the document.

preRegister(COSDocument, COSObjectKey, COSObject) - Method in class com.pd4ml.pdf.cos.util.COSObjectImporter

Seeds the import cache so any future reference to sourceKey in sourceDoc resolves directly to targetRef instead of being cloned.

PREV - Static variable in class com.pd4ml.pdf.cos.COSName

ProgressListener - Interface in com.pd4ml

Receives progress notifications during a conversion, for example to update a progress bar or to log timing information.

progressUpdate(int, int, String, long) - Method in interface com.pd4ml.ProgressListener

Called at each stage of the conversion.

PROTECTION_POLICY_CLASS - Static variable in class com.pd4ml.pdf.encryption.StandardSecurityHandler

Protection policy class for this handler.

ProtectionPolicy - Class in com.pd4ml.pdf.encryption

This class represents the protection policy to apply to a document.

ProtectionPolicy() - Constructor for class com.pd4ml.pdf.encryption.ProtectionPolicy

protectPhysicalUnitDimensions(boolean) - Method in class com.pd4ml.PD4ML

Keeps sizes given in physical units (in, cm, mm, pt, pc) at their exact physical size in the PDF, regardless of the HTML width.

pruneForDeletedPage(COSDictionary, COSObjectKey) - Static method in class com.pd4ml.pdf.cos.util.OutlineTree

Removes every outline node whose own destination resolves to deletedPageKey -- either a plain array-valued /Dest (first element the page reference), a named /Dest (a COSString looked up in the catalog's /Names/Dests name tree -- matching entries are also pruned from that tree, exactly as legacy's PdfDoc#getPageDestinations/cleanDestKids do), or an /A GoTo action's /D in either of those two shapes (not present in legacy's own equivalent, added here since it's the same information reached a different way) -- splicing the node out of its sibling chain.

PT - com.pd4ml.Dimensions.Units

Points (1/72 inch).

PublicKeyDecryptionMaterial - Class in com.pd4ml.pdf.encryption

This class holds necessary information to decrypt a PDF document protected by the public key security handler.

PublicKeyDecryptionMaterial(KeyStore, String, String) - Constructor for class com.pd4ml.pdf.encryption.PublicKeyDecryptionMaterial

Create a new public key decryption material.

PublicKeyProtectionPolicy - Class in com.pd4ml.pdf.encryption

The protection policy to use to protect a document with the public key security handler.

PublicKeyProtectionPolicy() - Constructor for class com.pd4ml.pdf.encryption.PublicKeyProtectionPolicy

Creates a new PublicKeyProtectionPolicy with an empty recipients list.

PublicKeyRecipient - Class in com.pd4ml.pdf.encryption

Represents a recipient in the public key protection policy.

PublicKeyRecipient() - Constructor for class com.pd4ml.pdf.encryption.PublicKeyRecipient

PublicKeySecurityHandler - Class in com.pd4ml.pdf.encryption

This class implements the public key security handler described in the PDF specification.

PublicKeySecurityHandler() - Constructor for class com.pd4ml.pdf.encryption.PublicKeySecurityHandler

Constructor.

PublicKeySecurityHandler(PublicKeyProtectionPolicy) - Constructor for class com.pd4ml.pdf.encryption.PublicKeySecurityHandler

Constructor used for encryption.

PX - com.pd4ml.Dimensions.Units

Pixels, converted at Dimensions.PIXELS_PER_POINT pixels per point.

R

RandomAccessBuffer - Class in com.pd4ml.pdf.cos.parser

Minimal seekable byte source over an in-memory PDF file.

RandomAccessBuffer(byte[]) - Constructor for class com.pd4ml.pdf.cos.parser.RandomAccessBuffer

RC4_128 - com.pd4ml.pdf.cos.security.PdfEncryptor.Algorithm

/V 2 /R 3, 128-bit RC4.

RC4_128BIT - Static variable in class com.pd4ml.Constants

RC4 encryption with a 128-bit key.

RC4_40BIT - Static variable in class com.pd4ml.Constants

RC4 encryption with a 40-bit key.

read() - Method in class com.pd4ml.pdf.cos.parser.RandomAccessBuffer

Reads the next byte, or -1 at end of data (does not throw).

read() - Method in class com.pd4ml.pdf.PdfDocumentBase

Loads and parses the document.

read(byte[]) - Static method in class com.pd4ml.pdf.xfdf.XfdfReader

Parses a complete XFDF document's bytes into an XfdfDocument.

readFully(int) - Method in class com.pd4ml.pdf.cos.parser.RandomAccessBuffer

readHTML(InputStream) - Method in class com.pd4ml.PD4ML

Reads and parses an HTML document from a stream.

readHTML(InputStream, URL) - Method in class com.pd4ml.PD4ML

Reads and parses an HTML document from a stream, decoding it with the platform default encoding (the file.encoding system property).

readHTML(InputStream, URL, String) - Method in class com.pd4ml.PD4ML

Reads and parses an HTML document from a stream, with an explicit encoding.

readHTML(URL) - Method in class com.pd4ml.PD4ML

Loads and parses an HTML document from a URL (file:, http:, https:, java: for classpath resources, or a protocol handled by a custom resource provider).

readHTML(URL, String) - Method in class com.pd4ml.PD4ML

Loads and parses an HTML document from a URL, with an explicit encoding.

redirected - Variable in class com.pd4ml.ResourceProvider

The final address of the resource if the request was redirected, otherwise null.

REFERENCE_R - com.pd4ml.pdf.cos.parser.TokenType

registerHandler(String, Class<? extends SecurityHandler>, Class<? extends ProtectionPolicy>) - Method in class com.pd4ml.pdf.encryption.SecurityHandlerFactory

Registers a security handler.

RELAXED - com.pd4ml.Constants.ErrorPolicy

The default: problems are logged and worked around; the conversion is not aborted.

RemoteSigner - Interface in com.pd4ml.pdf.sign

The cloud-KMS signing seam: implement this against whichever key management service holds your signing key -- AWS KMS, Azure Key Vault, GCP Cloud KMS, a corporate signing service, anything reachable over the network -- and hand the result to CertificateUtils.forRemoteKey(java.security.cert.Certificate[], com.pd4ml.pdf.sign.RemoteSigner).

remove(int) - Method in class com.pd4ml.pdf.cos.COSArray

remove(COSBase) - Method in class com.pd4ml.pdf.cos.COSArray

removeItem(COSName) - Method in class com.pd4ml.pdf.cos.COSDictionary

removeObject(COSObjectKey) - Method in class com.pd4ml.pdf.cos.COSDocument

Deregisters the object stored under key, if any.

removeRecipient(PublicKeyRecipient) - Method in class com.pd4ml.pdf.encryption.PublicKeyProtectionPolicy

Removes a recipient from the recipients list.

removeV45filters() - Method in class com.pd4ml.pdf.encryption.PDEncryption

remove CF, StmF, and StrF entries.

renderAsImages() - Method in class com.pd4ml.PD4ML

Lays out the document and draws each page as an image in memory, for example to display or post-process the pages.

renderAsImages(File, String, String) - Method in class com.pd4ml.PD4ML

Lays out the document and writes each page as a PNG image file.

renderAsImages(String) - Method in class com.pd4ml.PD4ML

Lays out the document and encodes each page as an image in memory.

RENDERER_TREE_BUILT - Static variable in interface com.pd4ml.ProgressListener

The layout structure has been built from the parsed document.

requiresColorspace() - Method in class com.pd4ml.PdfSpec

Tells whether the specification requires a device-independent color space or output intent for the colors used.

requiresMetadata() - Method in class com.pd4ml.PdfSpec

Tells whether the specification requires XMP metadata (PDF/A and PDF/UA).

requiresOutputInternet() - Method in class com.pd4ml.PdfSpec

Tells whether the specification requires an output intent (PDF/A and PDF/UA).

requiresReliableUnicodeSemantics() - Method in class com.pd4ml.PdfSpec

Tells whether the specification requires every glyph to map to Unicode text (PDF/A-1).

requiresTagging() - Method in class com.pd4ml.PdfSpec

Tells whether the specification requires a tagged PDF with a logical structure tree (PDF/A-1a, -2a, -3a and PDF/UA).

resolve() - Method in class com.pd4ml.pdf.cos.COSBase

Resolves through a COSObject indirection; every other COS type is already "resolved" and simply returns itself.

resolve() - Method in class com.pd4ml.pdf.cos.COSObject

ResourceProvider - Class in com.pd4ml

Base class for custom resource loaders, which let PD4ML load documents, images, stylesheets and other resources from sources it does not support natively: a proprietary protocol, a database, an encrypted store and so on.

ResourceProvider() - Constructor for class com.pd4ml.ResourceProvider

RESOURCES - Static variable in class com.pd4ml.pdf.cos.COSName

Result() - Constructor for class com.pd4ml.pdf.sign.ltv.RevocationFetcher.Result

revision - Variable in class com.pd4ml.pdf.merge.internal.PdfConformance.Level

RevocationFetcher - Class in com.pd4ml.pdf.sign.ltv

Fetches OCSP responses and CRLs for a certificate chain, over plain HTTP, using only the certificates' own Authority Information Access / CRL Distribution Points extensions to find where to ask -- no extra configuration needed for the common case.

RevocationFetcher.Result - Class in com.pd4ml.pdf.sign.ltv

Everything fetched for one RevocationFetcher.fetch(java.security.cert.Certificate[], com.pd4ml.pdf.sign.ltv.LtvOptions) call, ready to embed via LtvUpdater.

right - Variable in class com.pd4ml.PageMargins

The right margin in points.

RIGHT_ALIGN - Static variable in class com.pd4ml.Constants

Right alignment.

ROOT - Static variable in class com.pd4ml.pdf.cos.COSName

rotate() - Method in class com.pd4ml.PageMargins

Returns a copy rotated by 90 degrees, matching a page rotated with PageSize.rotate(): the new left margin is the old top margin, the new top is the old right, and so on.

rotate() - Method in class com.pd4ml.PageSize

Returns the size rotated by 90 degrees, with width and height swapped, for example to turn a portrait format into landscape.

rotated - Variable in class com.pd4ml.PageSize

true if the size was created by PageSize.rotate().

RTF - Static variable in class com.pd4ml.Constants

Output format "rtf": an RTF document with images embedded in their original format, which Microsoft Word and most other editors support.

RTF_PRE_RENDER_DONE - Static variable in interface com.pd4ml.ProgressListener

The preparation of RTF output is complete.

RTF_WMF - Static variable in class com.pd4ml.Constants

Output format "rtfwmf": an RTF document with images converted to WMF, for viewers such as WordPad that support no other image format.

S

SecurityHandler<T_POLICY extends ProtectionPolicy> - Class in com.pd4ml.pdf.encryption

A security handler as described in the PDF specifications.

SecurityHandlerFactory - Class in com.pd4ml.pdf.encryption

Manages security handlers for the application.

SecurityProvider - Class in com.pd4ml.pdf.encryption

Singleton which provides a security provider.

seek(long) - Method in class com.pd4ml.pdf.cos.parser.COSLexer

seek(long) - Method in class com.pd4ml.pdf.cos.parser.RandomAccessBuffer

SelectionFilter - Class in com.pd4ml.pdf.xfdf.internal

The optional "which annotations/fields" narrowing both XfdfExporter and XfdfImporter accept: a type filter and an ID filter, either or both of which may be unset (meaning "no restriction" for that one).

selectPages(String) - Method in class com.pd4ml.pdf.merge.PdfMergeSource

Selects which pages of this source to include in the merged output, and in what order -- e.g.

set(int, COSBase) - Method in class com.pd4ml.pdf.cos.COSArray

setAES(boolean) - Method in class com.pd4ml.pdf.encryption.SecurityHandler

Set to true if AES for encryption and decryption should be used.

setAttribute(String, String) - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Sets (or, with a null value, removes) one raw XFDF attribute directly -- what the typed setters below all funnel through.

setAuthor(String) - Method in class com.pd4ml.pdf.PdfDocumentBase

Sets the author in the document properties.

setAuthorName(String) - Method in class com.pd4ml.PD4ML

Sets the author stored in the document properties (metadata) of the output.

setBoolean(String, boolean) - Method in class com.pd4ml.pdf.cos.COSDictionary

setCache(Object) - Method in class com.pd4ml.PD4ML

Makes this instance reuse the font and resource cache of an earlier conversion.

setCanAssembleDocument(boolean) - Method in class com.pd4ml.pdf.encryption.AccessPermission

Set if the user can insert/rotate/delete pages.

setCanExtractContent(boolean) - Method in class com.pd4ml.pdf.encryption.AccessPermission

Set if the user can extract content from the document.

setCanExtractForAccessibility(boolean) - Method in class com.pd4ml.pdf.encryption.AccessPermission

Set if the user can extract content from the document for accessibility purposes.

setCanFillInForm(boolean) - Method in class com.pd4ml.pdf.encryption.AccessPermission

Set if the user can fill in interactive form fields (including signature fields) even if canModifyAnnotations() returns false.

setCanModify(boolean) - Method in class com.pd4ml.pdf.encryption.AccessPermission

Set if the user can modify the document.

setCanModifyAnnotations(boolean) - Method in class com.pd4ml.pdf.encryption.AccessPermission

Set if the user can add or modify text annotations and fill in interactive forms fields and, if canModify() returns true, create or modify interactive form fields (including signature fields).

setCanPrint(boolean) - Method in class com.pd4ml.pdf.encryption.AccessPermission

Set if the user can print.

setCanPrintDegraded(boolean) - Method in class com.pd4ml.pdf.encryption.AccessPermission

Set if the user can print the document in a degraded format.

setCertificationLevel(SigningOptions.CertificationLevel) - Method in class com.pd4ml.pdf.sign.SigningOptions

Set to something other than NOT_CERTIFIED only for the FIRST signature applied to a document.

setConnectTimeoutMillis(int) - Method in class com.pd4ml.pdf.sign.ltv.LtvOptions

setContactInfo(String) - Method in class com.pd4ml.pdf.sign.SigningOptions

setContents(String) - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Sets the plain-text <contents> body -- see XfdfAnnotation.getContents().

setContentsRichText(String) - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Sets the raw <contents-richtext> inner XML -- see XfdfAnnotation.getContentsRichText().

setCookie(String, String) - Method in class com.pd4ml.PD4ML

Adds a cookie to every HTTP request PD4ML makes to load the document and its resources, for example to pass an authentication or session cookie.

setCreator(String) - Method in class com.pd4ml.pdf.PdfDocumentBase

Sets the creator in the document properties.

setCrlOnlyAsFallback(boolean) - Method in class com.pd4ml.pdf.sign.ltv.LtvOptions

setCryptFilterDictionary(String, PDCryptFilterDictionary) - Method in class com.pd4ml.pdf.encryption.PDEncryption

Sets the crypt filter with the given name.

setCryptFilterMethod(String) - Method in class com.pd4ml.pdf.encryption.PDCryptFilterDictionary

This will set the crypt filter method.

setCurrentAccessPermission(AccessPermission) - Method in class com.pd4ml.pdf.encryption.SecurityHandler

Sets the access permissions.

setCustomSecureRandom(SecureRandom) - Method in class com.pd4ml.pdf.encryption.SecurityHandler

Set the custom SecureRandom.

setDecryptionCertificate(X509Certificate) - Method in class com.pd4ml.pdf.encryption.PublicKeyProtectionPolicy

Sets the decryption certificate

setDefaultAppearance(String) - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Sets the raw <defaultappearance> text -- see XfdfAnnotation.getDefaultAppearance().

setDefaultCryptFilterDictionary(PDCryptFilterDictionary) - Method in class com.pd4ml.pdf.encryption.PDEncryption

Sets the default crypt filter (for public-key security handler).

setDetails(String) - Method in class com.pd4ml.StatusMessage

Sets additional details about the problem.

setDigestAlgorithm(SigningOptions.DigestAlgorithm) - Method in class com.pd4ml.pdf.sign.SigningOptions

setDocumentTitle(String) - Method in class com.pd4ml.PD4ML

Sets the title stored in the document properties (metadata) of the output, overriding the <title> of the HTML document.

setDynamicData(Map<String, String>) - Method in class com.pd4ml.PD4ML

Sets values for $[key] placeholders in the document, so the HTML can be used as a template.

setElement(Element) - Method in class com.pd4ml.CustomTag

Called by PD4ML to pass the document element of this tag occurrence, for example to read its computed style.

setEncrypted(boolean) - Method in class com.pd4ml.pdf.cos.COSDocument

setEncryptionError(COSSecurityException) - Method in class com.pd4ml.pdf.cos.COSDocument

setEncryptionKey(byte[]) - Method in class com.pd4ml.pdf.encryption.SecurityHandler

Sets the current encryption key data.

setEncryptionKeyLength(int) - Method in class com.pd4ml.pdf.encryption.ProtectionPolicy

set the length in (bits) of the secret key that will be used to encrypt document data.

setEncryptMetaData(boolean) - Method in class com.pd4ml.pdf.encryption.PDCryptFilterDictionary

Set the EncryptMetaData dictionary info.

setErrorPolicy(Constants.ErrorPolicy) - Method in class com.pd4ml.PD4ML

Sets how strictly problems found during conversion are treated.

setFetchCrl(boolean) - Method in class com.pd4ml.pdf.sign.ltv.LtvOptions

setFetchOcsp(boolean) - Method in class com.pd4ml.pdf.sign.ltv.LtvOptions

setFieldName(String) - Method in class com.pd4ml.pdf.sign.SigningOptions

Name of the AcroForm signature field created/used.

setFilter(String) - Method in class com.pd4ml.pdf.encryption.PDEncryption

Sets the filter entry of the encryption dictionary.

setFloat(String, float) - Method in class com.pd4ml.pdf.cos.COSDictionary

setForceHexForm(boolean) - Method in class com.pd4ml.pdf.cos.COSString

setHeight(int) - Method in class com.pd4ml.CustomTag

Sets the height the default CustomTag.getHeight(int) reports.

setHtmlWidth(int) - Method in class com.pd4ml.PD4ML

Sets the width, in pixels, of the virtual browser window the document is laid out in.

setHttpOptions(String, String) - Method in class com.pd4ml.PD4ML

Sets the proxy and the credentials for HTTP requests PD4ML makes to load the document and its resources.

setIncludeRootCertificate(boolean) - Method in class com.pd4ml.pdf.sign.ltv.LtvOptions

setInitialPageNumber(int) - Method in class com.pd4ml.PD4ML

Sets the number of the first page, for example when the output is going to be appended to another document.

setInkList(List<float[]>) - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Replaces the whole ink gesture list -- see XfdfAnnotation.getInkList(); prefer XfdfAnnotation.addGesture(float[]) to append one stroke at a time.

setInnerCode(String) - Method in class com.pd4ml.CustomTag

Replaces the source code of the tag occurrence.

setInt(String, long) - Method in class com.pd4ml.pdf.cos.COSDictionary

setItem(COSName, COSBase) - Method in class com.pd4ml.pdf.cos.COSDictionary

setItem(String, COSBase) - Method in class com.pd4ml.pdf.cos.COSDictionary

setKey(COSObjectKey) - Method in class com.pd4ml.pdf.cos.COSBase

Records the indirect object identity this value was parsed as, so that a document writer can later decide whether to inline it or reference it with "n g R".

setKeyLength(int) - Method in class com.pd4ml.pdf.encryption.SecurityHandler

Setter of the property keyLength.

setKeywords(String) - Method in class com.pd4ml.pdf.PdfDocumentBase

Sets the keywords in the document properties.

setLength(int) - Method in class com.pd4ml.pdf.encryption.PDCryptFilterDictionary

This will set the number of bits to use for the crypt filter algorithm.

setLength(int) - Method in class com.pd4ml.pdf.encryption.PDEncryption

This will set the number of bits to use for the encryption algorithm.

setLocation(String) - Method in class com.pd4ml.pdf.sign.SigningOptions

setLogLevel(int) - Method in class com.pd4ml.PD4ML

Sets which log and diagnostic messages are written to the console.

setModDate() - Method in class com.pd4ml.pdf.PdfDocumentBase

Sets the modification date in the document properties to the current time.

setName(String) - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Sets the name attribute -- see XfdfAnnotation.getName().

setName(String, String) - Method in class com.pd4ml.pdf.cos.COSDictionary

setObject(COSObjectKey, COSBase) - Method in class com.pd4ml.pdf.cos.COSDocument

Registers/overwrites the object stored under key.

setOwnerEncryptionKey(byte[]) - Method in class com.pd4ml.pdf.encryption.PDEncryption

This will set the OE entry in the standard encryption dictionary.

setOwnerKey(byte[]) - Method in class com.pd4ml.pdf.encryption.PDEncryption

This will set the O entry in the standard encryption dictionary.

setOwnerPassword(String) - Method in class com.pd4ml.pdf.encryption.StandardProtectionPolicy

Sets the owner password

setPage(int) - Method in class com.pd4ml.pdf.sign.VisibleSignatureOptions

Zero-based page index the signature widget is placed on.

setPage(int) - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Sets the zero-based page attribute -- see XfdfAnnotation.getPage().

setPageBackground(String) - Method in class com.pd4ml.PD4ML

Sets HTML content to draw under the page content of every page, for example a letterhead or a page frame.

setPageBackground(String, String) - Method in class com.pd4ml.PD4ML

Sets HTML content to draw under the page content of the selected pages.

setPageFooter(String, int) - Method in class com.pd4ml.PD4ML

Sets an HTML page footer for all pages.

setPageFooter(String, int, String) - Method in class com.pd4ml.PD4ML

Sets an HTML page footer for the selected pages.

setPageHeader(String, int) - Method in class com.pd4ml.PD4ML

Sets an HTML page header for all pages.

setPageHeader(String, int, String) - Method in class com.pd4ml.PD4ML

Sets an HTML page header for the selected pages.

setPageMargins(PageMargins) - Method in class com.pd4ml.PD4ML

Sets the page margins for all pages.

setPageMargins(PageMargins, String) - Method in class com.pd4ml.PD4ML

Sets the page margins for the selected pages.

setPageSize(PageSize) - Method in class com.pd4ml.PD4ML

Sets the page size for all pages.

setPageSize(PageSize, String) - Method in class com.pd4ml.PD4ML

Sets the page size for the selected pages.

setParam(String, String) - Method in class com.pd4ml.PD4ML

Sets an advanced conversion parameter.

setParams(boolean, T_POLICY, PDEncryption, byte[], String) - Method in class com.pd4ml.pdf.encryption.SecurityHandler

setPdfHref(String) - Method in class com.pd4ml.pdf.xfdf.XfdfDocument

Sets the <f href="..."/> target -- see XfdfDocument.getPdfHref().

setPermission(AccessPermission) - Method in class com.pd4ml.pdf.encryption.PublicKeyRecipient

Set the access permission granted to the recipient.

setPermissions(int) - Method in class com.pd4ml.pdf.encryption.PDEncryption

This will set the permissions bit mask.

setPermissions(AccessPermission) - Method in class com.pd4ml.pdf.encryption.StandardProtectionPolicy

Sets the access permissions

setPermissions(String, int) - Method in class com.pd4ml.PD4ML

Encrypts the resulting PDF with 128-bit AES and restricts what users may do with it.

setPermissions(String, int, int) - Method in class com.pd4ml.PD4ML

Encrypts the resulting PDF with the given algorithm and restricts what users may do with it.

setPerms(byte[]) - Method in class com.pd4ml.pdf.encryption.PDEncryption

Set the Perms entry in the encryption dictionary.

setPopup(XfdfAnnotation) - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Sets the nested <popup> child -- see XfdfAnnotation.getPopup().

setPreferAES(boolean) - Method in class com.pd4ml.pdf.encryption.ProtectionPolicy

Set whether AES encryption is preferred when several encryption methods are available for the chosen key length.

setProvider(Provider) - Static method in class com.pd4ml.pdf.encryption.SecurityProvider

Set the provider to be used for advanced encrypting/decrypting.

setQuadPoints(float[]) - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Sets the quad points list -- see XfdfAnnotation.getQuadPoints().

setRawData(byte[]) - Method in class com.pd4ml.pdf.cos.COSStream

Sets the raw (still filtered/encoded) bytes exactly as they appear between "stream" and "endstream".

setReadOnly() - Method in class com.pd4ml.pdf.encryption.AccessPermission

Locks the access permission read only (ie, the setters will have no effects).

setReadTimeoutMillis(int) - Method in class com.pd4ml.pdf.sign.ltv.LtvOptions

setReason(String) - Method in class com.pd4ml.pdf.sign.SigningOptions

setRecipients(byte[][]) - Method in class com.pd4ml.pdf.encryption.PDEncryption

This will set the Recipients field of the dictionary.

setRect(float[]) - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Sets the rect attribute from [llx, lly, urx, ury] -- see XfdfAnnotation.getRect().

setRectangle(float, float, float, float) - Method in class com.pd4ml.pdf.sign.VisibleSignatureOptions

Position and size, in PDF user-space points, of the signature widget.

setRenderingHints(Map) - Method in class com.pd4ml.PD4ML

Sets the Java2D rendering hints used to draw pages in image output (renderAsImages(...)), for example to enable antialiasing or to trade quality for speed.

setRevision(int) - Method in class com.pd4ml.pdf.encryption.PDEncryption

This will set the R entry of the encryption dictionary.

See PDF Reference 1.4 Table 3.14.

setSessionID(String) - Method in class com.pd4ml.PD4ML

Sets the web application session ID to send with resource requests, so resources that require the user's session (stylesheets, images and so on) can be loaded.

setSignatureImage(File) - Method in class com.pd4ml.pdf.sign.VisibleSignatureOptions

setSignatureImage(InputStream) - Method in class com.pd4ml.pdf.sign.VisibleSignatureOptions

Optional image (PNG/JPEG) stamped into the signature widget, e.g.

setSignaturePlaceholderSize(int) - Method in class com.pd4ml.pdf.sign.SigningOptions

Bytes reserved in the PDF for the CMS/PKCS#7 signature blob (default 16384, i.e.

setSignerName(String) - Method in class com.pd4ml.pdf.sign.SigningOptions

Human-readable signer name; written to the signature dict and used as default visible-text if none is set.

setSourceToClose(Closeable) - Method in class com.pd4ml.pdf.cos.COSDocument

Wires up a resource (e.g.

setStdCryptFilterDictionary(PDCryptFilterDictionary) - Method in class com.pd4ml.pdf.encryption.PDEncryption

Sets the standard crypt filter.

setStreamFilterName(String) - Method in class com.pd4ml.pdf.encryption.PDEncryption

Sets the name of the filter which is used for de/encrypting streams.

setString(String, String) - Method in class com.pd4ml.pdf.cos.COSDictionary

setStringFilterName(String) - Method in class com.pd4ml.pdf.encryption.PDEncryption

Sets the name of the filter which is used for de/encrypting strings.

setSubFilter(String) - Method in class com.pd4ml.pdf.encryption.PDEncryption

Set the subfilter entry of the encryption dictionary.

setSubject(String) - Method in class com.pd4ml.pdf.PdfDocumentBase

Sets the subject in the document properties.

setTitle(String) - Method in class com.pd4ml.pdf.PdfDocumentBase

Sets the title in the document properties.

setTrailer(COSDictionary) - Method in class com.pd4ml.pdf.cos.COSDocument

setTsaCredentials(String, String) - Method in class com.pd4ml.pdf.sign.SigningOptions

Optional basic-auth credentials for TSAs that require them.

setTsaUrl(String) - Method in class com.pd4ml.pdf.sign.SigningOptions

RFC 3161 timestamp authority URL, e.g.

setUserEncryptionKey(byte[]) - Method in class com.pd4ml.pdf.encryption.PDEncryption

This will set the UE entry in the standard encryption dictionary.

setUserKey(byte[]) - Method in class com.pd4ml.pdf.encryption.PDEncryption

This will set the U entry in the standard encryption dictionary.

setUserPassword(String) - Method in class com.pd4ml.pdf.encryption.StandardProtectionPolicy

Sets the user password.

setVersion(float) - Method in class com.pd4ml.pdf.cos.COSDocument

setVersion(int) - Method in class com.pd4ml.pdf.encryption.PDEncryption

This will set the V entry of the encryption dictionary.

See PDF Reference 1.4 Table 3.13.

setVertices(float[]) - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

Sets the Polygon/Polyline vertex list -- see XfdfAnnotation.getVertices().

setVisibleSignatureOptions(VisibleSignatureOptions) - Method in class com.pd4ml.pdf.sign.SigningOptions

Supplying this makes the signature visible; omit it for an invisible signature.

setVisibleText(String) - Method in class com.pd4ml.pdf.sign.VisibleSignatureOptions

Optional plain text drawn into the signature widget (used when no image is supplied, or alongside it).

setWatermark(String, float, float, float, float, float, boolean, boolean, String) - Method in class com.pd4ml.PD4ML

Adds a watermark: HTML content drawn over the page content of the selected pages.

setWidth(int) - Method in class com.pd4ml.CustomTag

Sets the width the default CustomTag.getWidth(int) reports.

setX509(X509Certificate) - Method in class com.pd4ml.pdf.encryption.PublicKeyRecipient

Set the X509 certificate of the recipient.

SHA256 - com.pd4ml.pdf.sign.SigningOptions.DigestAlgorithm

SHA384 - com.pd4ml.pdf.sign.SigningOptions.DigestAlgorithm

SHA512 - com.pd4ml.pdf.sign.SigningOptions.DigestAlgorithm

sign(byte[]) - Method in interface com.pd4ml.pdf.sign.pdf.ByteRangeSigner

sign(byte[], CertificateUtils.SigningIdentity, SigningOptions) - Method in class com.pd4ml.pdf.sign.PdfSigner

Signs an in-memory PDF, returning the signed document's bytes.

sign(byte[], String) - Method in interface com.pd4ml.pdf.sign.RemoteSigner

Produces a raw signature over dataToSign, valid under jcaSignatureAlgorithm (e.g.

sign(ByteRangeSigner) - Method in class com.pd4ml.pdf.sign.pdf.IncrementalPdfSigner

Performs the whole incremental-update signing flow, calling signer exactly once, with exactly the bytes the resulting PDF signature is defined to cover.

sign(File, File, CertificateUtils.SigningIdentity, SigningOptions) - Method in class com.pd4ml.pdf.sign.PdfSigner

Signs inputPdf, writing the signed document to outputPdf.

sign(InputStream, OutputStream, CertificateUtils.SigningIdentity, SigningOptions) - Method in class com.pd4ml.pdf.sign.PdfSigner

Signs the PDF read from input, writing the signed bytes to output.

signForResult(byte[], CertificateUtils.SigningIdentity, SigningOptions) - Method in class com.pd4ml.pdf.sign.PdfSigner

Like PdfSigner.sign(byte[], CertificateUtils.SigningIdentity, SigningOptions), but returns the full SignResult -- signed PDF bytes plus the raw CMS/PKCS#7 signature that was embedded.

SigningOptions - Class in com.pd4ml.pdf.sign

Configuration for a single PdfSigner.sign(java.io.File, java.io.File, com.pd4ml.pdf.sign.CertificateUtils.SigningIdentity, com.pd4ml.pdf.sign.SigningOptions) call: which key to sign with, the metadata written into the signature dictionary, and (optionally) where to place a visible signature widget or which TSA to timestamp against.

SigningOptions() - Constructor for class com.pd4ml.pdf.sign.SigningOptions

SigningOptions.CertificationLevel - Enum in com.pd4ml.pdf.sign

Mirrors PDF's /DocMDP transform: how much further editing is permitted after this signature.

SigningOptions.DigestAlgorithm - Enum in com.pd4ml.pdf.sign

SignResult - Class in com.pd4ml.pdf.sign.pdf

Result of one IncrementalPdfSigner.sign(com.pd4ml.pdf.sign.pdf.ByteRangeSigner) call: the signed PDF, and the raw CMS/PKCS#7 signature bytes that were embedded in it (i.e.

SignResult(byte[], byte[]) - Constructor for class com.pd4ml.pdf.sign.pdf.SignResult

size() - Method in class com.pd4ml.pdf.cos.COSArray

size() - Method in class com.pd4ml.pdf.cos.COSDictionary

size() - Method in class com.pd4ml.pdf.cos.COSDocument

SIZE - Static variable in class com.pd4ml.pdf.cos.COSName

skipWhitespaceAndComments() - Method in class com.pd4ml.pdf.cos.parser.COSLexer

StandardDecryptionMaterial - Class in com.pd4ml.pdf.encryption

Represents the necessary information to decrypt a document protected by the standard security handler (password protection).

StandardDecryptionMaterial(String) - Constructor for class com.pd4ml.pdf.encryption.StandardDecryptionMaterial

Create a new standard decryption material with the given password.

StandardProtectionPolicy - Class in com.pd4ml.pdf.encryption

The protection policy to add to a document for password-based protection.

StandardProtectionPolicy(String, String, AccessPermission) - Constructor for class com.pd4ml.pdf.encryption.StandardProtectionPolicy

Creates an new instance of the standard protection policy in order to protect a PDF document with passwords.

StandardSecurityHandler - Class in com.pd4ml.pdf.cos.security

Implements the PDF Standard security handler (ISO 32000-1 §7.6.3 / ISO 32000-2 §7.6.4): given a document's /Encrypt dictionary, its first /ID element, and a candidate password, derives the file encryption key and can then decrypt any string or stream belonging to an indirect object in that document.

StandardSecurityHandler - Class in com.pd4ml.pdf.encryption

The standard security handler.

StandardSecurityHandler() - Constructor for class com.pd4ml.pdf.encryption.StandardSecurityHandler

Constructor.

StandardSecurityHandler(COSDictionary, byte[], String) - Constructor for class com.pd4ml.pdf.cos.security.StandardSecurityHandler

StandardSecurityHandler(StandardProtectionPolicy) - Constructor for class com.pd4ml.pdf.encryption.StandardSecurityHandler

Constructor used for encryption.

STARTXREF - com.pd4ml.pdf.cos.parser.TokenType

StatusMessage - Class in com.pd4ml

A warning or error recorded during a conversion, for example that a font could not be embedded in PDF/A output, or that the license does not cover the requested output format.

StatusMessage(int, int, String) - Constructor for class com.pd4ml.StatusMessage

Creates a message.

STREAM - com.pd4ml.pdf.cos.parser.TokenType

STRICT - com.pd4ml.Constants.ErrorPolicy

Any warning aborts the conversion, including problems that have a workaround.

STRING_HEX - com.pd4ml.pdf.cos.parser.TokenType

STRING_LITERAL - com.pd4ml.pdf.cos.parser.TokenType

stringWidth(String, float) - Static method in class com.pd4ml.pdf.cos.writer.HelveticaMetrics

Width of text at fontSize points, in points.

StructureTreeMerger - Class in com.pd4ml.pdf.merge.internal

Reconciles the accessibility structure tree (/StructTreeRoot / StructElem / ParentTree / /StructParents) across the pages pulled in from one or more source documents, building a single merged tree in the target document.

StructureTreeMerger(COSObjectImporter) - Constructor for class com.pd4ml.pdf.merge.internal.StructureTreeMerger

StructureTreeUpdater - Class in com.pd4ml.pdf.xfdf.internal

Wires a brand-new PDF annotation -- one XfdfImporter just added from an <annots> entry, not one it merely updated in place -- into an already-tagged target document's accessibility structure tree (/StructTreeRoot), so the imported annotation doesn't silently fall outside it.

SUBTYPE - Static variable in class com.pd4ml.pdf.cos.COSName

sweep(COSDocument) - Static method in class com.pd4ml.pdf.merge.internal.UnreachableObjectSweeper

T

TABLOID - Static variable in class com.pd4ml.PageSize

Tabloid: 792 x 1224 points (11 x 17 in).

tagNewAnnotation(COSDictionary, COSDictionary) - Method in class com.pd4ml.pdf.xfdf.internal.StructureTreeUpdater

Tags annotDict (already attached to page's /Annots) if it's the kind of annotation that should be, per this class's own documentation.

terminate() - Method in class com.pd4ml.PD4ML

Requests termination of a running conversion and clears the font cache.

testTermination() - Method in class com.pd4ml.PD4ML

Checks whether PD4ML.terminate() has been called, and aborts the conversion if so.

TIFF - Static variable in class com.pd4ml.Constants

Image format "tiff": one uncompressed TIFF image per page.

TIFF_COMPRESSED - Static variable in class com.pd4ml.Constants

Image format "tiffcomp": one compressed (PackBits) TIFF image per page.

toByteArray() - Method in class com.pd4ml.pdf.cos.COSStream

Convenience for new String(getDecodedBytes(), ...)-style access to content streams.

TOC_GENERATED - Static variable in interface com.pd4ml.ProgressListener

The table of contents has been generated.

toColorArray(String) - Static method in class com.pd4ml.pdf.xfdf.internal.ColorUtil

null if hex isn't a well-formed "#RRGGBB" string.

toFlagsString(int) - Static method in class com.pd4ml.pdf.xfdf.internal.FlagsUtil

null if flags is 0 (no flags set -- XFDF real-world producers simply omit the attribute in that case).

toFloatArray() - Method in class com.pd4ml.pdf.cos.COSArray

Convenience: a plain float[] from an array of numbers, e.g.

toHex(COSArray) - Static method in class com.pd4ml.pdf.xfdf.internal.ColorUtil

null if color is null, empty, or not a numeric-component array of length 1, 3 or 4.

Token - Class in com.pd4ml.pdf.cos.parser

A single lexical token: its type, source offset, and payload.

Token(TokenType, int, String) - Constructor for class com.pd4ml.pdf.cos.parser.Token

Token(TokenType, int, String, byte[]) - Constructor for class com.pd4ml.pdf.cos.parser.Token

TokenType - Enum in com.pd4ml.pdf.cos.parser

The lexical categories produced by COSLexer.

toList() - Method in class com.pd4ml.pdf.cos.COSArray

top - Variable in class com.pd4ml.PageMargins

The top margin in points.

toString() - Method in class com.pd4ml.PageMargins

toString() - Method in class com.pd4ml.PageSize

toString() - Method in class com.pd4ml.pdf.cos.COSArray

toString() - Method in class com.pd4ml.pdf.cos.COSBoolean

toString() - Method in class com.pd4ml.pdf.cos.COSDictionary

toString() - Method in class com.pd4ml.pdf.cos.COSFloat

toString() - Method in class com.pd4ml.pdf.cos.COSInteger

toString() - Method in class com.pd4ml.pdf.cos.COSName

toString() - Method in class com.pd4ml.pdf.cos.COSNull

toString() - Method in class com.pd4ml.pdf.cos.COSObject

toString() - Method in class com.pd4ml.pdf.cos.COSObjectKey

toString() - Method in class com.pd4ml.pdf.cos.COSStream

toString() - Method in class com.pd4ml.pdf.cos.COSString

toString() - Method in class com.pd4ml.pdf.cos.parser.Token

toString() - Method in class com.pd4ml.pdf.cos.path.COSPath

toString() - Method in class com.pd4ml.pdf.cos.path.COSPathSegment

toString() - Method in class com.pd4ml.pdf.merge.internal.PdfConformance.Level

toString() - Method in class com.pd4ml.pdf.xfdf.XfdfAnnotation

toString() - Method in class com.pd4ml.pdf.xfdf.XfdfField

toString() - Method in class com.pd4ml.PdfSpec

Returns the name of the specification, for example "1.7", "PDF/A-3b" or "ZUGFeRD".

toXfdf(COSDictionary, int) - Static method in class com.pd4ml.pdf.xfdf.internal.AnnotationMapper

null if annot's /Subtype isn't one AnnotationMapper.isSupportedSubtype(String) covers.

TRAILER - com.pd4ml.pdf.cos.parser.TokenType

TRAILER - com.pd4ml.pdf.cos.path.COSPath.RootKind

Start at the document's trailer dictionary.

transformXML(String) - Method in class com.pd4ml.tools.Pd4Cmd

TRANSLATE_FACTOR - Static variable in class com.pd4ml.Constants

The number of PDF points per millimeter: 2.835.

translateToPt(float) - Static method in class com.pd4ml.PD4ML

Converts millimeters to points (1/72 inch) at Constants.TRANSLATE_FACTOR points per millimeter.

TRUE - com.pd4ml.pdf.cos.parser.TokenType

TRUE - Static variable in class com.pd4ml.pdf.cos.COSBoolean

TYPE - Static variable in class com.pd4ml.pdf.cos.COSName

types(String) - Method in class com.pd4ml.pdf.xfdf.XfdfExporter.Options

Restricts export to annotations/fields of the given type(s), a comma-separated list, e.g.

types(String) - Method in class com.pd4ml.pdf.xfdf.XfdfImporter.Options

Restricts the import to XFDF entries of the given type(s), a comma-separated list, e.g.

U

underlay(PdfDocumentBase, int) - Method in class com.pd4ml.pdf.PdfDocumentBase

Draws the pages of another document under the pages of this one, for example a letterhead or a page background.

underlay(PdfDocumentBase, String, String, int) - Method in class com.pd4ml.pdf.PdfDocumentBase

Draws selected pages of another document under selected pages of this one.

UnreachableObjectSweeper - Class in com.pd4ml.pdf.merge.internal

Drops objects from a merge's in-progress target COSDocument that turn out unreachable from its trailer's /Root (and /Info//Encrypt, if present) once all cloning is done.

unread() - Method in class com.pd4ml.pdf.cos.parser.RandomAccessBuffer

updateIfExists(boolean) - Method in class com.pd4ml.pdf.xfdf.XfdfImporter.Options

When true, an <annots> entry whose name (PDF /NM) matches an annotation already in the PDF updates that annotation in place instead of adding a duplicate.

useHttpRequest(Object, Object) - Method in class com.pd4ml.PD4ML

Passes the current servlet request and response to PD4ML, for conversions running inside a web application.

userPassword(String) - Method in class com.pd4ml.pdf.cos.security.PdfEncryptor.Options

Password required to open the document for reading.

useTTF(String) - Method in class com.pd4ml.PD4ML

Registers a directory of TrueType/OpenType fonts to use in the output.

useTTF(String, boolean) - Method in class com.pd4ml.PD4ML

Registers a font directory like PD4ML.useTTF(String), and optionally creates its pd4fonts.properties mapping file.

useTTF(String, String) - Method in class com.pd4ml.PD4ML

Registers only the fonts of a directory whose names match a filter.

UTF8 - Static variable in class com.pd4ml.Constants

The UTF-8 encoding name.

V

valueOf(boolean) - Static method in class com.pd4ml.pdf.cos.COSBoolean

valueOf(String) - Static method in enum com.pd4ml.Constants.ErrorPolicy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.pd4ml.Dimensions.Units

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.pd4ml.pdf.cos.parser.TokenType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.pd4ml.pdf.cos.path.COSPath.RootKind

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.pd4ml.pdf.cos.path.COSPathSegment.Kind

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.pd4ml.pdf.cos.security.PdfEncryptor.Algorithm

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.pd4ml.pdf.sign.SigningOptions.CertificationLevel

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.pd4ml.pdf.sign.SigningOptions.DigestAlgorithm

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.pd4ml.Constants.ErrorPolicy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.pd4ml.Dimensions.Units

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.pd4ml.pdf.cos.parser.TokenType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.pd4ml.pdf.cos.path.COSPath.RootKind

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.pd4ml.pdf.cos.path.COSPathSegment.Kind

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.pd4ml.pdf.cos.security.PdfEncryptor.Algorithm

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.pd4ml.pdf.sign.SigningOptions.CertificationLevel

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.pd4ml.pdf.sign.SigningOptions.DigestAlgorithm

Returns an array containing the constants of this enum type, in the order they are declared.

VERSION0_UNDOCUMENTED_UNSUPPORTED - Static variable in class com.pd4ml.pdf.encryption.PDEncryption

See PDF Reference 1.4 Table 3.13.

VERSION1_40_BIT_ALGORITHM - Static variable in class com.pd4ml.pdf.encryption.PDEncryption

See PDF Reference 1.4 Table 3.13.

VERSION2_VARIABLE_LENGTH_ALGORITHM - Static variable in class com.pd4ml.pdf.encryption.PDEncryption

See PDF Reference 1.4 Table 3.13.

VERSION3_UNPUBLISHED_ALGORITHM - Static variable in class com.pd4ml.pdf.encryption.PDEncryption

See PDF Reference 1.4 Table 3.13.

VERSION4_SECURITY_HANDLER - Static variable in class com.pd4ml.pdf.encryption.PDEncryption

See PDF Reference 1.4 Table 3.13.

VisibleSignatureOptions - Class in com.pd4ml.pdf.sign

Optional configuration for rendering a visible signature widget on a page.

VisibleSignatureOptions() - Constructor for class com.pd4ml.pdf.sign.VisibleSignatureOptions

visitFromArray(COSArray) - Method in interface com.pd4ml.pdf.cos.ICOSVisitor

visitFromArray(COSArray) - Method in class com.pd4ml.pdf.cos.writer.COSWriter

visitFromBoolean(COSBoolean) - Method in interface com.pd4ml.pdf.cos.ICOSVisitor

visitFromBoolean(COSBoolean) - Method in class com.pd4ml.pdf.cos.writer.COSWriter

visitFromDictionary(COSDictionary) - Method in interface com.pd4ml.pdf.cos.ICOSVisitor

visitFromDictionary(COSDictionary) - Method in class com.pd4ml.pdf.cos.writer.COSWriter

visitFromFloat(COSFloat) - Method in interface com.pd4ml.pdf.cos.ICOSVisitor

visitFromFloat(COSFloat) - Method in class com.pd4ml.pdf.cos.writer.COSWriter

visitFromInteger(COSInteger) - Method in interface com.pd4ml.pdf.cos.ICOSVisitor

visitFromInteger(COSInteger) - Method in class com.pd4ml.pdf.cos.writer.COSWriter

visitFromName(COSName) - Method in interface com.pd4ml.pdf.cos.ICOSVisitor

visitFromName(COSName) - Method in class com.pd4ml.pdf.cos.writer.COSWriter

visitFromNull(COSNull) - Method in interface com.pd4ml.pdf.cos.ICOSVisitor

visitFromNull(COSNull) - Method in class com.pd4ml.pdf.cos.writer.COSWriter

visitFromObject(COSObject) - Method in interface com.pd4ml.pdf.cos.ICOSVisitor

visitFromObject(COSObject) - Method in class com.pd4ml.pdf.cos.writer.COSWriter

visitFromStream(COSStream) - Method in interface com.pd4ml.pdf.cos.ICOSVisitor

visitFromStream(COSStream) - Method in class com.pd4ml.pdf.cos.writer.COSWriter

visitFromString(COSString) - Method in interface com.pd4ml.pdf.cos.ICOSVisitor

visitFromString(COSString) - Method in class com.pd4ml.pdf.cos.writer.COSWriter

W

W - Static variable in class com.pd4ml.pdf.cos.COSName

WARNING - Static variable in class com.pd4ml.StatusMessage

Message type: a problem PD4ML worked around, for example by ignoring a setting.

width - Variable in class com.pd4ml.PageSize

The page width in points.

WINDOWS_1252 - Static variable in class com.pd4ml.Constants

The Windows-1252 encoding name.

withMinimumVersion(PdfSpec) - Method in class com.pd4ml.PdfSpec

Returns a specification with at least the given PDF version, keeping the PDF/A and PDF/UA standards of this one.

write(COSDocument) - Static method in class com.pd4ml.pdf.cos.writer.COSDocumentWriter

Writes document as a complete PDF file.

write(COSWriter) - Method in interface com.pd4ml.pdf.cos.writer.IncrementalUpdateWriter.CustomBodyWriter

write(XfdfDocument) - Static method in class com.pd4ml.pdf.xfdf.XfdfWriter

Serializes document to a complete, well-formed XFDF file's bytes (UTF-8, with the standard <?xml?> declaration and xmlns="http://ns.adobe.com/xfdf/" root).

write(OutputStream) - Method in class com.pd4ml.pdf.PdfDocumentBase

Writes the document with all changes, unencrypted, and closes the stream.

write(OutputStream, String, int) - Method in class com.pd4ml.pdf.PdfDocumentBase

Writes the document with all changes and closes the stream, optionally encrypted.

writeAscii(String) - Method in class com.pd4ml.pdf.cos.writer.COSWriter

writeBytes(byte[]) - Method in class com.pd4ml.pdf.cos.writer.COSWriter

writeDOCX(OutputStream) - Method in class com.pd4ml.PD4ML

Lays out the document read by readHTML(...) and writes it as a Microsoft Word (DOCX) document.

writeHex(byte[]) - Method in class com.pd4ml.pdf.cos.writer.COSWriter

writeIndirectObject(COSObjectKey, COSBase) - Method in class com.pd4ml.pdf.cos.writer.COSWriter

Writes a complete indirect object: "num gen obj\n<body>\nendobj\n".

writeName(String) - Method in class com.pd4ml.pdf.cos.writer.COSWriter

Writes /Name with the minimal escaping PDF name syntax requires.

writeObject(COSBase) - Method in class com.pd4ml.pdf.cos.writer.IncrementalUpdateWriter

Writes obj as a complete indirect object using its own (already-assigned, via IncrementalUpdateWriter.assignNewKey(com.pd4ml.pdf.cos.COSBase) or from the original parse) key, recording its offset for the xref table.

writeObjectCustom(COSObjectKey, IncrementalUpdateWriter.CustomBodyWriter) - Method in class com.pd4ml.pdf.cos.writer.IncrementalUpdateWriter

Like IncrementalUpdateWriter.writeObject(com.pd4ml.pdf.cos.COSBase), but the object's body is written by bodyWriter instead of the generic COSWriter visitor -- for the rare case where a caller needs to track exact byte offsets inside the body itself (a PDF signature's /Contents and /ByteRange being the motivating example).

writePDF(OutputStream) - Method in class com.pd4ml.PD4ML

Lays out the document read by readHTML(...) and writes it as a PDF 1.7 document.

writePDF(OutputStream, PdfSpec) - Method in class com.pd4ml.PD4ML

Lays out the document and writes it as a PDF that conforms to the given PDF version and, optionally, to PDF/A, PDF/UA, ZUGFeRD or Factur-X.

writePDF(OutputStream, String) - Method in class com.pd4ml.PD4ML

Lays out the document and writes it as a regular PDF, a PDF/A or a PDF/UA document.

writer() - Method in class com.pd4ml.pdf.cos.writer.IncrementalUpdateWriter

The shared COSWriter, for callers that need to hand-write part of an object's body (see IncrementalUpdateWriter.writeObjectCustom(com.pd4ml.pdf.cos.COSObjectKey, com.pd4ml.pdf.cos.writer.IncrementalUpdateWriter.CustomBodyWriter)).

writeRTF(OutputStream, boolean) - Method in class com.pd4ml.PD4ML

Lays out the document read by readHTML(...) and writes it as an RTF document.

writeString(COSString) - Method in class com.pd4ml.pdf.cos.writer.COSWriter

Writes a literal (...) string, escaping only what PDF syntax requires.

writeTrailerDictionary(COSDictionary) - Method in class com.pd4ml.pdf.cos.writer.COSWriter

Writes a bare dictionary body (no wrapping object header) -- used for the file trailer.

writeValue(COSBase) - Method in class com.pd4ml.pdf.cos.writer.COSWriter

Writes one nested value using the reference-vs-inline rule described in the class javadoc.

X

XfdfAnnotation - Class in com.pd4ml.pdf.xfdf

One <annots> entry (or a nested <popup>) -- a plain, generic bag of the XFDF attributes and child elements defined across every markup annotation type in ISO 19444-1 §6.4, rather than a separate Java class per PDF annotation subtype.

XfdfAnnotation(String) - Constructor for class com.pd4ml.pdf.xfdf.XfdfAnnotation

XfdfDocument - Class in com.pd4ml.pdf.xfdf

The parsed/in-memory form of one XFDF document (ISO 19444-1): the flat list of resolved XfdfFields from <fields> (see XfdfField.getQualifiedName() for how a nested <field> hierarchy collapses into this list), and the top-level XfdfAnnotations from <annots> (each already carrying its own nested <popup>, if it has one, rather than that popup also appearing separately in this list).

XfdfDocument() - Constructor for class com.pd4ml.pdf.xfdf.XfdfDocument

XfdfException - Exception in com.pd4ml.pdf.xfdf

Checked exception wrapping any failure that occurs while parsing an XFDF document, loading the PDF it targets, or applying/extracting annotation and form field data between the two.

XfdfException(String) - Constructor for exception com.pd4ml.pdf.xfdf.XfdfException

XfdfException(String, Throwable) - Constructor for exception com.pd4ml.pdf.xfdf.XfdfException

XfdfExporter - Class in com.pd4ml.pdf.xfdf

Exports a PDF's markup annotations and AcroForm field values to an XFDF document (ISO 19444-1) -- built entirely on the pd4ml com.pd4ml.pdf.cos object model/parser (no PDFBox, no other PDF library), the same foundation com.pd4ml.pdf.sign, com.pd4ml.pdf.merge and com.pd4ml.pdf.optimizer are built on.

XfdfExporter.Options - Class in com.pd4ml.pdf.xfdf

Export-time settings: the input password, and an optional type/ID subset to export.

XfdfField - Class in com.pd4ml.pdf.xfdf

One <field> entry under <fields> (ISO 19444-1 §6.3): a form field's fully-qualified name and its current value(s).

XfdfField(String, XfdfField) - Constructor for class com.pd4ml.pdf.xfdf.XfdfField

XfdfImporter - Class in com.pd4ml.pdf.xfdf

Imports an XFDF document's (ISO 19444-1) annotations and form field values into a PDF -- built entirely on the pd4ml com.pd4ml.pdf.cos object model/parser (no PDFBox, no other PDF library), the same foundation com.pd4ml.pdf.sign, com.pd4ml.pdf.merge and com.pd4ml.pdf.optimizer are built on.

XfdfImporter.Options - Class in com.pd4ml.pdf.xfdf

XfdfImporter.Result - Class in com.pd4ml.pdf.xfdf

The imported PDF, plus bookkeeping on what the import actually did.

XfdfReader - Class in com.pd4ml.pdf.xfdf

Parses an XFDF document (ISO 19444-1) into an XfdfDocument.

XfdfWriter - Class in com.pd4ml.pdf.xfdf

Serializes an XfdfDocument to XFDF XML bytes (ISO 19444-1), hand-rolled the same way com.pd4ml.pdf.merge.internal.PdfConformance builds its XMP packets, rather than pulling in a DOM/serializer dependency for what is, structurally, a very small and fixed document shape.

xid - Variable in class com.pd4ml.PdfSpec

The internal bit mask of the PDF/A and PDF/UA standards included.

XREF - com.pd4ml.pdf.cos.parser.TokenType

XREF_STM - Static variable in class com.pd4ml.pdf.cos.COSName

Z

ZERO - Static variable in class com.pd4ml.pdf.cos.COSInteger

ZUGFeRD - Static variable in class com.pd4ml.PdfSpec

ZUGFeRD electronic invoice profile: PDF 1.7 and PDF/A-3b.

ZUGFeRD_a - Static variable in class com.pd4ml.PdfSpec

ZUGFeRD electronic invoice profile, tagged: PDF 1.7 and PDF/A-3a.

A B C D E F G H I J K L M N O P R S T U V W X Z
All Classes All Packages