# Package org.faceless.pdf2

Contains the classes used to create a PDF document

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  Cache | This 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.Entry | Represents a single entry in the Cache.
  EGIZSignatureHandler.Factory | An implementation of this Factory is required to create and control the EGIZSignatureHandler
  LoadState | An interface which can be used to query the progress of a load of a page in a Linearized PDF.
  OutputProfiler.ColorAction | An action that can be `set` on an OutputProfiler to replace Colors.
  OutputProfiler.FontAction | An action that can be `set` on an OutputProfiler to replace one font with another in the PDF.
  PropertyManager | This 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.
  SignatureHandlerFactory | This interface defines a factory for creating `SignatureHandler` objects.

- Class Summary
  Class | Description
  --- | ---
  AcrobatSignatureHandlerFactory | An implementation of `SignatureHandlerFactory` that returns handlers suitable for signing documents for use with Acrobat 6.0 or later.
  AnnotationFile | A subtype new `PDFAnnotation` that allows files to be attached to the PDF.
  AnnotationLink | A subtype new `PDFAnnotation` that performs the specified action when clicked.
  AnnotationMarkup | This class represents the type of `PDFAnnotation` created by the "Text Edit" option in Acrobat 6.
  AnnotationNote | This class represents the type of `PDFAnnotation` created by the "Note Tool" in Acrobat.
  AnnotationRichMedia | This class is a type of `PDFAnnotation` that acts as a container for interactive media such as Flash and (eventually) video.
  AnnotationShape | Creates an annotation based on the specified `Shape`.
  AnnotationSound | A subtype of `PDFAnnotation` that allows audio samples to be attached to the PDF.
  AnnotationStamp | A "Rubber-Stamp" annotation, which can also contain a longer message in an associated pop-up window.
  AnnotationText | This class represents the type of `PDFAnnotation` created by the "Text Markup" tool in Acrobat.
  BarCode | This class allows the creation of various bar code symbols.
  CMYKColorSpace | A subclass of `ColorSpace` representing the uncalibrated (device-dependent) CMYK color space available in PDF documents.
  DeviceNColorSpace | This class represents a "Device N" ColorSpace, which is a ColorSpace with N individual inks - the `SpotColorSpace` class is a special case of this class where there is only one ink.
  DiskCache | A general purpose `Cache` which optionally writes closed streams to files on disk.
  EGIZSignatureHandler | The EGIZSignatureHandler `SignatureHandler` provides the framework for signing documents according to the requirements set by http://www.egiz.gv.at/.
  EmbeddedFile | This class represents a file which may be embedded into a PDF document, either by using the `AnnotationFile` class or through the `PDF.getEmbeddedFiles()` map.
  EncryptionHandler | An EncryptionHandler is the abstract superclass of all algorithms that are used to encrypt a PDF document before saving.
  Event | Enumeration class for listing the various types of event that can occur while a PDF document is being loded in Acrobat.
  FDF | A class representing an `FDF` object.
  Form | The Form class represents the interactive Form that may be included as part of a PDF document.
  FormBarCode | A type of form element representing a BarCode.
  FormButton | A type of `FormElement` representing a "Push Button", of the kind used to trigger an action like submitting or resetting a form.
  FormCheckbox | A 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.
  FormChoice | A "ListBox" type of form element, where the user can select an entry off a list of several predefined options.
  FormElement | The `FormElement` class is the baseclass for all elements which may be added to a `Form`.
  FormRadioButton | A 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.
  FormSignature | This class represents a public key "Digital Signature" which can be used to sign a PDF document.
  FormText | A type of form element representing a Text Field.
  LabColorSpace | Represents the CIE 1976 (L*, a*, b*) or "CIELAB" device-independent ColorSpace.
  LayoutBox | A `LayoutBox` is a box for laying out text, which allows a great deal more control over positioning than the standard `drawText` method.
  OpenTypeFont | A subclass of `PDFFont` that represents an OpenType font.
  OutputProfile | An OutputProfile defines a variation on the PDF specification which a document must adhere to.
  OutputProfile.Feature | An `OutputProfile` is made up of `Features`, which may be required or denied.
  OutputProfile.FontInfo | Represents information about a font used in the document.
  OutputProfiler | An `OutputProfiler` is used to create an `OutputProfile` for a PDF or to attempt to apply a new OutputProfile, modifying the PDF in the process.
  OutputProfiler.AutoEmbeddingFontAction | The `AutoEmbeddingFontAction` class is an implementation of `OutputProfiler.FontAction` that will replace unembedded fonts with embedded ones via a "best fit" algorithm.
  OutputProfiler.ProcessColorAction | The `ProcessColorAction` class is an implementation of `OutputProfiler.ColorAction` which will convert any process colors into the specified ColorSpace.
  PageExtractor | This class enables the extraction of text and images from a `PDFPage`.
  PagePainter | The PagePainter class renders a page of a PDF to a `Graphics2D` object - typically to a bitmap image or a printer.
  PDF | A `PDF` describes a single document in Adobe's Portable Document Format.
  PDFAction | An action tells the PDF viewer how to navigate around the document.
  PDFAnnotation | A PDFAnnotation allows the user to interact with the generated PDF document, by adding / viewing rubber-stamps, popup notes hyperlinks and so on.
  PDFBookmark | This class describes the `Bookmark` or `Outline` part of a PDF document - the "Table of Contents" structure that allows easy navigation through the document.
  PDFCanvas | This class represents a the visible content of a page, annotation or similar.
  PDFFont | The PDFFont is the abstract superclass for all Fonts in a PDF document.
  PDFGlyphVector | A PDFGlyphVector is a sequence of glyphs in a particular font.
  PDFImage | The PDFImage class encapsulates a bitmap image, like a JPEG or PNG file, which can be inserted directly into the PDF document.
  PDFImageSet | The `PDFImageSet` class is a thin wrapper around a multi-page image format (currently only TIFF images).
  PDFPage | Represents a Page in a `PDF` document.
  PDFParser | The `PDFParser` class 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.
  PDFPattern | Create a new "pattern" fill to paint with.
  PDFReader | The `PDFReader` class adds the ability to load an existing PDF to the library.
  PDFSound | A PDFSound represents an audio sample in a PDF document.
  PDFStyle | A PDFStyle controls the colors, font and many other aspects of the actual display of elements on a PDF page.
  PKCS7SignatureHandler | This 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.
  PublicKeyEncryptionHandler | The PublicKeyEncryptionHandler can be used to encrypt and decrypt documents using public/private key Encryption, so documents can only be opened by certain individuals.
  Redactor | The Redactor can be used to redact (completely remove) text and images from a PDF.
  RemoteSignatureHandlerFactory | An implementation of `SignatureHandlerFactory` that returns a handler which allow the PKCS#7 signature for a PDF to be calculated on a remote machine.
  RemoteSigningServlet | This Servlet can be used in conjunction with the `RemoteSignatureHandlerFactory` to remotely calculate the signature for a PDF.
  ServletContextPropertyManager | Defines a `PropertyManager` which checks the `ServletContext.getInitParameter(java.lang.String)` method for properties.
  SignatureHandler | This 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.Placeholder | A Placeholder can be used to mark a point in the PDF which needs to be updated after the signature has been applied
  SpotColorSpace | A type of `ColorSpace` dealing with Separation ("Spot") Colors.
  StandardCJKFont | A 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.
  StandardEncryptionHandler | Represents the standard Acrobat encryption algorithm, both 40-bit and 128-bit variants.
  StandardFont | A concrete subclass of `PDFFont` representing the standard 14 fonts guaranteed to exist in all PDF readers.
  Type1Font | Create a new PostScript Type 1 font.
  WidgetAnnotation | The `WidgetAnnotation` class represents the type of annotation used to represent the visual contents of a `FormElement` on the page.

- Enum Summary
  Enum | Description
  --- | ---
  OutputProfiler.ImageType | ImageType constants are passed in to the `setMaxImageDPI` method
  OutputProfiler.RenderingIntent | RenderingIntent constants are passed in to the `OutputProfiler.ProcessColorAction.setRenderingIntent(org.faceless.pdf2.OutputProfiler.RenderingIntent)` method

- Exception Summary
  Exception | Description
  --- | ---
  LinearizedException | This exception is thrown when there is a problem completing the load of a Linearized PDF.
  PasswordException | A subclass of `IOException` that's thrown by the `PDFReader` class when loading a PDF

## Package org.faceless.pdf2 Description

Contains the classes used to create a PDF document

Copyright © 2001-2015 Big Faceless Organization