pspdfkit/com.pspdfkit.annotations/AnnotationProvider

AnnotationProvider

interface AnnotationProvider

Handles all annotation related operations on the owning document. Retrieve it with getAnnotationProvider.

Inheritors

Types

Link copied to clipboard
interface OnAnnotationUpdatedListener
Listener for annotation update events inside AnnotationProvider.

Properties

Link copied to clipboard
val ALL_ANNOTATION_TYPES: EnumSet<AnnotationType>
All annotation types that can displayed in the annotation list.

Functions

Link copied to clipboard
abstract fun addAnnotationToPage(@NonNull annotation: Annotation)
Adds annotation to the owner PDF document.
abstract fun addAnnotationToPage(@NonNull annotation: Annotation, zIndex: Int)
Adds annotation to the owner PDF document at the specified z-index.
Link copied to clipboard
@NonNull
abstract fun addAnnotationToPageAsync(@NonNull annotation: Annotation): Completable
Adds annotation to the owner PDF document asynchronously.
@NonNull
abstract fun addAnnotationToPageAsync(@NonNull annotation: Annotation, zIndex: Int): Completable
Adds annotation to the owner PDF document asynchronously, at the specified z-index.
Link copied to clipboard
abstract fun addAppearanceStreamGenerator(@NonNull appearanceStreamGenerator: AppearanceStreamGenerator)
abstract fun addAppearanceStreamGenerator(@NonNull appearanceStreamGenerator: AppearanceStreamGenerator, addFirst: Boolean)
Adds appearance stream generator to the list of global appearance stream generators.
Link copied to clipboard
abstract fun addOnAnnotationUpdatedListener(@NonNull updatedListener: AnnotationProvider.OnAnnotationUpdatedListener)
Adds an OnAnnotationUpdatedListener for being notified of updates to annotations.
Link copied to clipboard
abstract fun appendAnnotationState(@NonNull annotation: Annotation, @NonNull annotationStateChange: AnnotationStateChange)
Appends a new annotation state for the given annotation (adds it to the review history).
Link copied to clipboard
@NonNull
abstract fun appendAnnotationStateAsync(@NonNull annotation: Annotation, @NonNull annotationStateChange: AnnotationStateChange): Completable
Appends a new annotation state for the given annotation asynchronously (adds it to the review history).
Link copied to clipboard
@NonNull
abstract fun createAnnotationFromInstantJson(@NonNull annotationJson: String): Annotation
Creates an annotation from the Instant JSON annotation format.
Link copied to clipboard
@NonNull
abstract fun createAnnotationFromInstantJsonAsync(@NonNull annotationJson: String): Single<Annotation>
Creates an annotation from the Instant JSON annotation format asynchronously.
Link copied to clipboard
@NonNull
abstract fun getAllAnnotationsOfType(@NonNull types: EnumSet<AnnotationType>): List<Annotation>
Returns all annotations of passed types in this document.
@NonNull
abstract fun getAllAnnotationsOfType(@NonNull types: EnumSet<AnnotationType>, startIndex: Int, pageCount: Int): List<Annotation>
Returns all annotations of passed types in the specified page index range.
Link copied to clipboard
@NonNull
abstract fun getAllAnnotationsOfTypeAsync(@NonNull types: EnumSet<AnnotationType>): Observable<Annotation>
Returns all annotations of passed types in this document.
@NonNull
abstract fun getAllAnnotationsOfTypeAsync(@NonNull types: EnumSet<AnnotationType>, startIndex: Int, pageCount: Int): Observable<Annotation>
Returns all annotations of passed types in the specified page index range.
Link copied to clipboard
@Nullable
abstract fun getAnnotation(@IntRange(from = 0) pageIndex: Int, objectNumber: Int): Annotation
Returns annotation with certain object ID on the page if it exists.
Link copied to clipboard
@NonNull
abstract fun getAnnotationAsync(@IntRange(from = 0) pageIndex: Int, objectNumber: Int): Maybe<Annotation>
Returns annotation with certain object ID on the page if it exists, asynchronously.
Link copied to clipboard
@NonNull
abstract fun getAnnotationReplies(@NonNull annotation: Annotation): List<Annotation>
Gets all first-level replies to a particular annotation.
Link copied to clipboard
@NonNull
abstract fun getAnnotationRepliesAsync(@NonNull annotation: Annotation): Single<List<Annotation>>
Gets all first-level replies to a particular annotation asynchronously.
Link copied to clipboard
@NonNull
abstract fun getAnnotations(@IntRange(from = 0) pageIndex: Int): List<Annotation>
Returns a list of annotations on the page.
@NonNull
abstract fun getAnnotations(@NonNull objectNumbers: Collection<Integer>): List<Annotation>
Returns annotations with given object numbers.
Link copied to clipboard
@NonNull
abstract fun getAnnotationsAsync(@IntRange(from = 0) pageIndex: Int): Observable<List<Annotation>>
Returns list of annotations on the page.
@NonNull
abstract fun getAnnotationsAsync(@NonNull objectNumbers: Collection<Integer>): Observable<List<Annotation>>
Returns annotations with given object numbers, asynchronously.
Link copied to clipboard
@NonNull
abstract fun getFlattenedAnnotationReplies(@NonNull annotation: Annotation): List<Annotation>
Gets all flattened replies (all replies included but no nesting) to a particular annotation.
Link copied to clipboard
@NonNull
abstract fun getFlattenedAnnotationRepliesAsync(@NonNull annotation: Annotation): Single<List<Annotation>>
Gets all flattened replies (all replies included but no nesting) to a particular annotation asynchronously.
Link copied to clipboard
@NonNull
abstract fun getReviewHistory(@NonNull annotation: Annotation): List<AnnotationStateChange>
Gets the review history of an annotation.
Link copied to clipboard
@NonNull
abstract fun getReviewHistoryAsync(@NonNull annotation: Annotation): Single<List<AnnotationStateChange>>
Gets the review history of an annotation asynchronously.
Link copied to clipboard
@Nullable
abstract fun getReviewSummary(@NonNull annotation: Annotation, @Nullable currentUser: String): AnnotationReviewSummary
Gets a summary information about the given annotation's review state.
Link copied to clipboard
@NonNull
abstract fun getReviewSummaryAsync(@NonNull annotation: Annotation, @Nullable currentUser: String): Maybe<AnnotationReviewSummary>
Gets a summary information about the given annotation's review state asynchronously.
Link copied to clipboard
abstract fun getZIndex(@NonNull annotation: Annotation): Int
Gets the z-index of the provided annotation.
Link copied to clipboard
@NonNull
abstract fun getZIndexAsync(@NonNull annotation: Annotation): Single<Integer>
Gets the z-index of the provided annotation.
Link copied to clipboard
abstract fun hasUnsavedChanges(): Boolean
Returns whether there are unsaved changes to annotations in this document.
Link copied to clipboard
abstract fun moveAnnotation(@NonNull annotation: Annotation, @NonNull zIndexMove: AnnotationZIndexMove)
Moves the annotation with the specified z-index move action.
abstract fun moveAnnotation(@NonNull annotation: Annotation, zIndex: Int)
abstract fun moveAnnotation(pageIndex: Int, fromZIndex: Int, toZIndex: Int)
Moves the annotation to the specified z-index.
Link copied to clipboard
@NonNull
abstract fun moveAnnotationAsync(@NonNull annotation: Annotation, @NonNull zIndexMove: AnnotationZIndexMove): Completable
Moves the annotation with the specified z-index move action asynchronously.
@NonNull
abstract fun moveAnnotationAsync(@NonNull annotation: Annotation, zIndex: Int): Completable
@NonNull
abstract fun moveAnnotationAsync(pageIndex: Int, fromZIndex: Int, toZIndex: Int): Completable
Moves the annotation to the specified z-index asynchronously.
Link copied to clipboard
abstract fun removeAnnotationFromPage(@NonNull annotation: Annotation)
Removes annotation from the document.
Link copied to clipboard
@NonNull
abstract fun removeAnnotationFromPageAsync(@NonNull annotation: Annotation): Completable
Removes annotation from this document asynchronously.
Link copied to clipboard
abstract fun removeAppearanceStreamGenerator(@NonNull appearanceStreamGenerator: AppearanceStreamGenerator)
Remove appearance stream generator that was previously added in addAppearanceStreamGenerator.
Link copied to clipboard