# FormEditInfo

Artifact: [androidx.pdf:pdf-core](https://developer.android.com/jetpack/androidx/releases/pdf) [View Source](https://cs.android.com/search?q=file:androidx/pdf/models/FormEditInfo.kt+class:androidx.pdf.models.FormEditInfo) Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

*** ** * ** ***


```
public final class FormEditInfo implements Parcelable
```

<br />

*** ** * ** ***

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 |
|---|---|
| `https://developer.android.com/reference/androidx/pdf/models/<` | [PDF 32000-1:2008]("https://opensource.adobe.com/dc-acrobat-sdk-docs/pdfstandards/PDF32000_2008.pdf") |

## Summary

| ### Constants |
|---|---|
| `static final int` | `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#EDIT_TYPE_CLICK() = 0` Indicates a click on a clickable form widget |
| `static final int` | `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#EDIT_TYPE_SET_INDICES() = 1` Represents setting indices on a combobox or listbox form widget |
| `static final int` | `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#EDIT_TYPE_SET_TEXT() = 2` Represents setting text on a text field or editable combobox form widget |

| ### Public fields |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Parcelable.Creator.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/pdf/models/FormEditInfo>` | `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#CREATOR()` |

| ### Public methods |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/pdf/models/FormEditInfo` | `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#createClick(kotlin.Int,androidx.pdf.PdfPoint)( @https://developer.android.com/reference/androidx/annotation/IntRange(from = 0) int widgetIndex, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/pdf/PdfPoint clickPoint )` Create a FormEditInfo object of type `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#EDIT_TYPE_CLICK()` |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/pdf/models/FormEditInfo` | `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#createSetIndices(kotlin.Int,kotlin.Int,kotlin.IntArray)( @https://developer.android.com/reference/androidx/annotation/IntRange(from = 0) int pageNumber, @https://developer.android.com/reference/androidx/annotation/IntRange(from = 0) int widgetIndex, @https://developer.android.com/reference/androidx/annotation/NonNull int[] selectedIndices )` Create a FormEditInfo object of type `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#EDIT_TYPE_SET_INDICES()` |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/pdf/models/FormEditInfo` | `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#createSetText(kotlin.Int,kotlin.Int,kotlin.String)( @https://developer.android.com/reference/androidx/annotation/IntRange(from = 0) int pageNumber, @https://developer.android.com/reference/androidx/annotation/IntRange(from = 0) int widgetIndex, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html text )` Create a FormEditInfo object of type `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#EDIT_TYPE_SET_TEXT()` |
| `int` | `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#describeContents()()` |
| `boolean` | `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#equals(kotlin.Any)(https://developer.android.com/reference/java/lang/Object.html other)` |
| `final https://developer.android.com/reference/androidx/pdf/PdfPoint` | `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#getClickPoint()()` |
| `final int` | `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#getPageNumber()()` Represents the page number on which the edit occurred |
| `final int` | `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#getSelectedIndexAt(kotlin.Int)(int index)` Returns the index of the selected item in the list `https://developer.android.com/reference/androidx/pdf/models/FormWidgetInfo#listItems()` at the given `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#getSelectedIndexAt(kotlin.Int)` in the list of selected indices. |
| `final int` | `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#getSelectedIndexCount()()` Returns the count of the selected items. |
| `final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#getText()()` |
| `final int` | `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#getType()()` |
| `final int` | `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#getWidgetIndex()()` Represents the index of the widget that was edited. |
| `int` | `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#hashCode()()` |
| `void` | `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#writeToParcel(android.os.Parcel,kotlin.Int)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Parcel.html dest, int flags)` |

## Constants

### EDIT_TYPE_CLICK

```
public static final int EDIT_TYPE_CLICK = 0
```

Indicates a click on a clickable form widget

### EDIT_TYPE_SET_INDICES

```
public static final int EDIT_TYPE_SET_INDICES = 1
```

Represents setting indices on a combobox or listbox form widget

### EDIT_TYPE_SET_TEXT

```
public static final int EDIT_TYPE_SET_TEXT = 2
```

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

## Public fields

### CREATOR

```
public static final @NonNull Parcelable.Creator<@NonNull FormEditInfo> CREATOR
```

## Public methods

### createClick

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
public static final @NonNull FormEditInfo createClick(
    @IntRange(from = 0) int widgetIndex,
    @NonNull PdfPoint clickPoint
)
```

Create a FormEditInfo object of type `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#EDIT_TYPE_CLICK()`

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/IntRange(from = 0) int widgetIndex` | The index of the widget that was edited. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/pdf/PdfPoint clickPoint` | The point on the `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#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](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
public static final @NonNull FormEditInfo createSetIndices(
    @IntRange(from = 0) int pageNumber,
    @IntRange(from = 0) int widgetIndex,
    @NonNull int[] selectedIndices
)
```

Create a FormEditInfo object of type `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#EDIT_TYPE_SET_INDICES()`

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/IntRange(from = 0) int pageNumber` | The page number on which the edit occurred. |
| `@https://developer.android.com/reference/androidx/annotation/IntRange(from = 0) int widgetIndex` | The index of the widget that was edited. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull int[] selectedIndices` | The indices of the selected items from `https://developer.android.com/reference/androidx/pdf/models/FormWidgetInfo#listItems()` |

### createSetText

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
public static final @NonNull FormEditInfo createSetText(
    @IntRange(from = 0) int pageNumber,
    @IntRange(from = 0) int widgetIndex,
    @NonNull String text
)
```

Create a FormEditInfo object of type `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#EDIT_TYPE_SET_TEXT()`

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/IntRange(from = 0) int pageNumber` | The page number on which the edit occurred. |
| `@https://developer.android.com/reference/androidx/annotation/IntRange(from = 0) int widgetIndex` | The index of the widget that was edited. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html text` | The text to set on the widget. |

### describeContents

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
public int describeContents()
```

### equals

```
public boolean equals(Object other)
```

### getClickPoint

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
public final PdfPoint getClickPoint()
```

### getPageNumber

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
public final int getPageNumber()
```

Represents the page number on which the edit occurred

### getSelectedIndexAt

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
public final int getSelectedIndexAt(int index)
```

Returns the index of the selected item in the list `https://developer.android.com/reference/androidx/pdf/models/FormWidgetInfo#listItems()` at the given `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#getSelectedIndexAt(kotlin.Int)` in the list of selected indices.

| Parameters |
|---|---|
| `int index` | The position of the selected index to retrieve, from 0 to `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#selectedIndexCount()` - 1. |

| Returns |
|---|---|
| `int` | The index of the selected item from the list `https://developer.android.com/reference/androidx/pdf/models/FormWidgetInfo#listItems()`, returns -1 in case there is no selection or the index is invalid. |

### getSelectedIndexCount

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
public final int getSelectedIndexCount()
```

Returns the count of the selected items.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#createSetIndices(kotlin.Int,kotlin.Int,kotlin.IntArray)` | 'selectedIndices' in `https://developer.android.com/reference/androidx/pdf/models/FormEditInfo#createSetIndices(kotlin.Int,kotlin.Int,kotlin.IntArray)`. |

### getText

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
public final String getText()
```

### getType

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
public final int getType()
```

### getWidgetIndex

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
public final int getWidgetIndex()
```

Represents the index of the widget that was edited.

### hashCode

```
public int hashCode()
```

### writeToParcel

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
public void writeToParcel(@NonNull Parcel dest, int flags)
```