org.pdfbox.pdmodel.fdf

Class FDFNamedPageReference

Implemented Interfaces:
COSObjectable

public class FDFNamedPageReference
extends java.lang.Object
implements COSObjectable

This represents an FDF named page reference that is part of the FDF field.
Version:
$Revision: 1.3 $
Author:
Ben Litchfield

Constructor Summary

FDFNamedPageReference()
Default constructor.
FDFNamedPageReference(COSDictionary r)
Constructor.

Method Summary

COSDictionary
getCOSDictionary()
Convert this standard java object to a COS object.
COSBase
getCOSObject()
Convert this standard java object to a COS object.
PDFileSpecification
getFileSpecification()
This will get the file specification of this reference.
String
getName()
This will get the name of the referenced page.
void
setFileSpecification(PDFileSpecification fs)
This will set the file specification for this named page reference.
void
setName(String name)
This will set the name of the referenced page.

Constructor Details

FDFNamedPageReference

public FDFNamedPageReference()
Default constructor.

FDFNamedPageReference

public FDFNamedPageReference(COSDictionary r)
Constructor.
Parameters:
r - The FDF named page reference dictionary.

Method Details

getCOSDictionary

public COSDictionary getCOSDictionary()
Convert this standard java object to a COS object.
Returns:
The cos object that matches this Java object.

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.

getFileSpecification

public PDFileSpecification getFileSpecification()
            throws IOException
This will get the file specification of this reference. An optional parameter.
Returns:
The F entry for this dictionary.

getName

public String getName()
This will get the name of the referenced page. A required parameter.
Returns:
The name of the referenced page.

setFileSpecification

public void setFileSpecification(PDFileSpecification fs)
This will set the file specification for this named page reference.
Parameters:
fs - The file specification to set.

setName

public void setName(String name)
This will set the name of the referenced page.
Parameters:
name - The referenced page name.