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 |
|
| 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 |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| 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 |
| Int |
Returns the type of this widget |
| Int |
hashCode()Returns a hash code value for the object. |
| Boolean |
Returns |
| Boolean |
Returns true if the widget supports multiple lines of text input |
| Boolean |
Returns |
| Boolean |
Returns |
| String |
toString()Returns a string representation of the object. |
| 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: 2WIDGET_TYPE_COMBOBOX
static val WIDGET_TYPE_COMBOBOX: Int
Represents a combobox type form widget
Value: 4WIDGET_TYPE_LISTBOX
static val WIDGET_TYPE_LISTBOX: Int
Represents a listbox type form widget
Value: 5WIDGET_TYPE_PUSHBUTTON
static val WIDGET_TYPE_PUSHBUTTON: Int
Represents a push button type form widget
Value: 1WIDGET_TYPE_RADIOBUTTON
static val WIDGET_TYPE_RADIOBUTTON: Int
Represents a radio button type form widget
Value: 3WIDGET_TYPE_SIGNATURE
static val WIDGET_TYPE_SIGNATURE: Int
Represents a signature type form widget
Value: 7WIDGET_TYPE_TEXTFIELD
static val WIDGET_TYPE_TEXTFIELD: Int
Represents a text field type form widget
Value: 6WIDGET_TYPE_UNKNOWN
static val WIDGET_TYPE_UNKNOWN: Int
Represents a form widget type that is unknown
Value: 0Public methods
describeContents
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
fun equals(other: Any?): Boolean
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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 |
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 0.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. |
getWidgetType
fun getWidgetType(): Int
Returns the type of this widget
| Return | |
|---|---|
Int |
Value is one of the following: |
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
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
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
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 the following:
|
Properties
CREATOR
static val CREATOR: Parcelable.Creator<FormWidgetInfo!>