Annotation
Handles all annotation related operations on the owning document. Retrieve it with com.pspdfkit.document.PdfDocument.getAnnotationProvider.
Inheritors
Types
Listener for annotation update events inside AnnotationProvider.
Functions
Adds annotation to the owner PDF document. The annotation will be attached to the page set in its constructor.
Adds annotation to the owner PDF document at the specified z-index. The annotation will be attached to the page set in its constructor.
Adds annotation to the owner PDF document asynchronously. The annotation will be attached to the page set in its constructor.
Adds annotation to the owner PDF document asynchronously, at the specified z-index. The annotation will be attached to the page set in its constructor.
Adds appearance stream generator to the list of global appearance stream generators.
Appends a new annotation state for the given annotation (adds it to the review history).
Appends a new annotation state for the given annotation asynchronously (adds it to the review history).
Creates an annotation from the Instant JSON annotation format. The JSON must contain the type, the page number and any other required properties for that type. The created annotation will be automatically added to the document, and any registered OnAnnotationUpdatedListener will be notified of the creation.
Creates an annotation from the Instant JSON annotation format asynchronously. The JSON must contain the type, the page number and any other required properties for that type. The created annotation will be automatically added to the document, and any registered OnAnnotationUpdatedListener will be notified of the creation.
Returns all annotations of passed types in this document.
Returns all annotations of passed types in the specified page index range.
Returns all annotations of passed types in this document.
Returns all annotations of passed types in the specified page index range.
Returns annotation with certain object ID on the page if it exists.
Returns annotation with certain object ID on the page if it exists, asynchronously.
Gets all first-level replies to a particular annotation. First-level replies are annotations that return the given annotation via Annotation.getInReplyTo. The sort order is determined by the creation date.
Gets all first-level replies to a particular annotation asynchronously. First-level replies are annotations that return the given annotation via Annotation.getInReplyTo. The sort order is determined by the creation date.
Returns a list of annotations on the page. For annotations not currently recognised and handled by Nutrient this returns UnknownAnnotation.
Returns annotations with given object numbers.
Returns list of annotations on the page. For annotations not currently recognised and handled by Nutrient this returns UnknownAnnotation.
Returns annotations with given object numbers, asynchronously.
Returns a JSON array in string format of annotations on the page.
Gets all flattened replies (all replies included but no nesting) to a particular annotation. The sort order is determined by the creation date.
Gets all flattened replies (all replies included but no nesting) to a particular annotation asynchronously. The sort order is determined by the creation date.
Gets the review history of an annotation. The review history of an annotation is the list of states it has passed, for example, "Accepted", "Cancelled", and so on. This list is ordered chronologically, where the last element is the most current one according to the creation date of the annotation change.
Gets the review history of an annotation asynchronously. The review history of an annotation is the list of states it has passed, for example, "Accepted", "Cancelled", and so on. This list is ordered chronologically, where the last element is the most current one according to the creation date of the annotation change.
Gets a summary information about the given annotation's review state.
Gets a summary information about the given annotation's review state asynchronously.
Gets the z-index of the provided annotation.
Gets the z-index of the provided annotation.
Returns whether there are unsaved changes to annotations in this document.
Moves the annotation with the specified z-index move action.
Moves the annotation to the specified z-index.
Moves the annotation with the specified z-index move action asynchronously.
Moves the annotation to the specified z-index asynchronously.
Removes annotation from the document. If the annotation is not attached to the document of this annotation provider, this will be a no-op. Note that when using the Replies component of Nutrient (requires extra license flag), any replies to the removed annotation will be automatically removed as well from the document.
Removes annotation from this document asynchronously.
Remove appearance stream generator that was previously added in addAppearanceStreamGenerator.