FormEditInfo

Kotlin |Java

class FormEditInfo : Parcelable

Record of a form filling operation that has been executed on a single form field in a PDF. Contains the minimum amount of data required to replicate the action on the form.

See also
`a href="https://opensource.adobe.com/dc-acrobat-sdk-docs/pdfstandards/PDF32000_2008.pdf"`	PDF 32000-1:2008

Summary

Constants
`const Int`	`EDIT_TYPE_CLICK = 0` Indicates a click on a clickable form widget
`const Int`	`EDIT_TYPE_SET_INDICES = 1` Represents setting indices on a combobox or listbox form widget
`const Int`	`EDIT_TYPE_SET_TEXT = 2` Represents setting text on a text field or editable combobox form widget

Public companion functions
`FormEditInfo`	`createClick(widgetIndex: @IntRange(from = 0) Int, clickPoint: PdfPoint)` Create a FormEditInfo object of type `EDIT_TYPE_CLICK`
`FormEditInfo`	`createSetIndices( pageNumber: @IntRange(from = 0) Int, widgetIndex: @IntRange(from = 0) Int, selectedIndices: IntArray )` Create a FormEditInfo object of type `EDIT_TYPE_SET_INDICES`
`FormEditInfo`	`createSetText( pageNumber: @IntRange(from = 0) Int, widgetIndex: @IntRange(from = 0) Int, text: String )` Create a FormEditInfo object of type `EDIT_TYPE_SET_TEXT`

Public companion properties
`Parcelable.Creator<FormEditInfo>`	`CREATOR`

Public functions
`open Int`	`describeContents()`
`open operator Boolean`	`equals(other: Any?)`
`Int`	`getSelectedIndexAt(index: Int)` Returns the index of the selected item in the list `FormWidgetInfo.listItems` at the given `index` in the list of selected indices.
`open Int`	`hashCode()`
`open Unit`	`writeToParcel(dest: Parcel, flags: Int)`

Public properties
`PdfPoint?`	`clickPoint`
`Int`	`pageNumber` Represents the page number on which the edit occurred
`Int`	`selectedIndexCount` Returns the count of the selected items.
`String?`	`text`
`Int`	`type`
`Int`	`widgetIndex` Represents the index of the widget that was edited.

Constants

EDIT_TYPE_CLICK

const val EDIT_TYPE_CLICK = 0: Int

Indicates a click on a clickable form widget

EDIT_TYPE_SET_INDICES

const val EDIT_TYPE_SET_INDICES = 1: Int

Represents setting indices on a combobox or listbox form widget

EDIT_TYPE_SET_TEXT

const val EDIT_TYPE_SET_TEXT = 2: Int

Represents setting text on a text field or editable combobox form widget

Public companion functions

createClick

Added in 1.0.0-beta01

fun createClick(widgetIndex: @IntRange(from = 0) Int, clickPoint: PdfPoint): FormEditInfo

Create a FormEditInfo object of type EDIT_TYPE_CLICK

Parameters
`widgetIndex: @IntRange(from = 0) Int`	The index of the widget that was edited.
`clickPoint: PdfPoint`	The point on the `pageNumber` in PDF coordinates where the click occurred. Note: The origin exists at the top left corner of the page.

createSetIndices

Added in 1.0.0-beta01

fun createSetIndices(
    pageNumber: @IntRange(from = 0) Int,
    widgetIndex: @IntRange(from = 0) Int,
    selectedIndices: IntArray
): FormEditInfo

Create a FormEditInfo object of type EDIT_TYPE_SET_INDICES

Parameters
`pageNumber: @IntRange(from = 0) Int`	The page number on which the edit occurred.
`widgetIndex: @IntRange(from = 0) Int`	The index of the widget that was edited.
`selectedIndices: IntArray`	The indices of the selected items from `FormWidgetInfo.listItems`

createSetText

Added in 1.0.0-beta01

fun createSetText(
    pageNumber: @IntRange(from = 0) Int,
    widgetIndex: @IntRange(from = 0) Int,
    text: String
): FormEditInfo

Create a FormEditInfo object of type EDIT_TYPE_SET_TEXT

Parameters
`pageNumber: @IntRange(from = 0) Int`	The page number on which the edit occurred.
`widgetIndex: @IntRange(from = 0) Int`	The index of the widget that was edited.
`text: String`	The text to set on the widget.

Public companion properties

CREATOR

val CREATOR: Parcelable.Creator<FormEditInfo>

Public functions

describeContents

Added in 1.0.0-beta01

open fun describeContents(): Int

equals

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

getSelectedIndexAt

Added in 1.0.0-beta01

fun getSelectedIndexAt(index: Int): Int

Returns the index of the selected item in the list FormWidgetInfo.listItems at the given index in the list of selected indices.

Parameters
`index: Int`	The position of the selected index to retrieve, from 0 to `selectedIndexCount` - 1.

Returns
`Int`	The index of the selected item from the list `FormWidgetInfo.listItems`, returns -1 in case there is no selection or the index is invalid.

hashCode

open fun hashCode(): Int

writeToParcel

Added in 1.0.0-beta01

open fun writeToParcel(dest: Parcel, flags: Int): Unit

Public properties

clickPoint

Added in 1.0.0-beta01

val clickPoint: PdfPoint?

pageNumber

Added in 1.0.0-beta01

val pageNumber: Int

Represents the page number on which the edit occurred

selectedIndexCount

Added in 1.0.0-beta01

val selectedIndexCount: Int

Returns the count of the selected items.

See also
`createSetIndices`	'selectedIndices' in `FormEditInfo.createSetIndices`.

text

Added in 1.0.0-beta01

val text: String?

type

Added in 1.0.0-beta01

val type: Int

widgetIndex

Added in 1.0.0-beta01

val widgetIndex: Int

Represents the index of the widget that was edited.