Class PDObjectReference
java.lang.Object
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference
- All Implemented Interfaces:
COSObjectable
An object reference.
This is described as "Entries in an object reference dictionary" in the PDF specification.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final COSDictionary
static final String
TYPE of this object. -
Constructor Summary
ConstructorsConstructorDescriptionDefault Constructor.PDObjectReference
(COSDictionary theDictionary) Constructor for an existing object reference. -
Method Summary
Modifier and TypeMethodDescriptionReturns the underlying dictionary.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 Details
-
TYPE
TYPE of this object.- See Also:
-
dictionary
-
-
Constructor Details
-
PDObjectReference
public PDObjectReference()Default Constructor. -
PDObjectReference
Constructor for an existing object reference.- Parameters:
theDictionary
- The existing dictionary.
-
-
Method Details
-
getCOSObject
Returns the underlying dictionary.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- the dictionary
-
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
Sets the referenced annotation.- Parameters:
annotation
- the referenced annotation
-
setReferencedObject
Sets the referenced XObject.- Parameters:
xobject
- the referenced XObject
-