PDAnnotationFileAttachment (PDFBox reactor 2.0.2 API)

java.lang.Object
- org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
- - org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
  - - org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment

All Implemented Interfaces:

COSObjectable
```
public class PDAnnotationFileAttachment
extends PDAnnotationMarkup
```
This is the class that represents a file attachement.

Author:

Ben Litchfield

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ATTACHMENT_NAME_GRAPH` See get/setAttachmentName.
`static String`	`ATTACHMENT_NAME_PAPERCLIP` See get/setAttachmentName.
`static String`	`ATTACHMENT_NAME_PUSH_PIN` See get/setAttachmentName.
`static String`	`ATTACHMENT_NAME_TAG` See get/setAttachmentName.
`static String`	`SUB_TYPE` The type of annotation.

Fields inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
RT_GROUP, RT_REPLY, SUB_TYPE_CARET, SUB_TYPE_FREETEXT, SUB_TYPE_INK, SUB_TYPE_POLYGON, SUB_TYPE_POLYLINE, SUB_TYPE_SOUND

Constructor Summary

Constructors
Constructor and Description
`PDAnnotationFileAttachment()` Constructor.
`PDAnnotationFileAttachment(COSDictionary field)` Creates a Link annotation from a COSDictionary, expected to be a correct object definition.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getAttachmentName()` This is the name used to draw the type of attachment.
`PDFileSpecification`	`getFile()` Return the attached file.
`void`	`setAttachementName(String name)` Set the name used to draw the attachement icon.
`void`	`setFile(PDFileSpecification file)` Set the attached file.

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
getBorderStyle, getConstantOpacity, getCreationDate, getExternalData, getInReplyTo, getIntent, getPopup, getReplyType, getRichContents, getSubject, getTitlePopup, setBorderStyle, setConstantOpacity, setCreationDate, setExternalData, setInReplyTo, setIntent, setPopup, setReplyType, setRichContents, setSubject, setTitlePopup

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
createAnnotation, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceState, getBorder, getColor, getColor, getContents, getCOSObject, getModifiedDate, getNormalAppearanceStream, getPage, getRectangle, getStructParent, getSubtype, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceState, setBorder, setColor, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPage, setPrinted, setReadOnly, setRectangle, setStructParent, setToggleNoView

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ATTACHMENT_NAME_PUSH_PIN
```
public static final String ATTACHMENT_NAME_PUSH_PIN
```
    See get/setAttachmentName.
    
    See Also:
    Constant Field Values
  - ATTACHMENT_NAME_GRAPH
```
public static final String ATTACHMENT_NAME_GRAPH
```
    See get/setAttachmentName.
    
    See Also:
    Constant Field Values
  - ATTACHMENT_NAME_PAPERCLIP
```
public static final String ATTACHMENT_NAME_PAPERCLIP
```
    See get/setAttachmentName.
    
    See Also:
    Constant Field Values
  - ATTACHMENT_NAME_TAG
```
public static final String ATTACHMENT_NAME_TAG
```
    See get/setAttachmentName.
    
    See Also:
    Constant Field Values
  - SUB_TYPE
```
public static final String SUB_TYPE
```
    The type of annotation.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - 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 objet to represent as a field.
- Method Detail
  - 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
```
public void setAttachementName(String name)
```
    Set the name used to draw the attachement icon. See the ATTACHMENT_NAME_XXX constants.
    
    Parameters:
    name - The name of the visual icon to draw.

Class PDAnnotationFileAttachment

Field Summary

Fields inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup

Constructor Summary

Method Summary

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup

Methods inherited from class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation

Methods inherited from class java.lang.Object

Field Detail

ATTACHMENT_NAME_PUSH_PIN

ATTACHMENT_NAME_GRAPH

ATTACHMENT_NAME_PAPERCLIP

ATTACHMENT_NAME_TAG

SUB_TYPE

Constructor Detail

PDAnnotationFileAttachment

PDAnnotationFileAttachment

Method Detail

getFile

setFile

getAttachmentName

setAttachementName