PdfPageGotoLinkContent
public
final
class
PdfPageGotoLinkContent
extends Object
implements
Parcelable
java.lang.Object | |
↳ | 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 | |
---|---|
class |
PdfPageGotoLinkContent.Destination
Represents the content associated with the destination where a goto link is directing |
Inherited constants | ||||
---|---|---|---|---|
|
Fields | |
---|---|
public
static
final
Creator<PdfPageGotoLinkContent> |
CREATOR
|
Public constructors | |
---|---|
PdfPageGotoLinkContent(List<RectF> bounds, PdfPageGotoLinkContent.Destination destination)
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 of a |
PdfPageGotoLinkContent.Destination
|
getDestination()
Gets the destination |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
|
Fields
CREATOR
public static final Creator<PdfPageGotoLinkContent> CREATOR
Public constructors
PdfPageGotoLinkContent
public PdfPageGotoLinkContent (List<RectF> bounds, PdfPageGotoLinkContent.Destination destination)
Creates a new instance of PdfPageGotoLinkContent
using the bounds of the goto link
and the destination where it is directing
Parameters | |
---|---|
bounds |
List : 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 . |
Throws | |
---|---|
NullPointerException |
If bounds or destination is null. |
IllegalArgumentException |
If the bounds list is empty. |
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 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.
getDestination
public PdfPageGotoLinkContent.Destination getDestination ()
Gets the destination Destination
of the PdfPageGotoLinkContent
.
Returns | |
---|---|
PdfPageGotoLinkContent.Destination |
Destination where goto link is directing the user.
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 |