Contains the classes used to create a PDF document
Interface Summary Interface Description ArlingtonModelIssueThis interface represents an "issue" reported by comparing a PDF against the Arlington Model, a formal description of the PDF file format described at https://github.com/pdf-association/arlington-pdf-model. CacheThis interface represents a structure which can be used to store parts of a PDF to disk, a database or some other secondary storage, to reduce the amount of memory required to generate a PDF. Cache.EntryRepresents a single entry in the Cache. EGIZSignatureHandler.FactoryAn implementation of this Factory is required to create and control the EGIZSignatureHandler LoadStateAn interface which can be used to query the progress of a load of a page in a Linearized PDF. OpenTypeFont.PaletteA Palette defines the color palette used for Color OpenType fonts with the SVG or COLR tables (although only COLR is currently supported). OpenTypeFont.SVGA system interface to provide an SVG parser for SVG-format fonts. OutputProfiler.ColorActionAn action that can be
seton an OutputProfiler to replace Colors.
OutputProfiler.FontActionAn action that can be
seton an OutputProfiler to replace one font with another in the PDF.
OutputProfiler.ImageActionAn action that can be used to resample or recompress bitmap images. PDFDrawableThis interface is implemented by PDFPage and PDFDrawable, and covers all of the operations common to both used to place content (graphics, images and text) onto the output. PKCS7SignatureHandler.SigningEngineThis interface defines the engine used to actually sign a PDF. PropertyManagerThis interface defines an object which can be used to set values to be used to control the PDF library - turning on or off debug flags, controlling the location of additional software and so on. SignatureHandlerFactoryThis interface defines a factory for creating
Class Summary Class Description AcrobatSignatureHandlerFactoryAn implementation of
SignatureHandlerFactorythat returns handlers suitable for signing documents for use with Acrobat 6.0 or later.
AnnotationFileA subtype new
PDFAnnotationthat allows files to be attached to the PDF.
AnnotationLinkA subtype new
PDFAnnotationthat performs the specified action when clicked.
AnnotationMarkupThis class represents the type of
PDFAnnotationcreated by the "Text Edit" option in Acrobat 6.
AnnotationNoteThis class represents the type of
PDFAnnotationcreated by the "Note Tool" in Acrobat.
AnnotationRichMediaThis class is a type of
PDFAnnotationthat acts as a container for interactive media such as video.
AnnotationShapeCreates an annotation based on the specified
AnnotationSoundA subtype of
PDFAnnotationthat allows audio samples to be attached to the PDF.
AnnotationStampA "Rubber-Stamp" annotation, which can also contain a longer message in an associated pop-up window. AnnotationTextThis class represents the type of
PDFAnnotationcreated by the "Text Markup" tool in Acrobat.
BarCodeThis class allows the creation of various bar code symbols. CMYKColorSpaceA subclass of
ColorSpacerepresenting the uncalibrated (device-dependent) CMYK color space available in PDF documents.
DeviceNColorSpaceThis class represents a "Device N" ColorSpace, which is a ColorSpace with N individual inks - the
SpotColorSpaceclass is a special case of this class where there is only one ink.
DeviceNColorSpace.BuilderThe Builder subclass allows the creation of a custom DeviceN ColorSpace, by specifying first the fallback ColorSpace, then the individual inks. DiskCacheA general purpose
Cachewhich optionally writes closed streams to files on disk.
SignatureHandlerprovides the framework for signing documents according to the requirements set by http://www.egiz.gv.at/.
EmbeddedFileThis class represents a file which may be embedded into a PDF document, either by using the
PDFAnnotation, by adding to the
StructureTree, or (most typically) through the
EncryptionHandlerAn EncryptionHandler is the abstract superclass of all algorithms that are used to encrypt a PDF document before saving. EventEnumeration class for listing the various types of event that can occur while a PDF document is being loded in Acrobat. FDFA class representing an
FormThe Form class represents the interactive Form that may be included as part of a PDF document. FormBarCodeA type of form element representing a BarCode. FormButtonA type of
FormElementrepresenting a "Push Button", of the kind used to trigger an action like submitting or resetting a form.
FormCheckboxA type of form element representing a Check Box, which can be either "checked" or "cleared" (on or off), in the same way as the HTML "checkbox" input type. FormChoiceA "ListBox" type of form element, where the user can select an entry off a list of several predefined options. FormElementThe
FormElementclass is the baseclass for all elements which may be added to a
FormRadioButtonA type of form element representing a Radio Button, which can be either "checked" or "cleared" (on or off), in the same way as the HTML "radiobutton" input type. FormSignatureThis class represents a public key "Digital Signature" which can be used to sign a PDF document. FormTextA type of form element representing a Text Field. GlobalSignDSSManagerThis class creates a
SignatureHandlerFactorythat makes use of GlobalSign's Digital Signing Service to sign documents remotely.
ICCColorSpaceA pure Java version of
ICC_Profile, this class avoids the many issues with the use of those classes in a multi-threaded environment.
LabColorSpaceRepresents the CIE 1976 (L*, a*, b*) or "CIELAB" device-independent ColorSpace. LayoutBoxA
LayoutBoxis a box for laying out text, which allows a great deal more control over positioning than the standard
MeshGradientA MeshGradient is a "Coons Patch Array" based shading pattern, which can be used to give photorealistic shading to a fill. MeshGradient.BuilderA Builder used for creating a
OpenTypeFontA subclass of
PDFFontthat represents an OpenType font.
OptionalContentDescriptorAn OptionalContentDescriptor is either an
OptionalContentLayeror a logical expression containing one or two OptionalContentDescriptors.
OptionalContentLayerThis class represents an optional content layer in the PDF. OutputIntentThe OutputIntent class represents an intended output device for PDF. OutputProfileAn OutputProfile defines a variation on the PDF specification which a document must adhere to. OutputProfile.ExtensionDescribes an extension to the PDF specification, as recorded in the "Extensions" item of the PDF catalog. OutputProfile.FeatureAn
OutputProfileis made up of
Features, which may be required or denied.
OutputProfile.SeparationRepresents an individual "ink" used in the PDF. OutputProfilerAn
OutputProfileris used to create an
OutputProfilefor a PDF or to attempt to apply a new OutputProfile, modifying the PDF in the process.
AutoEmbeddingFontActionclass is an implementation of
OutputProfiler.FontActionthat will replace unembedded fonts with embedded ones via a "best fit" algorithm.
ProcessColorActionclass is an implementation of
OutputProfiler.ColorActionwhich will convert any process colors (i.e.
OutputProfiler.RasterizingActionAn action that will rasterize a page to a bitmap if required. OutputProfiler.SimpleImageActionAn implementation of
OutputProfiler.ImageActionthat implements the functionality that was available via the
OutputProfiler.setMaxImageDPI(org.faceless.pdf2.OutputProfiler.ImageType, float, float)method.
PageExtractorThis class enables the extraction of text and images from a
PagePainterThe PagePainter class renders a page of a PDF to a
Graphics2Dobject - typically to a bitmap image or a printer.A
PDFActionAn action tells the PDF viewer how to navigate around the document. PDFAnnotationA PDFAnnotation allows the user to interact with the generated PDF document, by adding / viewing rubber-stamps, popup notes hyperlinks and so on. PDFBookmarkThis class describes the
Outlinepart of a PDF document - the "Table of Contents" structure that allows easy navigation through the document.
PDFCanvasThis class represents a the visible content of a page, annotation or similar. PDFFontThe PDFFont is the abstract superclass for all Fonts in a PDF document. PDFGlyphVectorA PDFGlyphVector is a sequence of glyphs in a particular font. PDFImageThe PDFImage class encapsulates a bitmap image, like a JPEG or PNG file, which can be inserted directly into the PDF document. PDFImageSetThe
PDFImageSetclass is a thin wrapper around a multi-page image format (currently only TIFF images).
PDFPageRepresents a Page in a PDFParserThe
PDFParserclass can be used to parse the contents of a PDF document, for example converting it to an Image, writing to TIFF, printing it and so on.
PDFPatternCreate a new "pattern" fill to paint with. PDFReaderThe
PDFReaderclass adds the ability to load an existing PDF to the library.
PDFSoundA PDFSound represents an audio sample in a PDF document. PDFStyleA PDFStyle controls the colors, font and many other aspects of the actual display of elements on a PDF page. PKCS7SignatureHandlerThis class represents the subclass of digital signatures that rely on Public/Private key pairs and that meet the requirements laid down in the document "PDF Public-Key Digital Signature and Encryption Specification", published by Adobe. PKCS7SignatureHandler.OCSPResponseAn OCSP response relating to the validity of a digital signature. PKCS7SignatureHandler.OCSPResponse.SingleResponseRepresents a SingleResponse item from the OCSP response PortfolioA "Portfolio PDF" is a PDF that primarily exists as a container for other documents, which are included as
EmbeddedFileobjects in the
Portfolio.FieldTypeThe FieldType class determines which properties of an EmbeddedFile are presented in the user-interface. PublicKeyEncryptionHandlerThe PublicKeyEncryptionHandler can be used to encrypt and decrypt documents using public/private key Encryption, so documents can only be opened by certain individuals. RedactorThe Redactor can be used to redact (completely remove) text and images from a PDF. ServletContextPropertyManagerDefines a
PropertyManagerwhich checks the
ServletContext.getInitParameter(java.lang.String)method for properties.
SignatureHandlerThis class is the baseline handler for all digital signatures - it could theoretically be used for any type of signature, using biometrics, public/private key and so on. SignatureHandler.PlaceholderA Placeholder can be used to mark a point in the PDF which needs to be updated after the signature has been applied SignaturePolicyA SignaturePolicy represents a policy against which digital signatures are verified. SpotColorSpaceA type of ColorSpace dealing with Separation ("Spot") Colors. StandardCJKFontA subclass of PDFFont representing the "standard" Chinese, Japanese and Korean fonts which are supplied by default with Acrobat 5.0 or later, or with a supplementary "language pack" for earlier releases. StandardEncryptionHandlerRepresents the standard Acrobat encryption algorithm, both 40-bit and 128-bit variants. StandardFontA concrete subclass of
PDFFontrepresenting the standard 14 fonts guaranteed to exist in all PDF readers.
TimeStampHandlerFactoryAn implementation of
SignatureHandlerFactorythat returns a
SignatureHandlersuitable for adding a "Document Level Timestamp" to the PDF.
Type1FontCreate a new PostScript Type 1 font. Type3FontA Type3 font is an artificial font made up of shapes drawn directly to the PDF, rather than stored in a font file embedded in the PDF. WidgetAnnotationThe
WidgetAnnotationclass represents the type of annotation used to represent the visual contents of a
FormElementon the page.
XMPThe XMP class encapsulates the "Extensible Metadata Platform" format metadata which underpins all PDF metadata since PDF 1.4. XMP.PropertyA Property is a "key" for any values set on the XMP. XMP.SchemaA Schema is a collection of properties and types, grouped together under a single XML namespace. XMP.TypeA Type determines the underlying Type of a Property. XMP.ValueA Value is a typed-value which is stored in the XMP against a
Enum Summary Enum Description OptionalContentLayer.WhenThe "When" enum can be used to set under what conditions a layer is printed/exported. OutputProfiler.ImageTypeImageType constants are passed in to the
OutputProfiler.RenderingIntentRenderingIntent constants are passed in to the
OutputProfiler.StrategyThe Strategy enum determines how a PDF is repaired when an OutputProfile is applied to it - for example, are invalid fields in the metadata deleted? PKCS7SignatureHandler.SigningEngine.Type
Exception Summary Exception Description LinearizedExceptionThis exception is thrown when there is a problem completing the load of a Linearized PDF. PasswordExceptionA subclass of
IOExceptionthat's thrown by the
PDFReaderclass when loading a PDF
ProfileComplianceExceptionThis exception is thrown when an action is not allowed based on the OutputProfile that is applied to the PDF - for example, if the PDF only allows CMYK colors and an attempt is made to add RGB to the page.