PdfPageGotoLinkContent
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 | |
|---|---|
|
Represents the content associated with the destination where a goto link is directing |
|
| Inherited constants | |
|---|---|
| Public constructors | |
|---|---|
PdfPageGotoLinkContent(bounds: MutableList<RectF!>, destination: PdfPageGotoLinkContent.Destination)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 of a |
| PdfPageGotoLinkContent.Destination |
Gets the destination |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<PdfPageGotoLinkContent!> | |
Public constructors
PdfPageGotoLinkContent
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.IllegalArgumentException |
If the bounds list is empty. |
java.lang.NullPointerException |
If bounds or destination 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 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
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
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<PdfPageGotoLinkContent!>