Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions) Summary: [Nested Classes](https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#nestedclasses) \| [Constants](https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#constants) \| [Inherited Constants](https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#inhconstants) \| [Fields](https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#lfields) \| [Methods](https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#inhmethods)

# FormWidgetInfo

*** ** * ** ***


`
public

final

class
FormWidgetInfo
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/android/os/Parcelable


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.graphics.pdf.models.FormWidgetInfo |

<br />

*** ** * ** ***

Information about a form widget of a PDF document.
**See also:**

- [PDF
  32000-1:2008](https://opensource.adobe.com/dc-acrobat-sdk-docs/pdfstandards/PDF32000_2008.pdf)

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo.Builder` Builder for `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo` |

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#WIDGET_TYPE_CHECKBOX` Represents a checkbox type form widget |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#WIDGET_TYPE_COMBOBOX` Represents a combobox type form widget |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#WIDGET_TYPE_LISTBOX` Represents a listbox type form widget |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#WIDGET_TYPE_PUSHBUTTON` Represents a push button type form widget |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#WIDGET_TYPE_RADIOBUTTON` Represents a radio button type form widget |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#WIDGET_TYPE_SIGNATURE` Represents a signature type form widget |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#WIDGET_TYPE_TEXTFIELD` Represents a text field type form widget |
| `int` | `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#WIDGET_TYPE_UNKNOWN` Represents a form widget type that is unknown |

| ### Inherited constants |
|---|
| From interface `https://developer.android.com/reference/android/os/Parcelable` |---|---| | `int` | `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo>` | `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#CREATOR` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#getAccessibilityLabel()() ` Returns the field's accessibility label, if present **Note:** Comes from the "TU" value in the annotation dictionary, if present, or else the "T" value. |
| ` float` | ` https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#getFontSize()() ` Returns the font size in pixels for text input, or 0 for text inputs without a specified font size and widgets that are not text inputs. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/graphics/pdf/models/ListItem>` | ` https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#getListItems()() ` Returns the list of choice options in the order that it was passed in, or an empty list for widgets without choice options. |
| ` int` | ` https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#getMaxLength()() ` Returns the maximum length of text supported by a text input widget, or -1 for text inputs without a maximum length and widgets that are not text inputs. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#getTextValue()() ` Returns the field's text value, if present **Note:** Comes from the "V" value in the annotation dictionary. |
| ` int` | ` https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#getWidgetIndex()() ` Returns the index of the widget within the page's "Annot" array in the PDF document |
| ` https://developer.android.com/reference/android/graphics/Rect` | ` https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#getWidgetRect()() ` Returns the `https://developer.android.com/reference/android/graphics/Rect` in page coordinates occupied by the widget |
| ` int` | ` https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#getWidgetType()() ` Returns the type of this widget |
| ` int` | ` https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#hashCode()() ` Returns a hash code value for the object. |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#isEditableText()() ` Returns `true` if the widget is editable text |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#isMultiLineText()() ` Returns true if the widget supports multiple lines of text input |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#isMultiSelect()() ` Returns `true` if the widget supports selecting multiple values |
| ` boolean` | ` https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#isReadOnly()() ` Returns `true` if the widget is read-only |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

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

## Constants

### WIDGET_TYPE_CHECKBOX

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public static final int WIDGET_TYPE_CHECKBOX
```

Represents a checkbox type form widget

<br />

Constant Value:

2
(0x00000002)


### WIDGET_TYPE_COMBOBOX

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public static final int WIDGET_TYPE_COMBOBOX
```

Represents a combobox type form widget

<br />

Constant Value:

4
(0x00000004)


### WIDGET_TYPE_LISTBOX

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public static final int WIDGET_TYPE_LISTBOX
```

Represents a listbox type form widget

<br />

Constant Value:

5
(0x00000005)


### WIDGET_TYPE_PUSHBUTTON

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public static final int WIDGET_TYPE_PUSHBUTTON
```

Represents a push button type form widget

<br />

Constant Value:

1
(0x00000001)


### WIDGET_TYPE_RADIOBUTTON

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public static final int WIDGET_TYPE_RADIOBUTTON
```

Represents a radio button type form widget

<br />

Constant Value:

3
(0x00000003)


### WIDGET_TYPE_SIGNATURE

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public static final int WIDGET_TYPE_SIGNATURE
```

Represents a signature type form widget

<br />

Constant Value:

7
(0x00000007)


### WIDGET_TYPE_TEXTFIELD

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public static final int WIDGET_TYPE_TEXTFIELD
```

Represents a text field type form widget

<br />

Constant Value:

6
(0x00000006)


### WIDGET_TYPE_UNKNOWN

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public static final int WIDGET_TYPE_UNKNOWN
```

Represents a form widget type that is unknown

<br />

Constant Value:

0
(0x00000000)


## Fields

### CREATOR

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public static final Creator<FormWidgetInfo> CREATOR
```

<br />

<br />

## Public methods

### describeContents

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`,
the return value of this method must include the
`https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### equals

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

| Parameters ||
|---|---|
| `obj` | `Object`: the reference object with which to compare. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getAccessibilityLabel

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public String getAccessibilityLabel ()
```

Returns the field's accessibility label, if present

**Note:** Comes from the "TU" value in the annotation dictionary, if present,
or else the "T" value. See PDF Spec 1.7 Table 8.69

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value may be `null`. <br /> |

### getFontSize

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public float getFontSize ()
```

Returns the font size in pixels for text input, or 0 for text inputs without a specified font
size and widgets that are not text inputs.

<br />

| Returns ||
|---|---|
| `float` | Value is 0.0f or greater <br /> |

### getListItems

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public List<ListItem> getListItems ()
```

Returns the list of choice options in the order that it was passed in, or an empty list for
widgets without choice options.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/graphics/pdf/models/ListItem>` | This value cannot be `null`. <br /> |

### getMaxLength

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public int getMaxLength ()
```

Returns the maximum length of text supported by a text input widget, or -1 for text inputs
without a maximum length and widgets that are not text inputs.

<br />

| Returns ||
|---|---|
| `int` | Value is -1 or greater <br /> |

### getTextValue

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public String getTextValue ()
```

Returns the field's text value, if present

**Note:** Comes from the "V" value in the annotation dictionary. See [PDF
Spec 1.7 Table 8.69](https://opensource.adobe.com/dc-acrobat-sdk-docs/pdfstandards/pdfreference1.7old
.pdf)
Table 8.69

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value may be `null`. <br /> |

### getWidgetIndex

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public int getWidgetIndex ()
```

Returns the index of the widget within the page's "Annot" array in the PDF document

<br />

| Returns ||
|---|---|
| `int` | Value is 0 or greater <br /> |

### getWidgetRect

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public Rect getWidgetRect ()
```

Returns the `https://developer.android.com/reference/android/graphics/Rect` in page coordinates occupied by the widget

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/graphics/Rect` | This value cannot be `null`. <br /> |

### getWidgetType

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public int getWidgetType ()
```

Returns the type of this widget

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#WIDGET_TYPE_UNKNOWN` - `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#WIDGET_TYPE_PUSHBUTTON` - `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#WIDGET_TYPE_CHECKBOX` - `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#WIDGET_TYPE_RADIOBUTTON` - `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#WIDGET_TYPE_COMBOBOX` - `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#WIDGET_TYPE_LISTBOX` - `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#WIDGET_TYPE_TEXTFIELD` - `https://developer.android.com/reference/android/graphics/pdf/models/FormWidgetInfo#WIDGET_TYPE_SIGNATURE` |

### hashCode

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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
`https://developer.android.com/reference/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 `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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### isEditableText

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public boolean isEditableText ()
```

Returns `true` if the widget is editable text

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### isMultiLineText

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public boolean isMultiLineText ()
```

Returns true if the widget supports multiple lines of text input

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### isMultiSelect

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public boolean isMultiSelect ()
```

Returns `true` if the widget supports selecting multiple values

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### isReadOnly

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public boolean isReadOnly ()
```

Returns `true` if the widget is read-only

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### toString

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### writeToParcel

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |