java.lang.Object
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference
All Implemented Interfaces:
COSObjectable

public class PDObjectReference extends Object implements COSObjectable
An object reference.

This is described as "Entries in an object reference dictionary" in the PDF specification.

  • Field Details

  • Constructor Details

    • PDObjectReference

      public PDObjectReference()
      Default Constructor.
    • PDObjectReference

      public PDObjectReference(COSDictionary theDictionary)
      Constructor for an existing object reference.
      Parameters:
      theDictionary - The existing dictionary.
  • Method Details

    • getCOSObject

      public COSDictionary getCOSObject()
      Returns the underlying dictionary.
      Specified by:
      getCOSObject in interface COSObjectable
      Returns:
      the dictionary
    • getReferencedObject

      public COSObjectable getReferencedObject()
      Gets a higher-level object for the referenced object. Currently this method may return a PDAnnotation, a PDXObject or null.
      Returns:
      a higher-level object for the referenced object
    • setReferencedObject

      public void setReferencedObject(PDAnnotation annotation)
      Sets the referenced annotation.
      Parameters:
      annotation - the referenced annotation
    • setReferencedObject

      public void setReferencedObject(PDXObject xobject)
      Sets the referenced XObject.
      Parameters:
      xobject - the referenced XObject