PdfPageLinkContent
public final class PdfPageLinkContent
extends Object implements Parcelable
| java.lang.Object | |
| ↳ | 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 |
|---|
Fields | |
|---|---|
public static final Creator<PdfPageLinkContent> | CREATOR
|
Public constructors | |
|---|---|
PdfPageLinkContent(List<RectF> bounds, Uri uri) 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 the embedded weblink represented as a list of |
Uri | getUri() Gets the weblink on the page of the PDF document. |
void | writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
Fields
CREATOR
public static final Creator<PdfPageLinkContent> CREATOR
Public constructors
PdfPageLinkContent
public PdfPageLinkContent (List<RectF> bounds, Uri uri)
Creates a new instance of PdfPageLinkContent using the embedded Uri and the bounds of the uri.
| Parameters | |
|---|---|
bounds | List: Bounds which envelop the URI. This value cannot be null. |
uri | Uri: Uri embedded in the PDF document. This value cannot be null. |
| Throws | |
|---|---|
NullPointerException | If bounds or uri 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 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.
| Returns | |
|---|---|
List<RectF> | The bounds of the link. This value cannot be null. |
getUri
public Uri getUri ()
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.
| Returns | |
|---|---|
Uri | The weblink embedded 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 |