PdfPageGotoLinkContent

Kotlin |Java

class PdfPageGotoLinkContent : Parcelable

kotlin.Any
↳	android.graphics.pdf.content.PdfPageGotoLinkContent

Represents the content associated with a goto link on a page in the PDF document. Goto Link is an internal navigation link which directs the user to a different location within the same pdf document

Summary

Nested classes
	`Destination` Represents the content associated with the destination where a goto link is directing

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public constructors
`PdfPageGotoLinkContent(bounds: MutableList<RectF!>, destination: PdfPageGotoLinkContent.Destination)` Creates a new instance of `PdfPageGotoLinkContent` using the bounds of the goto link and the destination where it is directing

Public methods
Int	`describeContents()`
MutableList<RectF!>	`getBounds()` Gets the bounds of a `PdfPageGotoLinkContent` represented as a list of `RectF`.
PdfPageGotoLinkContent.Destination	`getDestination()` Gets the destination `Destination` of the `PdfPageGotoLinkContent`.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<PdfPageGotoLinkContent!>	`CREATOR`

Public constructors

PdfPageGotoLinkContent

Added in API level VanillaIceCream

PdfPageGotoLinkContent(
    bounds: MutableList<RectF!>, 
    destination: PdfPageGotoLinkContent.Destination)

Creates a new instance of PdfPageGotoLinkContent using the bounds of the goto link and the destination where it is directing

Parameters
`bounds`	MutableList<RectF!>: Bounds which envelop the goto link This value cannot be `null`.
`destination`	PdfPageGotoLinkContent.Destination: Destination where the goto link is directing This value cannot be `null`.

Exceptions
`java.lang.NullPointerException`	If bounds or destination is null.
`java.lang.IllegalArgumentException`	If the bounds list is empty.

Public methods

describeContents

Added in API level VanillaIceCream

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

Added in API level VanillaIceCream

fun getBounds(): MutableList<RectF!>

Gets the bounds of a PdfPageGotoLinkContent 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 goto link 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 goto link. This value cannot be `null`.

getDestination

Added in API level VanillaIceCream

fun getDestination(): PdfPageGotoLinkContent.Destination

Gets the destination Destination of the PdfPageGotoLinkContent.

Return
`PdfPageGotoLinkContent.Destination`	Destination where goto link is directing the user. This value cannot be `null`.

writeToParcel

Added in API level VanillaIceCream

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

Added in API level VanillaIceCream

static val CREATOR: Parcelable.Creator<PdfPageGotoLinkContent!>