PageMatchBounds


public final class PageMatchBounds
extends Object implements Parcelable

java.lang.Object
   ↳ android.graphics.pdf.models.PageMatchBounds


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

Summary

Inherited constants

Fields

public static final Creator<PageMatchBounds> CREATOR

Public constructors

PageMatchBounds(List<RectF> bounds, int textStartIndex)

Creates a new instance of PageMatchBounds for the text match found on the page.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

List<RectF> getBounds()

Represents the RectF bounds of a match.

int getTextStartIndex()

Gets the starting index of the match found on the page.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 35
Also in S Extensions 13
public static final Creator<PageMatchBounds> CREATOR

Public constructors

PageMatchBounds

Added in API level 35
Also in S Extensions 13
public PageMatchBounds (List<RectF> bounds, 
                int textStartIndex)

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 List: Bounds of the text match. This value cannot be null.

textStartIndex int: starting index of the text match.

Throws
NullPointerException If bounds if null.
IllegalArgumentException If bounds list is empty or if the text starting index is negative.

Public methods

describeContents

Added in API level 35
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

getBounds

Added in API level 35
Also in S Extensions 13
public List<RectF> getBounds ()

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.

Returns
List<RectF> list of bounds for the match on the page. This value cannot be null.

getTextStartIndex

Added in API level 35
Also in S Extensions 13
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.

Returns
int the starting index of the match on the page.

writeToParcel

Added in API level 35
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