NoteAnnotation

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

Constructors

Link copied to clipboard
constructor(@IntRange(from = 0) pageIndex: Int, annotationRect: RectF, contents: String, iconName: String?)

Creates a new note annotation

Types

Link copied to clipboard
object Companion

Icon name constants for NoteAnnotation.

Link copied to clipboard
annotation class IconName

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

Properties

Link copied to clipboard

The name of the icon that should be displayed for this annotation. Defaults to NOTE when no value has been set.

Link copied to clipboard

Checks if the popup of this annotation is opened.

Link copied to clipboard
open override val isResizable: Boolean

Always returns false, since note annotations are not resizable.

Link copied to clipboard
open override val type: AnnotationType

Gets the annotation type of the annotation.

Functions

Link copied to clipboard
open override fun getCopy(): NoteAnnotation

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

Link copied to clipboard
open override fun updateTransformationProperties(newBoundingBox: RectF, oldBoundingBox: RectF)

Annotations may override this method to transform their properties (i.e. points, rects, sizes) whenever the bounding box of the annotation changed.