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

PdfPageGotoLinkContent.Destination

Kotlin |Java

public static final class PdfPageGotoLinkContent.Destination
extends Object implements Parcelable

java.lang.Object
↳	android.graphics.pdf.content.PdfPageGotoLinkContent.Destination

Represents the content associated with the destination where a goto link is directing

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<PdfPageGotoLinkContent.Destination>`	`CREATOR`

Public constructors
`Destination(int pageNumber, float xCoordinate, float yCoordinate, float zoom)` Creates a new instance of `Destination` using the page number, x coordinate, and y coordinate of the destination where goto link is directing, and the zoom factor of the page when goto link takes to the destination Note: Here (0,0) represents top-left corner of the page

Public constructors


      Destination(int pageNumber, float xCoordinate, float yCoordinate, float zoom)

Creates a new instance of Destination using the page number, x coordinate, and y coordinate of the destination where goto link is directing, and the zoom factor of the page when goto link takes to the destination

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

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`int`	`getPageNumber()` Gets the page number of the destination where the `PdfPageGotoLinkContent` is directing.
`float`	`getXCoordinate()` Gets the x coordinate in points (1/72") of the destination where the `PdfPageGotoLinkContent` is directing.
`float`	`getYCoordinate()` Gets the y coordinate in points (1/72") of the destination where the `PdfPageGotoLinkContent` is directing.
`float`	`getZoom()` Gets the zoom factor of the page when the goto link takes to the destination Note: If there is no zoom value embedded, default value of Zoom will be zero.
`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<PdfPageGotoLinkContent.Destination> CREATOR

Public constructors

Destination

Added in Android VanillaIceCream

public Destination (int pageNumber, 
                float xCoordinate, 
                float yCoordinate, 
                float zoom)

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

Parameters
`pageNumber`	`int`: Page number of the goto link Destination
`xCoordinate`	`float`: X coordinate of the goto link Destination in points (1/72")
`yCoordinate`	`float`: Y coordinate of the goto link Destination in points (1/72")
`zoom`	`float`: Zoom factor `Destination#getZoom()` of the page when goto link takes to the destination

Throws
`IllegalArgumentException`	If pageNumber or either of the coordinates or zoom are less than zero

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`

getPageNumber

Added in Android VanillaIceCream

public int getPageNumber ()

Gets the page number of the destination where the PdfPageGotoLinkContent is directing.

Returns
`int`	page number of the destination where goto link is directing the user. Value is 0 or greater

getXCoordinate

Added in Android VanillaIceCream

public float getXCoordinate ()

Gets the x coordinate in points (1/72") of the destination where the PdfPageGotoLinkContent is directing.

Note: If underlying pdfium library can't determine the x coordinate, it will be set to 0

Returns
`float`	x coordinate of the Destination where the goto link is directing the user. Value is 0.0f or greater

getYCoordinate

Added in Android VanillaIceCream

public float getYCoordinate ()

Gets the y coordinate in points (1/72") of the destination where the PdfPageGotoLinkContent is directing.

Note: If underlying pdfium library can't determine the y coordinate, it will be set to 0

Returns
`float`	y coordinate of the Destination where the goto link is directing the user. Value is 0.0f or greater

getZoom

Added in Android VanillaIceCream

public float getZoom ()

Gets the zoom factor of the page when the goto link takes to the destination

Note: If there is no zoom value embedded, default value of Zoom will be zero. Otherwise, it will be less than 1.0f in case of zoom out and greater than 1.0f in case of zoom in.

Returns
`float`	zoom factor of the page when the goto link takes to the destination Value is 0.0f or greater

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