Package org.apache.pdfbox.pdmodel.fdf
Class FDFNamedPageReference
java.lang.Object
org.apache.pdfbox.pdmodel.fdf.FDFNamedPageReference
- All Implemented Interfaces:
COSObjectable
This represents an FDF named page reference that is part of the FDF field.
- Author:
- Ben Litchfield
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.Constructor. -
Method Summary
Modifier and TypeMethodDescriptionConvert this standard java object to a COS object.This will get the file specification of this reference.getName()
This will get the name of the referenced page.void
This will set the file specification for this named page reference.void
This will set the name of the referenced page.
-
Constructor Details
-
FDFNamedPageReference
public FDFNamedPageReference()Default constructor. -
FDFNamedPageReference
Constructor.- Parameters:
r
- The FDF named page reference dictionary.
-
-
Method Details
-
getCOSObject
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
getName
This will get the name of the referenced page. A required parameter.- Returns:
- The name of the referenced page.
-
setName
This will set the name of the referenced page.- Parameters:
name
- The referenced page name.
-
getFileSpecification
This will get the file specification of this reference. An optional parameter.- Returns:
- The F entry for this dictionary.
- Throws:
IOException
- If there is an error creating the file spec.
-
setFileSpecification
This will set the file specification for this named page reference.- Parameters:
fs
- The file specification to set.
-