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

Packages that use PdfAnnotation

Package	Description
com.itextpdf.kernel.pdf
com.itextpdf.kernel.pdf.action
com.itextpdf.kernel.pdf.annot
com.itextpdf.kernel.pdf.tagging
com.itextpdf.kernel.pdf.tagutils

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

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 and 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 and Description
class	Pdf3DAnnotation
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
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	PdfRichMediaAnnotation
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 and Description
protected PdfAnnotation	PdfMarkupAnnotation.inReplyTo
protected PdfAnnotation	PdfPopupAnnotation.parent

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

Modifier and Type	Method and 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.
static PdfAnnotation	PdfAnnotation.makeAnnotation(PdfObject pdfObject, PdfAnnotation parent) Deprecated. This method will be removed in iText 7.1. Please, simply use makeAnnotation(PdfObject).
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.setAction(PdfAction action) Sets a PdfAction to this annotation which will be performed when the annotation is activated.
PdfAnnotation	PdfAnnotation.setAdditionalAction(PdfName key, PdfAction action) Sets an additional PdfAction to this annotation which will be performed in response to the specific trigger event defined by key.
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.setAppearanceCharacteristics(PdfDictionary characteristics) Sets an appearance characteristics dictionary containing additional information for constructing the annotation’s appearance stream.
PdfAnnotation	PdfAnnotation.setAppearanceState(PdfName as) Sets the annotation’s appearance state, which selects the applicable appearance stream from an appearance subdictionary.
PdfAnnotation	PdfAnnotation.setBorder(PdfArray border) Sets the characteristics of the annotation’s border.
PdfAnnotation	PdfAnnotation.setBorderStyle(PdfDictionary borderStyle) Sets border style dictionary that has more settings than the array specified for the Border entry (getBorder()).
PdfAnnotation	PdfAnnotation.setBorderStyle(PdfName style) Setter for the annotation's preset border style.
PdfAnnotation	PdfAnnotation.setColor(Color color) Sets an annotation color.
PdfAnnotation	PdfAnnotation.setColor(float[] 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.setDashPattern(PdfArray dashPattern) Setter for the annotation's preset dashed border style.
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.setName(PdfString name) Sets the annotation name, a text string uniquely identifying it among all the annotations on its page.
PdfAnnotation	PdfAnnotation.setNormalAppearance(PdfAnnotationAppearance appearance) Sets normal appearance using PdfAnnotationAppearance wrapper.
PdfAnnotation	PdfAnnotation.setNormalAppearance(PdfDictionary appearance) Sets normal appearance.
PdfAnnotation	PdfAnnotation.setOpen(boolean open) Sets a flag specifying whether the annotation shall initially be displayed open.
PdfAnnotation	PdfAnnotation.setPage(PdfPage page) Method that modifies annotation page property, which defines to which page annotation belongs.
PdfAnnotation	PdfAnnotation.setQuadPoints(PdfArray quadPoints) Sets n quadrilaterals in default user space by passing an PdfArray of 8 × n numbers.
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.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 and Description
static PdfAnnotation	PdfAnnotation.makeAnnotation(PdfObject pdfObject, PdfAnnotation parent) Deprecated. This method will be removed in iText 7.1. Please, simply use makeAnnotation(PdfObject).
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

Constructor and Description
PdfObjRef(PdfAnnotation annot, PdfStructElem parent)
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 and 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.