pspdfkit/com.pspdfkit.annotations/NoteAnnotation

NoteAnnotation

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

Constructors

constructor(@IntRange(from = 0) pageIndex: Int, @NonNull annotationRect: RectF, @NonNull contents: String, @Nullable iconName: String)

Creates a new note annotation

constructor(@NonNull properties: AnnotationPropertyMap, markDirty: Boolean)

Intended for internal usage only.

Types

IconName

@Documented

@Retention(value = RetentionPolicy.SOURCE)

annotation class IconName

Denotes that a parameter must belong to on of these strings defined in : COMMENT, RIGHT_POINTER, RIGHT_ARROW, CHECK, CIRCLE, CROSS, INSERT, NEW_PARAGRAPH, NOTE, PARAGRAPH, HELP, STAR, KEY.

Properties

CHECK

val CHECK: String = "Check"

CIRCLE

val CIRCLE: String = "Circle"

COMMENT

val COMMENT: String = "Comment"

CROSS

val CROSS: String = "Cross"

HELP

val HELP: String = "Help"

INSERT

val INSERT: String = "Insert"

KEY

val KEY: String = "Key"

NEW_PARAGRAPH

val NEW_PARAGRAPH: String = "NewParagraph"

NOTE

val NOTE: String = "Note"

PARAGRAPH

val PARAGRAPH: String = "Paragraph"

RIGHT_ARROW

val RIGHT_ARROW: String = "RightArrow"

RIGHT_POINTER

val RIGHT_POINTER: String = "RightPointer"

STAR

val STAR: String = "Star"

Functions

getIconName

@NonNull

open fun getIconName(): String

Returns the name of the icon that should be displayed for this annotation.

getType

@NonNull

open fun getType(): AnnotationType

Gets the annotation type of the annotation.

isOpen

open fun isOpen(): Boolean

Checks if the popup of this annotation is opened.

isResizable

open fun isResizable(): Boolean

Always returns false, since note annotations are not resizable.

setIconName

open fun setIconName(@NoteAnnotation.IconName iconName: String)

Sets the name of the icon that should be displayed for this annotation.

updateTransformationProperties

open fun updateTransformationProperties(@NonNull newBoundingBox: RectF, @NonNull oldBoundingBox: RectF)

Annotations may override this method to transform their properties (i.e.