PdfPageTextContent
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 |
---|
Fields | |
---|---|
public
static
final
Creator<PdfPageTextContent> |
CREATOR
|
Public constructors | |
---|---|
PdfPageTextContent(String text)
Creates a new instance of |
|
PdfPageTextContent(String text, List<RectF> bounds)
Creates a new instance of |
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 |
String
|
getText()
Gets the text content on the document. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Fields
CREATOR
public static final Creator<PdfPageTextContent> CREATOR
Public constructors
PdfPageTextContent
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
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
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
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
public String getText ()
Gets the text content on the document.
Returns | |
---|---|
String |
The text content on the page.
This value cannot be null . |
writeToParcel
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 |