Package de.intarsys.pdf.pd

The higher level building blocks of a PDF document.

See: Description

Interface Summary

Interface	Description
IAdditionalActionSupport	A PD object that supports additional actions.
IResourcesProvider	An interface for all owner of PDResources.

Class Summary

Class	Description
AbstractBitFlags	AbstractBitFlags provides access to an integer containing bit wise flags.
AcroFormFieldFlags	The flags of a field in an acrobat form.
AcroFormSigFlags	The flags of a signature field.
AnnotationFlags	The flags of an annotation.
DefaultAppearance	A internal representation of the parsed CSContent for the default appearance content stream fragment in a PDAcroFormField.
OutlineItemFlags	The flags of an outline item.
PDAcroForm	The logical AcroForm hosted in a PDF document.
PDAcroForm.MetaClass	The meta class implementation
PDAcroFormField	Abstract superclass for the different field types in an AcroForm.
PDAcroFormField.MetaClass	The meta class implementation
PDAcroFormNode	Abstract superclass to factor out commons between PDAcroForm and PDAcroFormField.
PDAcroFormNode.MetaClass	The meta class implementation
PDAcroFormTools	PDAcroForm related tool methods.
PDAction	A PDF document can be interative by defining actions for different events.
PDAction.MetaClass	The meta class implementation
PDActionAny	A generic action implementation to be used when no specific implementation needed or around.
PDActionAny.MetaClass	The meta class implementation
PDActionGoTo	The GoTo action.
PDActionGoTo.MetaClass	The meta class implementation
PDActionGoToR	The GoToR action.
PDActionGoToR.MetaClass	The meta class implementation
PDActionJavaScript	The JavaScript action.
PDActionJavaScript.MetaClass	The meta class implementation
PDActionLaunch	The Launch action.
PDActionLaunch.MetaClass	The meta class implementation
PDActionNamed	A named action.
PDActionNamed.MetaClass	The meta class implementation
PDActionRendition	The GoTo action.
PDActionRendition.MetaClass	The meta class implementation
PDActionResetForm	The ResetForm action.
PDActionResetForm.MetaClass	The meta class implementation
PDActionSubmitForm	The SubmitForm action.
PDActionSubmitForm.MetaClass	The meta class implementation
PDActionURI	The URI action.
PDActionURI.MetaClass	The meta class implementation
PDAdditionalActions	An object defining the association of an event to an action for a PDF document object, for example a PDPage.
PDAdditionalActions.MetaClass	The meta class implementation
PDAFButtonField	A logical button within an AcroForm.
PDAFButtonField.MetaClass
PDAFChoiceField	A logical choice field within an AcroForm.
PDAFChoiceField.MetaClass
PDAFIntermediateNode	Just an intermediate, structural node in the acro form hierarchy.
PDAFIntermediateNode.MetaClass
PDAFSignatureField	A logical signature field within an AcroForm.
PDAFSignatureField.MetaClass
PDAFTextField	A logical text field within an AcroForm.
PDAFTextField.MetaClass	The meta class implementation
PDAnnotation	An Annotation is an abstract object that allows a PDF document to be changed and extended in a variety of ways.
PDAnnotation.MetaClass	The meta class implementation
PDAnnotationTools	Tool class for common tasks with PDAnnotation objects.
PDAnyAnnotation	A generic annotation implementation.
PDAnyAnnotation.MetaClass	The meta class implementation
PDAppearance	The PDAppearance describes the visual content of a PDAnnotation.
PDAppearance.MetaClass	The meta class implementation
PDAppearanceCharacteristics	More details on the appearance of an annotation.
PDAppearanceCharacteristics.MetaClass	The meta class implementation
PDAppearanceTools	A tool class for common tasks with PDAppearance instances.
PDApplicationData	Application specific transparently handled data objects.
PDApplicationData.MetaClass	The meta class implementation
PDAxialShading	Use axial shading for filling the shape.
PDAxialShading.MetaClass	The meta class implementation
PDBorderStyle	The definition of a border style for an annotation.
PDBorderStyle.MetaClass	The meta class implementation
PDBuildData
PDBuildData.MetaClass	The meta class implementation
PDBuildProperties
PDBuildProperties.MetaClass	The meta class implementation
PDCircleAnnotation
PDCircleAnnotation.MetaClass	The meta class implementation
PDCollection
PDCollection.MetaClass	The meta class implementation
PDColorSpace	An abstract superclass for all color spaces.
PDColorSpace.MetaClass	The meta class implementation
PDCoonsShading	Use coons shading for filling the shape.
PDCoonsShading.MetaClass	The meta class implementation
PDCSCalGray	Calibrated gray color space.
PDCSCalGray.MetaClass	The meta class implementation
PDCSCalRGB	Calibrated RGB color space.
PDCSCalRGB.MetaClass	The meta class implementation
PDCSCIEBased	Abstract superclass for all CIE based color spaces
PDCSCIEBased.MetaClass	The meta class implementation
PDCSDevice	Abstract superclass for all device color spaces.
PDCSDevice.MetaClass	The meta class implementation
PDCSDeviceCMYK	Device color space CMYK support.
PDCSDeviceCMYK.MetaClass	The meta class implementation
PDCSDeviceGray	Device color space gray support.
PDCSDeviceGray.MetaClass	The meta class implementation
PDCSDeviceN	Special color space.
PDCSDeviceN.MetaClass	The meta class implementation
PDCSDeviceRGB	Device color space RGB support.
PDCSDeviceRGB.MetaClass	The meta class implementation
PDCSICCBased	ICC standards based color space definition.
PDCSICCBased.MetaClass	The meta class implementation
PDCSIndexed	Support for indexed color spaces.
PDCSIndexed.MetaClass	The meta class implementation
PDCSLab	Support for lab color space.
PDCSLab.MetaClass	The meta class implementation
PDCSPattern	Support for pattern based color spaces.
PDCSPattern.MetaClass	The meta class implementation
PDCSSeparation	Separation color spaces.
PDCSSeparation.MetaClass	The meta class implementation
PDCSSpecial	Abstract superclass for special color spaces.
PDCSSpecial.MetaClass	The meta class implementation
PDDestination	Abstract superclass for objects defining a destination in a PDF document.
PDDestination.MetaClass	The meta class implementation
PDDocument	The PD Level representation of a PDF Document.
PDDocumentTimeStamp
PDDocumentTimeStamp.MetaClass	The meta class implementation
PDEmbeddedFile	An embedding of another file (and optional content) within the PDF.
PDEmbeddedFile.MetaClass	The meta class implementation
PDEmbeddedFileParams
PDEmbeddedFileParams.MetaClass	The meta class implementation
PDExplicitDestination	The explicit reference to a destination in a PDF document, consisting of a page and a definition of the rectangle to be displayed.
PDExplicitDestination.MetaClass	The meta class implementation
PDExtGState	The extended graphic state object.
PDExtGState.MetaClass	The meta class implementation
PDFileAttachmentAnnotation	The file attachment annotation
PDFileAttachmentAnnotation.MetaClass	The meta class implementation
PDFileSpecification	Repesents the PDF's FileSpecification-type
PDFileSpecification.MetaClass	The meta class implementation
PDFileSpecificationURL
PDFileSpecificationURL.MetaClass	The meta class implementation
PDForm	A form object.
PDForm.MetaClass	The meta class implementation
PDFormTools	PDForm related tool methods.
PDFreeFormShading	Use a free form shading when filling the shape.
PDFreeFormShading.MetaClass	The meta class implementation
PDFunction	Abstract superclass for PDF function objects.
PDFunction.MetaClass	The meta class implementation
PDFunctionBasedShading	Evaluate a function when filling the shape.
PDFunctionBasedShading.MetaClass	The meta class implementation
PDHighlightAnnotation
PDHighlightAnnotation.MetaClass	The meta class implementation
PDIconFit	An object describing the appearance of an icon within a button.
PDIconFit.MetaClass	The meta class implementation
PDImage	The representation of an image.
PDImage.MetaClass	The meta class implementation
PDInkAnnotation
PDInkAnnotation.MetaClass	The meta class implementation
PDInterpolationFunction	Function implementation supporting interpolation.
PDInterpolationFunction.MetaClass	The meta class implementation
PDLatticeFormShading	Use the lattice shading when filling the shape.
PDLatticeFormShading.MetaClass	The meta class implementation
PDLineAnnotation
PDLineAnnotation.MetaClass	The meta class implementation
PDLinkAnnotation	An annotation implementing a hyperlink behavior within a document.
PDLinkAnnotation.MetaClass	The meta class implementation
PDMarkupAnnotation	A generic markup annotation implementation.
PDMarkupAnnotation.MetaClass	The meta class implementation
PDNamedDestination	A destination within a document defined using a named destination.
PDNamedDestination.MetaClass	The meta class implementation
PDObject	This is the abstract superclass for all complex PD level objects.
PDObject.MetaClass	The meta class implementation
PDOutline	The root of the document outline tree ("bookmarks").
PDOutline.MetaClass	The meta class implementation
PDOutlineItem	A document outline item.
PDOutlineItem.MetaClass	The meta class implementation
PDOutlineNode	Factoring out the commonalities between the PDOutline and PDOutlineItem.
PDOutlineNode.MetaClass	The meta class implementation
PDOutputIntent	The output intent for the associated object.
PDOutputIntent.MetaClass	The meta class implementation
PDPage	A single concrete page in a PDF document.
PDPage.MetaClass	The meta class implementation
PDPageNode	An abstract superclass for pages and page tree nodes
PDPageNode.MetaClass	The meta class implementation
PDPageTree	A page tree node is a container for pages (and other page tree nodes) within a PFD document.
PDPageTree.MetaClass	The meta class implementation
PDPattern	A pattern to be used when filling a shape.
PDPattern.MetaClass	The meta class implementation
PDPolygonAnnotation
PDPolygonAnnotation.MetaClass	The meta class implementation
PDPolylineAnnotation
PDPolylineAnnotation.MetaClass	The meta class implementation
PDPopupAnnotation	The implementation of a popup window definition within the document.
PDPopupAnnotation.MetaClass	The meta class implementation
PDPostScript	The representation of embedded postscript programs
PDPostScript.MetaClass	The meta class implementation
PDPostScriptFunction	A function implementation based on a "mini" postscript interpreter.
PDPostScriptFunction.MetaClass	The meta class implementation
PDRadialShading	Use radial shading for filling the shape.
PDRadialShading.MetaClass	The meta class implementation
PDResources	The implementation of a resource dictionary.
PDResources.MetaClass	The meta class implementation
PDSampledFunction	Function implementation based on samples.
PDSampledFunction.MetaClass	The meta class implementation
PDShading	An object defining the shading to be used when filling a shape.
PDShading.MetaClass	The meta class implementation
PDShadingPattern	A shading fill pattern.
PDShadingPattern.MetaClass	The meta class implementation
PDSignature	This class represents the signature object referenced for example in an AcroForm signature field.
PDSignature.MetaClass	The meta class implementation
PDSignatureLock
PDSignatureLock.MetaClass
PDSignatureReference	This object specifies details on the signature.
PDSignatureReference.MetaClass	The meta class implementation
PDSignatureSeedValue
PDSignatureSeedValue.MetaClass
PDSquareAnnotation
PDSquareAnnotation.MetaClass	The meta class implementation
PDSquigglyAnnotation
PDSquigglyAnnotation.MetaClass	The meta class implementation
PDStampAnnotation	A stamp annotation.
PDStampAnnotation.MetaClass	The meta class implementation
PDStitchingFunction	Function implementation for stitching functions.
PDStitchingFunction.MetaClass	The meta class implementation
PDStrikeOutAnnotation
PDStrikeOutAnnotation.MetaClass	The meta class implementation
PDTensorProductShading	Use tensor product shading when filling the shape.
PDTensorProductShading.MetaClass	The meta class implementation
PDTextAnnotation	The /Text annotation.
PDTextAnnotation.MetaClass	The meta class implementation
PDTextMarkupAnnotation	An abstract text markup (highlight, underline, squiggly, strikeout) annotation.
PDTextMarkupAnnotation.MetaClass	The meta class implementation
PDTilingPattern	A tile used to fill the shape.
PDTilingPattern.MetaClass	The meta class implementation
PDTransformMethod	An abstract implementation of the strategy for computing a signature.
PDTransformMethod.MetaClass	The meta class implementation
PDTransformMethodDocMDP	The implementation of the DocMDP algorithm.
PDTransformMethodDocMDP.MetaClass	The meta class implementation
PDTransformMethodFieldMDP	The implementation of the FieldMDP algorithm.
PDTransformMethodFieldMDP.MetaClass	The meta class implementation
PDTransformMethodIdentity	The implementation of the Identity algorithm.
PDTransformMethodIdentity.MetaClass	The meta class implementation
PDTransformMethodUR	The implementation of the UR algorithm.
PDTransformMethodUR.MetaClass	The meta class implementation
PDTransformParams	The parameters for the PDTransformMethod algorithms.
PDTransformParams.MetaClass	The meta class implementation
PDUnderlineAnnotation
PDUnderlineAnnotation.MetaClass	The meta class implementation
PDWidgetAnnotation	The annotation representing a field in an AcroForm.
PDWidgetAnnotation.MetaClass	The meta class implementation
PDXObject	The representation of a XObject.
PDXObject.MetaClass	The meta class implementation
SubmitFormFlags	The flags for subimtting a form The flags are bits of an integer.

Package de.intarsys.pdf.pd Description

The higher level building blocks of a PDF document. The PD level objects carry the PDF document semantics like "this is a page" and "this is a image". The PD objects itself are built upon COS objects, sometimes primitives like COSString or COSName, but most often COSDictionary and COSStream.

This implementation is guided by the following rules:

• META class structure:
  Every PD class is accompanied with a META class defining META information and acting as a factory.
• Factory creation:
  The PD level object is created or looked up using the factory methods provided by its META class.
• Identity:
  A PD object is always 1:1 associated with a COSObject.
• COSObject and Java return types:
  The return types of the PDObject level methods are as follows: All "cos" prefixed methods reference back to the COS level and return COSObjects. All other methods return (or act upon) either higher level data structures like CDS or PD itself or plain Java objects.
• COSObject, COSNull and plain null:
  All methods with a COSObject in return signature will never return plain Java null, but COSNull. Methods that are already narrowed to a specific subtype, like COSName, will return either an instance of that type or Java null.