PdfPageLinkContent


class PdfPageLinkContent : Parcelable
kotlin.Any
   ↳ android.graphics.pdf.content.PdfPageLinkContent

Represents the bounds and link on a page of the PDF document. Weblinks are those links implicitly embedded in PDF pages. Note: Only weblinks that are embedded will be supported. Links encoded as plain text will be returned as part of PdfPageTextContent.

Summary

Inherited constants
Public constructors

Creates a new instance of PdfPageLinkContent using the embedded Uri and the bounds of the uri.

Public methods
Int

MutableList<RectF!>

Gets the bounds of the embedded weblink represented as a list of RectF.

Uri

Gets the weblink on the page of the PDF document.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<PdfPageLinkContent!>

Public constructors

PdfPageLinkContent

PdfPageLinkContent(
    bounds: MutableList<RectF!>,
    uri: Uri)

Creates a new instance of PdfPageLinkContent using the embedded Uri and the bounds of the uri.

Parameters
bounds MutableList<RectF!>: Bounds which envelop the URI. This value cannot be null.
uri Uri: Uri embedded in the PDF document. This value cannot be null.
Exceptions
java.lang.NullPointerException If bounds or uri is null.
java.lang.IllegalArgumentException If the bounds list is empty.

Public methods

describeContents

Added in API level 35
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

getBounds

fun getBounds(): MutableList<RectF!>

Gets the bounds of the embedded weblink represented as a list of RectF. Links which are spread across multiple lines will be surrounded by multiple RectF in order of viewing.

Note: Each RectF represents a bound of the weblink in a single line and defines the coordinates of its 4 edges (left, top, right and bottom) in points (1/72"). The developer will need to render the highlighter as well as intercept the touch events for functionalities such as clicking the link.

Return
MutableList<RectF!> The bounds of the link. This value cannot be null.

getUri

fun getUri(): Uri

Gets the weblink on the page of the PDF document. Weblinks are those links implicitly embedded in PDF pages. Note: Only weblinks that are embedded will be supported. Links encoded as plain text will be returned as part of PdfPageTextContent.

Return
Uri The weblink embedded on the page. This value cannot be null.

writeToParcel

Added in API level 35
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 android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

static val CREATOR: Parcelable.Creator<PdfPageLinkContent!>