Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

PageSelection

Kotlin |Java

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

From interface android.os.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(Parcel, int)`: 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)`".

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

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in Android VanillaIceCream

public static final Creator<PageSelection> CREATOR

Public constructors

PageSelection

Added in Android VanillaIceCream

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 Android VanillaIceCream

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 Android VanillaIceCream

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 Android VanillaIceCream

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 Android VanillaIceCream

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 Android VanillaIceCream

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 Android VanillaIceCream

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