FormWidgetInfo
public
final
class
FormWidgetInfo
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.graphics.pdf.models.FormWidgetInfo |
Information about a form widget of a PDF document.
See also:
Summary
Nested classes | |
---|---|
class |
FormWidgetInfo.Builder
Builder for |
Constants | |
---|---|
int |
WIDGET_TYPE_CHECKBOX
Represents a checkbox type form widget |
int |
WIDGET_TYPE_COMBOBOX
Represents a combobox type form widget |
int |
WIDGET_TYPE_LISTBOX
Represents a listbox type form widget |
int |
WIDGET_TYPE_PUSHBUTTON
Represents a push button type form widget |
int |
WIDGET_TYPE_RADIOBUTTON
Represents a radio button type form widget |
int |
WIDGET_TYPE_SIGNATURE
Represents a signature type form widget |
int |
WIDGET_TYPE_TEXTFIELD
Represents a text field type form widget |
int |
WIDGET_TYPE_UNKNOWN
Represents a form widget type that is unknown |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<FormWidgetInfo> |
CREATOR
|
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one. |
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. |
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. |
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. |
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 Note: Comes from the "V" value in the annotation dictionary. |
int
|
getWidgetIndex()
Returns the index of the widget within the page's "Annot" array in the PDF document |
Rect
|
getWidgetRect()
Returns the |
int
|
getWidgetType()
Returns the type of this widget |
int
|
hashCode()
Returns a hash code value for the object. |
boolean
|
isEditableText()
Returns |
boolean
|
isMultiLineText()
Returns true if the widget supports multiple lines of text input |
boolean
|
isMultiSelect()
Returns |
boolean
|
isReadOnly()
Returns |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Constants
WIDGET_TYPE_CHECKBOX
public static final int WIDGET_TYPE_CHECKBOX
Represents a checkbox type form widget
Constant Value: 2 (0x00000002)
WIDGET_TYPE_COMBOBOX
public static final int WIDGET_TYPE_COMBOBOX
Represents a combobox type form widget
Constant Value: 4 (0x00000004)
WIDGET_TYPE_LISTBOX
public static final int WIDGET_TYPE_LISTBOX
Represents a listbox type form widget
Constant Value: 5 (0x00000005)
WIDGET_TYPE_PUSHBUTTON
public static final int WIDGET_TYPE_PUSHBUTTON
Represents a push button type form widget
Constant Value: 1 (0x00000001)
WIDGET_TYPE_RADIOBUTTON
public static final int WIDGET_TYPE_RADIOBUTTON
Represents a radio button type form widget
Constant Value: 3 (0x00000003)
WIDGET_TYPE_SIGNATURE
public static final int WIDGET_TYPE_SIGNATURE
Represents a signature type form widget
Constant Value: 7 (0x00000007)
WIDGET_TYPE_TEXTFIELD
public static final int WIDGET_TYPE_TEXTFIELD
Represents a text field type form widget
Constant Value: 6 (0x00000006)
WIDGET_TYPE_UNKNOWN
public static final int WIDGET_TYPE_UNKNOWN
Represents a form widget type that is unknown
Constant Value: 0 (0x00000000)
Fields
CREATOR
public static final Creator<FormWidgetInfo> CREATOR
Public methods
describeContents
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 writeToParcel(android.os.Parcel, int)
,
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR
bit.
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled
by this Parcelable object instance.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
equals
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons 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 |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getAccessibilityLabel
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
Returns | |
---|---|
String |
This value may be null . |
getFontSize
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.
Returns | |
---|---|
float |
Value is 0f or greater |
getListItems
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.
Returns | |
---|---|
List<ListItem> |
This value cannot be null . |
getMaxLength
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.
Returns | |
---|---|
int |
Value is -1 or greater |
getTextValue
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 Table 8.69
Returns | |
---|---|
String |
This value may be null . |
getWidgetIndex
public int getWidgetIndex ()
Returns the index of the widget within the page's "Annot" array in the PDF document
Returns | |
---|---|
int |
Value is 0 or greater |
getWidgetRect
public Rect getWidgetRect ()
Returns the Rect
in page coordinates occupied by the widget
Returns | |
---|---|
Rect |
This value cannot be null . |
getWidgetType
public int getWidgetType ()
Returns the type of this widget
hashCode
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
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 inequals
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
equals
method, then calling thehashCode
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
equals
method, then calling thehashCode
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.
Returns | |
---|---|
int |
a hash code value for this object. |
isEditableText
public boolean isEditableText ()
Returns true
if the widget is editable text
Returns | |
---|---|
boolean |
isMultiLineText
public boolean isMultiLineText ()
Returns true if the widget supports multiple lines of text input
Returns | |
---|---|
boolean |
isMultiSelect
public boolean isMultiSelect ()
Returns true
if the widget supports selecting multiple values
Returns | |
---|---|
boolean |
isReadOnly
public boolean isReadOnly ()
Returns true
if the widget is read-only
Returns | |
---|---|
boolean |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the object. |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
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.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-06-18 UTC.