PdfPageTextContent
class PdfPageTextContent : Parcelable
| kotlin.Any | |
| ↳ | 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 | |
|---|---|
| Public constructors | |
|---|---|
PdfPageTextContent(text: String)Creates a new instance of |
|
PdfPageTextContent(text: String, bounds: MutableList<RectF!>)Creates a new instance of |
|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| MutableList<RectF!> |
Gets the bounds for the text content represented as a list of |
| String |
getText()Gets the text content on the document. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<PdfPageTextContent!> | |
Public constructors
PdfPageTextContent
PdfPageTextContent(text: String)
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. |
| Exceptions | |
|---|---|
java.lang.NullPointerException |
If text is null. |
PdfPageTextContent
PdfPageTextContent(
text: String,
bounds: MutableList<RectF!>)
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 |
MutableList<RectF!>: Bounds for the text content. This value cannot be null. |
| Exceptions | |
|---|---|
java.lang.NullPointerException |
If text or bounds is null. |
Public methods
describeContents
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
getBounds
fun getBounds(): MutableList<RectF!>
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.
| Return | |
|---|---|
MutableList<RectF!> |
The bounds of the text content. This value cannot be null. |
getText
fun getText(): String
Gets the text content on the document.
| Return | |
|---|---|
String |
The text content on the page. This value cannot be null. |
writeToParcel
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 the following:
|
Properties
CREATOR
static val CREATOR: Parcelable.Creator<PdfPageTextContent!>