Uses of Class
com.itextpdf.kernel.pdf.annot.PdfAnnotation

Packages that use PdfAnnotation

Package	Description
com.itextpdf.forms.fields
com.itextpdf.kernel.pdf
com.itextpdf.kernel.pdf.action
com.itextpdf.kernel.pdf.annot
com.itextpdf.kernel.pdf.tagging
com.itextpdf.kernel.pdf.tagutils
com.itextpdf.kernel.utils
com.itextpdf.kernel.utils.annotationsflattening

Uses of PdfAnnotation in com.itextpdf.forms.fields

Methods in com.itextpdf.forms.fields with parameters of type PdfAnnotation

Modifier and Type	Method	Description
static void	PdfFormAnnotationUtil.addWidgetAnnotationToPage(PdfPage page, PdfAnnotation annotation)	Add widget annotation to the specified page.
static void	PdfFormAnnotationUtil.addWidgetAnnotationToPage(PdfPage page, PdfAnnotation annotation, int index)	Add widget annotation to the specified page.

Uses of PdfAnnotation in com.itextpdf.kernel.pdf

Methods in com.itextpdf.kernel.pdf that return types with arguments of type PdfAnnotation

Modifier and Type	Method	Description
List<PdfAnnotation>	PdfPage.getAnnotations()	Gets array of annotation dictionaries that shall contain indirect references to all annotations associated with the page.

Methods in com.itextpdf.kernel.pdf with parameters of type PdfAnnotation

Modifier and Type	Method	Description
PdfPage	PdfPage.addAnnotation(int index, PdfAnnotation annotation, boolean tagAnnotation)	Adds specified PdfAnnotation to specified index in annotations array with or without autotagging.
PdfPage	PdfPage.addAnnotation(PdfAnnotation annotation)	Adds specified annotation to the end of annotations array and tagged it.
boolean	PdfPage.containsAnnotation(PdfAnnotation annotation)	Checks if page contains the specified annotation.
PdfPage	PdfPage.removeAnnotation(PdfAnnotation annotation)	Removes an annotation from the page.
PdfPage	PdfPage.removeAnnotation(PdfAnnotation annotation, boolean rememberTagPointer)	Removes an annotation from the page.

Uses of PdfAnnotation in com.itextpdf.kernel.pdf.action

Methods in com.itextpdf.kernel.pdf.action with parameters of type PdfAnnotation

Modifier and Type	Method	Description
static PdfAction	PdfAction.createHide(PdfAnnotation[] annotations, boolean hidden)	Creates a Hide action (section 12.6.4.10 of ISO 32000-1).
static PdfAction	PdfAction.createHide(PdfAnnotation annotation, boolean hidden)	Creates a Hide action (section 12.6.4.10 of ISO 32000-1).
static PdfAction	PdfAction.createMovie(PdfAnnotation annotation, String title, PdfName operation)	Creates a Movie annotation (section 12.6.4.9 of ISO 32000-1).
static PdfAction	PdfAction.createRendition(String file, PdfFileSpec fileSpec, String mimeType, PdfAnnotation screenAnnotation)	Creates a Rendition action (section 12.6.4.13 of ISO 32000-1).

Uses of PdfAnnotation in com.itextpdf.kernel.pdf.annot

Subclasses of PdfAnnotation in com.itextpdf.kernel.pdf.annot

Modifier and Type	Class	Description
class	Pdf3DAnnotation	This class represents 3D annotations by which 3D artwork shall be represented in a PDF document.
class	PdfCaretAnnotation
class	PdfCircleAnnotation
class	PdfFileAttachmentAnnotation
class	PdfFreeTextAnnotation
class	PdfInkAnnotation
class	PdfLineAnnotation	The purpose of a line annotation is to display a single straight line on the page.
class	PdfLinkAnnotation	A link annotation represents either a hypertext link to a destination elsewhere in the document or an PdfAction to be performed.
class	PdfMarkupAnnotation	This is a super class for the annotations which are defined as markup annotations because they are used primarily to mark up PDF documents.
class	PdfPolyGeomAnnotation
class	PdfPopupAnnotation
class	PdfPrinterMarkAnnotation
class	PdfRedactAnnotation
class	PdfScreenAnnotation
class	PdfSoundAnnotation
class	PdfSquareAnnotation
class	PdfStampAnnotation
class	PdfTextAnnotation
class	PdfTextMarkupAnnotation
class	PdfTrapNetworkAnnotation	A PdfTrapNetworkAnnotation may be used to define the trapping characteristics for a page of a PDF document.
class	PdfWatermarkAnnotation
class	PdfWidgetAnnotation

Fields in com.itextpdf.kernel.pdf.annot declared as PdfAnnotation

Modifier and Type	Field	Description
protected PdfAnnotation	PdfMarkupAnnotation.inReplyTo
protected PdfAnnotation	PdfPopupAnnotation.parent

