Added in API level 35
Also in S Extensions 13

Summary: Nested Classes | Constants | Inherited Constants | Fields | Methods | Inherited Methods

FormEditRecord

---

Kotlin |Java

public final class FormEditRecord
extends Object implements Parcelable

java.lang.Object
↳	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.

See also:

• PDF 32000-1:2008

Summary

Nested classes
class	FormEditRecord.Builder Builder for FormEditRecord

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

Inherited constants

From interface android.os.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(Parcel, int): 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)".

Fields
public static final Creator<FormEditRecord>	CREATOR

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
Point	getClickPoint()
int	getPageNumber()
int[]	getSelectedIndices()
String	getText()
int	getType()
int	getWidgetIndex()
int	hashCode() Returns a hash code value for the object.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Constants

EDIT_TYPE_CLICK

Added in API level 35
Also in S Extensions 13

public static final int EDIT_TYPE_CLICK

Indicates a click on a clickable form widget

Constant Value: 0 (0x00000000)

EDIT_TYPE_SET_INDICES

Added in API level 35
Also in S Extensions 13

public static final int EDIT_TYPE_SET_INDICES

Represents setting indices on a combobox or listbox form widget

Constant Value: 1 (0x00000001)

EDIT_TYPE_SET_TEXT

Added in API level 35
Also in S Extensions 13

public static final int EDIT_TYPE_SET_TEXT

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

Constant Value: 2 (0x00000002)

Fields

CREATOR

Added in API level 35
Also in S Extensions 13

public static final Creator<FormEditRecord> CREATOR

Public methods

describeContents

Added in API level 35

public int describeContents ()

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.

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 35

public boolean equals (Object obj)

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 return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

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	Object: the reference object with which to compare.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

getClickPoint

Added in API level 35
Also in S Extensions 13

public Point getClickPoint ()

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

getPageNumber

Added in API level 35
Also in S Extensions 13

public int getPageNumber ()

Returns
int	the page on which the edit occurred Value is 0 or greater

getSelectedIndices

Added in API level 35
Also in S Extensions 13

public int[] getSelectedIndices ()

Returns
int[]	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 35
Also in S Extensions 13

public String getText ()

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

getType

Added in API level 35
Also in S Extensions 13

public int getType ()

Returns
int	the type of the edit Value is EDIT_TYPE_CLICK, EDIT_TYPE_SET_INDICES, or EDIT_TYPE_SET_TEXT

getWidgetIndex

Added in API level 35
Also in S Extensions 13

public int getWidgetIndex ()

Returns
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 35

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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 hashCode method must consistently return the same integer, provided no information used in equals comparisons 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 equals method, then calling the hashCode method 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 equals method, then calling the hashCode method 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.

Returns
int	a hash code value for this object.

writeToParcel

Added in API level 35

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES