Returns the border color of this annotation or Color.TRANSPARENT if no color is set. Note that alpha channel is not taken into account as per PDF specifications.

borderDashArray

var borderDashArray: List<Int>?

Returns currently set dash array or null if no pattern is set.

borderEffect

var borderEffect: BorderEffect

Returns the current border effect on the annotation or BorderEffect.NO_EFFECT if none is set.

borderEffectIntensity

@get:FloatRange(from = 0.0)

var borderEffectIntensity: Float

Returns the current border effect intensity. Valid only if the border effect is BorderEffect.CLOUDY. The value is suggested to be between 0 and 2 but other values are valid as well. Default value is 0.

borderStyle

open var borderStyle: BorderStyle

Returns the current border style on the annotation or BorderStyle.NONE if none is set.

borderWidth

var borderWidth: Float

Returns the border line width / thickness. For border to appear, color and style should be set via borderColor and borderStyle as well.

boundingBox

open var boundingBox: RectF

Position of this annotation on the page. The returned RectF is a copy, so changing its values won't update the annotation's bounds. Instead call boundingBox providing the altered rect to update the annotation.

color

@get:ColorInt

var color: Int

Returns a color associated with this annotation or Color.TRANSPARENT if no color is set. Note that alpha channel is not taken into account as per PDF specifications. This is the text color for FreeTextAnnotation and WidgetAnnotation. This is the stroke color for shapes.

contents

open var contents: String?

Returns text contents of the annotation. This is usually the displayed text for annotations that display text or accessibility label for annotations that don't.

createdDate

var createdDate: Date?

Returns the creation date of the annotation.

creator

var creator: String?

Returns the name of the creator of this annotation.

customData

var customData: JSONObject?

Sets custom data to the annotation. The contents of this property are saved to the document when saving.

fillAlpha

@get:FloatRange(from = 0.0, to = 1.0)

var fillAlpha: Float

Returns the fill alpha.

fillColor

@get:ColorInt

open var fillColor: Int

Returns a fill color associated with this object or Color.TRANSPARENT if no color is set. Note that alpha channel is not taken into account as per PDF specifications.

flags

open var flags: EnumSet<ERROR CLASS: Symbol not found for AnnotationFlags>

Annotation flags set. Changing returned EnumSet does not change annotation flags. Instead call flags to change annotation flags.

fontName

var fontName: String?

Gets/sets the font name for this annotation.

group

var group: String?

Returns the group string of the annotation. May be used to have multiple annotations that behave as single one, if their group string is equal. Only works within one page. This is a proprietary extension

hasLockedContents

val hasLockedContents: Boolean

Check if the annotation has locked contents - i.e. annotation content can't be modified.

instantRecordGroup

val instantRecordGroup: String?

Gets instant record group of the annotation, or null if this annotation is detached.

isAttached

val isAttached: Boolean

Tells whether this annotation is attached to a document.

isLocked

open val isLocked: Boolean

Check if the annotation is locked - i.e. annotation can't be deleted or modified (except contents).

isMeasurement

open val isMeasurement: Boolean

Returns true when the annotation is a measurement annotation. Measurement annotations can be:

isModified

val isModified: Boolean

Returns whether the annotation is modified or not.

isReply

val isReply: Boolean

Whether the annotations is a reply to another annotation.

isResizable

open val isResizable: Boolean

Check if the annotation is resizable, or if this is a non-resizable annotation.

isSignature

val isSignature: Boolean

Returns true when the annotation is a signature annotation. Annotations that can be signatures are InkAnnotation and StampAnnotation.

isUiRotationSupported

open val isUiRotationSupported: Boolean

Returns true if this Annotation can be rotated in the UI.

measurementInfo

val measurementInfo: MeasurementInfo?

Returns MeasurementInfo when the annotation is a measurement annotation (see isMeasurement), null if not.

minimumSize

open val minimumSize: ERROR CLASS: Symbol not found for Size

Returns the minimum size of the annotation.

modifiedDate

var modifiedDate: Date?

Returns the date when this annotation was last modified.

name

var name: String?

Returns the content of Title/Name field of this annotation. This can be used to globally identify the annotation. This property will be automatically set to a type 4 (pseudo random) UUID during annotation construction time.

objectNumber

val objectNumber: Int

The object number of this annotation inside the PDF document file. This method will only return a valid object number if this annotation is attached to a document (i.e. when isAttached returns true). If the annotation is not attached to any document, this method will return Annotation.OBJECT_NUMBER_NOT_SET.

pageIndex

