PageSelection


public final class PageSelection
extends Object implements Parcelable

java.lang.Object
   ↳ android.graphics.pdf.models.selection.PageSelection


Represents the list of selected content on a particular page of the PDF document. By default, the selection boundary is represented from left to right. Note: Currently supports text selection only.

Summary

Inherited constants

Fields

public static final Creator<PageSelection> CREATOR

Public constructors

PageSelection(int page, SelectionBoundary start, SelectionBoundary stop, List<PdfPageTextContent> selectedContents)

Creates a new instance of PageSelection for the specified page, the start and stop selection boundary, and the selected text content.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

int getPage()

Gets the particular page for which the selection is highlighted.

List<PdfPageTextContent> getSelectedTextContents()

Returns the text content within the selection boundaries on the page.

SelectionBoundary getStart()

Gets the edge from where the selection starts- index is inclusive.

SelectionBoundary getStop()

Gets the edge where the selection stops - index is inclusive.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 35
Also in S Extensions 13
public static final Creator<PageSelection> CREATOR

Public constructors

PageSelection

Added in API level 35
Also in S Extensions 13
public PageSelection (int page, 
                SelectionBoundary start, 
                SelectionBoundary stop, 
                List<PdfPageTextContent> selectedContents)

Creates a new instance of PageSelection for the specified page, the start and stop selection boundary, and the selected text content.

Parameters
page int: The page number of the selection.

start SelectionBoundary: Boundary where the selection starts. This value cannot be null.

stop SelectionBoundary: Boundary where the selection stops. This value cannot be null.

selectedContents List: list of segments of selected text content. This value cannot be null.

Throws
IllegalArgumentException If the page number is negative.
NullPointerException If start/stop edge or text selection is null.

Public methods

describeContents

Added in API level 35
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

getPage

Added in API level 35
Also in S Extensions 13
public int getPage ()

Gets the particular page for which the selection is highlighted.

Returns
int The page number on which the current selection resides.

getSelectedTextContents

Added in API level 35
Also in S Extensions 13
public List<PdfPageTextContent> getSelectedTextContents ()

Returns the text content within the selection boundaries on the page. In case there are non-continuous selections, this method returns the list of those text content in order of viewing.

Returns
List<PdfPageTextContent> list of text contents within the selection boundaries. This value cannot be null.

getStart

Added in API level 35
Also in S Extensions 13
public SelectionBoundary getStart ()

Gets the edge from where the selection starts- index is inclusive.

Returns
SelectionBoundary The starting edge of the selection. This value cannot be null.

getStop

Added in API level 35
Also in S Extensions 13
public SelectionBoundary getStop ()

Gets the edge where the selection stops - index is inclusive.

Returns
SelectionBoundary The stopping edge of the selection. This value cannot be null.

writeToParcel

Added in API level 35
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