PdfRendererPreV

Kotlin |Java

class PdfRendererPreV : AutoCloseable

kotlin.Any
↳	android.graphics.pdf.PdfRendererPreV

This class enables rendering a PDF document and selecting, searching, fast scrolling, annotations, etc from Android R till Android U. This class is not thread safe.

If you want to render a PDF, you will need to create a new instance of renderer for each document. To render each page, you open the page using the renderer instance created earlier, 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
  try (PdfRendererPreV renderer = new PdfRendererPreV(getSeekableFileDescriptor(), loadParams)) {
       // let us just render all pages
       final int pageCount = renderer.getPageCount();
       for (int i = 0; i < pageCount; i++) {
           Page page = renderer.openPage(i);
           RenderParams params = new RenderParams.Builder(Page.RENDER_MODE_FOR_DISPLAY).build();
 
           // say we render for showing on the screen
           page.render(mBitmap, params, null, null);
 
           // do stuff with the bitmap
 
           // close the page
           page.close();
       }
  }

Print preview and print output

Please refer to PdfRenderer for fulfilling this usecase.

Summary

Nested classes
	`Page` This class represents a PDF document page for rendering.

Constants
static Int	`DOCUMENT_LINEARIZED_TYPE_LINEARIZED` Represents a linearized PDF document.
static Int	`DOCUMENT_LINEARIZED_TYPE_NON_LINEARIZED` Represents a non-linearized PDF document.
static Int	`PDF_FORM_TYPE_ACRO_FORM` Represents a PDF with form fields specified using the AcroForm spec
static Int	`PDF_FORM_TYPE_NONE` Represents a PDF without form fields
static Int	`PDF_FORM_TYPE_XFA_FOREGROUND` Represents a PDF with form fields specified using the XFAF subset of the XFA spec
static Int	`PDF_FORM_TYPE_XFA_FULL` Represents a PDF with form fields specified using the entire XFA spec

Public constructors
`PdfRendererPreV(fileDescriptor: ParcelFileDescriptor)` Creates a new instance of PdfRendererPreV class.
`PdfRendererPreV(fileDescriptor: ParcelFileDescriptor, params: LoadParams)` Creates a new instance of PdfRendererPreV class.

Public methods
Unit	`close()` Closes this renderer and destroys any cached instance of the document.
Int	`getDocumentLinearizationType()` Gets the type of the PDF document.
Int	`getPageCount()` Gets the number of pages in the document.
Int	`getPdfFormType()` Returns the form type of the loaded PDF
PdfRendererPreV.Page	`openPage(index: Int)` Opens a `Page` for rendering.
Unit	`write(destination: ParcelFileDescriptor, removePasswordProtection: Boolean)` Saves the current state of the loaded PDF document to the given writable `ParcelFileDescriptor`.

Protected methods
Unit	`finalize()`

Exceptions
`java.io.IOException`	If an error occurs while reading the file.
`java.lang.SecurityException`	If the file requires a password or the security scheme is not supported by the renderer.
`java.lang.IllegalArgumentException`	If the `ParcelFileDescriptor` is not seekable.
`java.lang.NullPointerException`	If the file descriptor is null.

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.lang.Exception`	if this resource cannot be closed
`java.lang.IllegalStateException`	If `close()` is called before invoking this.

Exceptions
`java.lang.IllegalStateException`	if the renderer is closed
`java.lang.IllegalArgumentException`	if an unexpected PDF form type is returned

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.

PdfRendererPreV

Print preview and print output

Summary

Constants

DOCUMENT_LINEARIZED_TYPE_LINEARIZED

DOCUMENT_LINEARIZED_TYPE_NON_LINEARIZED

PDF_FORM_TYPE_ACRO_FORM

PDF_FORM_TYPE_NONE

PDF_FORM_TYPE_XFA_FOREGROUND

PDF_FORM_TYPE_XFA_FULL

Public constructors

PdfRendererPreV

PdfRendererPreV

Public methods

close

getDocumentLinearizationType

getPageCount

getPdfFormType

openPage

write

Protected methods

finalize