Uses of Class org.apache.fop.pdf.PDFObject (Apache FOP Core 2.11 API)
Date: 2025-04-24

## Uses of Class
org.apache.fop.pdf.PDFObject

- Packages that use PDFObject
  Package | Description
  --- | ---
  org.apache.fop.pdf | Classes for handling the low-level creation of PDF documents.
  org.apache.fop.render.pdf | PDF Renderer

- - ### Uses of PDFObject in org.apache.fop.pdf

    Subclasses of PDFObject in org.apache.fop.pdf
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractPDFFontStream` Base class for PDF font streams.
    `class` | `AbstractPDFStream` This is an abstract base class for PDF streams.
    `class` | `ObjectStream` An object stream, as described in section 3.4.6 of the PDF 1.5 Reference.
    `class` | `PDFAction` class representing an action object.
    `class` | `PDFAnnotList` class representing an object which is a list of annotations.
    `class` | `PDFArray` Class representing an array object.
    `class` | `PDFCFFStream` Special PDFStream for embeddable CFF fonts.
    `class` | `PDFCFFStreamType0C` PDFStream for embeddable OpenType CFF fonts.
    `class` | `PDFCharProcs` class representing a /CharProcs dictionary for Type3 fonts.
    `class` | `PDFCIDFont` Class representing a "character identifier" font (p 210 and onwards).
    `class` | `PDFCIDFontDescriptor` Class representing a font descriptor for CID fonts.
    `class` | `PDFCIDSystemInfo` class representing system information for "character identifier" fonts.
    `class` | `PDFCIELabColorSpace` This class represents a "CIE L*a*b*" color space.
    `class` | `PDFCMap` Class representing the CMap encodings.
    `class` | `PDFColor` PDF Color object.
    `class` | `PDFDestination` class representing a named destination
    `class` | `PDFDests` class representing an /Dests dictionary object
    `class` | `PDFDictionary` Class representing a PDF dictionary object
    `class` | `PDFDPart`
    `class` | `PDFDPartRoot`
    `class` | `PDFEmbeddedFile` This class represents an embedded file stream.
    `class` | `PDFEmbeddedFiles` Class representing an /EmbeddedFiles dictionary object (name tree).
    `class` | `PDFEncoding` Class representing an /Encoding object.
    `class` | `PDFEncryptionJCE` An implementation of the Standard Security Handler.
    `class` | `PDFFileSpec` Class representing a /FileSpec object.
    `class` | `PDFFont` Class representing a /Font object.
    `class` | `PDFFontDescriptor` Class representing a font descriptor (/FontDescriptor object).
    `class` | `PDFFontNonBase14` A common ancestor for Type1, TrueType, MMType1 and Type3 fonts (all except base 14 fonts).
    `class` | `PDFFontTrueType` Class representing a TrueType font.
    `class` | `PDFFontType0` Class representing a Type0 font.
    `class` | `PDFFontType1` Class representing a Type1 or MMType1 font (not necessary for the base 14).
    `class` | `PDFFontType3` Class representing a Type3 font.
    `class` | `PDFFormXObject` PDF Form XObject A derivative of the PDFXObject, is a PDF Stream that has not only a dictionary but a stream of image data.
    `class` | `PDFFunction` class representing a PDF Function.
    `class` | `PDFGoTo` class representing a /GoTo object.
    `class` | `PDFGoToRemote` Class representing a /GoToR object.
    `class` | `PDFGState` Class representing a /ExtGState object.
    `class` | `PDFICCBasedColorSpace` Represents an ICCBased color space in PDF.
    `class` | `PDFICCStream` Special PDFStream for ICC profiles (color profiles).
    `class` | `PDFIdentifiedDictionary` Identified Dictionary.
    `class` | `PDFImageXObject` PDF XObject A derivative of the PDF Object, is a PDF Stream that has not only a dictionary but a stream of image data.
    `class` | `PDFInfo` class representing an /Info object
    `class` | `PDFInternalLink` class used to create a PDF internal link
    `class` | `PDFJavaScriptLaunchAction` PDF Action which executes some JavaScript code.
    `class` | `PDFLaunch` This class represents the /Launch action.
    `class` | `PDFLayer` Optional Content Group Dictionary, which we will call a 'layer'.
    `class` | `PDFLink` class representing an /Annot object of /Subtype /Link
    `class` | `PDFMetadata` Special PDFStream for Metadata.
    `class` | `PDFName` Class representing a PDF name object.
    `class` | `PDFNames` Class representing a PDF Names object
    `class` | `PDFNameTreeNode` Class representing a PDF name tree node.
    `class` | `PDFNavigator` Navigation Node Dictionary, which we call a 'navigator'.
    `class` | `PDFNavigatorAction`
    `class` | `PDFNumber` This class represents a simple number object.
    `class` | `PDFNumberTreeNode` Class representing a PDF number tree node.
    `class` | `PDFNumsArray` Class representing an "Nums" array object (for Number Trees).
    `class` | `PDFOutline` This represents a single Outline object in a PDF, including the root Outlines object.
    `class` | `PDFOutputIntent` Represents the OutputIntent dictionary.
    `class` | `PDFPage` Class representing a /Page object.
    `class` | `PDFPageLabels` Class representing a PDF /PageLabels dictionary.
    `class` | `PDFPages` class representing a /Pages object.
    `class` | `PDFParentTree` Class representing a PDF /ParentTree.
    `class` | `PDFPathPaint` Base class for PDF painting operations.
    `class` | `PDFPattern` class representing a PDF Function.
    `class` | `PDFResourceContext` The PDF resource context.
    `class` | `PDFResources` Class representing a /Resources object.
    `class` | `PDFRoot` Class representing a Root (/Catalog) object.
    `class` | `PDFSeparationColorSpace` This class represents a "Separation" color space.
    `class` | `PDFSetOCGStateAction`
    `class` | `PDFShading` class representing a PDF Smooth Shading object.
    `class` | `PDFStream` Class representing a PDF stream.
    `class` | `PDFStructElem` Class representing a PDF Structure Element.
    `static class` | `PDFStructElem.Placeholder` Class representing a placeholder for a PDF Structure Element.
    `class` | `PDFStructTreeRoot` Class representing a PDF /StructTreeRoot dictionary.
    `class` | `PDFT1Stream` Special PDFStream for embedding Type 1 fonts.
    `class` | `PDFText` This class represents a simple number object.
    `class` | `PDFToUnicodeCMap` Class representing ToUnicode CMaps.
    `class` | `PDFTransitionAction`
    `class` | `PDFTTFStream` Special PDFStream for embeddable TrueType fonts.
    `class` | `PDFUri` class used to create a PDF Uri link
    `class` | `PDFXObject` Abstract base class of PDF XObjects.
    `class` | `StructureHierarchyMember` An element in the document's structure tree.
    `class` | `TransitionDictionary` Transition Dictionary This class is used to build a transition dictionary to specify the transition between pages.

    Fields in org.apache.fop.pdf with type parameters of type PDFObject
    Modifier and Type | Field and Description
    --- | ---
    `protected List<PDFObject>` | PDFStructElem.`kids` Elements to be added to the kids array.
    `protected List<PDFObject>` | PDFDocument.`objects` the objects themselves
    `protected List<PDFObject>` | PDFDocument.`trailerObjects` List of objects to write in the trailer

    Methods in org.apache.fop.pdf with type parameters of type PDFObject
    Modifier and Type | Method and Description
    --- | ---
    `<T extends PDFObject> T` | PDFDocument.`registerTrailerObject(T obj)` Registers a `PDFObject` in this PDF document at end.

    Methods in org.apache.fop.pdf that return PDFObject
    Modifier and Type | Method and Description
    --- | ---
    `PDFObject` | ASCIIHexFilter.`getDecodeParms()` Get the decode params.
    `abstract PDFObject` | PDFFilter.`getDecodeParms()` return a parameter dictionary for this filter, or null
    `PDFObject` | FlateFilter.`getDecodeParms()` Get the decode params for this filter.
    `PDFObject` | ASCII85Filter.`getDecodeParms()` Get the decode parameters.
    `PDFObject` | DCTFilter.`getDecodeParms()` Get the decode params for this filter.
    `PDFObject` | CCFFilter.`getDecodeParms()` return a parameter dictionary for this filter, or null
    `PDFObject` | NullFilter.`getDecodeParms()` return a parameter dictionary for this filter, or null
    `PDFObject` | PDFReference.`getObject()` Returns the PDF object
    `PDFObject` | PDFObject.`getParent()` Returns this objects's parent.
    `PDFObject` | PDFDocument.`registerObject(PDFObject obj)` Registers a `PDFObject` in this PDF document.

    Methods in org.apache.fop.pdf that return types with arguments of type PDFObject
    Modifier and Type | Method and Description
    --- | ---
    `List<PDFObject>` | PDFStructElem.`getKids()`

    Methods in org.apache.fop.pdf with parameters of type PDFObject
    Modifier and Type | Method and Description
    --- | ---
    `void` | PDFAnnotList.`addAnnot(PDFObject link)` add an /Annot object of /Subtype /Link.
    `void` | PDFResourceContext.`addAnnotation(PDFObject annot)` set this page's annotation list
    `void` | PDFStructTreeRoot.`addKid(PDFObject kid)` Adds the given object to the array of kids.
    `abstract void` | StructureHierarchyMember.`addKid(PDFObject kid)` Adds the given object to the array of kids.
    `void` | PDFStructElem.`addKid(PDFObject kid)` Adds a kid to this structure element.
    `void` | PDFDocument.`addObject(PDFObject obj)` Adds a `PDFObject` to this document.
    `void` | PDFDocument.`addTrailerObject(PDFObject obj)` Add trailer object.
    `void` | PDFDocument.`assignObjectNumber(PDFObject obj)` Assigns the `PDFObject` an object number, and sets the parent of the `PDFObject` to this document.
    `protected boolean` | PDFGState.`contentEquals(PDFObject obj)` Check if the other PDFObject has the same content as the current object.
    `protected boolean` | PDFObject.`contentEquals(PDFObject o)` Check if the other PDFObject has the same content as the current object.
    `protected boolean` | PDFFunction.`contentEquals(PDFObject obj)` Check if the other PDFObject has the same content as the current object.
    `protected boolean` | PDFGoToRemote.`contentEquals(PDFObject obj)` Check if the other PDFObject has the same content as the current object.
    `protected boolean` | PDFShading.`contentEquals(PDFObject obj)` Check if the other PDFObject has the same content as the current object.
    `protected boolean` | PDFGoTo.`contentEquals(PDFObject obj)` Check if the other PDFObject has the same content as the current object.
    `protected boolean` | PDFLink.`contentEquals(PDFObject obj)` Check if the other PDFObject has the same content as the current object.
    `protected boolean` | PDFFileSpec.`contentEquals(PDFObject obj)` Check if the other PDFObject has the same content as the current object.
    `protected boolean` | PDFPattern.`contentEquals(PDFObject obj)` Check if the other PDFObject has the same content as the current object.
    `protected boolean` | PDFColor.`contentEquals(PDFObject obj)` Check if the other PDFObject has the same content as the current object.
    `protected boolean` | PDFJavaScriptLaunchAction.`contentEquals(PDFObject obj)` Check if the other PDFObject has the same content as the current object.
    `protected boolean` | PDFLaunch.`contentEquals(PDFObject obj)` Check if the other PDFObject has the same content as the current object.
    `byte[]` | PDFEncryption.`encrypt(byte[] data, PDFObject refObj)` Encrypt an array of bytes using a reference PDFObject for calculating the encryption key.
    `byte[]` | PDFEncryptionJCE.`encrypt(byte[] data, PDFObject refObj)` Encrypt an array of bytes using a reference PDFObject for calculating the encryption key.
    `static int` | PDFDocument.`outputIndirectObject(PDFObject object, OutputStream stream)` Outputs the given object, wrapped by obj/endobj, to the given stream.
    `PDFObject` | PDFDocument.`registerObject(PDFObject obj)` Registers a `PDFObject` in this PDF document.
    `void` | CCFFilter.`setDecodeParms(PDFObject decodeParms)` Sets the CCF decoding parameters
    `void` | PDFObject.`setParent(PDFObject parent)` Sets the direct parent object.
    `void` | PDFStructElem.`setParent(PDFObject parent)` Sets the direct parent object.
    `protected int` | PDFDocument.`streamIndirectObject(PDFObject o, OutputStream stream)`

    Method parameters in org.apache.fop.pdf with type arguments of type PDFObject
    Modifier and Type | Method and Description
    --- | ---
    `static void` | PDFDictionary.`getChildren(Collection<Object> values, Set<PDFObject> children)`
    `void` | PDFObject.`getChildren(Set<PDFObject> children)`
    `void` | PDFResources.`getChildren(Set<PDFObject> children)`
    `void` | PDFImageXObject.`getChildren(Set<PDFObject> children)`
    `void` | PDFLink.`getChildren(Set<PDFObject> children)`
    `void` | PDFAnnotList.`getChildren(Set<PDFObject> children)`
    `void` | PDFCIDFont.`getChildren(Set<PDFObject> children)`
    `void` | PDFICCBasedColorSpace.`getChildren(Set<PDFObject> children)`
    `void` | PDFArray.`getChildren(Set<PDFObject> children)`
    `void` | PDFOutline.`getChildren(Set<PDFObject> children)`
    `void` | PDFDictionary.`getChildren(Set<PDFObject> children)`
    `void` | AbstractPDFStream.`getChildren(Set<PDFObject> children)`

    Constructors in org.apache.fop.pdf with parameters of type PDFObject
    Constructor and Description
    `PDFArray(PDFObject parent)` Create a new, empty array object
    `PDFArray(PDFObject parent, double[] values)` Create an array object.
    `PDFArray(PDFObject parent, int[] values)` Create an array object.
    `PDFArray(PDFObject parent, List<?> values)` Create an array object.
    `PDFArray(PDFObject parent, Object[] values)` Create the array object
    `PDFDictionary(PDFObject parent)` Create a new dictionary object.
    `PDFNumsArray(PDFObject parent)` Create a new, empty array object.
    `PDFObject(PDFObject parent)` Constructor for direct objects.
    `PDFReference(PDFObject obj)` Creates a new PDF reference.
    `PDFStructElem(PDFObject parent, StructureType structureType)` Creates a new structure element.
    `Placeholder(PDFObject parent)`

  - ### Uses of PDFObject in org.apache.fop.render.pdf

    Subclasses of PDFObject in org.apache.fop.render.pdf
    Modifier and Type | Class and Description
    --- | ---
    `class` | `PageSequenceStructElem`

Copyright © 2025 Apache Software Foundation. All rights reserved.