Package com.itextpdf.kernel.pdf.annot

Class PdfStampAnnotation

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

public class PdfStampAnnotation
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
	PdfStampAnnotation(Rectangle rect)
protected	PdfStampAnnotation(PdfDictionary pdfObject)	Instantiates a new PdfStampAnnotation instance based on PdfDictionary instance, that represents existing annotation object in the document.

Method Summary

Modifier and Type	Method	Description
PdfName	getIconName()	The name of an icon that is used in displaying the annotation.
PdfNumber	getRotation()	Gets the rotation angle in degrees.
PdfName	getStampName()
PdfName	getSubtype()	Gets a PdfName which value is a subtype of this annotation.
PdfStampAnnotation	setIconName(PdfName name)	The name of an icon that is used in displaying the annotation.
PdfStampAnnotation	setRotation(int degAngle)	Sets the rotation angle in degrees.
PdfStampAnnotation	setStampName(PdfName name)

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

PdfStampAnnotation

public PdfStampAnnotation(Rectangle rect)

PdfStampAnnotation

protected PdfStampAnnotation(PdfDictionary pdfObject)

Instantiates a new PdfStampAnnotation 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.

setStampName

public PdfStampAnnotation setStampName(PdfName name)

getStampName

public PdfName getStampName()

getIconName

public PdfName getIconName()

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

Returns:

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

getRotation

public PdfNumber getRotation()

Gets the rotation angle in degrees.

Returns:

PdfNumber representing the clockwise rotation in degrees.

setIconName

public PdfStampAnnotation 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:

• Approved
• Experimental
• NotApproved
• AsIs
• Expired
• NotForPublicRelease
• Confidential
• Final
• Sold
• Departmental
• ForComment
• TopSecret
• Draft
• ForPublicRelease.

Returns:

this PdfStampAnnotation instance.

setRotation

public PdfStampAnnotation setRotation(int degAngle)

Sets the rotation angle in degrees.

Parameters:

degAngle - an integer representing the clockwise rotation in degrees.

Returns:

this PdfStampAnnotation instance.