org.apache.pdfbox.pdmodel.interactive.annotation
public class: PDAnnotationFileAttachment [javadoc |
source]
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
This is the class that represents a file attachement.
- author:
- href="mailto:ben@benlitchfield.com">Ben Litchfield
- version:
$ - Revision: 1.2 $
| Field Summary |
|---|
| public static final String | ATTACHMENT_NAME_PUSH_PIN | See get/setAttachmentName. |
| public static final String | ATTACHMENT_NAME_GRAPH | See get/setAttachmentName. |
| public static final String | ATTACHMENT_NAME_PAPERCLIP | See get/setAttachmentName. |
| public static final String | ATTACHMENT_NAME_TAG | See get/setAttachmentName. |
| public static final String | SUB_TYPE | The type of annotation. |
| Methods from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup: |
|---|
|
getConstantOpacity, getCreationDate, getExternalData, getInReplyTo, getIntent, getPopup, getReplyType, getRichContents, getSubject, getTitlePopup, setConstantOpacity, setCreationDate, setExternalData, setInReplyTo, setIntent, setPopup, setReplyType, setRichContents, setSubject, setTitlePopup |
| Methods from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation: |
|---|
|
createAnnotation, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceStream, getCOSObject, getColour, getContents, getDictionary, getModifiedDate, getPage, getRectangle, getSubtype, isHidden, isInvisible, isLocked, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceStream, setColour, setContents, setHidden, setInvisible, setLocked, setModifiedDate, setNoRotate, setNoView, setNoZoom, setPrinted, setReadOnly, setRectangle, setToggleNoView |
| Methods from java.lang.Object: |
|---|
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment Detail: |
|---|
 public String getAttachmentName() {
return getDictionary().getNameAsString( "Name", ATTACHMENT_NAME_PUSH_PIN );
}
This is the name used to draw the type of attachment.
See the ATTACHMENT_NAME_XXX constants. |
public PDFileSpecification getFile() throws IOException {
return PDFileSpecification.createFS( getDictionary().getDictionaryObject( "FS" ) );
} Return the attached file. |
public void setAttachementName(String name) {
getDictionary().setName( "Name", name );
} Set the name used to draw the attachement icon.
See the ATTACHMENT_NAME_XXX constants. |
public void setFile(PDFileSpecification file) {
getDictionary().setItem( "FS", file );
} |