FormWidgetInfo

const val WIDGET_TYPE_CHECKBOX = 2: Int

Represents a checkbox type form widget

const val WIDGET_TYPE_COMBOBOX = 4: Int

Represents a combobox type form widget

const val WIDGET_TYPE_LISTBOX = 5: Int

Represents a listbox type form widget

const val WIDGET_TYPE_PUSHBUTTON = 1: Int

Represents a push button type form widget

const val WIDGET_TYPE_RADIOBUTTON = 3: Int

Represents a radio button type form widget

const val WIDGET_TYPE_SIGNATURE = 7: Int

Represents a signature type form widget

const val WIDGET_TYPE_TEXTFIELD = 6: Int

Represents a text field type form widget

const val WIDGET_TYPE_UNKNOWN = 0: Int

Represents a form widget type that is unknown

fun createCheckbox(
    widgetIndex: @IntRange(from = 0) Int,
    widgetRect: Rect,
    textValue: String?,
    accessibilityLabel: String?,
    isReadOnly: Boolean
): FormWidgetInfo

Factory method for creating form widget of type WIDGET_TYPE_CHECKBOX.

fun createComboBox(
    widgetIndex: @IntRange(from = 0) Int,
    widgetRect: Rect,
    textValue: String?,
    accessibilityLabel: String?,
    isReadOnly: Boolean,
    isEditableText: Boolean,
    fontSize: @FloatRange(from = 0.0) Float,
    listItems: List<ListItem>
): FormWidgetInfo

Factory method for creating form widget of type WIDGET_TYPE_COMBOBOX.

fun createPushButton(
    widgetIndex: @IntRange(from = 0) Int,
    widgetRect: Rect,
    textValue: String?,
    accessibilityLabel: String?,
    isReadOnly: Boolean
): FormWidgetInfo

Factory method for creating form widget of type WIDGET_TYPE_PUSHBUTTON.

fun createRadioButton(
    widgetIndex: @IntRange(from = 0) Int,
    widgetRect: Rect,
    textValue: String?,
    accessibilityLabel: String?,
    isReadOnly: Boolean
): FormWidgetInfo

Factory method for creating form widget of type WIDGET_TYPE_RADIOBUTTON.

fun createSignature(
    widgetIndex: @IntRange(from = 0) Int,
    widgetRect: Rect,
    textValue: String?,
    accessibilityLabel: String?,
    isReadOnly: Boolean
): FormWidgetInfo

Factory method for creating form widget of type WIDGET_TYPE_SIGNATURE.

fun createTextField(
    widgetIndex: @IntRange(from = 0) Int,
    widgetRect: Rect,
    textValue: String?,
    accessibilityLabel: String?,
    isReadOnly: Boolean,
    isEditableText: Boolean,
    isMultiLineText: Boolean,
    maxLength: @IntRange(from = 0) Int,
    fontSize: @FloatRange(from = 0.0) Float
): FormWidgetInfo

Factory method for creating form widget of type WIDGET_TYPE_TEXTFIELD.

val accessibilityLabel: String?

The accessibility label for this widget, if present. Comes from the "TU" or "T" value in the annotation dictionary.

See PDF spec 1.7 Table 8.69

val fontSize: Float

The configured font size for a form widget that accepts text input (WIDGET_TYPE_COMBOBOX or WIDGET_TYPE_TEXTFIELD), or 0 for widgets this does not apply to.

val isEditableText: Boolean

True if this widget has editable text. Only applicable to WIDGET_TYPE_COMBOBOX or WIDGET_TYPE_TEXTFIELD. Defaults to 'false' for other widget types.

val isMultiLineText: Boolean

True if this widget supports multi-line text input. Only applicable to WIDGET_TYPE_TEXTFIELD. Defaults to 'false' for other widget types.

val isMultiSelect: Boolean

True if this widget supports selecting multiple ListItems. Only applicable to WIDGET_TYPE_LISTBOX. Defaults to 'false' for other widget types.

val isReadOnly: Boolean

True if this widget is read-only and accepts changes

val listItems: List<ListItem>

The set of choice options in a form widget of type WIDGET_TYPE_COMBOBOX or WIDGET_TYPE_LISTBOX, or an empty list for other widget types.

val maxLength: Int

The configured maximum text length for a form widget of type WIDGET_TYPE_TEXTFIELD), or -1 for widgets this does not apply to.

val textValue: String?

The text value of this widget, if present. Comes from the "V" value in the annotation dictionary.

See PDF spec 1.7 Table 8.69

val widgetIndex: Int

The index of this widget among all form widgets on the page

val widgetRect: Rect

The bounds of this widget in PDF coordinates

val widgetType: Int

The WidgetType of this widget