NoteAnnotation

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

Constructors

Link copied to clipboard
constructor(@IntRange(from = 0) pageIndex: Int, @NonNull annotationRect: RectF, @NonNull contents: String, @Nullable iconName: String)
Creates a new note annotation
constructor(@NonNull properties: AnnotationPropertyManager, markDirty: Boolean)
Intended for internal usage only.

Types

Link copied to clipboard
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

Link copied to clipboard
val CHECK: String = "Check"
Link copied to clipboard
val CIRCLE: String = "Circle"
Link copied to clipboard
val COMMENT: String = "Comment"
Link copied to clipboard
val CROSS: String = "Cross"
Link copied to clipboard
val HELP: String = "Help"
Link copied to clipboard
val INSERT: String = "Insert"
Link copied to clipboard
val KEY: String = "Key"
Link copied to clipboard
val NEW_PARAGRAPH: String = "NewParagraph"
Link copied to clipboard
val NOTE: String = "Note"
Link copied to clipboard
val PARAGRAPH: String = "Paragraph"
Link copied to clipboard
val RIGHT_ARROW: String = "RightArrow"
Link copied to clipboard
val RIGHT_POINTER: String = "RightPointer"
Link copied to clipboard
val STAR: String = "Star"

Functions

Link copied to clipboard
Returns the name of the icon that should be displayed for this annotation.
Link copied to clipboard
Gets the annotation type of the annotation.
Link copied to clipboard
open fun isOpen(): Boolean
Checks if the popup of this annotation is opened.
Link copied to clipboard
open fun isResizable(): Boolean
Always returns false, since note annotations are not resizable.
Link copied to clipboard
Sets the name of the icon that should be displayed for this annotation.
Link copied to clipboard
open fun updateTransformationProperties(@NonNull newBoundingBox: RectF, @NonNull oldBoundingBox: RectF)
Annotations may override this method to transform their properties (i.e.