Added in API level 21

PdfRenderer

class PdfRenderer : AutoCloseable
kotlin.Any
   ↳ android.graphics.pdf.PdfRenderer

This class enables rendering a PDF document and selecting, searching, fast scrolling, annotations, etc. from Android V. This class is thread safe and can be called by multiple threads however only one thread will be executed at a time as the access is synchronized by internal locking.

If you want to render a PDF, you create a renderer and for every page you want to render, you open the page, render it, and close the page. After you are done with rendering, you close the renderer. After the renderer is closed it should not be used anymore. Note that the pages are rendered one by one, i.e. you can have only a single page opened at any given time.

A typical use of the APIs to render a PDF looks like this: 

// create a new renderer
  PdfRenderer renderer = new PdfRenderer(getSeekableFileDescriptor());
 
  // let us just render all pages
  final int pageCount = renderer.getPageCount();
  for (int i = 0; i < pageCount; i++) {
      Page page = renderer.openPage(i);
 
      // say we render for showing on the screen
      page.render(mBitmap, null, null, Page.RENDER_MODE_FOR_DISPLAY);
 
      // do stuff with the bitmap
 
      // close the page
      page.close();
  }
 
  // close the renderer
  renderer.close();

If you are using this class to rasterize a PDF for printing or show a print preview, it is recommended that you respect the following contract in order to provide a consistent user experience when seeing a preview and printing, i.e. the user sees a preview that is the same as the printout.

  • Respect the property whether the document would like to be scaled for printing as per shouldScaleForPrinting().
  • When scaling a document for printing the aspect ratio should be preserved.
  • Do not inset the content with any margins from the android.print.PrintAttributes as the application is responsible to render it such that the margins are respected.
  • If document page size is greater than the printed media size the content should be anchored to the upper left corner of the page for left-to-right locales and top right corner for right-to-left locales.

Summary

Nested classes

This class represents a PDF document page for rendering.
Constants
static Int

Represents a linearized PDF document.
static Int

Represents a non-linearized PDF document.
static Int

Represents a PDF with form fields specified using the AcroForm spec
static Int

Represents a PDF without form fields
static Int

Represents a PDF with form fields specified using the XFAF subset of the XFA spec
static Int

Represents a PDF with form fields specified using the entire XFA spec
Public constructors

Creates a new instance.
PdfRenderer(fileDescriptor: ParcelFileDescriptor, params: LoadParams)

Creates a new instance of PdfRenderer class.
Public methods
Unit

Closes this renderer.
Int

Gets the type of the PDF document.
Int

Gets the number of pages in the document.
Int

Returns the form type of the loaded PDF
PdfRenderer.Page
openPage(index: Int)

Opens a page for rendering.
Boolean

Gets whether the document prefers to be scaled for printing.
Unit
write(destination: ParcelFileDescriptor, removePasswordProtection: Boolean)

Saves the current state of the loaded PDF document to the given writable ParcelFileDescriptor.
Protected methods
Unit

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Constants

DOCUMENT_LINEARIZED_TYPE_LINEARIZED

Added in API level 35
static val DOCUMENT_LINEARIZED_TYPE_LINEARIZED: Int

Represents a linearized PDF document.

Value: 1

DOCUMENT_LINEARIZED_TYPE_NON_LINEARIZED

Added in API level 35
static val DOCUMENT_LINEARIZED_TYPE_NON_LINEARIZED: Int

Represents a non-linearized PDF document.

Value: 0

PDF_FORM_TYPE_ACRO_FORM

Added in API level 35
static val PDF_FORM_TYPE_ACRO_FORM: Int

Represents a PDF with form fields specified using the AcroForm spec

Value: 1

PDF_FORM_TYPE_NONE

Added in API level 35
static val PDF_FORM_TYPE_NONE: Int

Represents a PDF without form fields

Value: 0

PDF_FORM_TYPE_XFA_FOREGROUND

Added in API level 35
static val PDF_FORM_TYPE_XFA_FOREGROUND: Int

Represents a PDF with form fields specified using the XFAF subset of the XFA spec

Value: 3

PDF_FORM_TYPE_XFA_FULL

Added in API level 35
static val PDF_FORM_TYPE_XFA_FULL: Int

Represents a PDF with form fields specified using the entire XFA spec

Value: 2

Public constructors

PdfRenderer

Added in API level 21
PdfRenderer(fileDescriptor: ParcelFileDescriptor)

Creates a new instance.

Note: The provided file descriptor must be seekable, i.e. its data being randomly accessed, e.g. pointing to a file.

Note: This class takes ownership of the passed in file descriptor and is responsible for closing it when the renderer is closed.

