pdfpreview/com.harissk.pdfpreview/PdfFile

PdfFile

class PdfFile(pdfiumCore: PdfiumCore, pageFitPolicy: FitPolicy, viewSize: Size, originalUserPages: List<Int>?, isVertical: Boolean, spacingPx: Int, autoSpacing: Boolean, fitEachPage: Boolean, maxPageCacheSize: Int)

Manages PDF document and its pages.

Parameters

pdfiumCore

The {@link PdfiumCore} instance used to interact with the PDF document.

pageFitPolicy

The policy used to fit pages to the view.

viewSize

The size of the view where the PDF document is displayed.

originalUserPages

The original user-defined page order (optional).

isVertical

True if scrolling is vertical, else it's horizontal.

spacingPx

Fixed spacing between pages in pixels.

autoSpacing

Calculate spacing automatically so each page fits on its own in the center of the view.

fitEachPage

True if every page should fit separately according to the {@link FitPolicy}, else the largest page fits and other pages scale relatively.

maxPageCacheSize

The maximum number of pages that can be kept in the view

Constructors

constructor(pdfiumCore: PdfiumCore, pageFitPolicy: FitPolicy, viewSize: Size, originalUserPages: List<Int>?, isVertical: Boolean, spacingPx: Int, autoSpacing: Boolean, fitEachPage: Boolean, maxPageCacheSize: Int)

Types

object Companion

Properties

val bookmarks: List<Bookmark>

val maxPageHeight: Float

val maxPageSize: SizeF?

get page size with biggest dimension (width in vertical mode and height in horizontal mode)

val maxPageWidth: Float

val metaData: Meta

var pagesCount: Int

Functions

determineValidPageNumberFrom

fun determineValidPageNumberFrom(userPage: Int): Int

Ensures the given user-specified page number is within the valid range, considering the original user-defined page order if provided.

fun documentPage(userPage: Int): Int

fun getDocLen(zoom: Float): Float

getPageAtOffset

fun getPageAtOffset(offset: Float, zoom: Float): Int

fun getPageLength(pageIndex: Int, zoom: Float): Float

Get the page's height if swiping vertical, or width if swiping horizontal.

fun getPageLinks(pageIndex: Int): List<Link>

fun getPageOffset(pageIndex: Int, zoom: Float): Float

Get primary page offset, that is Y for vertical scroll and X for horizontal scroll

fun getPageSize(pageIndex: Int): SizeF?

fun getPageSpacing(pageIndex: Int, zoom: Float): Float

getScaledPageSize

fun getScaledPageSize(pageIndex: Int, zoom: Float): SizeF

getSecondaryPageOffset

fun getSecondaryPageOffset(pageIndex: Int, zoom: Float): Float

Get secondary page offset, that is X for vertical scroll and Y for horizontal scroll

mapRectToDevice

fun mapRectToDevice(pageIndex: Int, startX: Int, startY: Int, sizeX: Int, sizeY: Int, rect: RectF): RectF

fun openPage(pageIndex: Int): Boolean

fun pageHasError(pageIndex: Int): Boolean

recalculatePageSizes

fun recalculatePageSizes(viewSize: Size)

Recalculates the page sizes, offsets, and document length based on the current view size.

renderPageBitmap

fun renderPageBitmap(bitmap: Bitmap, pageIndex: Int, bounds: Rect, annotationRendering: Boolean)