PDObjectReference (Apache PDFBox 2.0.1 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference

All Implemented Interfaces:

COSObjectable
```
public class PDObjectReference
extends Object
implements COSObjectable
```
An object reference.

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
`COSDictionary`	`getCOSObject()` Returns the underlying dictionary.
`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
  - 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

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2002–2016 The Apache Software Foundation. All rights reserved.