org.pdfbox.pdmodel.interactive.documentnavigation.destination
Class PDNamedDestination

java.lang.Object
  extended by org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
      extended by org.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.

Version:
$Revision: 1.3 $
Author:
Ben Litchfield

Constructor Summary
PDNamedDestination()
          Default constructor.
PDNamedDestination(COSName dest)
          Constructor.
PDNamedDestination(COSString dest)
          Constructor.
PDNamedDestination(java.lang.String dest)
          Default constructor.
 
Method Summary
 COSBase getCOSObject()
          Convert this standard java object to a COS object.
 java.lang.String getNamedDestination()
          This will get the name of the destination.
 void setNamedDestination(java.lang.String dest)
          Set the named destination.
 
Methods inherited from class org.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
create, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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(java.lang.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 java.lang.String getNamedDestination()
This will get the name of the destination.

Returns:
The name of the destination.

setNamedDestination

public void setNamedDestination(java.lang.String dest)
                         throws java.io.IOException
Set the named destination.

Parameters:
dest - The new named destination.
Throws:
java.io.IOException - If there is an error setting the named destination.