nutrient/com.pspdfkit.annotations/StampAnnotation

StampAnnotation

open class StampAnnotation : Annotation

Represents a stamp or annotationBitmap annotation on the page.

Constructors

StampAnnotation

constructor(@IntRange(from = 0) pageIndex: Int, rect: RectF, compressedBitmap: ByteArray)

Creates a new stamp annotation with the passed bitmap as contents.

constructor(@IntRange(from = 0) pageIndex: Int, rect: RectF, bitmap: Bitmap)

Creates a new stamp annotation with the passed bitmap as contents.

constructor(@IntRange(from = 0) pageIndex: Int, rect: RectF, stampType: StampType?)

Creates a new standard stamp annotation.

constructor(@IntRange(from = 0) pageIndex: Int, rect: RectF, title: String)

Creates a new stamp with custom title.

Types

Companion

object Companion

Internal stamp type constants used by core.

Properties

bitmap

@get:Synchronized

val bitmap: Bitmap?

Returns a bitmap from this stamp annotation if there is any.

isUiRotationSupported

open override val isUiRotationSupported: Boolean

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

minimumSize

open override val minimumSize: Size

Returns the minimum size of the annotation.

rotation

var rotation: Int

The clockwise rotation of this stamp in degrees.

stampType

@set:Synchronized

var stampType: StampType?

Type of this stamp if it's one of the standard types listed in StampType, or null if the stamp uses a non-standard title.

subtitle

var subtitle: String?

Text in second line of the stamp if any is available.

title

var title: String?

Text in first line of the stamp if any is available.

type

open override val type: AnnotationType

Gets the annotation type of the annotation.

Functions

adjustBoundsForRotation

fun adjustBoundsForRotation()

This adjusts the annotations bounding box to the smallest possible size that will encompass the rotated annotations at it's default size.

hasBitmap

@Synchronized

fun hasBitmap(): Boolean

Checks whether annotation is an annotationBitmap annotation.

setBitmap

@Synchronized

fun setBitmap(bitmap: Bitmap)

@Synchronized

fun setBitmap(compressedBitmap: ByteArray)

Sets a custom bitmap for this stamp annotation.

setIsSignature

fun setIsSignature(isSignature: Boolean)

Sets whether this annotation is an electronic signature annotation.

setRotation

fun setRotation(rotation: Int, contentSize: Size)

Sets the rotation of this stamp. This will adjust the bounding box so rotating the annotation will cause the bounds to change.

fun setRotation(rotation: Int, adjustBounds: Boolean)

fun setRotation(rotation: Int, contentSize: Size, adjustBounds: Boolean)

Sets the rotation of this stamp.

toInstantJson

open override fun toInstantJson(): String

Produces Instant JSON representation of this annotation.

updateTransformationProperties

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.