nutrient/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

Types

IconName

@Documented

@Retention(value = RetentionPolicy.SOURCE)

annotation class IconName

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

Properties

CHECK

val CHECK: String = "Check"

Note annotation icon: checkmark.

CIRCLE

val CIRCLE: String = "Circle"

Note annotation icon: circle shape.

COMMENT

val COMMENT: String = "Comment"

Note annotation icon: speech bubble for comments.

CROSS

val CROSS: String = "Cross"

Note annotation icon: X or cross shape.

HELP

val HELP: String = "Help"

Note annotation icon: question mark for help.

INSERT

val INSERT: String = "Insert"

Note annotation icon: caret for text insertion.

KEY

val KEY: String = "Key"

Note annotation icon: key shape.

NEW_PARAGRAPH

val NEW_PARAGRAPH: String = "NewParagraph"

Note annotation icon: new paragraph marker.

NOTE

val NOTE: String = "Note"

Note annotation icon: standard note icon.

PARAGRAPH

val PARAGRAPH: String = "Paragraph"

Note annotation icon: paragraph marker.

RIGHT_ARROW

val RIGHT_ARROW: String = "RightArrow"

Note annotation icon: arrow facing right.

RIGHT_POINTER

val RIGHT_POINTER: String = "RightPointer"

Note annotation icon: pointer arrow facing right.

STAR

val STAR: String = "Star"

Note annotation icon: star shape.

Functions

getCopy

open fun getCopy(): NoteAnnotation

Gets a copy of this annotation with the page index and object number reset.

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.