If the file is from an untrusted source it is recommended to run the renderer in a separate, isolated process with minimal permissions to limit the impact of security exploits. Note: The constructor should be instantiated on the android.annotation.WorkerThread as it can be long-running while loading the document.

Parameters
fileDescriptor ParcelFileDescriptor: Seekable file descriptor to read from.
This value cannot be null.
Exceptions
java.io.IOException If an error occurs while reading the file.
java.lang.IllegalArgumentException If the ParcelFileDescriptor is not seekable.
java.lang.NullPointerException If the file descriptor is null.
java.lang.SecurityException If the file requires a password or the security scheme is not supported.

PdfRenderer

Added in API level 35
PdfRenderer(
    fileDescriptor: ParcelFileDescriptor, 
    params: LoadParams)

Creates a new instance of PdfRenderer class.

Note: The provided file descriptor must be seekable, i.e. its data being randomly accessed, e.g. pointing to a file. If the password passed in android.graphics.pdf.LoadParams is incorrect, the android.graphics.pdf.PdfRenderer will throw a SecurityException.

Note: This class takes ownership of the passed in file descriptor and is responsible for closing it when the renderer is closed.

If the file is from an untrusted source it is recommended to run the renderer in a separate, isolated process with minimal permissions to limit the impact of security exploits. Note: The constructor should be instantiated on the android.annotation.WorkerThread as it can be long-running while loading the document.

Parameters
fileDescriptor ParcelFileDescriptor: Seekable file descriptor to read from.
This value cannot be null.
params LoadParams: Instance of LoadParams specifying params for loading PDF document.
This value cannot be null.
Exceptions
java.io.IOException If an error occurs while reading the file.
java.lang.IllegalArgumentException If the ParcelFileDescriptor is not seekable.
java.lang.NullPointerException If the file descriptor or load params is null.
java.lang.SecurityException If the file requires a password or the security scheme is not supported by the renderer.

Public methods

close

Added in API level 21
fun close(): Unit

Closes this renderer. You should not use this instance after this method is called.

Exceptions
java.lang.Exception if this resource cannot be closed
java.lang.IllegalStateException If close() is called before invoking this or if any page is opened and not closed

getDocumentLinearizationType

Added in API level 35
fun getDocumentLinearizationType(): Int

Gets the type of the PDF document.

Return
Int The PDF document type.
Value is one of the following:
Exceptions
java.lang.IllegalStateException If close() is called before invoking this.

getPageCount

Added in API level 21
fun getPageCount(): Int

Gets the number of pages in the document.

Return
Int The page count.
Value is 0 or greater
Exceptions
java.lang.IllegalStateException If close() is called before invoking this.

getPdfFormType

Added in API level 35
fun getPdfFormType(): Int

Returns the form type of the loaded PDF

Return
Int Value is one of the following:
Exceptions
java.lang.IllegalArgumentException if an unexpected PDF form type is returned
java.lang.IllegalStateException if the renderer is closed

openPage

Added in API level 21
fun openPage(index: Int): PdfRenderer.Page

Opens a page for rendering.

Parameters
index Int: The page index to open, starting from index 0.
Value is 0 or greater
Return
PdfRenderer.Page A page that can be rendered.
This value cannot be null.
Exceptions
java.lang.IllegalArgumentException If the page number is less than 0 or greater than or equal to the total page count.
java.lang.IllegalStateException If close() is called before invoking this.

shouldScaleForPrinting

Added in API level 21
fun shouldScaleForPrinting(): Boolean

Gets whether the document prefers to be scaled for printing. You should take this info account if the document is rendered for printing and the target media size differs from the page size.

Return
Boolean If to scale the document.
Exceptions
java.lang.IllegalStateException If close() is called before invoking this.

write

Added in API level 35
fun write(
    destination: ParcelFileDescriptor, 
    removePasswordProtection: Boolean
): Unit

Saves the current state of the loaded PDF document to the given writable ParcelFileDescriptor. If the document is password-protected then setting removePasswordProtection removes the protection before saving. The PDF document should already be decrypted with the correct password before writing. Useful for printing or sharing. Note: This method closes the provided file descriptor.

Parameters
destination ParcelFileDescriptor: The writable ParcelFileDescriptor
This value cannot be null.
removePasswordProtection Boolean: If true, removes password protection from the PDF before saving.
Exceptions
java.io.IOException If there's a write error, or if 'removePasswordSecurity' is true but the document remains encrypted.
java.lang.IllegalStateException If close() is called before invoking this.

Protected methods

finalize

Added in API level 21
protected fun finalize(): Unit

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Exceptions
java.lang.Throwable the Exception raised by this method