Class PDObjectReference
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference
-
- All Implemented Interfaces:
COSObjectable
public class PDObjectReference extends java.lang.Object implements COSObjectable
An object reference.This is described as "Entries in an object reference dictionary" in the PDF specification.
-
-
Field Summary
Fields Modifier and Type Field Description private COSDictionary
dictionary
static java.lang.String
TYPE
TYPE of this object.
-
Constructor Summary
Constructors Constructor Description PDObjectReference()
Default Constructor.PDObjectReference(COSDictionary theDictionary)
Constructor for an existing object reference.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description COSDictionary
getCOSObject()
Returns the underlying dictionary.COSObjectable
getReferencedObject()
Gets a higher-level object for the referenced object.void
setReferencedObject(PDXObject xobject)
Sets the referenced XObject.void
setReferencedObject(PDAnnotation annotation)
Sets the referenced annotation.
-
-
-
Field Detail
-
TYPE
public static final java.lang.String TYPE
TYPE of this object.- See Also:
- Constant Field Values
-
dictionary
private final COSDictionary dictionary
-
-
Constructor Detail
-
PDObjectReference
public PDObjectReference()
Default Constructor.
-
PDObjectReference
public PDObjectReference(COSDictionary theDictionary)
Constructor for an existing object reference.- Parameters:
theDictionary
- The existing dictionary.
-
-
Method Detail
-
getCOSObject
public COSDictionary getCOSObject()
Returns the underlying dictionary.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- the dictionary
-
getReferencedObject
public COSObjectable getReferencedObject()
Gets a higher-level object for the referenced object. Currently this method may return aPDAnnotation
, aPDXObject
ornull
.- 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
-
-