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

SelectionBoundary

Kotlin |Java

public final class SelectionBoundary
extends Object implements Parcelable

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

Represents one edge of the selected content.

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<SelectionBoundary>`	`CREATOR`

Public constructors
`SelectionBoundary(int index)` Create a new instance of `SelectionBoundary` if index of boundary is known.
`SelectionBoundary(Point point)` Create a new instance of `SelectionBoundary` if the boundary `Point` is known.

Public constructors


      SelectionBoundary(int index)

Create a new instance of SelectionBoundary if index of boundary is known.


      SelectionBoundary(Point point)

Create a new instance of SelectionBoundary if the boundary Point is known.

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`int`	`getIndex()` Gets the index of the text as determined by the text stream processed.
`boolean`	`getIsRtl()` Gets whether the direction of selection is right-to-left (rtl) or reverse.
`Point`	`getPoint()` Gets the x, y coordinates of the selection boundary in points (1/72").
`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<SelectionBoundary> CREATOR

Public constructors

SelectionBoundary

Added in Android VanillaIceCream

public SelectionBoundary (int index)

Create a new instance of SelectionBoundary if index of boundary is known. The text returned by PdfPageTextContent#getText() form a "stream" and inside this "stream" each character has an index. Note: Point defaults to null in this case.

Parameters
`index`	`int`: index of the selection boundary.

Throws
`IllegalArgumentException`	If the index is negative.

SelectionBoundary

Added in Android VanillaIceCream

public SelectionBoundary (Point point)

Create a new instance of SelectionBoundary if the boundary Point is known. Index defaults to -1.

Parameters
`point`	`Point`: The point of selection boundary. This value cannot be `null`.

Throws
`NullPointerException`	If the point 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`

getIndex

Added in Android VanillaIceCream

public int getIndex ()

Gets the index of the text as determined by the text stream processed. If the value is -1 then the getPoint() will determine the selection boundary.

Returns
`int`	index of the selection boundary.

getIsRtl

Added in Android VanillaIceCream

public boolean getIsRtl ()

Gets whether the direction of selection is right-to-left (rtl) or reverse. The value of isRtl is determined by the underlying native layer using the start and stop boundaries.

Returns
`boolean`	The direction of selection

getPoint

Added in Android VanillaIceCream

public Point getPoint ()

Gets the x, y coordinates of the selection boundary in points (1/72"). These coordinates are represented by a Point . If the value is null then the getIndex() will determine the selection boundary.

Note: Point (0,0) represents the top-left corner of the page

Returns
`Point`	The point of the selection boundary.

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