Methods in com.itextpdf.kernel.pdf.annot that return PdfAnnotation

Modifier and Type	Method	Description
PdfAnnotation	PdfMarkupAnnotation.getInReplyTo()	An annotation that this annotation is "in reply to." Both annotations shall be on the same page of the document.
PdfAnnotation	PdfPopupAnnotation.getParent()
static PdfAnnotation	PdfAnnotation.makeAnnotation(PdfObject pdfObject)	Factory method that creates the type specific PdfAnnotation from the given PdfObject that represents annotation object.
PdfAnnotation	PdfAnnotation.put(PdfName key, PdfObject value)	Inserts the value into into the underlying PdfDictionary of this PdfAnnotation and associates it with the specified key.
PdfAnnotation	PdfAnnotation.remove(PdfName key)	Removes the specified key from the underlying PdfDictionary of this PdfAnnotation.
PdfAnnotation	PdfAnnotation.resetFlag(int flag)	Resets a flag that specifies a characteristic of the annotation to disabled state (see ISO-320001 12.5.3, "Annotation Flags").
PdfAnnotation	PdfAnnotation.setAppearance(PdfName appearanceType, PdfAnnotationAppearance appearance)	Sets a specific type of the appearance using PdfAnnotationAppearance wrapper.
PdfAnnotation	PdfAnnotation.setAppearance(PdfName appearanceType, PdfDictionary appearance)	Sets a specific type of the appearance.
PdfAnnotation	PdfAnnotation.setAppearanceState(PdfName as)	Sets the annotation’s appearance state, which selects the applicable appearance stream from an appearance subdictionary.
PdfAnnotation	PdfAnnotation.setBlendMode(PdfName blendMode)	PDF 2.0.
PdfAnnotation	PdfAnnotation.setBorder(PdfAnnotationBorder border)	Sets the characteristics of the annotation’s border.
PdfAnnotation	PdfAnnotation.setBorder(PdfArray border)	Sets the characteristics of the annotation’s border.
PdfAnnotation	PdfAnnotation.setColor(float[] color)	Sets an annotation color.
PdfAnnotation	PdfAnnotation.setColor(Color color)	Sets an annotation color.
PdfAnnotation	PdfAnnotation.setColor(PdfArray color)	Sets an annotation color.
PdfAnnotation	PdfAnnotation.setContents(PdfString contents)	Sets the text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form.
PdfAnnotation	PdfAnnotation.setContents(String contents)	Sets the text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form.
PdfAnnotation	PdfAnnotation.setDate(PdfString date)	The date and time when the annotation was most recently modified.
PdfAnnotation	PdfAnnotation.setDownAppearance(PdfAnnotationAppearance appearance)	Sets down appearance using PdfAnnotationAppearance wrapper.
PdfAnnotation	PdfAnnotation.setDownAppearance(PdfDictionary appearance)	Sets down appearance.
PdfAnnotation	PdfAnnotation.setFlag(int flag)	Sets a flag that specifies a characteristic of the annotation to enabled state (see ISO-320001 12.5.3, "Annotation Flags").
PdfAnnotation	PdfAnnotation.setFlags(int flags)	Sets a set of flags specifying various characteristics of the annotation (see ISO-320001 12.5.3, "Annotation Flags").
PdfAnnotation	PdfAnnotation.setLang(String lang)	PDF 2.0.
PdfAnnotation	PdfAnnotation.setName(PdfString name)	Sets the annotation name, a text string uniquely identifying it among all the annotations on its page.
PdfAnnotation	PdfAnnotation.setNonStrokingOpacity(float nonStrokingOpacity)	PDF 2.0.
PdfAnnotation	PdfAnnotation.setNormalAppearance(PdfAnnotationAppearance appearance)	Sets normal appearance using PdfAnnotationAppearance wrapper.
PdfAnnotation	PdfAnnotation.setNormalAppearance(PdfDictionary appearance)	Sets normal appearance.
PdfAnnotation	PdfAnnotation.setPage(PdfPage page)	Method that modifies annotation page property, which defines to which page annotation belongs.
PdfAnnotation	PdfAnnotation.setRectangle(PdfArray array)	The annotation rectangle, defining the location of the annotation on the page in default user space units.
PdfAnnotation	PdfAnnotation.setRolloverAppearance(PdfAnnotationAppearance appearance)	Sets rollover appearance using PdfAnnotationAppearance wrapper.
PdfAnnotation	PdfAnnotation.setRolloverAppearance(PdfDictionary appearance)	Sets rollover appearance.
PdfAnnotation	PdfAnnotation.setStrokingOpacity(float strokingOpacity)	PDF 2.0.
PdfAnnotation	PdfAnnotation.setStructParentIndex(int structParentIndex)	Sets he integer key of the annotation’s entry in the structural parent tree (see ISO-320001 14.7.4.4, "Finding Structure Elements from Content Items").
PdfAnnotation	PdfAnnotation.setTitle(PdfString title)	Sets annotation title.

