org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure

Class PDObjectReference

java.lang.Object

org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference

All Implemented Interfaces:

COSObjectable

public class PDObjectReference
extends Object
implements COSObjectable

An object reference.

Version:

$Revision: $

Author:

Johannes Koch

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE TYPE of this object.

Constructor Summary

Constructors

Constructor and Description
PDObjectReference() Default Constructor.
PDObjectReference(COSDictionary theDictionary) Constructor for an existing object reference.

Method Summary

Methods

Modifier and Type	Method and Description
protected COSDictionary	getCOSDictionary() Returns the underlying dictionary.
COSBase	getCOSObject() Convert this standard java object to a COS object.
COSObjectable	getReferencedObject() Gets a higher-level object for the referenced object.
void	setReferencedObject(PDAnnotation annotation) Sets the referenced annotation.
void	setReferencedObject(PDXObject xobject) Sets the referenced XObject.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE

public static final String TYPE

TYPE of this object.

See Also:

Constant Field Values

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

getCOSDictionary

protected COSDictionary getCOSDictionary()

Returns the underlying dictionary.

Returns:

the dictionary

getCOSObject

public COSBase getCOSObject()

Convert this standard java object to a COS object.

Specified by:

getCOSObject in interface COSObjectable

Returns:

The cos object that matches this Java object.

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