PageMatchBounds

Kotlin |Java

class PageMatchBounds : Parcelable

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

Represents the bounds of a single search match on a page of the PDF document.

Summary

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 constructors
`PageMatchBounds(bounds: MutableList<RectF!>, textStartIndex: Int)` Creates a new instance of `PageMatchBounds` for the text match found on the page.

Public methods
Int	`describeContents()`
MutableList<RectF!>	`getBounds()` Represents the `RectF` bounds of a match.
Int	`getTextStartIndex()` Gets the starting index of the match found on the page.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

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

Public constructors

PageMatchBounds

Added in API level VanillaIceCream

PageMatchBounds(
    bounds: MutableList<RectF!>, 
    textStartIndex: Int)

Creates a new instance of PageMatchBounds for the text match found on the page. The match is represented by bounds of the text match and the starting index of the character "stream" (0-based index).

Parameters
`bounds`	MutableList<RectF!>: Bounds of the text match. This value cannot be `null`.
`textStartIndex`	Int: starting index of the text match.

Exceptions
`java.lang.NullPointerException`	If bounds if null.
`java.lang.IllegalArgumentException`	If bounds list is empty or if the text starting index is negative.

Public methods

describeContents

Added in API level VanillaIceCream

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`

getBounds

Added in API level VanillaIceCream

fun getBounds(): MutableList<RectF!>

Represents the RectF bounds of a match. Matches which are spread across multiple lines will be represented by multiple RectF in order of viewing.

Note: The bounds only represent the coordinates of the bounds of a single line using RectF. The developer will need to render the highlighter as well as intercept the touch events for any additional UI interactions.

Return
`MutableList<RectF!>`	list of bounds for the match on the page. This value cannot be `null`.

getTextStartIndex

Added in API level VanillaIceCream

fun getTextStartIndex(): Int

Gets the starting index of the match found on the page. Characters in a page form a "stream" and inside the stream, each character has an index starting from 0.

Return
`Int`	the starting index of the match on the page.

writeToParcel

Added in API level VanillaIceCream

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 VanillaIceCream

static val CREATOR: Parcelable.Creator<PageMatchBounds!>