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

All Implemented Interfaces:

Serializable

public class PdfFileAttachmentAnnotation
extends PdfMarkupAnnotation

See Also:

Serialized Form

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

Constructor and Description
PdfFileAttachmentAnnotation(PdfDictionary pdfObject) Deprecated. Use PdfAnnotation.makeAnnotation(PdfObject) instead. Will be made protected in 7.1
PdfFileAttachmentAnnotation(Rectangle rect)
PdfFileAttachmentAnnotation(Rectangle rect, PdfFileSpec file)

Method Summary

Modifier and Type	Method and 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

getBorderEffect, getCreationDate, getDefaultAppearance, getExternalData, getInReplyTo, getInReplyToObject, getIntent, getInteriorColor, getJustification, getOpacity, getPopup, getPopupObject, getRectangleDifferences, getReplyType, getRichText, getSubject, getText, setBorderEffect, setCreationDate, setDefaultAppearance, setExternalData, setInReplyTo, setIntent, setInteriorColor, setInteriorColor, setJustification, setOpacity, setPopup, setRectangleDifferences, setReplyType, setRichText, setSubject, setText

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

flush, getAction, getAdditionalAction, getAppearanceCharacteristics, getAppearanceDictionary, getAppearanceObject, getAppearanceState, getBorder, getBorderStyle, getColorObject, getContents, getDate, getDownAppearanceObject, getFlags, getName, getNormalAppearanceObject, getOpen, getPage, getPageObject, getQuadPoints, getRectangle, getRolloverAppearanceObject, getStructParentIndex, getTitle, hasFlag, isWrappedObjectMustBeIndirect, makeAnnotation, makeAnnotation, put, remove, resetFlag, setAction, setAdditionalAction, setAppearance, setAppearance, setAppearanceCharacteristics, setAppearanceState, setBorder, setBorderStyle, setBorderStyle, setColor, setColor, setColor, setContents, setContents, setDashPattern, setDate, setDownAppearance, setDownAppearance, setFlag, setFlags, setLayer, setName, setNormalAppearance, setNormalAppearance, setOpen, setPage, setQuadPoints, setRectangle, setRolloverAppearance, setRolloverAppearance, 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

@Deprecated
public PdfFileAttachmentAnnotation(PdfDictionary pdfObject)

Deprecated. Use PdfAnnotation.makeAnnotation(PdfObject) instead. Will be made protected in 7.1

Parameters:

pdfObject - object representing this annotation

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).

Overrides:

getIconName in class PdfMarkupAnnotation

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.

Overrides:

setIconName in class PdfMarkupAnnotation

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.