Class FDFNamedPageReference

java.lang.Object
org.apache.pdfbox.pdmodel.fdf.FDFNamedPageReference
All Implemented Interfaces:
COSObjectable

public class FDFNamedPageReference extends Object implements COSObjectable
This represents an FDF named page reference that is part of the FDF field.
  • Field Details

  • Constructor Details

    • FDFNamedPageReference

      public FDFNamedPageReference()
      Default constructor.
    • FDFNamedPageReference

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

    • getCOSObject

      public COSDictionary 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.
    • getName

      public 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(String name)
      This will set the name of the referenced page.
      Parameters:
      name - The referenced page name.
    • 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.
      Throws:
      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.