PdfPageImageContent

Kotlin |Java

class PdfPageImageContent : Parcelable

kotlin.Any
↳	android.graphics.pdf.content.PdfPageImageContent

Represents the content associated with an image type in a page of a PDF document.

Summary

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public constructors
`PdfPageImageContent(altText: String)` Creates a new instance of `PdfPageImageContent` using the alternate text of the image on the page.

Public methods
Int	`describeContents()`
String	`getAltText()` Gets the alternate text associated with the image represented by this instance.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<PdfPageImageContent!>	`CREATOR`

Public constructors

PdfPageImageContent

Added in API level VanillaIceCream

PdfPageImageContent(altText: String)

Creates a new instance of PdfPageImageContent using the alternate text of the image on the page.

Parameters
`altText`	String: Alternate text for the image. This value cannot be `null`.

Exceptions
`java.lang.NullPointerException`	If the alternate text is null.

Public methods

describeContents

Added in API level VanillaIceCream

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

getAltText

Added in API level VanillaIceCream

fun getAltText(): String

Gets the alternate text associated with the image represented by this instance. If there is no such text associated with the image, the method will return an empty string.

Return
`String`	the alternate text of the image. This value cannot be `null`.

writeToParcel

Added in API level VanillaIceCream

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level VanillaIceCream

static val CREATOR: Parcelable.Creator<PdfPageImageContent!>