PDNamedDestination (library 2.0.27.0 API)

java.lang.Object
- com.tom_roush.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
- - com.tom_roush.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination

All Implemented Interfaces:

COSObjectable, PDDestinationOrAction
```
public class PDNamedDestination
extends PDDestination
```
This represents a destination to a page by referencing it with a name.

Constructor Summary

Constructors
Constructor	Description
`PDNamedDestination()`	Default constructor.
`PDNamedDestination(COSName dest)`	Constructor.
`PDNamedDestination(COSString dest)`	Constructor.
`PDNamedDestination(String dest)`	Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`COSBase`	`getCOSObject()`	Convert this standard java object to a COS object.
`String`	`getNamedDestination()`	This will get the name of the destination.
`void`	`setNamedDestination(String dest)`	Set the named destination.

Methods inherited from class com.tom_roush.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
create

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PDNamedDestination
```
public PDNamedDestination(COSString dest)
```
    Constructor.
    
    Parameters:
    
    dest - The named destination.
  - PDNamedDestination
```
public PDNamedDestination(COSName dest)
```
    Constructor.
    
    Parameters:
    
    dest - The named destination.
  - PDNamedDestination
```
public PDNamedDestination()
```
    Default constructor.
  - PDNamedDestination
```
public PDNamedDestination(String dest)
```
    Default constructor.
    
    Parameters:
    
    dest - The named destination.
- Method Detail
  - getCOSObject
```
public COSBase getCOSObject()
```
    Convert this standard java object to a COS object.
    
    Returns:
    
    The cos object that matches this Java object.
  - getNamedDestination
```
public String getNamedDestination()
```
    This will get the name of the destination.
    
    Returns:
    
    The name of the destination.
  - setNamedDestination
```
public void setNamedDestination(String dest)
                         throws IOException
```
    Set the named destination.
    
    Parameters:
    
    dest - The new named destination.
    
    Throws:
    
    IOException - If there is an error setting the named destination.