Added in API level 35
Also in S Extensions 13

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

PdfPageTextContent

---

Kotlin |Java

public final class PdfPageTextContent
extends Object implements Parcelable

java.lang.Object
↳	android.graphics.pdf.content.PdfPageTextContent

---

Represents a continuous stream of text in a page of a PDF document in the order of viewing.

Summary

Inherited constants

From interface android.os.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(Parcel, int): 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 Creator<PdfPageTextContent>	CREATOR

Public constructors
PdfPageTextContent(String text) Creates a new instance of PdfPageTextContent using the raw text on the page of the document.
PdfPageTextContent(String text, List<RectF> bounds) Creates a new instance of PdfPageTextContent to represent text content within defined bounds represented by a non-empty list of RectF on the page of the document.

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
List<RectF>	getBounds() Gets the bounds for the text content represented as a list of RectF.
String	getText() Gets the text content on the document.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(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 wait(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 wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 35
Also in S Extensions 13

public static final Creator<PdfPageTextContent> CREATOR

Public constructors

PdfPageTextContent

Added in API level 35
Also in S Extensions 13

public PdfPageTextContent (String text)

Creates a new instance of PdfPageTextContent using the raw text on the page of the document. By default, the bounds will be an empty list.

Parameters
text	String: Text content on the page. This value cannot be null.

Throws
NullPointerException	If text is null.

PdfPageTextContent

Added in API level 35
Also in S Extensions 13

public PdfPageTextContent (String text, 
                List<RectF> bounds)

Creates a new instance of PdfPageTextContent to represent text content within defined bounds represented by a non-empty list of RectF on the page of the document.

Parameters
text	String: Text content within the bounds. This value cannot be null.
bounds	List: Bounds for the text content This value cannot be null.

Throws
NullPointerException	If text or bounds is null.

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 ()

Gets the bounds for the text content represented as a list of RectF. Each RectF represents text content in a single line defined in points (1/72") for its 4 corners. Content spread across multiple lines is represented by list of RectF in the order of viewing (left to right and top to bottom). If the text content is unbounded then the list will be empty.

Returns
List<RectF>	The bounds of the text content. This value cannot be null.

getText

Added in API level 35
Also in S Extensions 13

public String getText ()

Gets the text content on the document.

Returns
String	The text content on the page. This value cannot be null.

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