nutrient/com.pspdfkit.annotations

Package-level declarations

Annotation API (with all available annotation types).

Types

Annotation

abstract class Annotation

Represents a generic annotation in the PDF document.

AnnotationFlags

enum AnnotationFlags

Specifies various characteristics of the annotation.

AnnotationProvider

interface AnnotationProvider

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

AnnotationType

enum AnnotationType

All currently supported annotation types.

AnnotationZIndexMove

enum AnnotationZIndexMove

The possible z-index moves that can be applied on the annotation.

AssetAnnotation

abstract class AssetAnnotation : LinkAnnotation

Abstract subclass that contains an asset from a link.

BaseLineAnnotation

abstract class BaseLineAnnotation : ShapeAnnotation

Abstract base class for PolygonAnnotation and PolylineAnnotation.

BaseRectsAnnotation

abstract class BaseRectsAnnotation : Annotation

Abstract base-class of all markup annotations: TextMarkupAnnotation and RedactionAnnotation.

BlendMode

enum BlendMode

List of blending modes available for the annotations that can be set by setBlendMode.

BorderEffect

enum BorderEffect

Border effect types for annotations.

BorderStyle

enum BorderStyle

Border style types for annotations.

CircleAnnotation

open class CircleAnnotation : ShapeAnnotation

Represents a circle on the page.

FileAnnotation

open class FileAnnotation : Annotation

Represents an annotation associated with EmbeddedFile.

FreeTextAnnotation

open class FreeTextAnnotation : Annotation

Represents a free text annotation on the page.

HighlightAnnotation

open class HighlightAnnotation : TextMarkupAnnotation

Represents a text highlight annotation on the page.

InkAnnotation

open class InkAnnotation : Annotation

Represents a freehand drawing on the page.

LineAnnotation

open class LineAnnotation : BaseLineAnnotation

Represents a line on the page.

LineEndType

enum LineEndType

Types of available line ends in annotations.

LinkAnnotation

open class LinkAnnotation : Annotation

Link type of annotation either carrying an URI or a page destination.

MediaAnnotation

abstract class MediaAnnotation : AssetAnnotation

Abstract annotation class holding a media file asset.

MediaWindowType

enum MediaWindowType

The type of the window to display the media in.

NoteAnnotation

open class NoteAnnotation : Annotation

Represents a note (shown as an icon) on the page.

PolygonAnnotation

open class PolygonAnnotation : BaseLineAnnotation

Represents a closed polygon on a page.

PolylineAnnotation

open class PolylineAnnotation : BaseLineAnnotation

Represents a polyline on the page.

RedactionAnnotation

open class RedactionAnnotation : BaseRectsAnnotation

Represents a redaction annotation on the document.

RichMediaAnnotation

open class RichMediaAnnotation : MediaAnnotation

RichMedia annotations are defined in the ISO32000 Adobe Supplement and are the modern way of embedding video content.

ScreenAnnotation

open class ScreenAnnotation : MediaAnnotation

A screen annotation (PDF 1.5) specifies a region of a page upon which media clips may be played.

ShapeAnnotation

abstract class ShapeAnnotation : Annotation

Abstract base-class of all shape annotations: LineAnnotation, SquareAnnotation, CircleAnnotation, PolygonAnnotation, PolylineAnnotation.

SoundAnnotation

open class SoundAnnotation : Annotation

Represents an audio file added to a page.

SquareAnnotation

open class SquareAnnotation : ShapeAnnotation

Represents a square rendered on the page.

SquigglyAnnotation

open class SquigglyAnnotation : TextMarkupAnnotation

Represents a squiggly text underline on the page.

StampAnnotation

open class StampAnnotation : Annotation

Represents a stamp or annotationBitmap annotation on the page.

StrikeOutAnnotation

open class StrikeOutAnnotation : TextMarkupAnnotation

Represents a strike-out text on the page.

TextMarkupAnnotation

abstract class TextMarkupAnnotation : BaseRectsAnnotation

Abstract base-class of all text markup annotations: HighlightAnnotation, SquigglyAnnotation, UnderlineAnnotation and StrikeOutAnnotation.

UnderlineAnnotation

open class UnderlineAnnotation : TextMarkupAnnotation

Represents underlined text on the page.

UnknownAnnotation

open class UnknownAnnotation : Annotation

Represents an annotation that is currently not recognised and handled by Nutrient.

VerticalTextAlignment

enum VerticalTextAlignment

Possible values for the vertical alignment of the text.

WidgetAnnotation

open class WidgetAnnotation : LinkAnnotation

Represents the appearance of a field in interactive forms.

Functions

addAnnotationToPageBlocking

fun AnnotationProvider.~~addAnnotationToPageBlocking~~(annotation: Annotation)

Adds annotation to the owner PDF document, blocking until the operation completes.

addAnnotationToPageCompletable

fun AnnotationProvider.~~addAnnotationToPageCompletable~~(annotation: Annotation): Completable

Adds the provided annotation to the page via AnnotationProvider.addAnnotationToPage and exposes the result as a Completable.

createAnnotationFromInstantJsonSingle

fun AnnotationProvider.~~createAnnotationFromInstantJsonSingle~~(annotationJson: String): Single<Annotation>

Creates an annotation via AnnotationProvider.createAnnotationFromInstantJson as a Single.

getAllAnnotationsOfTypeBlocking

fun AnnotationProvider.~~getAllAnnotationsOfTypeBlocking~~(types: EnumSet<ERROR CLASS: Symbol not found for AnnotationType>): List<Annotation>

Returns all annotations of passed types in this document, blocking until the operation completes.

fun AnnotationProvider.~~getAllAnnotationsOfTypeBlocking~~(types: EnumSet<ERROR CLASS: Symbol not found for AnnotationType>, @IntRange(from = 0) startPageIndex: Int, @IntRange(from = 1) pageCount: Int): List<Annotation>

Returns all annotations of passed types in the specified page range, blocking until the operation completes.

getAllAnnotationsOfTypeObservable

fun AnnotationProvider.~~getAllAnnotationsOfTypeObservable~~(types: EnumSet<ERROR CLASS: Symbol not found for AnnotationType>): Observable<Annotation>

Returns all annotations of the given types for the entire document as an Observable, using AnnotationProvider.getAllAnnotationsOfType.

fun AnnotationProvider.~~getAllAnnotationsOfTypeObservable~~(types: EnumSet<ERROR CLASS: Symbol not found for AnnotationType>, startIndex: Int, pageCount: Int): Observable<Annotation>

Returns annotations of the given types for the provided page range as an Observable, using AnnotationProvider.getAllAnnotationsOfType.

getAnnotationBlocking

fun AnnotationProvider.~~getAnnotationBlocking~~(@IntRange(from = 0) pageIndex: Int, objectNumber: Int): Annotation?

Returns annotation with certain object ID on the page if it exists, blocking until the operation completes.

fun AnnotationProvider.~~getAnnotationBlocking~~(@IntRange(from = 0) pageIndex: Int, uuid: String): Annotation?

Returns annotation with certain UUID on the page if it exists, blocking until the operation completes.

getAnnotationsBlocking

fun AnnotationProvider.~~getAnnotationsBlocking~~(@IntRange(from = 0) pageIndex: Int): List<Annotation>

Returns a list of annotations on the page, blocking until the operation completes.

getAnnotationsObservable

fun AnnotationProvider.~~getAnnotationsObservable~~(pageIndex: Int): Observable<List<Annotation>>

Returns all annotations on the given page as an Observable by bridging AnnotationProvider.getAnnotations.

removeAnnotationFromPageBlocking

fun AnnotationProvider.~~removeAnnotationFromPageBlocking~~(annotation: Annotation)

Removes annotation from the document, blocking until the operation completes.