Methods in com.itextpdf.kernel.pdf.annot with parameters of type PdfAnnotation

Modifier and Type	Method	Description
PdfMarkupAnnotation	PdfMarkupAnnotation.setInReplyTo(PdfAnnotation inReplyTo)	Sets an annotation that this annotation is "in reply to." Both annotations shall be on the same page of the document.
PdfPopupAnnotation	PdfPopupAnnotation.setParent(PdfAnnotation parent)

Uses of PdfAnnotation in com.itextpdf.kernel.pdf.tagging

Constructors in com.itextpdf.kernel.pdf.tagging with parameters of type PdfAnnotation

Modifier	Constructor	Description
	PdfObjRef(PdfAnnotation annot, PdfStructElem parent, int nextStructParentIndex)
	PdfStructElem(PdfDocument document, PdfName role, PdfAnnotation annot)

Uses of PdfAnnotation in com.itextpdf.kernel.pdf.tagutils

Methods in com.itextpdf.kernel.pdf.tagutils with parameters of type PdfAnnotation

Modifier and Type	Method	Description
TagTreePointer	TagTreePointer.addAnnotationTag(PdfAnnotation annotation)	Adds a new content item for the given PdfAnnotation under the current tag.
TagTreePointer	TagStructureContext.removeAnnotationTag(PdfAnnotation annotation)	Removes annotation content item from the tag structure.
TagTreePointer	TagStructureContext.removeAnnotationTag(PdfAnnotation annotation, boolean setAutoTaggingPointer)	Removes annotation content item from the tag structure and sets autoTaggingPointer if true is passed.

Uses of PdfAnnotation in com.itextpdf.kernel.utils

Methods in com.itextpdf.kernel.utils that return types with arguments of type PdfAnnotation

Modifier and Type	Method	Description
List<PdfAnnotation>	PdfAnnotationFlattener.flatten(PdfDocument document)	Flattens the annotations on the page according to the defined implementation of IAnnotationFlattener.
List<PdfAnnotation>	PdfAnnotationFlattener.flatten(List<PdfAnnotation> annotationsToFlatten)	Flattens the annotations on the page according to the defined implementation of IAnnotationFlattener.

Method parameters in com.itextpdf.kernel.utils with type arguments of type PdfAnnotation

Modifier and Type	Method	Description
List<PdfAnnotation>	PdfAnnotationFlattener.flatten(List<PdfAnnotation> annotationsToFlatten)	Flattens the annotations on the page according to the defined implementation of IAnnotationFlattener.

Uses of PdfAnnotation in com.itextpdf.kernel.utils.annotationsflattening

Methods in com.itextpdf.kernel.utils.annotationsflattening with parameters of type PdfAnnotation

Modifier and Type	Method	Description
protected boolean	DefaultAnnotationFlattener.draw(PdfAnnotation annotation, PdfPage page)	Draws annotation.
protected boolean	HighLightTextMarkupAnnotationFlattener.draw(PdfAnnotation annotation, PdfPage page)	Draws annotation.
protected boolean	SquigglyTextMarkupAnnotationFlattener.draw(PdfAnnotation annotation, PdfPage page)	Draws annotation.
protected boolean	StrikeOutTextMarkupAnnotationFlattener.draw(PdfAnnotation annotation, PdfPage page)	Draws annotation.
protected boolean	UnderlineTextMarkupAnnotationFlattener.draw(PdfAnnotation annotation, PdfPage page)	Draws annotation.
boolean	AbstractTextMarkupAnnotationFlattener.flatten(PdfAnnotation annotation, PdfPage page)	Flatten annotation.
boolean	DefaultAnnotationFlattener.flatten(PdfAnnotation annotation, PdfPage page)	Flatten annotation.
boolean	IAnnotationFlattener.flatten(PdfAnnotation annotation, PdfPage page)	Flatten annotation.
boolean	NotSupportedFlattener.flatten(PdfAnnotation annotation, PdfPage page)	Logs a warning that annotation flattening is not supported for the given annotation.
boolean	RemoveWithoutDrawingFlattener.flatten(PdfAnnotation annotation, PdfPage page)	Flatten annotation.
boolean	WarnFormfieldFlattener.flatten(PdfAnnotation annotation, PdfPage page)	Flatten annotation.
protected Color	AbstractTextMarkupAnnotationFlattener.getColor(PdfAnnotation annotation)
static float[]	AbstractTextMarkupAnnotationFlattener.getQuadPointsAsFloatArray(PdfAnnotation annotation)	Gets the quadpoints as a float array.