Package com.itextpdf.kernel.pdf.annot

Class PdfFileAttachmentAnnotation

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>

com.itextpdf.kernel.pdf.annot.PdfAnnotation

com.itextpdf.kernel.pdf.annot.PdfMarkupAnnotation

com.itextpdf.kernel.pdf.annot.PdfFileAttachmentAnnotation

public class PdfFileAttachmentAnnotation
extends PdfMarkupAnnotation

Nested Class Summary

Nested classes/interfaces inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation

PdfAnnotation.PdfUnknownAnnotation

Field Summary

Fields inherited from class com.itextpdf.kernel.pdf.annot.PdfMarkupAnnotation

inReplyTo, popup

Fields inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation

Accepted, Canceled, Completed, HIDDEN, HIGHLIGHT_INVERT, HIGHLIGHT_NONE, HIGHLIGHT_OUTLINE, HIGHLIGHT_PUSH, HIGHLIGHT_TOGGLE, INVISIBLE, LOCKED, LOCKED_CONTENTS, Marked, MarkedModel, NO_ROTATE, NO_VIEW, NO_ZOOM, None, page, PRINT, READ_ONLY, Rejected, ReviewModel, STYLE_BEVELED, STYLE_DASHED, STYLE_INSET, STYLE_SOLID, STYLE_UNDERLINE, TOGGLE_NO_VIEW, Unmarked

Constructor Summary

Constructors

Modifier	Constructor	Description
	PdfFileAttachmentAnnotation(Rectangle rect)
	PdfFileAttachmentAnnotation(Rectangle rect, PdfFileSpec file)
protected	PdfFileAttachmentAnnotation(PdfDictionary pdfObject)	Instantiates a new PdfFileAttachmentAnnotation instance based on PdfDictionary instance, that represents existing annotation object in the document.

Method Summary

Modifier and Type	Method	Description
PdfObject	getFileSpecObject()
PdfName	getIconName()	The name of an icon that is used in displaying the annotation.
PdfName	getSubtype()	Gets a PdfName which value is a subtype of this annotation.
PdfFileAttachmentAnnotation	setIconName(PdfName name)	The name of an icon that is used in displaying the annotation.

Methods inherited from class com.itextpdf.kernel.pdf.annot.PdfMarkupAnnotation

getCreationDate, getExternalData, getInReplyTo, getInReplyToObject, getIntent, getOpacity, getPopup, getPopupObject, getReplyType, getRichText, getSubject, getText, setCreationDate, setExternalData, setInReplyTo, setIntent, setOpacity, setPopup, setReplyType, setRichText, setSubject, setText

Methods inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation

addAssociatedFile, flush, getAppearanceDictionary, getAppearanceObject, getAppearanceState, getAssociatedFiles, getBlendMode, getBorder, getColorObject, getContents, getDate, getDownAppearanceObject, getFlags, getLang, getName, getNonStrokingOpacity, getNormalAppearanceObject, getPage, getPageObject, getRectangle, getRolloverAppearanceObject, getStrokingOpacity, getStructParentIndex, getTitle, hasFlag, isWrappedObjectMustBeIndirect, makeAnnotation, put, remove, resetFlag, setAppearance, setAppearance, setAppearanceState, setBlendMode, setBorder, setBorder, setColor, setColor, setColor, setContents, setContents, setDate, setDownAppearance, setDownAppearance, setFlag, setFlags, setLang, setLayer, setName, setNonStrokingOpacity, setNormalAppearance, setNormalAppearance, setPage, setRectangle, setRolloverAppearance, setRolloverAppearance, setStrokingOpacity, setStructParentIndex, setTitle

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PdfFileAttachmentAnnotation

public PdfFileAttachmentAnnotation(Rectangle rect)

PdfFileAttachmentAnnotation

public PdfFileAttachmentAnnotation(Rectangle rect,
                                   PdfFileSpec file)

PdfFileAttachmentAnnotation

protected PdfFileAttachmentAnnotation(PdfDictionary pdfObject)

Instantiates a new PdfFileAttachmentAnnotation instance based on PdfDictionary instance, that represents existing annotation object in the document.

Parameters:

pdfObject - the PdfDictionary representing annotation object

See Also:

PdfAnnotation.makeAnnotation(PdfObject)

Method Detail

getSubtype

public PdfName getSubtype()

Description copied from class: PdfAnnotation

Gets a PdfName which value is a subtype of this annotation. See ISO-320001 12.5.6, "Annotation Types" for the reference to the possible types.

Specified by:

getSubtype in class PdfAnnotation

Returns:

subtype of this annotation.

getFileSpecObject

public PdfObject getFileSpecObject()

getIconName

public PdfName getIconName()

The name of an icon that is used in displaying the annotation. Possible values are different for different annotation types. See setIconName(PdfName).

Returns:

a PdfName that specifies the icon for displaying annotation, or null if icon name is not specified.

setIconName

public PdfFileAttachmentAnnotation setIconName(PdfName name)

The name of an icon that is used in displaying the annotation.

Parameters:

name - a PdfName that specifies the icon for displaying annotation. Possible values are different for different annotation types:

• GraphPushPin
• PaperclipTag

Additional names may be supported as well.

Returns:

this PdfFileAttachmentAnnotation instance.