pspdfkit/com.pspdfkit.annotations/WidgetAnnotation

WidgetAnnotation

open class WidgetAnnotation : LinkAnnotation

Represents the appearance of a field in interactive forms. For form elements with text, the text color comes from the color property of Annotation. Use getFormElement to access associated FormElement.

See also

Constructors

Link copied to clipboard
constructor(@NonNull properties: AnnotationPropertyMap, markDirty: Boolean, @Nullable imageResourceId: String)
Intended for internal usage only
constructor(@IntRange(from = 0) pageIndex: Int, @NonNull boundingBox: RectF)
Intended for internal usage only

Properties

Link copied to clipboard
val FONT_SIZE_AUTO: Float = 0.0f
The font size value used by setFontSize and getFontSize to represent automatic font sizing of text form elements.

Functions

Link copied to clipboard
@Nullable
open fun getAdditionalAction(@NonNull triggerEvent: AnnotationTriggerEvent): Action
Returns the action that should be executed on annotation trigger event.
Link copied to clipboard
@Nullable
open fun getAdditionalActions(): Map<AnnotationTriggerEvent, Action>
Returns a map of additional actions keyed by their trigger events.
Link copied to clipboard
@ColorInt
open fun getBorderColor(): Int
Returns the border color of this annotation or Color#TRANSPARENT if no color is set.
Link copied to clipboard
@FloatRange(from = 0.0)
open fun getFontSize(): Float
Returns the font size of this widget annotation in PDF points.
Link copied to clipboard
@Nullable
open fun getFormElement(): FormElement
Returns a form element for widget annotation.
Link copied to clipboard
@NonNull
open fun getFormElementAsync(): Maybe<FormElement>
Returns a form element for widget annotation, asynchronously.
Link copied to clipboard
@NonNull
open fun getType(): AnnotationType
Gets the annotation type of the annotation.
Link copied to clipboard
@NonNull
open fun getVerticalTextAlignment(): VerticalTextAlignment
Returns the vertical text alignment used by this widget annotation.
Link copied to clipboard
open fun setAdditionalAction(@NonNull triggerEvent: AnnotationTriggerEvent, @Nullable action: Action)
Sets the action that should be executed for the given annotation trigger event.
Link copied to clipboard
open fun setBorderColor(@ColorInt color: Int)
Sets the border color for this annotation.
Link copied to clipboard
open fun setFontSize(fontSize: Float)
Sets the font size for this widget annotation in PDF points.
Link copied to clipboard
open fun setVerticalTextAlignment(@NonNull verticalAlignment: VerticalTextAlignment)
Sets the vertical text alignment to use in this widget annotation.