Package org.apache.pdfbox.pdmodel.fdf
Class FDFNamedPageReference
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.fdf.FDFNamedPageReference
-
- All 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.
-
-
Field Summary
Fields Modifier and Type Field Description private COSDictionary
ref
-
Constructor Summary
Constructors Constructor Description FDFNamedPageReference()
Default constructor.FDFNamedPageReference(COSDictionary r)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description COSDictionary
getCOSObject()
Convert this standard java object to a COS object.PDFileSpecification
getFileSpecification()
This will get the file specification of this reference.java.lang.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(java.lang.String name)
This will set the name of the referenced page.
-
-
-
Field Detail
-
ref
private final COSDictionary ref
-
-
Constructor Detail
-
FDFNamedPageReference
public FDFNamedPageReference()
Default constructor.
-
FDFNamedPageReference
public FDFNamedPageReference(COSDictionary r)
Constructor.- Parameters:
r
- The FDF named page reference dictionary.
-
-
Method Detail
-
getCOSObject
public COSDictionary 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
public java.lang.String getName()
This will get the name of the referenced page. A required parameter.- Returns:
- The name of the referenced page.
-
setName
public void setName(java.lang.String name)
This will set the name of the referenced page.- Parameters:
name
- The referenced page name.
-
getFileSpecification
public PDFileSpecification getFileSpecification() throws java.io.IOException
This will get the file specification of this reference. An optional parameter.- Returns:
- The F entry for this dictionary.
- Throws:
java.io.IOException
- If there is an error creating the file spec.
-
setFileSpecification
public void setFileSpecification(PDFileSpecification fs)
This will set the file specification for this named page reference.- Parameters:
fs
- The file specification to set.
-
-