FormEditRecord
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 for |
|
| Constants | |
|---|---|
| static Int |
Indicates a click on a clickable form widget |
| static Int |
Represents setting indices on a combobox or listbox form widget |
| static Int |
Represents setting text on a text field or editable combobox form widget |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Point? | |
| Int | |
| IntArray | |
| String? |
getText() |
| Int |
getType() |
| Int | |
| Int |
hashCode()Returns a hash code value for the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<FormEditRecord!> | |
Constants
EDIT_TYPE_CLICK
static val EDIT_TYPE_CLICK: Int
Indicates a click on a clickable form widget
Value: 0EDIT_TYPE_SET_INDICES
static val EDIT_TYPE_SET_INDICES: Int
Represents setting indices on a combobox or listbox form widget
Value: 1EDIT_TYPE_SET_TEXT
static val EDIT_TYPE_SET_TEXT: Int
Represents setting text on a text field or editable combobox form widget
Value: 2Public methods
describeContents
fun describeContents(): Int
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| 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
fun getClickPoint(): Point?
| Return | |
|---|---|
Point? |
the point on which the user tapped, if this record is of type EDIT_TYPE_CLICK, else null |
getPageNumber
fun getPageNumber(): Int
| Return | |
|---|---|
Int |
the page on which the edit occurred. Value is 0 or greater |
getSelectedIndices
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
fun getText(): String?
| Return | |
|---|---|
String? |
the text input by the user, if this record is of type EDIT_TYPE_SET_TEXT, else null |
getWidgetIndex
fun getWidgetIndex(): Int
| Return | |
|---|---|
Int |
the index of the widget within the page's widget annotations array in the PDF document. Value is 0 or greater |
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
| Return | |
|---|---|
Int |
a hash code value for this object. |
writeToParcel
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 the following:
|
Properties
CREATOR
static val CREATOR: Parcelable.Creator<FormEditRecord!>