Uses of Class
com.itextpdf.kernel.pdf.annot.PdfAnnotation
Packages that use PdfAnnotation
Package
Description
-
Uses of PdfAnnotation in com.itextpdf.kernel.pdf
Methods in com.itextpdf.kernel.pdf that return types with arguments of type PdfAnnotationModifier and TypeMethodDescriptionPdfPage.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 PdfAnnotationModifier and TypeMethodDescriptionPdfPage.addAnnotation
(int index, PdfAnnotation annotation, boolean tagAnnotation) Adds specifiedPdfAnnotation
to specified index in annotations array with or without autotagging.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.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 PdfAnnotationModifier and TypeMethodDescriptionstatic 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.annotModifier and TypeClassDescriptionclass
This class represents 3D annotations by which 3D artwork shall be represented in a PDF document.class
class
class
class
class
class
The purpose of a line annotation is to display a single straight line on the page.class
A link annotation represents either a hypertext link to a destination elsewhere in the document or anPdfAction
to be performed.class
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
class
class
class
class
class
class
class
class
class
class
APdfTrapNetworkAnnotation
may be used to define the trapping characteristics for a page of a PDF document.class
class
Fields in com.itextpdf.kernel.pdf.annot declared as PdfAnnotationModifier and TypeFieldDescriptionprotected PdfAnnotation
PdfMarkupAnnotation.inReplyTo
protected PdfAnnotation
PdfPopupAnnotation.parent
Methods in com.itextpdf.kernel.pdf.annot that return PdfAnnotationModifier and TypeMethodDescriptionPdfMarkupAnnotation.getInReplyTo()
An annotation that this annotation is "in reply to." Both annotations shall be on the same page of the document.PdfPopupAnnotation.getParent()
static PdfAnnotation
PdfAnnotation.makeAnnotation
(PdfObject pdfObject) Factory method that creates the type specificPdfAnnotation
from the givenPdfObject
that represents annotation object.Inserts the value into into the underlyingPdfDictionary
of thisPdfAnnotation
and associates it with the specified key.Removes the specified key from the underlyingPdfDictionary
of thisPdfAnnotation
.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.setAppearance
(PdfName appearanceType, PdfAnnotationAppearance appearance) Sets a specific type of the appearance usingPdfAnnotationAppearance
wrapper.PdfAnnotation.setAppearance
(PdfName appearanceType, PdfDictionary appearance) Sets a specific type of the appearance.PdfAnnotation.setAppearanceState
(PdfName as) Sets the annotation’s appearance state, which selects the applicable appearance stream from an appearance subdictionary.PdfAnnotation.setBlendMode
(PdfName blendMode) PDF 2.0.PdfAnnotation.setBorder
(PdfAnnotationBorder border) Sets the characteristics of the annotation’s border.Sets the characteristics of the annotation’s border.PdfAnnotation.setColor
(float[] color) Sets an annotation color.Sets an annotation color.Sets an annotation color.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.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.The date and time when the annotation was most recently modified.PdfAnnotation.setDownAppearance
(PdfAnnotationAppearance appearance) Sets down appearance usingPdfAnnotationAppearance
wrapper.PdfAnnotation.setDownAppearance
(PdfDictionary appearance) Sets down appearance.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.setFlags
(int flags) Sets a set of flags specifying various characteristics of the annotation (see ISO-320001 12.5.3, "Annotation Flags").PDF 2.0.Sets the annotation name, a text string uniquely identifying it among all the annotations on its page.PdfAnnotation.setNonStrokingOpacity
(float nonStrokingOpacity) PDF 2.0.PdfAnnotation.setNormalAppearance
(PdfAnnotationAppearance appearance) Sets normal appearance usingPdfAnnotationAppearance
wrapper.PdfAnnotation.setNormalAppearance
(PdfDictionary appearance) Sets normal appearance.Method that modifies annotation page property, which defines to which page annotation belongs.PdfAnnotation.setRectangle
(PdfArray array) The annotation rectangle, defining the location of the annotation on the page in default user space units.PdfAnnotation.setRolloverAppearance
(PdfAnnotationAppearance appearance) Sets rollover appearance usingPdfAnnotationAppearance
wrapper.PdfAnnotation.setRolloverAppearance
(PdfDictionary appearance) Sets rollover appearance.PdfAnnotation.setStrokingOpacity
(float strokingOpacity) PDF 2.0.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").Sets annotation title.Methods in com.itextpdf.kernel.pdf.annot with parameters of type PdfAnnotationModifier and TypeMethodDescriptionPdfMarkupAnnotation.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.setParent
(PdfAnnotation parent) -
Uses of PdfAnnotation in com.itextpdf.kernel.pdf.tagging
Constructors in com.itextpdf.kernel.pdf.tagging with parameters of type PdfAnnotationModifierConstructorDescriptionPdfObjRef
(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 PdfAnnotationModifier and TypeMethodDescriptionTagTreePointer.addAnnotationTag
(PdfAnnotation annotation) Adds a new content item for the givenPdfAnnotation
under the current tag.TagStructureContext.removeAnnotationTag
(PdfAnnotation annotation) Removes annotation content item from the tag structure.