Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions) Summary: [Inherited Constants](https://developer.android.com/reference/android/graphics/pdf/models/PageMatchBounds#inhconstants) \| [Fields](https://developer.android.com/reference/android/graphics/pdf/models/PageMatchBounds#lfields) \| [Ctors](https://developer.android.com/reference/android/graphics/pdf/models/PageMatchBounds#pubctors) \| [Methods](https://developer.android.com/reference/android/graphics/pdf/models/PageMatchBounds#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/graphics/pdf/models/PageMatchBounds#inhmethods)

# PageMatchBounds

*** ** * ** ***

` public final class PageMatchBounds `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.graphics.pdf.models.PageMatchBounds |

<br />

*** ** * ** ***

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

## Summary

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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)`".

| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/graphics/pdf/models/PageMatchBounds>` | `https://developer.android.com/reference/android/graphics/pdf/models/PageMatchBounds#CREATOR` <br /> |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/graphics/pdf/models/PageMatchBounds#PageMatchBounds(java.util.List<android.graphics.RectF>,%20int)(https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/graphics/RectF> bounds, int textStartIndex) ` Creates a new instance of `https://developer.android.com/reference/android/graphics/pdf/models/PageMatchBounds` for the text match found on the page. |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/graphics/pdf/models/PageMatchBounds#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/graphics/RectF>` | ` https://developer.android.com/reference/android/graphics/pdf/models/PageMatchBounds#getBounds()() ` <br /> Represents the `https://developer.android.com/reference/android/graphics/RectF` bounds of a match. |
| ` int` | ` https://developer.android.com/reference/android/graphics/pdf/models/PageMatchBounds#getTextStartIndex()() ` Gets the starting index of the match found on the page. |
| ` void` | ` https://developer.android.com/reference/android/graphics/pdf/models/PageMatchBounds#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Fields

### CREATOR

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public static final Creator<PageMatchBounds> CREATOR
```

<br />

<br />

## Public constructors

### PageMatchBounds

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public PageMatchBounds (List<RectF> bounds, 
                int textStartIndex)
```

Creates a new instance of `https://developer.android.com/reference/android/graphics/pdf/models/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).

<br />

| Parameters ||
|---|---|
| `bounds` | `List`: Bounds of the text match. This value cannot be `null`. <br /> |
| `textStartIndex` | `int`: starting index of the text match. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | If bounds list is empty or if the text starting index is negative. |
| `https://developer.android.com/reference/java/lang/NullPointerException` | If bounds if null. |

## Public methods

### describeContents

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### getBounds

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public List<RectF> getBounds ()
```

<br />

Represents the `https://developer.android.com/reference/android/graphics/RectF` bounds of a match. Matches which are spread across multiple lines will be represented by multiple `https://developer.android.com/reference/android/graphics/RectF` in order of viewing.

**Note:** The bounds only represent the coordinates of the bounds of a single line using `https://developer.android.com/reference/android/graphics/RectF`. The developer will need to render the highlighter as well as intercept the touch events for any additional UI interactions.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/graphics/RectF>` | list of bounds for the match on the page. This value cannot be `null`. <br /> |

### getTextStartIndex

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [S Extensions 13](https://developer.android.com/sdkExtensions)

```
public int getTextStartIndex ()
```

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.

<br />

| Returns ||
|---|---|
| `int` | the starting index of the match on the page. <br /> |

### writeToParcel

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |