Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.fdf

public Class FDFNamedPageReference

extends Object
implements COSObjectable
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.COSObjectable
Imports
java.io.IOException, org.apache.pdfbox.cos.COSDictionary, .COSName, org.apache.pdfbox.pdmodel.common.COSObjectable, org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification
This represents an FDF named page reference that is part of the FDF field.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
private final COSDictionary
ref

Constructor Summary

AccessConstructor and Description
public
FDFNamedPageReference()

Default constructor.

public
FDFNamedPageReference(COSDictionary
The FDF named page reference dictionary.
r)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public COSDictionary

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 PDFileSpecification

Returns:

The F entry for this dictionary.
getFileSpecification()

This will get the file specification of this reference.

public String

Returns:

The name of the referenced page.
getName()

This will get the name of the referenced page.

public void
setFileSpecification(PDFileSpecification
The file specification to set.
fs)

This will set the file specification for this named page reference.

public void
setName(String
The referenced page name.
name)

This will set the name of the referenced page.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

refback to summary
private final COSDictionary ref

Constructor Detail

FDFNamedPageReferenceback to summary
public FDFNamedPageReference()

Default constructor.

FDFNamedPageReferenceback to summary
public FDFNamedPageReference(COSDictionary r)

Constructor.

Parameters
r:COSDictionary

The FDF named page reference dictionary.

Method Detail

getCOSObjectback to summary
public COSDictionary getCOSObject()

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

Convert this standard java object to a COS object.

Returns:COSDictionary

The cos object that matches this Java object.

Annotations
@Override
getFileSpecificationback to summary
public PDFileSpecification getFileSpecification() throws IOException

This will get the file specification of this reference. An optional parameter.

Returns:PDFileSpecification

The F entry for this dictionary.

Exceptions
IOException:
If there is an error creating the file spec.
getNameback to summary
public String getName()

This will get the name of the referenced page. A required parameter.

Returns:String

The name of the referenced page.

setFileSpecificationback to summary
public void setFileSpecification(PDFileSpecification fs)

This will set the file specification for this named page reference.

Parameters
fs:PDFileSpecification

The file specification to set.

setNameback to summary
public void setName(String name)

This will set the name of the referenced page.

Parameters
name:String

The referenced page name.