nutrient/com.pspdfkit.annotations/FreeTextAnnotation

FreeTextAnnotation

open class FreeTextAnnotation : Annotation

Represents a free text annotation on the page. The annotation’s text color comes from the color property of Annotation.

Constructors

FreeTextAnnotation

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

Creates a new FreeText annotation.

Types

object Companion

Constants for FreeTextAnnotation.

FreeTextAnnotationIntent

enum FreeTextAnnotationIntent : Enum<FreeTextAnnotation.FreeTextAnnotationIntent>

Possible styles of free text annotation.

FreeTextTextJustification

enum FreeTextTextJustification : Enum<FreeTextAnnotation.FreeTextTextJustification>

Possible values for the alignment of the text.

Properties

var callOutPoints: @JvmSuppressWildcards List<PointF>

The points used to describe the call out line.

open override 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.

open override var flags: EnumSet<AnnotationFlags>

Sets the annotation flags for this annotation. Since a FreeTextAnnotation with an intent of type FreeTextAnnotationIntent.FREE_TEXT_CALLOUT does not work with the AnnotationFlags.NOZOOM flag, we will remove it if it exists from the provided flags set.

var intent: FreeTextAnnotation.FreeTextAnnotationIntent

Type (also called intent) of the free text annotation.

open override val isResizable: Boolean

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

isUiRotationSupported

open override val isUiRotationSupported: Boolean

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

var lineEnd: LineEndType

The line end for the call out line.

open override val minimumSize: Size

Returns the minimum size of the annotation.

var rotation: Int

The clockwise rotation of this free text annotation in degrees.

var textInsets: EdgeInsets

The insets that are applied to the text. This describes the offset of the inner rect containing the text, to the bounding box.

textStrokeColor

var textStrokeColor: Int

Text stroke color of this annotation. For the main text color use Annotation.color.

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.

open override fun getCopy(): FreeTextAnnotation

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

placeCallOutPoints

fun FreeTextAnnotation.placeCallOutPoints()

Places the callout points in the same way the UI will place them based on user interaction.

resizeToFitText

fun FreeTextAnnotation.resizeToFitText(document: PdfDocument, widthScaleMode: ScaleMode, heightScaleMode: ScaleMode)

Resizes this free text annotation so the text fits inside its bounds.

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

Sets the rotation of this free text 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.