pdfpreview/com.harissk.pdfpreview/PDFView

PDFView

class PDFView(context: Context?, attrs: AttributeSet?) : RelativeLayout

A view for displaying and interacting with PDF documents. It supports features like animation, zoom, caching, and swiping.

The PDF document is rendered as if we want to draw all pages side-by-side, with only the visible portions actually drawn on the screen. All parts are rendered at the same size to optimize performance and allow for interruption of native rendering. Parts are loaded when the offset or zoom level changes.

Constructors

constructor(context: Context?, attrs: AttributeSet?)

Types

object Companion

Properties

var currentPage: Int

The index of the current sequence

var currentXOffset: Float

If you picture all the pages side by side in their optimal width, and taking into account the zoom level, the current offset is the position of the left border of the screen in this big picture

var currentYOffset: Float

If you picture all the pages side by side in their optimal width, and taking into account the zoom level, the current offset is the position of the left border of the screen in this big picture

val documentMeta: Meta?

Returns null if document is not loaded

var isPageSnap: Boolean

var isSwipeEnabled: Boolean

val logWriter: LogWriter?

val maxZoom: Float

val midZoom: Float

val minZoom: Float

val pageCount: Int

val pdfFile: PdfFile

pdfViewerConfiguration

val pdfViewerConfiguration: PdfViewerConfiguration

var positionOffset: Float

Get current position as ratio of document length to visible area. 0 means that document start is visible, 1 that document end is visible

tableOfContents

val tableOfContents: List<Bookmark>

Will be empty until document is loaded

var zoom: Float

The zoom level, always >= 1

Functions

canScrollHorizontally

open override fun canScrollHorizontally(direction: Int): Boolean

canScrollVertically

open override fun canScrollVertically(direction: Int): Boolean

open override fun computeScroll()

Handle fling animation

documentFitsView

fun documentFitsView(): Boolean

Checks if whole document can be displayed on screen, doesn't include zoom

fun enqueue(pdfRequest: PdfRequest)

fun fitToWidth(page: Int)

fun getLinks(page: Int): List<Link>

Will be empty until document is loaded

getPageAtPositionOffset

fun getPageAtPositionOffset(positionOffset: Float): Int

Get page number at given offset

fun getPageSize(pageIndex: Int): SizeF

fun jumpTo(page: Int, withAnimation: Boolean = false)

Go to the given page.

fun moveRelativeTo(dx: Float, dy: Float)

Move relatively to the current position.

setPositionOffset

fun setPositionOffset(progress: Float, moveHandle: Boolean = false)

fun showPage(pageNb: Int)

fun stopFling()

zoomCenteredRelativeTo

fun zoomCenteredRelativeTo(dzoom: Float, pivot: PointF)

fun zoomCenteredTo(zoom: Float, pivot: PointF)

Change the zoom level, relatively to a pivot point. It will call moveTo() to make sure the given point stays in the middle of the screen.

zoomWithAnimation

fun zoomWithAnimation(scale: Float)

fun zoomWithAnimation(centerX: Float, centerY: Float, scale: Float)

Inherited functions

inline fun PDFView.load(uri: Uri, builder: PdfRequest.Builder.() -> Unit = {})

Load PDF from a URI. Useful for content providers.

inline fun PDFView.load(source: DocumentSource, builder: PdfRequest.Builder.() -> Unit = {})

Load PDF using custom DocumentSource.

inline fun PDFView.load(file: File, builder: PdfRequest.Builder.() -> Unit = {})

Load PDF from a file.

inline fun PDFView.load(stream: InputStream, builder: PdfRequest.Builder.() -> Unit = {})

Load PDF from an {@link InputStream}. The stream is converted to a byte array, since native code does not support direct stream handling.

inline fun PDFView.load(bytes: ByteArray, builder: PdfRequest.Builder.() -> Unit = {})

Load PDF from a byte array. Document is not saved on disk.

inline fun PDFView.load(assetName: String, builder: PdfRequest.Builder.() -> Unit = {})

Load PDF from the assets file.