Class PDNamedDestination
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
-
- org.apache.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.
-
-
Field Summary
Fields Modifier and Type Field Description private COSBase
namedDestination
-
Constructor Summary
Constructors Constructor Description PDNamedDestination()
Default constructor.PDNamedDestination(java.lang.String dest)
Default constructor.PDNamedDestination(COSName dest)
Constructor.PDNamedDestination(COSString dest)
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.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.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
create
-
-
-
-
Field Detail
-
namedDestination
private COSBase namedDestination
-
-
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.
-
-