Class PDAnnotationFileAttachment

All Implemented Interfaces:
COSObjectable

public class PDAnnotationFileAttachment extends PDAnnotationMarkup
This is the class that represents a file attachment.
Author:
Ben Litchfield
  • Field Details

  • Constructor Details

    • PDAnnotationFileAttachment

      public PDAnnotationFileAttachment()
      Constructor.
    • PDAnnotationFileAttachment

      public PDAnnotationFileAttachment(COSDictionary field)
      Creates a Link annotation from a COSDictionary, expected to be a correct object definition.
      Parameters:
      field - the PDF object to represent as a field.
  • Method Details

    • getFile

      public PDFileSpecification getFile() throws IOException
      Return the attached file.
      Returns:
      The attached file.
      Throws:
      IOException - If there is an error creating the file spec.
    • setFile

      public void setFile(PDFileSpecification file)
      Set the attached file.
      Parameters:
      file - The file that is attached.
    • getAttachmentName

      public String getAttachmentName()
      This is the name used to draw the type of attachment. See the ATTACHMENT_NAME_XXX constants.
      Returns:
      The name that describes the visual cue for the attachment.
    • setAttachementName

      @Deprecated public void setAttachementName(String name)
      Set the name used to draw the attachment icon. See the ATTACHMENT_NAME_XXX constants.
      Parameters:
      name - The name of the visual icon to draw.
    • setAttachmentName

      public void setAttachmentName(String name)
      Set the name used to draw the attachment icon. See the ATTACHMENT_NAME_XXX constants.
      Parameters:
      name - The name of the visual icon to draw.