val pageIndex: Int

The page number to which this annotation belongs. If the annotation is not attached to any document, this method will return Annotation.PAGE_NUMBER_NOT_SET.

richText

var richText: String?

Returns rich text contents of the annotation. This is text to be displayed in a pop-up for text markup annotations.

subject

var subject: String?

Returns the subject of this annotation.

textJustification

var textJustification: FreeTextAnnotation.FreeTextTextJustification

Returns/sets the text justification used by this free text annotation.

textSize

var textSize: Float

Returns/sets the text size for this annotation (in PDF points).

type

abstract val type: ERROR CLASS: Symbol not found for AnnotationType

Gets the annotation type of the annotation.

uuid

val uuid: String

A unique in-memory identifier for each annotation. Generated at runtime, therefore not persisted (in the PDF).

verticalTextAlignment

open var verticalTextAlignment: VerticalTextAlignment

Returns/sets the vertical text alignment used by this free text annotation.

Functions

attachBinaryInstantJsonAttachment

fun attachBinaryInstantJsonAttachment(dataProvider: ERROR CLASS: Symbol not found for DataProvider, mimeType: String?)

Attaches a binary instant JSON attachment to the annotation. Can later be fetched using fetchBinaryInstantJsonAttachment.

createTextBlock

fun Annotation.createTextBlock(document: PdfDocument, range: ERROR CLASS: Symbol not found for Range): ERROR CLASS: Symbol not found for TextBlock

Creates TextBlock from textual annotation.

equals

open operator override fun equals(other: Any?): Boolean

Compares this annotation with another object for equality. Two annotations are considered equal if they have the same UUID.

fetchBinaryInstantJsonAttachment

fun fetchBinaryInstantJsonAttachment(outputStream: OutputStream): String?

If this annotation has a binary instant JSON attachment, this will write it into the provided OutputStream.

generateAppearanceStream

@WorkerThread

fun generateAppearanceStream()

Regenerates the annotation's appearance stream if necessary.

generateAppearanceStreamAsync

fun generateAppearanceStreamAsync(): Completable

Regenerates the annotation's appearance stream if necessary.

getBoundingBox

fun getBoundingBox(rect: RectF?): RectF

Position of this annotation on the page. Changing bounding box does not change annotations bounds. Instead call boundingBox to change annotation bounds.

getCopy

fun getCopy(@IntRange(from = 0) pageIndex: Int): Annotation?

Creates a copy of this annotation that isn't attached to the document with the page index set to given index. If this type of annotation can't be copied this method will return null.

getInReplyTo

fun getInReplyTo(): Annotation?

Retrieves the annotation this annotation replies to, or null it this annotation is not a reply or the license doesn't support replies feature.

getInReplyToAsync

fun getInReplyToAsync(): Maybe<Annotation>

Retrieves the annotation this annotation replies to asynchronously. The response is emitted inside the RxJava's Maybe. It will contain the requested annotation if it exists, or be empty otherwise.

hasBinaryInstantJsonAttachment

fun hasBinaryInstantJsonAttachment(): Boolean

Checks if this annotation has a binary instant JSON attachment. For example, a stamp annotation with an image has one.

hasFlag

fun hasFlag(flag: ERROR CLASS: Symbol not found for AnnotationFlags): Boolean

Test annotation flag.

hashCode

open override fun hashCode(): Int

Returns a hash code value for this annotation based on its UUID.

hasSamePropertiesAs

fun hasSamePropertiesAs(other: Annotation): Boolean

Checks if this annotation has the same properties as another annotation, excluding identity properties like UUID, modified date, and name. This is useful for comparing annotations based on their visual and semantic content rather than their identity.

renderToBitmap

fun renderToBitmap(bitmap: Bitmap)

fun renderToBitmap(bitmap: Bitmap, configuration: AnnotationRenderConfiguration)

Renders the appearance of this annotation into the passed bitmap.

renderToBitmapAsync

fun renderToBitmapAsync(bitmap: Bitmap): Single<Bitmap>

fun renderToBitmapAsync(bitmap: Bitmap, configuration: AnnotationRenderConfiguration): Single<Bitmap>

Asynchronously renders the appearance of this annotation into the passed bitmap.

setInReplyTo

fun setInReplyTo(parentAnnotation: Annotation?)

Sets the annotation that this annotation replies to.

toInstantJson

open fun toInstantJson(): String

Produces Instant JSON representation of this annotation.

toString

open override fun toString(): String

Returns a string representation of this annotation including its type and properties.

updateTransformationProperties

abstract 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.