Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination

public Class PDNamedDestination

extends PDDestination
Class Inheritance
Imports
java.io.IOException, org.apache.pdfbox.cos.COSBase, .COSName, .COSString
This represents a destination to a page by referencing it with a name.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
private COSBase
namedDestination

Constructor Summary

AccessConstructor and Description
public
PDNamedDestination(COSString
The named destination.
dest)

Constructor.

public
PDNamedDestination(COSName
The named destination.
dest)

Constructor.

public
PDNamedDestination()

Default constructor.

public
PDNamedDestination(String
The named destination.
dest)

Default constructor.

Method Summary

Modifier and TypeMethod and Description
public COSBase

Returns:

The cos object that matches this Java object.
getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

public String

Returns:

The name of the destination.
getNamedDestination()

This will get the name of the destination.

public void
setNamedDestination(String
The new named destination.
dest)

Set the named destination.

Inherited from org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination:
create

Field Detail

namedDestinationback to summary
private COSBase namedDestination

Constructor Detail

PDNamedDestinationback to summary
public PDNamedDestination(COSString dest)

Constructor.

Parameters
dest:COSString

The named destination.

PDNamedDestinationback to summary
public PDNamedDestination(COSName dest)

Constructor.

Parameters
dest:COSName

The named destination.

PDNamedDestinationback to summary
public PDNamedDestination()

Default constructor.

PDNamedDestinationback to summary
public PDNamedDestination(String dest)

Default constructor.

Parameters
dest:String

The named destination.

Method Detail

getCOSObjectback to summary
public COSBase getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSBase

The cos object that matches this Java object.

Annotations
@Override
getNamedDestinationback to summary
public String getNamedDestination()

This will get the name of the destination.

Returns:String

The name of the destination.

setNamedDestinationback to summary
public void setNamedDestination(String dest) throws IOException

Set the named destination.

Parameters
dest:String

The new named destination.

Exceptions
IOException:
If there is an error setting the named destination.