FormEditRecord

Kotlin |Java

class FormEditRecord : Parcelable

kotlin.Any
↳	android.graphics.pdf.models.FormEditRecord

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.

Summary

Nested classes
	`Builder` Builder for `FormEditRecord`

Constants
static Int	`EDIT_TYPE_CLICK` Indicates a click on a clickable form widget
static Int	`EDIT_TYPE_SET_INDICES` Represents setting indices on a combobox or listbox form widget
static Int	`EDIT_TYPE_SET_TEXT` Represents setting text on a text field or editable combobox form widget

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)`
Point?	`getClickPoint()`
Int	`getPageNumber()`
IntArray	`getSelectedIndices()`
String?	`getText()`
Int	`getType()`
Int	`getWidgetIndex()`
Int	`hashCode()`
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<FormEditRecord!>	`CREATOR`

Constants

EDIT_TYPE_CLICK

Added in API level VanillaIceCream

static val EDIT_TYPE_CLICK: Int

Indicates a click on a clickable form widget

Value: 0

EDIT_TYPE_SET_INDICES

Added in API level VanillaIceCream

static val EDIT_TYPE_SET_INDICES: Int

Represents setting indices on a combobox or listbox form widget

Value: 1

EDIT_TYPE_SET_TEXT

Added in API level VanillaIceCream

static val EDIT_TYPE_SET_TEXT: Int

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

Value: 2

Public methods

describeContents

Added in API level VanillaIceCream

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level VanillaIceCream

fun equals(other: Any?): Boolean

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getClickPoint

Added in API level VanillaIceCream

fun getClickPoint(): Point?

Return
`Point?`	the point on which the user tapped, if this record is of type `EDIT_TYPE_CLICK`, else null

getPageNumber

Added in API level VanillaIceCream

fun getPageNumber(): Int

Return
`Int`	the page on which the edit occurred Value is 0 or greater

getSelectedIndices

Added in API level VanillaIceCream

fun getSelectedIndices(): IntArray

Return
`IntArray`	the selected indices in the choice widget, if this record is of type `EDIT_TYPE_SET_INDICES`, else an empty array This value cannot be `null`.

getText

Added in API level VanillaIceCream

fun getText(): String?

Return
`String?`	the text input by the user, if this record is of type `EDIT_TYPE_SET_TEXT`, else null

getType

Added in API level VanillaIceCream

fun getType(): Int

Return
`Int`	the type of the edit Value is `android.graphics.pdf.models.FormEditRecord#EDIT_TYPE_CLICK`, `android.graphics.pdf.models.FormEditRecord#EDIT_TYPE_SET_INDICES`, or `android.graphics.pdf.models.FormEditRecord#EDIT_TYPE_SET_TEXT`

getWidgetIndex

Added in API level VanillaIceCream

fun getWidgetIndex(): Int

Return
`Int`	the index of the widget within the page's "Annot" array in the PDF document Value is 0 or greater

hashCode

Added in API level VanillaIceCream

fun hashCode(): Int

Return
`Int`	a hash code value for this object.

writeToParcel

Added in API level VanillaIceCream

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

Flatten this object in to a Parcel.

Parameters
`dest`	Parcel: This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level VanillaIceCream

static val CREATOR: Parcelable.Creator<FormEditRecord!>