FormWidgetInfo


class FormWidgetInfo : Parcelable
kotlin.Any
   ↳ android.graphics.pdf.models.FormWidgetInfo

Information about a form widget of a PDF document.

Summary

Nested classes

Builder for FormWidgetInfo

Constants
static Int

Represents a checkbox type form widget

static Int

Represents a combobox type form widget

static Int

Represents a listbox type form widget

static Int

Represents a push button type form widget

static Int

Represents a radio button type form widget

static Int

Represents a signature type form widget

static Int

Represents a text field type form widget

static Int

Represents a form widget type that is unknown

Inherited constants
Public methods
Int

Boolean
equals(other: Any?)

String?

Returns the field's accessibility label, if present

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.

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.

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.

String?

Returns the field's text value, if present

Int

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

Rect

Returns the Rect in page coordinates occupied by the widget

Int

Returns the type of this widget

Int

Boolean

Returns true if the widget is editable text

Boolean

Returns true if the widget supports multiple lines of text input

Boolean

Returns true if the widget supports selecting multiple values

Boolean

Returns true if the widget is read-only

String

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<FormWidgetInfo!>

Constants

WIDGET_TYPE_CHECKBOX

static val WIDGET_TYPE_CHECKBOX: Int

Represents a checkbox type form widget

Value: 2

WIDGET_TYPE_COMBOBOX

static val WIDGET_TYPE_COMBOBOX: Int

Represents a combobox type form widget

Value: 4

WIDGET_TYPE_LISTBOX

static val WIDGET_TYPE_LISTBOX: Int

Represents a listbox type form widget

Value: 5

WIDGET_TYPE_PUSHBUTTON

static val WIDGET_TYPE_PUSHBUTTON: Int

Represents a push button type form widget

Value: 1

WIDGET_TYPE_RADIOBUTTON

static val WIDGET_TYPE_RADIOBUTTON: Int

Represents a radio button type form widget

Value: 3

WIDGET_TYPE_SIGNATURE

static val WIDGET_TYPE_SIGNATURE: Int

Represents a signature type form widget

Value: 7

WIDGET_TYPE_TEXTFIELD

static val WIDGET_TYPE_TEXTFIELD: Int

Represents a text field type form widget

Value: 6

WIDGET_TYPE_UNKNOWN

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

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

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 0f or greater

getListItems

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

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

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

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

fun getWidgetRect(): Rect

Returns the Rect in page coordinates occupied by the widget

Return
Rect This value cannot be null.

hashCode

Added in API level 35
fun hashCode(): Int
Return
Int a hash code value for this object.

isEditableText

fun isEditableText(): Boolean

Returns true if the widget is editable text

isMultiLineText

fun isMultiLineText(): Boolean

Returns true if the widget supports multiple lines of text input

isMultiSelect

fun isMultiSelect(): Boolean

Returns true if the widget supports selecting multiple values

isReadOnly

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

static val CREATOR: Parcelable.Creator<FormWidgetInfo!>