Stay organized with collections
Save and categorize content based on your preferences.
PdfPageImageObject
class PdfPageImageObject : PdfPageObject
Represents an image object on a PDF page. This class extends PdfPageObject
and provides methods to access and modify the image content.
Summary
Public constructors |
Constructor for the PdfPageImageObject.
|
Public methods |
Bitmap |
Returns the bitmap image of the object.
|
Unit |
Sets the bitmap image of the object.
|
Public constructors
PdfPageImageObject
PdfPageImageObject(bitmap: Bitmap)
Constructor for the PdfPageImageObject. Sets the object type to IMAGE.
Parameters |
bitmap |
Bitmap: This value cannot be null . |
Exceptions |
java.lang.IllegalArgumentException |
if bitmap config is not ARGB_8888. |
Public methods
getBitmap
fun getBitmap(): Bitmap
Returns the bitmap image of the object.
Return |
Bitmap |
The bitmap image of the object. This value cannot be null . |
setBitmap
fun setBitmap(bitmap: Bitmap): Unit
Sets the bitmap image of the object.
Parameters |
bitmap |
Bitmap: The bitmap image to set. This value cannot be null . |
Exceptions |
java.lang.IllegalArgumentException |
if bitmap config is not ARGB_8888. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[],[],null,["# PdfPageImageObject\n\nAdded in [S Extensions 18](https://developer.android.com/sdkExtensions)\n\nPdfPageImageObject\n==================\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/graphics/pdf/component/PdfPageImageObject \"View this page in Java\") \n\n```\nclass PdfPageImageObject : PdfPageObject\n```\n\n|---|---|--------------------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) |||\n| ↳ | [android.graphics.pdf.component.PdfPageObject](/reference/kotlin/android/graphics/pdf/component/PdfPageObject) ||\n| | ↳ | [android.graphics.pdf.component.PdfPageImageObject](#) |\n\nRepresents an image object on a PDF page. This class extends [PdfPageObject](/reference/kotlin/android/graphics/pdf/component/PdfPageObject) and provides methods to access and modify the image content.\n\nSummary\n-------\n\n| Public constructors ||\n|--------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [PdfPageImageObject](#PdfPageImageObject(android.graphics.Bitmap))`(`bitmap:` `[Bitmap](../../Bitmap.html#)`)` Constructor for the PdfPageImageObject. |\n\n| Public methods ||\n|------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| [Bitmap](../../Bitmap.html#) | [getBitmap](#getBitmap())`()` Returns the bitmap image of the object. |\n| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setBitmap](#setBitmap(android.graphics.Bitmap))`(`bitmap:` `[Bitmap](../../Bitmap.html#)`)` Sets the bitmap image of the object. |\n\n| Inherited functions ||\n|---|---|\n| From class [PdfPageObject](/reference/kotlin/android/graphics/pdf/component/PdfPageObject) |-------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [FloatArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float-array/index.html) | [getMatrix](/reference/kotlin/android/graphics/pdf/component/PdfPageObject#getMatrix())`()` Returns the transformation matrix of the object. \u003cbr /\u003e | | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [getPdfObjectType](/reference/kotlin/android/graphics/pdf/component/PdfPageObject#getPdfObjectType())`()` Returns the type of the page object. \u003cbr /\u003e | | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setMatrix](/reference/kotlin/android/graphics/pdf/component/PdfPageObject#setMatrix(android.graphics.Matrix))`(`matrix:` `[Matrix](../../Matrix.html#)`)` Sets the transformation matrix of the object. \u003cbr /\u003e | | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [transform](/reference/kotlin/android/graphics/pdf/component/PdfPageObject#transform(kotlin.Float,%20kotlin.Float,%20kotlin.Float,%20kotlin.Float,%20kotlin.Float,%20kotlin.Float))`(`a:` `[Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`, `b:` `[Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`, `c:` `[Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`, `d:` `[Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`, `e:` `[Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`, `f:` `[Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)`)` Transform the page object The matrix is composed as: \\|a c e\\| \\|b d f\\| and can be used to scale, rotate, shear and translate the \\|page_object\\|. \u003cbr /\u003e | ||\n\nPublic constructors\n-------------------\n\n### PdfPageImageObject\n\nAdded in [S Extensions 18](https://developer.android.com/sdkExtensions) \n\n```\nPdfPageImageObject(bitmap: Bitmap)\n```\n\nConstructor for the PdfPageImageObject. Sets the object type to IMAGE.\n\n| Parameters ||\n|----------|------------------------------------------------------------|\n| `bitmap` | [Bitmap](../../Bitmap.html#): This value cannot be `null`. |\n\n| Exceptions ||\n|--------------------------------------|------------------------------------|\n| `java.lang.IllegalArgumentException` | if bitmap config is not ARGB_8888. |\n\nPublic methods\n--------------\n\n### getBitmap\n\nAdded in [S Extensions 18](https://developer.android.com/sdkExtensions) \n\n```\nfun getBitmap(): Bitmap\n```\n\nReturns the bitmap image of the object.\n\n| Return ||\n|------------------------------|--------------------------------------------------------------|\n| [Bitmap](../../Bitmap.html#) | The bitmap image of the object. This value cannot be `null`. |\n\n### setBitmap\n\nAdded in [S Extensions 18](https://developer.android.com/sdkExtensions) \n\n```\nfun setBitmap(bitmap: Bitmap): Unit\n```\n\nSets the bitmap image of the object.\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------------|\n| `bitmap` | [Bitmap](../../Bitmap.html#): The bitmap image to set. This value cannot be `null`. |\n\n| Exceptions ||\n|--------------------------------------|------------------------------------|\n| `java.lang.IllegalArgumentException` | if bitmap config is not ARGB_8888. |"]]