Builder
class Builder
kotlin.Any | |
↳ | android.graphics.pdf.models.FormEditRecord.Builder |
Builder for FormEditRecord
Summary
Public constructors | |
---|---|
Creates a new instance. |
Public methods | |
---|---|
FormEditRecord |
build() Builds this record |
FormEditRecord.Builder |
setClickPoint(clickPoint: Point?) Sets the click point for this record |
FormEditRecord.Builder |
setSelectedIndices(selectedIndices: IntArray?) Sets the selected indices for this record |
FormEditRecord.Builder |
Sets the text for this record |
Public constructors
Builder
Builder(
type: Int,
pageNumber: Int,
widgetIndex: Int)
Creates a new instance.
Parameters | |
---|---|
type |
Int: the type of FormEditRecord to create Value is android.graphics.pdf.models.FormEditRecord#EDIT_TYPE_CLICK , android.graphics.pdf.models.FormEditRecord#EDIT_TYPE_SET_INDICES , or android.graphics.pdf.models.FormEditRecord#EDIT_TYPE_SET_TEXT |
pageNumber |
Int: the page number of which the record is Value is 0 or greater |
widgetIndex |
Int: the index of the widget within the page's "Annot" array in the PDF Value is 0 or greater |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if a negative page number or widget index is provided |
Public methods
build
fun build(): FormEditRecord
Builds this record
Return | |
---|---|
FormEditRecord |
This value cannot be null . |
Exceptions | |
---|---|
java.lang.NullPointerException |
if the click point is not provided for a click type record, if the selected indices are not provided for a set indices type record, or if the text is not provided for a set text type record |
setClickPoint
fun setClickPoint(clickPoint: Point?): FormEditRecord.Builder
Sets the click point for this record
Parameters | |
---|---|
clickPoint |
Point?: This value may be null . |
Return | |
---|---|
FormEditRecord.Builder |
This value cannot be null . |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if this is not a click type record |
setSelectedIndices
fun setSelectedIndices(selectedIndices: IntArray?): FormEditRecord.Builder
Sets the selected indices for this record
Parameters | |
---|---|
selectedIndices |
IntArray?: This value may be null . |
Return | |
---|---|
FormEditRecord.Builder |
This value cannot be null . |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if this is not a set indices type record |
setText
fun setText(text: String?): FormEditRecord.Builder
Sets the text for this record
Parameters | |
---|---|
text |
String?: This value may be null . |
Return | |
---|---|
FormEditRecord.Builder |
This value cannot be null . |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if this is not a set text type record |