com.snowtide.pdf.annot

Class FileAttachmentAnnotation

java.lang.Object

com.snowtide.pdf.annot.FileAttachmentAnnotation

All Implemented Interfaces:

Annotation, DocumentLocation, Bounded

public class FileAttachmentAnnotation
extends java.lang.Object

An Annotation implementation that represents a PDF annotation of type FileAttachment. Attachment annotations contain a reference to a file, the contents of which are usually embedded within the PDF document.

Since:

v3.0.0

Version:

©2004-2014 Snowtide

Constructor Summary

Constructors

Constructor and Description
FileAttachmentAnnotation()

Method Summary

Modifier and Type	Method and Description
EmbeddedFile	getAttachment() Returns the EmbeddedFile associated with this annotation.
java.lang.String	getIconName() Returns the name of the icon that is associated with this file annotation; this is generally displayed in the PDF as the clickable target that will open the file attachment.
java.lang.String	getTitle() Returns the title associated with this file annotation.

Methods inherited from interface com.snowtide.pdf.annot.Annotation

getAppearance, getContents, getModificationDate, getName, getTypeCd

Methods inherited from interface com.snowtide.pdf.DocumentLocation

pageNumber

Methods inherited from interface com.snowtide.pdf.layout.Bounded

bounds

Constructor Detail

FileAttachmentAnnotation

public FileAttachmentAnnotation()

Method Detail

getIconName

public java.lang.String getIconName()

Returns the name of the icon that is associated with this file annotation; this is generally displayed in the PDF as the clickable target that will open the file attachment. Known "standard" icon names include:

 Graph
 Paperclip
 PushPin
 Tag
 

getTitle

public java.lang.String getTitle()

Returns the title associated with this file annotation.

getAttachment

public EmbeddedFile getAttachment()

Returns the EmbeddedFile associated with this annotation.