Page

RENDER_MODE_FOR_DISPLAY

static val RENDER_MODE_FOR_DISPLAY: Int

Mode to render the content for display on a screen.

Value: 1

RENDER_MODE_FOR_PRINT

static val RENDER_MODE_FOR_PRINT: Int

Mode to render the content for printing.

Value: 2

applyEdit

fun applyEdit(editRecord: FormEditRecord): MutableList<Rect!>

Applies a FormEditRecord to the PDF.

Apps must call render(android.graphics.Bitmap,android.graphics.Rect,android.graphics.Matrix,android.graphics.pdf.RenderParams) to render new bitmaps for the corresponding areas of the page.

For click type FormEditRecords, performs a click on android.graphics.pdf.models.FormEditRecord#getClickPoint()

For set text type FormEditRecords, sets the text value of the form widget.

For set indices type FormEditRecords, sets the android.graphics.pdf.models.FormEditRecord#getSelectedIndices() as selected and all others as unselected for the form widget indicated by the record.

close

fun close(): Unit

Closes this page.

getFormWidgetInfoAtIndex

fun getFormWidgetInfoAtIndex(widgetIndex: Int): FormWidgetInfo

Returns information about the widget with widgetIndex.

getFormWidgetInfoAtPosition

fun getFormWidgetInfoAtPosition(
    x: Int, 
    y: Int
): FormWidgetInfo

Returns information about the widget at the given point.

getFormWidgetInfos

fun getFormWidgetInfos(): MutableList<FormWidgetInfo!>

Returns information about all form widgets on the page, or an empty list if there are no form widgets on the page.

getFormWidgetInfos

fun getFormWidgetInfos(types: IntArray): MutableList<FormWidgetInfo!>

Returns information about all form widgets of the specified types on the page, or an empty list if there are no form widgets of the specified types on the page.

getGotoLinks

fun getGotoLinks(): MutableList<PdfPageGotoLinkContent!>

Gets bookmarks and goto links present on the page of a pdf document. Goto Links are the internal navigation links which directs the user to different location within the same document.

getHeight

fun getHeight(): Int

Returns the height of the PdfRenderer.Page object in points (1/72"). It is not guaranteed that all pages will have the same height and the viewport should be resized to the page height.

getImageContents

fun getImageContents(): MutableList<PdfPageImageContent!>

Return list of PdfPageImageContent found on the page, ordered left to right and top to bottom. It contains all the content associated with images found on the page including alt text. The list will be empty if there are no results found. Currently, localisation does not have any impact on the order in which PdfPageImageContent is returned.

getIndex

fun getIndex(): Int

Gets the page index.

getLinkContents

fun getLinkContents(): MutableList<PdfPageLinkContent!>

Get the bounds and URLs of all the links on the page.

getTextContents

fun getTextContents(): MutableList<PdfPageTextContent!>

Return list of PdfPageTextContent found on the page, ordered left to right and top to bottom. It contains all the content associated with text found on the page. The list will be empty if there are no results found. Currently, localisation does not have any impact on the order in which PdfPageTextContent is returned.

getWidth

fun getWidth(): Int

Returns the width of the PdfRenderer.Page object in points (1/72"). It is not guaranteed that all pages will have the same width and the viewport should be resized to the page width.

render

fun render(
    destination: Bitmap, 
    destClip: Rect?, 
    transform: Matrix?, 
    params: RenderParams
): Unit

Renders a page to a bitmap. In case of default zoom, the Bitmap dimensions will be equal to the page dimensions. In this case, Rect parameter can be null.

In case of zoom, the Rect parameter needs to be specified which represents the offset from top and left for tile generation purposes. In this case, the Bitmap dimensions should be equal to the tile dimensions.

Note: The method will take care of closing the bitmap. Should be invoked on the android.annotation.WorkerThread as it is long-running task.

render

fun render(
    destination: Bitmap, 
    destClip: Rect?, 
    transform: Matrix?, 
    renderMode: Int
): Unit

Renders a page to a bitmap.

You may optionally specify a rectangular clip in the bitmap bounds. No rendering outside the clip will be performed, hence it is your responsibility to initialize the bitmap outside the clip.

You may optionally specify a matrix to transform the content from page coordinates which are in points (1/72") to bitmap coordinates which are in pixels. If this matrix is not provided this method will apply a transformation that will fit the whole page to the destination clip if provided or the destination bitmap if no clip is provided.

The clip and transformation are useful for implementing tile rendering where the destination bitmap contains a portion of the image, for example when zooming. Another useful application is for printing where the size of the bitmap holding the page is too large and a client can render the page in stripes.

Note: The destination bitmap format must be ARGB.

Note: The optional transformation matrix must be affine as per Matrix.isAffine(). Hence, you can specify rotation, scaling, translation but not a perspective transformation.

searchText

fun searchText(query: String): MutableList<PageMatchBounds!>

Search for the given string on the page and returns the bounds of all the matches. The list will be empty if there are no matches on the page. If this function was invoked previously for any page, it will wait for that operation to complete before this operation is started.

Note: Should be invoked on the android.annotation.WorkerThread as it is long-running task.

selectContent

fun selectContent(
    start: SelectionBoundary, 
    stop: SelectionBoundary
): PageSelection?

Return a PageSelection which represents the selected content that spans between the two boundaries. The boundaries can be either exactly defined with text indexes, or approximately defined with points on the page. The resulting selection will also be exactly defined with both indexes and points. If the start and stop boundary are both at the same point, selects the word at that point. In case the selection from the given boundaries result in an empty space, then the method returns null. The start and stop SelectionBoundary in PageSelection resolves to the "nearest" index when returned.

Note: Should be invoked on a android.annotation.WorkerThread as it is long-running task.

finalize

protected fun finalize(): Unit