Added in API level 35
Also in S Extensions 13

FormWidgetInfo

Kotlin |Java

class FormWidgetInfo : Parcelable

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

Information about a form widget of a PDF document.

Summary

Nested classes
	`Builder` Builder for `FormWidgetInfo`

Constants
static Int	`WIDGET_TYPE_CHECKBOX` Represents a checkbox type form widget
static Int	`WIDGET_TYPE_COMBOBOX` Represents a combobox type form widget
static Int	`WIDGET_TYPE_LISTBOX` Represents a listbox type form widget
static Int	`WIDGET_TYPE_PUSHBUTTON` Represents a push button type form widget
static Int	`WIDGET_TYPE_RADIOBUTTON` Represents a radio button type form widget
static Int	`WIDGET_TYPE_SIGNATURE` Represents a signature type form widget
static Int	`WIDGET_TYPE_TEXTFIELD` Represents a text field type form widget
static Int	`WIDGET_TYPE_UNKNOWN` Represents a form widget type that is unknown

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?)`
String?	`getAccessibilityLabel()` Returns the field's accessibility label, if present
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.
MutableList<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.
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.
String?	`getTextValue()` Returns the field's text value, if present
Int	`getWidgetIndex()` Returns the index of the widget within the page's "Annot" array in the PDF document
Rect	`getWidgetRect()` Returns the `Rect` in page coordinates occupied by the widget
Int	`getWidgetType()` Returns the type of this widget
Int	`hashCode()`
Boolean	`isEditableText()` Returns `true` if the widget is editable text
Boolean	`isMultiLineText()` Returns true if the widget supports multiple lines of text input
Boolean	`isMultiSelect()` Returns `true` if the widget supports selecting multiple values
Boolean	`isReadOnly()` Returns `true` if the widget is read-only
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

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

Constants

WIDGET_TYPE_CHECKBOX

Added in API level 35
Also in S Extensions 13

static val WIDGET_TYPE_CHECKBOX: Int

Represents a checkbox type form widget

Value: 2

WIDGET_TYPE_COMBOBOX

Added in API level 35
Also in S Extensions 13

static val WIDGET_TYPE_COMBOBOX: Int

Represents a combobox type form widget

Value: 4

WIDGET_TYPE_LISTBOX

Added in API level 35
Also in S Extensions 13

static val WIDGET_TYPE_LISTBOX: Int

Represents a listbox type form widget

Value: 5

WIDGET_TYPE_PUSHBUTTON

Added in API level 35
Also in S Extensions 13

static val WIDGET_TYPE_PUSHBUTTON: Int

Represents a push button type form widget

Value: 1

WIDGET_TYPE_RADIOBUTTON

Added in API level 35
Also in S Extensions 13

static val WIDGET_TYPE_RADIOBUTTON: Int

Represents a radio button type form widget

Value: 3

WIDGET_TYPE_SIGNATURE

Added in API level 35
Also in S Extensions 13

static val WIDGET_TYPE_SIGNATURE: Int

Represents a signature type form widget

Value: 7

WIDGET_TYPE_TEXTFIELD

Added in API level 35
Also in S Extensions 13

static val WIDGET_TYPE_TEXTFIELD: Int

Represents a text field type form widget

Value: 6

WIDGET_TYPE_UNKNOWN

Added in API level 35
Also in S Extensions 13

static val WIDGET_TYPE_UNKNOWN: Int

Represents a form widget type that is unknown

Value: 0

Public methods

describeContents

Added in API level 35

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 35

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.

getAccessibilityLabel

Added in API level 35
Also in S Extensions 13

fun getAccessibilityLabel(): String?

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

Return
`String?`	This value may be `null`.

getFontSize

Added in API level 35
Also in S Extensions 13

fun getFontSize(): Float

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.

Return
`Float`	Value is 0.0f or greater

getListItems

Added in API level 35
Also in S Extensions 13

fun getListItems(): MutableList<ListItem!>

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

Return
`MutableList<ListItem!>`	This value cannot be `null`.

getMaxLength

Added in API level 35
Also in S Extensions 13

fun getMaxLength(): Int

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.

Return
`Int`	Value is -1 or greater

getTextValue

Added in API level 35
Also in S Extensions 13

fun getTextValue(): String?

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 Table 8.69

Return
`String?`	This value may be `null`.

getWidgetIndex

Added in API level 35
Also in S Extensions 13

fun getWidgetIndex(): Int

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

Return
`Int`	Value is 0 or greater

getWidgetRect

Added in API level 35
Also in S Extensions 13

fun getWidgetRect(): Rect

Returns the Rect in page coordinates occupied by the widget

Return
`Rect`	This value cannot be `null`.

getWidgetType

Added in API level 35
Also in S Extensions 13

fun getWidgetType(): Int

Returns the type of this widget

Return

Int Value is android.graphics.pdf.models.FormWidgetInfo#WIDGET_TYPE_UNKNOWN, android.graphics.pdf.models.FormWidgetInfo#WIDGET_TYPE_PUSHBUTTON, android.graphics.pdf.models.FormWidgetInfo#WIDGET_TYPE_CHECKBOX, android.graphics.pdf.models.FormWidgetInfo#WIDGET_TYPE_RADIOBUTTON, android.graphics.pdf.models.FormWidgetInfo#WIDGET_TYPE_COMBOBOX, android.graphics.pdf.models.FormWidgetInfo#WIDGET_TYPE_LISTBOX, android.graphics.pdf.models.FormWidgetInfo#WIDGET_TYPE_TEXTFIELD, or android.graphics.pdf.models.FormWidgetInfo#WIDGET_TYPE_SIGNATURE

Return
`Int`	Value is `android.graphics.pdf.models.FormWidgetInfo#WIDGET_TYPE_UNKNOWN`, `android.graphics.pdf.models.FormWidgetInfo#WIDGET_TYPE_PUSHBUTTON`, `android.graphics.pdf.models.FormWidgetInfo#WIDGET_TYPE_CHECKBOX`, `android.graphics.pdf.models.FormWidgetInfo#WIDGET_TYPE_RADIOBUTTON`, `android.graphics.pdf.models.FormWidgetInfo#WIDGET_TYPE_COMBOBOX`, `android.graphics.pdf.models.FormWidgetInfo#WIDGET_TYPE_LISTBOX`, `android.graphics.pdf.models.FormWidgetInfo#WIDGET_TYPE_TEXTFIELD`, or `android.graphics.pdf.models.FormWidgetInfo#WIDGET_TYPE_SIGNATURE`

hashCode

Added in API level 35

fun hashCode(): Int

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

isEditableText

Added in API level 35
Also in S Extensions 13

fun isEditableText(): Boolean

Returns true if the widget is editable text

isMultiLineText

Added in API level 35
Also in S Extensions 13

fun isMultiLineText(): Boolean

Returns true if the widget supports multiple lines of text input

isMultiSelect

Added in API level 35
Also in S Extensions 13

fun isMultiSelect(): Boolean

Returns true if the widget supports selecting multiple values

isReadOnly

Added in API level 35
Also in S Extensions 13

fun isReadOnly(): Boolean

Returns true if the widget is read-only

toString

Added in API level 35

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 35

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 35
Also in S Extensions 13

static val CREATOR: Parcelable.Creator<FormWidgetInfo!>