pspdfkit/com.pspdfkit.annotations

Package-level declarations

Annotation API (with all available annotation types).

Types

Link copied to clipboard
abstract class Annotation
Represents a generic annotation in the PDF document.
Link copied to clipboard
enum AnnotationFlags
Specifies various characteristics of the annotation.
Link copied to clipboard
interface AnnotationProvider
Handles all annotation related operations on the owning document.
Link copied to clipboard
enum AnnotationType
All currently supported annotation types.
Link copied to clipboard
enum AnnotationZIndexMove
The possible z-index moves that can be applied on the annotation.
Link copied to clipboard
abstract class AssetAnnotation : LinkAnnotation
Abstract subclass that contains an asset from a link.
Link copied to clipboard
abstract class BaseLineAnnotation : ShapeAnnotation
Abstract base class for PolygonAnnotation and PolylineAnnotation.
Link copied to clipboard
abstract class BaseRectsAnnotation : Annotation
Abstract base-class of all markup annotations: TextMarkupAnnotation and .
Link copied to clipboard
enum BlendMode
List of blending modes available for the annotations that can be set by setBlendMode.
Link copied to clipboard
enum BorderEffect
Border effect types for annotations.
Link copied to clipboard
enum BorderStyle
Border style types for annotations.
Link copied to clipboard
open class CircleAnnotation : ShapeAnnotation
Represents a circle on the page.
Link copied to clipboard
open class FileAnnotation : Annotation
Represents an annotation associated with EmbeddedFile.
Link copied to clipboard
open class FreeTextAnnotation : Annotation
Represents a free text annotation on the page.
Link copied to clipboard
open class HighlightAnnotation : TextMarkupAnnotation
Represents a text highlight annotation on the page.
Link copied to clipboard
open class InkAnnotation : Annotation
Represents a freehand drawing on the page.
Link copied to clipboard
open class LineAnnotation : BaseLineAnnotation
Represents a line on the page.
Link copied to clipboard
enum LineEndType
Types of available line ends in annotations.
Link copied to clipboard
open class LinkAnnotation : Annotation
Link type of annotation either carrying an URI or a page destination.
Link copied to clipboard
abstract class MediaAnnotation : AssetAnnotation
Abstract annotation class holding a media file asset.
Link copied to clipboard
enum MediaWindowType
The type of the window to display the media in.
Link copied to clipboard
open class NoteAnnotation : Annotation
Represents a note (shown as an icon) on the page.
Link copied to clipboard
open class PolygonAnnotation : BaseLineAnnotation
Represents a closed polygon on a page.
Link copied to clipboard
open class PolylineAnnotation : BaseLineAnnotation
Represents a polyline on the page.
Link copied to clipboard
open class RedactionAnnotation : BaseRectsAnnotation
Represents a redaction annotation on the document.
Link copied to clipboard
open class RichMediaAnnotation : MediaAnnotation
RichMedia annotations are defined in the ISO32000 Adobe Supplement and are the modern way of embedding video content.
Link copied to clipboard
open class ScreenAnnotation : MediaAnnotation
A screen annotation (PDF 1.5) specifies a region of a page upon which media clips may be played.
Link copied to clipboard
abstract class ShapeAnnotation : Annotation
Abstract base-class of all shape annotations: LineAnnotation, SquareAnnotation, CircleAnnotation, PolygonAnnotation, PolylineAnnotation.
Link copied to clipboard
open class SoundAnnotation : Annotation
Represents an audio file added to a page.
Link copied to clipboard
open class SquareAnnotation : ShapeAnnotation
Represents a square rendered on the page.
Link copied to clipboard
open class SquigglyAnnotation : TextMarkupAnnotation
Represents a squiggly text underline on the page.
Link copied to clipboard
open class StampAnnotation : Annotation
Represents a stamp or annotationBitmap annotation on the page.
Link copied to clipboard
open class StrikeOutAnnotation : TextMarkupAnnotation
Represents a strike-out text on the page.
Link copied to clipboard
abstract class TextMarkupAnnotation : BaseRectsAnnotation
Abstract base-class of all text markup annotations: HighlightAnnotation, , UnderlineAnnotation and StrikeOutAnnotation.
Link copied to clipboard
open class UnderlineAnnotation : TextMarkupAnnotation
Represents underlined text on the page.
Link copied to clipboard
open class UnknownAnnotation : Annotation
Represents an annotation that is currently not recognised and handled by PSPDFKit.
Link copied to clipboard
enum VerticalTextAlignment
Possible values for the vertical alignment of the text.
Link copied to clipboard
open class WidgetAnnotation : LinkAnnotation
Represents the appearance of a field in interactive forms.