All Classes and Interfaces
Class
Description
This class represents the access permissions to a document.
Verify and ensure default resources for /AcroForm.
Generate field entries from page level widget annotations
if there AcroForm /Fields entry is empty.
Simple interface allowing the use of an annotation filter visitor.
Define styling attributes to be used for text formatting.
re Appends a rectangle to the path.
AWT PaintContext for axial shading.
AWT Paint for axial shading.
This class is used to contain parsing logic that will be used by both the
PDFParser and the COSStreamParser.
BI Begins an inline image.
BMC : Begins a marked-content sequence.
BDC : Begins a marked-content sequence with property list.
BT: Begin text.
AWT composite for blend modes.
Blend mode.
A font's built-in encoding.
Factory for creating a PDImageXObject containing a CCITT Fax compressed TIFF image.
Utility class providing common Charsets used in PDFBox.
A CIDFontMapping is a kind of FontMapping which allows for an additional TrueTypeFont substitute
to be provided if a CID font is not available.
Represents a CIDSystemInfo for the FontMapper API.
W* Set clipping path using even odd rule.
W Set the clipping path using non zero winding rule.
s: close and stroke the path.
b* Close, fill and stroke the path with even-odd winding rule.
b Close, fill and stroke the path with non-zero winding rule.
h Close the path.
cm: Concatenate matrix to current transformation matrix.
A class that will take a list of tokens and write out a stream with them.
An array of PDFBase objects as part of the PDF document.
This is an implementation of a List that will sync its contents to a COSArray.
The base object that all objects in the PDF document will extend.
This class represents a boolean value in the PDF document.
This class represents a dictionary where name/value pairs reside.
This is a Map that will automatically sync the contents to a COSDictionary.
This is the in-memory representation of the PDF document.
A filtered stream that includes the bytes that are in the (begin,length) intervals passed in the
constructor.
This class represents a floating point number in a PDF document.
An InputStream which reads from an encoded COS stream.
This class represents an integer number in a PDF document.
A PDF Name object.
This class represents a null PDF object.
This class represents an abstract number in a PDF document.
This class represents a PDF object.
This is an interface used to get/create the underlying COSObject.
Object representing the physical reference to an indirect pdf object.
An OutputStream which writes to an encoded COS stream.
PDF-Parser which first reads startxref and xref tables in order to know valid objects and parse only these objects.
simple output stream with some minor features for generating "pretty" PDF files.
This class represents a stream object in a PDF document.
A string object, which may be a text string, a PDFDocEncoded string, ASCII string, or byte string.
This class acts on a in-memory representation of a PDF document.
this is en entry in the xref section of the physical pdf document
generated by the COSWriter.
c Append curved segment to path.
y Append curved segment to path with final point replicated.
v Append curved segment to path with the initial point replicated.
Converts dates to strings and back using the PDF date standard
in section 3.8.2 of PDF Reference 1.7.
Options that may be passed to a Filter to request special handling when decoding the stream.
The result of a filter decode operation.
This class represents data required to decrypt PDF documents.
A resource cached based on SoftReference, retains resources until memory pressure causes them
to be garbage collected.
This will perform the encoding from a dictionary.
Do: Draws an XObject.
Do: Draws an XObject.
Do: Draws an XObject.
Throw when restore is executed when the graphics stack is empty.
A PostScript encoding vector, maps character codes to glyph names.
EMC : Ends a marked-content sequence begun by BMC or BDC.
n End the path.
ET: End text.
Makes up the execution context, holding the available operators and the execution stack.
Interface for external signature creation scenarios.
This represents an FDF annotation that is part of the FDF document.
This represents a Caret FDF annotation.
This represents a Circle FDF annotation.
This represents a FileAttachment FDF annotation.
This represents a FreeText FDF annotation.
This represents a Highlight FDF annotation.
This represents a Ink FDF annotation.
This represents a Line FDF annotation.
This represents a Polygon FDF annotation.
This represents a Polygon FDF annotation.
This represents a Polyline FDF annotation.
This represents a Sound FDF annotation.
This represents a Square FDF annotation.
This represents a Squiggly FDF annotation.
This represents a Stamp FDF annotation.
This represents a StrikeOut FDF annotation.
This represents a Text FDF annotation.
This abstract class is used as a superclass for the different FDF annotations with text markup attributes.
This represents a Underline FDF annotation.
This represents an FDF catalog that is part of the FDF document.
This represents an FDF dictionary that is part of the FDF document.
This is the in-memory representation of the FDF document.
This represents an FDF field that is part of the FDF document.
This represents an Icon fit dictionary for an FDF field.
This represents an FDF JavaScript dictionary that is part of the FDF document.
This represents an FDF named page reference that is part of the FDF field.
This represents an object that can be used in a Field's Opt entry to represent an available option and a default
appearance string.
This represents an FDF page that is part of the FDF document.
This represents an FDF page info that is part of the FDF page.
This represents an FDF template that is part of the FDF page.
A set of utility methods to help with common AcroForm form and field related functions.
B* Fill and then stroke the path, using the even-odd rule to determine the region to fill.
f* Fill path using even odd rule.
B Fill and then stroke the path, using the nonzero winding number rule to determine the region
to fill.
f Fill path using non zero winding rule.
A filter for stream data.
Factory for Filter classes.
An in-memory cache for system fonts.
Font file format.
Information about a font on the system.
Font mapper, locates non-embedded fonts.
FontMapper factory class.
FontMapping<T extends org.apache.fontbox.FontBoxFont>
A font mapping from a PDF font to a FontBox font.
External font service provider interface.
PostScript glyph list, maps glyph names to sequences of Unicode characters.
Base class for graphics operators.
Utility functions for hex encoding.
An interface for visiting a PDF document at the type (COS) level.
Image type for rendering.
Represents an instruction sequence, a combination of values, operands and nested procedures.
Basic parser for Type 4 functions which is used to build up instruction sequences.
Indicates that an invalid password was supplied.
This class contains various I/O-related methods.
This class provides an iterative (bottom-up) implementation of the
MergeSort algorithm for any generic Java
object which implements a
Comparator.Factory for creating a PDImageXObject containing a JPEG compressed image.
Decompress data encoded using the wavelet-based JPEG 2000 standard,
reproducing the original data.
This class allows to import pages as Form XObjects into a document and use them to create layers
(optional content groups).
F Fill path using non zero winding rule.
l Append straight line segment to path.
Factory for creating a PDImageXObject containing a lossless compressed image.
This is the filter used for the LZWDecode filter.
This is an interface to a text encoder.
This is the Mac OS Roman encoding, which is similar to the
MacRomanEncoding with the addition of 15 entries
This is an interface to a text encoder.
This class will be used for matrix manipulation.
Controls how memory/temporary files are used for
buffering streams etc.
Thrown when a required JAI ImageReader is missing.
Throw when a PDF operator is missing required operands.
Thrown when a named resource is missing.
Td: Move text position.
TD: Move text position and set leading.
m Begins a new subpath.
T*: Move to start of next text line.
Non-separable blend mode (supports blend function).
This class contains methods to format numbers.
This will specify whether to open the destination document in a new window.
An Operator in a PDF content stream.
Interface for PostScript operators.
Processes a PDF operator.
This class provides all the supported operators.
Orientation of printed pages.
Adds an overlay to an existing PDF document.
Possible location of the overlaid pages: foreground or background.
Paints a page in a PDF document to a Graphics context.
Parameters for a PageDrawer.
This class will extract one or more sequential pages and create a new document.
A name object specifying the page layout shall be used when the document is opened.
A name object specifying how the document shall be displayed when opened.
Parser for PDF Type 4 functions.
Abstract base class for a
Parser.SyntaxHandler.This interface defines all possible syntactic elements of a Type 4 function.
Generic handler to generate the fields appearance.
This class wraps a pattern dictionary.
An interactive form, also known as an AcroForm.
This represents an action that can be executed in a PDF document.
This represents a embedded go-to action that can be executed in a PDF document.
This class will take a dictionary and determine which type of action to create.
This represents a go-to action that can be executed in a PDF document.
This represents a thread action that can be executed in a PDF document.
This represents a JavaScript action.
This represents a launch action that can be executed in a PDF document.
This represents a named action in a PDF document.
This represents a remote go-to action that can be executed in a PDF document.
This represents a Sound action that can be executed in a PDF document
This represents a Submit-Form action that can be executed in a PDF document.
This represents a thread action that can be executed in a PDF document.
This represents a URI action that can be executed in a PDF document.
This represents a dictionary of actions that occur due to events.
A PDF annotation.
This class represents an annotation's dictionary of actions
that occur due to events.
This is the class that represents a file attachment.
This is the class that represents a line annotation.
This is the class that represents a link annotation.
This class represents the additional fields of a Markup type Annotation.
This is the class that represents a popup annotation.
This is the class that represents a rubber stamp annotation.
This is the class that represents a rectangular or eliptical annotation Introduced in PDF 1.3 specification .
This is the class that represents a text annotation.
This is the abstract class that represents a text markup annotation Introduced in PDF 1.3 specification, except
Squiggly lines in 1.4.
This is the class that represents an arbitrary Unknown Annotation type.
This is the class that represents a widget annotation.
This class represents an appearance characteristics dictionary.
Provides the ability to write to an appearance content stream.
An appearance dictionary specifying how the annotation shall be presented visually on the page.
An entry in an appearance dictionary.
An appearance stream is a form XObject, a self-contained content stream that shall be rendered inside the annotation
rectangle.
An artifact marked content.
An attribute object.
This class represents a PDF /BE entry the border effect dictionary.
This class represents a PDF /BS entry the border style dictionary.
The Box Style specifies visual characteristics for displaying box areas.
A button field represents an interactive control on the screen
that the user can manipulate with the mouse.
A CalGray colour space is a special case of a single-component CIE-based
colour space.
A CalRGB colour space is a CIE-based colour space with one transformation stage instead of two.
Handler to generate the caret annotations appearance.
A check box toggles between two states, on and off.
A choice field contains several text items, one or more of which shall be selected as the field
value.
A CIDFont.
Type 0 CIDFont (CFF).
Type 2 CIDFont (TrueType).
Represents a CIDSystemInfo.
CIE-based colour spaces specify colours in a way that is independent of the characteristics
of any particular output device.
CIE-based colour spaces that use a dictionary.
Handler to generate the circle annotations appearance.
A color value, consisting of one or more color components, or for pattern color spaces,
a name and optional color components.
A color space specifies how the colours of graphics objects will be painted on the page.
A combo box consisting of a drop-down list.
This represents a file specification.
A content stream.
This class is a specialized view of the crypt filter dictionary of a PDF document.
A default attribute object.
This represents a destination in a PDF document.
This class holds all of the name trees that are available at the document level.
This is an interface used for some elements such as the document
OpenAction that can be either a Destination or an Action.
Allows colors to be specified according to the subtractive CMYK (cyan, magenta, yellow, black)
model typical of printers and other paper-based output devices.
Device colour spaces directly specify colours or shades of gray produced by an output device.
A color space with black, white, and intermediate shades of gray.
DeviceN colour spaces may contain an arbitrary number of colour components.
Contains additional information about the components of colour space.
A DeviceN Process Dictionary
Colours in the DeviceRGB colour space are specified according to the additive
RGB (red-green-blue) colour model.
A wrapper for a COS dictionary.
This is the in-memory representation of the PDF document.
The Document Catalog of a PDF.
This class represents a document catalog's dictionary of actions
that occur due to events.
This is the document metadata.
This encapsulates the "dictionary of names and corresponding destinations" for the /Dests entry
in the document catalog.
This class holds all of the name trees that are available at the document level.
This represents an outline in a pdf document.
This represents an embedded file in a file specification.
This class holds all of the name trees that are available at the document level.
This class is a specialized view of the encryption dictionary of a PDF document.
Deprecated.
An Export Format attribute object.
An extended graphics state dictionary.
This class represents an external data dictionary.
Utility class used to clone PDF objects.
PDFStreamEngine subclass for advanced processing of graphics.
A field in an interactive form.
A PDField factory.
The field tree.
This represents a file specification.
This is an stream engine to extract the marked content of a pdf.
This class will take a list of pdf documents and merge them, saving the
result in a new document.
The mode to use when merging AcroForm between documents:
Although the API is finalized processing of different form field types is still in development. Currently only (nested) text fields do work with intermediate nodes being existent.
PDFMergerUtility.AcroFormMergeMode.JOIN_FORM_FIELDS_MODE fields with the same fully qualified name
will be merged into one with the widget annotations of the merged fields
becoming part of the same field.Although the API is finalized processing of different form field types is still in development. Currently only (nested) text fields do work with intermediate nodes being existent.
The mode to use when merging documents:
PDFMergerUtility.DocumentMergeMode.OPTIMIZE_RESOURCES_MODE Optimizes resource handling such as
closing documents early.This will parse a PDF 1.5 object stream and extract all of the objects from the stream.
This is the base class for all PDF fonts.
A font descriptor.
Creates the appropriate font subtype based on information in the dictionary.
A font-like object.
This class represents a font setting used for the graphics state.
This class represents a form field's dictionary of actions
that occur due to events.
A Form XObject.
An object for four colours.
Prints a PDF document using its original paper size.
Prints pages from a PDF document using any page size or scaling mode.
Renders a PDF document to an AWT BufferedImage.
Processes a PDF content stream and executes certain operations.
This will parse a PDF byte stream and extract operands and such.
That class builds visible signature template which will be added in our PDF document.
Class to build PDF template.
Structure of PDF document with visible signature.
This class will take a pdf document and strip out all of the text and ignore the formatting and such.
This will extract text from a specified region in the PDF.
This class represents a function in a PDF document.
This class represents a type 0 function in a PDF document.
This class represents a Type 2 (exponential interpolation) function in a PDF
document.
This class represents a Type 3 (stitching) function in a PDF document.
This class represents a Type 4 (PostScript calculator) function in a PDF document.
The identity function.
This will parse a PDF 1.5 (or better) Xref stream and
extract the xref information from the stream.
A gamma array, or collection of three floating point parameters used for color operations.
The current state of the graphics parameters when executing a content stream.
ICCBased color spaces are based on a cross-platform color profile as defined by the
International Color Consortium (ICC).
An image in a PDF document.
An Image XObject.
An Indexed colour space specifies that an area is to be painted using a colour table
of arbitrary colours from another color space.
Handler to generate the ink annotations appearance.
An inline image object which uses a special syntax to express the data for a
small image directly within the content stream.
This class holds all of the name trees that are available at the document level.
A color space embedded in a JPX file.
A Lab colour space is a CIE-based ABC colour space with two transformation stages.
A Layout attribute object.
A line dash pattern for stroking paths.
Handler to generate the link annotations appearance.
A List attribute object.
A scrollable list box.
A marked content.
A marked-content reference.
The MarkInfo provides additional information relevant to specialized
uses of structured documents.
This class represents a measure dictionary.
This class represents metadata for various objects in a PDF document.
Type 1 Multiple Master Font.
This represents a destination to a page by referencing it with a name.
This class represents a node in a name tree.
A non terminal field in an interactive form.
This class represents a number format dictionary.
This class represents a PDF Number tree.
An object reference.
A PDStream represents a stream in a PDF document.
An optional content group (OCG).
Enumeration for the renderState dictionary entry on the "Export", "View"
and "Print" dictionary.
An optional content membership dictionary (OCMD).
This class represents the optional content properties dictionary.
Enumeration for the BaseState dictionary entry on the "D" dictionary.
This represents an outline item in a pdf document.
Base class for a node in the outline of a PDF document.
An Output Intent describes the colour reproduction characteristics of a possible output
device or production condition.
A page in a PDF document.
This class represents a page object's dictionary of actions
that occur due to events.
Provides the ability to write to a page content stream.
This is to choose what to do with the stream: overwrite, append or prepend.
This represents a destination to a page, see subclasses for specific parameters.
This represents a destination to a page and the page contents will be magnified to just
fit on the screen.
This represents a destination to a page at a x location and the height is magnified
to just fit on the screen.
This represents a destination to a page at a y location and the width is magnified
to just fit on the screen.
This represents a destination to a page at a y location and the width is magnified
to just fit on the screen.
Contains information for a page label range.
Represents the page label dictionary of a document.
The page tree, which defines the ordering of pages in the document in an efficient manner.
This represents a destination to a page at an x,y coordinate with a zoom setting.
Represents the "Panose" entry of a FontDescriptor's Style dictionary.
Represents a 10-byte PANOSE classification.
Described in the PDF specification in the ParentTree segment of the table "Entries in the
structure tree root".
A Pattern color space is either a Tiling pattern or a Shading pattern.
Handler to generate the polygon annotations appearance.
Handler to generate the polyline annotations appearance.
A PostScript XObject.
A PrintField attribute object.
A signature build dictionary as specified in the PDF Signature Build Dictionary Specification.
The general property dictionaries from the build property dictionary.
A property list is a dictionary containing private information meaningful to the conforming
writer creating the marked content.
A pushbutton is a purely interactive control that responds immediately to user
input without retaining a permanent value.
Radio button fields contain a set of related buttons that can each be on or off.
This class will be used to signify a range.
A rectangle in a PDF document.
This class represents a rectlinear measure dictionary.
A set of resources available at the page/pages/stream level.
This represents a pdf signature seed value dictionary.
This class represents a certificate seed value dictionary that is in the seed value which puts
constraints on certificates when signing documents.
This MDP dictionary is a part of the seed value dictionary and define
if a author signature or a certification signature should be use.
If exist, it describe where the signature handler can request a RFC3161
timestamp and if it is a must have for the signature.
A Separation color space used to specify either additional colorants or for isolating the
control of individual colour components of a device colour space for a subtractive device.
A Shading Resource.
A shading pattern dictionary.
Resources for a function based shading.
Resources for an axial shading.
Resources for a radial shading.
Resources for a shading type 4 (Free-Form Gouraud-Shaded Triangle Mesh).
Resources for a shading type 5 (Lattice-Form Gouraud-Shade Triangle Mesh).
Resources for a shading type 6 (Coons Patch Mesh).
Resources for a shading type 7 (Tensor-Product Patch Mesh).
This represents a digital signature that can be attached to a document.
A signature field is a form field that contains a digital signature.
A file specification that is just a string.
A simple font.
Soft mask.
Special colour spaces add features or properties to an underlying colour space.
Handler to generate the square annotations appearance.
A standard attribute object.
A PDStream represents a stream in a PDF document.
A structure element.
todo: JavaDoc
A node in the structure tree.
A root of a structure tree.
A Table attribute object.
A target dictionary specifying path information to the target document.
A field in an interactive form.
A text field is a box or space for text fill-in data typically entered from a keyboard.
This class will hold the current state of the text parameters when executing a
content stream.
This a single thread in a PDF document.
This a single bead in a thread in a PDF document.
A tiling pattern dictionary.
Represents a page transition as defined in paragraph 12.4.4.1 of PDF 32000-1:2008
The dimension in which the specified transition effect shall occur.
The direction in which the specified transition effect shall moves, expressed in degrees counterclockwise starting
from a left-to-right direction.
The direction of motion for the specified transition effect.
The transition style that shall be used when moving to the page from another during a presentation.
A transparency group.
Transparency group attributes.
A tristimulus, or collection of three floating point parameters used for color operations.
TrueType font.
A Composite (Type 0) font.
Type 1-equivalent CFF font.
A PostScript Type 1 Font.
A Type 3 character procedure.
A PostScript Type 3 Font.
A wrapper for a COS dictionary including Type information.
This is the implementation of an URI dictionary.
A User attribute object.
A user property.
Base class for fields which use "Variable Text".
A vector outline font, e.g.
This is the document viewing preferences.
Enumeration containing all valid values for boundaries.
Enumeration containing all valid values for duplex.
Enumeration containing all valid values for NonFullScreenPageMode.
Enumeration containing all valid values for printscaling.
Enumeration containing all valid values for ReadingDirection.
This class represents a viewport dictionary.
Implementation of
PDFTemplateBuilder.Class for visible signature design properties.
This builder class is in order to create visible signature properties.
Launch parameters for the windows OS.
An XML Forms Architecture (XFA) resource.
An external object, or "XObject".
A block of text.
TextFormatter to handle plain text formatting for annotation rectangles.
Helper class to contain predictor decoding used by Flate and LZW filter.
This class represents the protection policy to apply to a document.
This class holds necessary information to decrypt a PDF document
protected by the public key security handler.
The protection policy to use to protect a document with the public key security handler.
Represents a recipient in the public key protection policy.
This class implements the public key security handler described in the PDF specification.
AWT PaintContext for radial shading.
AWT Paint for radial shading.
An interface to allow data to be stored completely in memory or
to use a scratch file on the disk.
An implementation of the RandomAccess interface to store data in memory.
Provides
InputStream access to portions of a file combined with
buffered reading of content.A RandomAccess implementation which allows data to be stored in a scratch file on the disk to
reduce memory consumption.
An InputStream which reads from a RandomAccessRead.
An OutputStream which writes to a RandomAccessWrite.
An interface allowing random access read operations.
An interface allowing random access write operations.
Optional content groups are visible depending on the render purpose.
Rendering intent.
Text Rendering Mode.
A document-wide cache for page resources.
Q: Restore the graphics state.
q: Save the graphics state.
Scale of the image on printed pages.
Implements a memory page handling mechanism as base for creating (multiple)
RandomAccess buffers each having its set of pages (implemented by
ScratchFileBuffer).A security handler as described in the PDF specifications.
Manages security handlers for the application.
Singleton which provides a security provider.
Separable blend mode (support blendChannel)
An interface allowing sequential read operations.
Tc: Set character spacing.
sc,scn,SC,SCN: Sets the color to use for stroking or non-stroking operations.
i: Set the flatness tolerance.
Tf: Set text font and size.
gs: Set parameters from graphics state parameter dictionary.
J: Set the line cap style.
d: Set the line dash pattern.
j: Set the line join style.
M: Set miter limit.
w: Set line width.
Tm: Set text matrix and text line matrix.
sc: Sets the colour to use for non-stroking operations.
scn: Sets the colour to use for non-stroking operations.
cs: Sets the non-stroking color space.
k: Set the non-stroking colour space to DeviceCMYK and set the colour to
use for non-stroking operations.
g: Set the non-stroking colour space to DeviceGray and set the gray
level to use for non-stroking operations.
rg: Set the non-stroking colour space to DeviceRGB and set the colour to
use for non-stroking operations.
ri: Set the rendering intent.
SC: Sets the colour to use for stroking stroking operations.
SCN: Sets the colour to use for stroking stroking operations.
CS: Set color space for stroking operations.
K: Set the stroking colour space to DeviceCMYK and set the colour to use for stroking operations.
G: Set the stroking colour space to DeviceGray and set the gray level to use for stroking
operations.
RG: Set the stroking colour space to DeviceRGB and set the colour to use for stroking operations.
Tz: Set horizontal text scaling.
TL: Set text leading.
Tr: Set text rendering mode.
Ts: Set text rise.
Tw: Set word spacing.
A base class to handle what is common to all shading types.
sh Fills the clipping area with the given shading pattern.
This is base class for all PDShading-Paints to allow other low level libraries access to the
shading source data.
Tj: Show text.
TJ: Show text, with position adjustments.
': Move to the next line and show text.
": Set word and character spacing, move to next line, and show text.
Providing an interface for accessing necessary functions for signing a PDF document.
This contains the visual signature as a COSDocument, its preferred size and the page.
Class to be used when creating PDF signatures externally.
Map implementation with a smallest possible memory usage.
Split a document into several other documents.
Represents the necessary information to decrypt a document protected by
the standard security handler (password protection).
This is an interface to a text encoder.
The protection policy to add to a document for password-based protection.
The standard security handler.
The standard structure types.
S Stroke the path.
This is an interface to a text encoder.
This represents a string and a position on the screen of those characters.
This class is a comparator for TextPosition operators.
An encoding for a Type 1 font.
A 2D vector.
Exposes PDFBox version.
This the win ansi encoding.
This class with handle some simple XML operations.
This class will collect all XRef/trailer objects and creates correct
xref/trailer information after all objects are read using startxref
and 'Prev' information (unused XRef/trailer objects are discarded).
The XRefType of a trailer.
This is an interface to a text encoder.
PDEncryptioninstead