org.pdfbox.pdmodel.interactive.documentnavigation.destination

Class PDNamedDestination

Implemented Interfaces:
COSObjectable, PDDestinationOrAction

public class PDNamedDestination
extends PDDestination

This represents a destination to a page by referencing it with a name.
Version:
$Revision: 1.3 $
Author:
Ben Litchfield

Constructor Summary

PDNamedDestination()
Default constructor.
PDNamedDestination(String dest)
Default constructor.
PDNamedDestination(COSName dest)
Constructor.
PDNamedDestination(COSString dest)
Constructor.

Method Summary

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 org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination

create, toString

Constructor Details

PDNamedDestination

public PDNamedDestination()
Default constructor.

PDNamedDestination

public PDNamedDestination(String dest)
Default constructor.
Parameters:
dest - The named destination.

PDNamedDestination

public PDNamedDestination(COSName dest)
Constructor.
Parameters:
dest - The named destination.

PDNamedDestination

public PDNamedDestination(COSString dest)
Constructor.
Parameters:
dest - The named destination.

Method Details

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.

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.