All Implemented Interfaces:

java.io.Closeable , java.lang.AutoCloseable
```
public final class PdfDocument
 implements Closeable
                    
```
PdfDocument represents a PDF file and allows you to load pages from it.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`PdfDocument.Meta`
`public final class`	`PdfDocument.Bookmark`
`public final class`	`PdfDocument.Link`
`public final class`	`PdfDocument.PageCount`
`public class`	`PdfDocument.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private Boolean`	`isClosed`
`private ParcelFileDescriptor`	`parcelFileDescriptor`
`private PdfiumSource`	`source`
`private final Long`	`mNativeDocPtr`

Constructor Summary

Constructors
Constructor	Description
`PdfDocument(Long mNativeDocPtr)`

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`getIsClosed()`
`final Unit`	`setIsClosed(Boolean isClosed)`
`final ParcelFileDescriptor`	`getParcelFileDescriptor()`
`final Unit`	`setParcelFileDescriptor(ParcelFileDescriptor parcelFileDescriptor)`
`final PdfiumSource`	`getSource()`
`final Unit`	`setSource(PdfiumSource source)`
`final Long`	`getMNativeDocPtr()`
`final Integer`	`getPageCount()`	Get the page count of the PDF document
`final IntArray`	`getPageCharCounts()`	Get the page character counts for every page of the PDF document
`final PdfPage`	`openPage(Integer pageIndex)`	Open page and store native pointer in PdfDocument
`final Unit`	`deletePage(Integer pageIndex)`	Delete page
`final List<PdfPage>`	`openPages(Integer fromIndex, Integer toIndex)`	Open range of pages and store native pointers in PdfDocument
`final Unit`	`renderPages(Long bufferPtr, Integer drawSizeX, Integer drawSizeY, List<PdfPage> pages, List<Matrix> matrices, List<RectF> clipRects, Boolean renderAnnot, Boolean textMask, Integer canvasColor, Integer pageBackgroundColor)`	Render page fragment on Surface.
`final Boolean`	`renderPages(Surface surface, List<PdfPage> pages, List<Matrix> matrices, List<RectF> clipRects, Boolean renderAnnot, Boolean textMask, Integer canvasColor, Integer pageBackgroundColor)`
`final PdfDocument.Meta`	`getDocumentMeta()`	Get metadata for given document
`final List<PdfDocument.Bookmark>`	`getTableOfContents()`	Get table of contents (bookmarks) for given document
`final PdfTextPage`	`openTextPage(PdfPage page)`	Open a text page
`final List<PdfTextPage>`	`openTextPages(Integer fromIndex, Integer toIndex)`	Open a range of text pages
`final Boolean`	`saveAsCopy(PdfWriteCallback callback, Integer flags)`	Save document as a copy
`Unit`	`close()`	Close the document

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PdfDocument
```
PdfDocument(Long mNativeDocPtr)
```
- Method Detail
  - getIsClosed
```
 final Boolean getIsClosed()
```
  - setIsClosed
```
 final Unit setIsClosed(Boolean isClosed)
```
  - getParcelFileDescriptor
```
 final ParcelFileDescriptor getParcelFileDescriptor()
```
  - setParcelFileDescriptor
```
 final Unit setParcelFileDescriptor(ParcelFileDescriptor parcelFileDescriptor)
```
  - getSource
```
 final PdfiumSource getSource()
```
  - setSource
```
 final Unit setSource(PdfiumSource source)
```
  - getMNativeDocPtr
```
 final Long getMNativeDocPtr()
```
  - getPageCount
```
 final Integer getPageCount()
```
    Get the page count of the PDF document
  - getPageCharCounts
```
 final IntArray getPageCharCounts()
```
    Get the page character counts for every page of the PDF document
  - openPage
```
 final PdfPage openPage(Integer pageIndex)
```
    Open page and store native pointer in PdfDocument
    
    Parameters:
    
    pageIndex - the page index
  - deletePage
```
 final Unit deletePage(Integer pageIndex)
```
    Delete page
    
    Parameters:
    
    pageIndex - the page index
  - openPages
```
 final List<PdfPage> openPages(Integer fromIndex, Integer toIndex)
```
    Open range of pages and store native pointers in PdfDocument
    
    Parameters:
    
    fromIndex - the start index of the range
    
    toIndex - the end index of the range
  - renderPages
```
 final Unit renderPages(Long bufferPtr, Integer drawSizeX, Integer drawSizeY, List<PdfPage> pages, List<Matrix> matrices, List<RectF> clipRects, Boolean renderAnnot, Boolean textMask, Integer canvasColor, Integer pageBackgroundColor)
```
    Render page fragment on Surface.<br></br>
    
    Parameters:
    
    bufferPtr - Surface's buffer on which to render page
    
    pages - The pages to render
    
    matrices - The matrices to map the pages to the surface
    
    clipRects - The rectangles to clip the pages to
    
    renderAnnot - whether render annotation
    
    textMask - whether to render text as image mask - currently ignored
    
    canvasColor - The color to fill the canvas with.
    
    pageBackgroundColor - The color for the page background.
  - renderPages
```
 final Boolean renderPages(Surface surface, List<PdfPage> pages, List<Matrix> matrices, List<RectF> clipRects, Boolean renderAnnot, Boolean textMask, Integer canvasColor, Integer pageBackgroundColor)
```
  - getDocumentMeta
```
 final PdfDocument.Meta getDocumentMeta()
```
    Get metadata for given document
  - getTableOfContents
```
 final List<PdfDocument.Bookmark> getTableOfContents()
```
    Get table of contents (bookmarks) for given document
  - openTextPage
```
 final PdfTextPage openTextPage(PdfPage page)
```
    Open a text page
    
    Parameters:
    
    page - the PdfPage
  - openTextPages
```
 final List<PdfTextPage> openTextPages(Integer fromIndex, Integer toIndex)
```
    Open a range of text pages
    
    Parameters:
    
    fromIndex - the start index of the range
    
    toIndex - the end index of the range
  - saveAsCopy
```
 final Boolean saveAsCopy(PdfWriteCallback callback, Integer flags)
```
    Save document as a copy
    
    Parameters:
    
    callback - the PdfWriteCallback to be called with the data
    
    flags - must be one of FPDF_INCREMENTAL, FPDF_NO_INCREMENTAL or FPDF_REMOVE_SECURITY
  - close
```
 Unit close()
```
    Close the document

Class PdfDocument

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PdfDocument

Method Detail

getIsClosed

setIsClosed

getParcelFileDescriptor

setParcelFileDescriptor

getSource

setSource

getMNativeDocPtr

getPageCount

getPageCharCounts

openPage

deletePage

openPages

renderPages

renderPages

getDocumentMeta

getTableOfContents

openTextPage

openTextPages

saveAsCopy

close