Added in API level 21

Summary: Constants | Methods | Protected Methods | Inherited Methods

PdfRenderer.Page

Kotlin |Java

public final class PdfRenderer.Page
extends Object implements AutoCloseable

java.lang.Object
↳	android.graphics.pdf.PdfRenderer.Page

This class represents a PDF document page for rendering.

Summary

Constants
`int`	`RENDER_MODE_FOR_DISPLAY` Mode to render the content for display on a screen.
`int`	`RENDER_MODE_FOR_PRINT` Mode to render the content for printing.

Public methods
`List<Rect>`	`applyEdit(FormEditRecord editRecord)` Applies a `FormEditRecord` to the PDF.
`void`	`close()` Closes this page.
`FormWidgetInfo`	`getFormWidgetInfoAtIndex(int widgetIndex)` Returns information about the widget with `widgetIndex`.
`FormWidgetInfo`	`getFormWidgetInfoAtPosition(int x, int y)` Returns information about the widget at the given point.
`List<FormWidgetInfo>`	`getFormWidgetInfos()` Returns information about all form widgets on the page, or an empty list if there are no form widgets on the page.
`List<FormWidgetInfo>`	`getFormWidgetInfos(int[] types)` 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.
`List<PdfPageGotoLinkContent>`	`getGotoLinks()` Gets bookmarks and goto links present on the page of a pdf document.
`int`	`getHeight()` Returns the height of the `PdfRenderer.Page` object in points (1/72").
`List<PdfPageImageContent>`	`getImageContents()` Return list of `PdfPageImageContent` found on the page, ordered left to right and top to bottom.
`int`	`getIndex()` Gets the page index.
`List<PdfPageLinkContent>`	`getLinkContents()` Get the bounds and URLs of all the links on the page.
`List<PdfPageTextContent>`	`getTextContents()` Return list of `PdfPageTextContent` found on the page, ordered left to right and top to bottom.
`int`	`getWidth()` Returns the width of the `PdfRenderer.Page` object in points (1/72").
`void`	`render(Bitmap destination, Rect destClip, Matrix transform, int renderMode)` Renders a page to a bitmap.
`void`	`render(Bitmap destination, Rect destClip, Matrix transform, RenderParams params)` Renders a page to a bitmap.
`List<PageMatchBounds>`	`searchText(String query)` Search for the given string on the page and returns the bounds of all the matches.
`PageSelection`	`selectContent(SelectionBoundary start, SelectionBoundary stop)` Return a `PageSelection` which represents the selected content that spans between the two boundaries.

Protected methods
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Constants

RENDER_MODE_FOR_DISPLAY

Added in API level 21

public static final int RENDER_MODE_FOR_DISPLAY

Mode to render the content for display on a screen.

Constant Value: 1 (0x00000001)

RENDER_MODE_FOR_PRINT

Added in API level 21

public static final int RENDER_MODE_FOR_PRINT

Mode to render the content for printing.

Constant Value: 2 (0x00000002)

Public methods

applyEdit

Added in API level 35

public List<Rect> applyEdit (FormEditRecord editRecord)

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 FormEditRecord.getClickPoint()

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

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

Parameters
`editRecord`	`FormEditRecord`: the `FormEditRecord` to be applied This value cannot be `null`.

Returns
`List<Rect>`	Rectangular areas of the page bitmap that have been invalidated by this action. This value cannot be `null`.

Throws
`IllegalArgumentException`	if the provided `FormEditRecord` cannot be applied to the widget indicated by the index, or if the index does not correspond to a widget on the page.
`IllegalStateException`	If the document is already closed.
`IllegalStateException`	If the page is already closed.

close

Added in API level 21

public void close ()

Closes this page.

See also:

PdfRenderer.openPage(int)

getFormWidgetInfoAtIndex

Added in API level 35

public FormWidgetInfo getFormWidgetInfoAtIndex (int widgetIndex)

Returns information about the widget with widgetIndex.

Parameters
`widgetIndex`	`int`: the index of the widget within the page's "Annot" array in the PDF document, available on results of previous calls to `getFormWidgetInfos(int[])` or `getFormWidgetInfoAtPosition(int, int)` via `FormWidgetInfo#getWidgetIndex()`. Value is 0 or greater

Returns
`FormWidgetInfo`	This value cannot be `null`.

Throws
`IllegalArgumentException`	if there is no form widget at the provided index.
`IllegalStateException`	if the renderer or page is closed

getFormWidgetInfoAtPosition

Added in API level 35

public FormWidgetInfo getFormWidgetInfoAtPosition (int x, 
                int y)

Returns information about the widget at the given point.

Parameters
`x`	`int`: the x position of the widget on the page, in points
`y`	`int`: the y position of the widget on the page, in points

Returns
`FormWidgetInfo`	This value cannot be `null`.

Throws
`IllegalArgumentException`	if there is no form widget at the provided position.
`IllegalStateException`	if the renderer or page is closed

getFormWidgetInfos

Added in API level 35

public List<FormWidgetInfo> getFormWidgetInfos ()

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

Returns
`List<FormWidgetInfo>`	This value cannot be `null`.

Throws
`IllegalStateException`	if the renderer or page is closed

getFormWidgetInfos

Added in API level 35

public List<FormWidgetInfo> getFormWidgetInfos (int[] types)

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.

Parameters
`types`	`int`: the types of form widgets to return, or an empty array to return all widgets This value cannot be `null`.

Returns
`List<FormWidgetInfo>`	This value cannot be `null`.

Throws
`IllegalStateException`	if the renderer or page is closed

getGotoLinks

Added in API level 35

public List<PdfPageGotoLinkContent> getGotoLinks ()

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.

Returns
`List<PdfPageGotoLinkContent>`	list of all goto links `PdfPageGotoLinkContent` on a page, ordered left to right and top to bottom. This value cannot be `null`.

Throws
`IllegalStateException`	If the document/page is closed before invocation.

getHeight

Added in API level 21

public int getHeight ()

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.

Returns
`int`	height of the page Value is 0 or greater

Throws
`IllegalStateException`	If the document/page is closed before invocation.

getImageContents

Added in API level 35

public List<PdfPageImageContent> getImageContents ()

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.

Returns
`List<PdfPageImageContent>`	list of image content found on the page. This value cannot be `null`.

Throws
`IllegalStateException`	If the document/page is closed before invocation.

getIndex

Added in API level 21

public int getIndex ()

Gets the page index.

Returns
`int`	The index. Value is 0 or greater

getLinkContents

Added in API level 35

public List<PdfPageLinkContent> getLinkContents ()

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

Returns
`List<PdfPageLinkContent>`	list of all links on the page. This value cannot be `null`.

Throws
`IllegalStateException`	If the document/page is closed before invocation.

getTextContents

Added in API level 35

public List<PdfPageTextContent> getTextContents ()

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.

Returns
`List<PdfPageTextContent>`	list of text content found on the page. This value cannot be `null`.

Throws
`IllegalStateException`	If the document/page is closed before invocation.

getWidth

Added in API level 21

public int getWidth ()

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.

Returns
`int`	width of the page Value is 0 or greater

Throws
`IllegalStateException`	If the document/page is closed before invocation.

render

Added in API level 21

public void render (Bitmap destination, 
                Rect destClip, 
                Matrix transform, 
                int renderMode)

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.

Parameters
`destination`	`Bitmap`: Destination bitmap to which to render. This value cannot be `null`.
`destClip`	`Rect`: Optional clip in the bitmap bounds. This value may be `null`.
`transform`	`Matrix`: Optional transformation to apply when rendering. This value may be `null`.
`renderMode`	`int`: The render mode. Value is `RENDER_MODE_FOR_DISPLAY`, or `RENDER_MODE_FOR_PRINT`

See also:

render

Added in API level 35

public void render (Bitmap destination, 
                Rect destClip, 
                Matrix transform, 
                RenderParams params)

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 ERROR(/android.annotation.WorkerThread) as it is long-running task.

Parameters
`destination`	`Bitmap`: Destination bitmap to write to. This value cannot be `null`.
`destClip`	`Rect`: If null, default zoom is applied. In case the value is non-null, the value specifies the top top-left corner of the tile.
`transform`	`Matrix`: Applied to scale the bitmap up/down from default 1/72 points. This value may be `null`.
`params`	`RenderParams`: Render params for the changing display mode and/or annotations. This value cannot be `null`.

Throws
`IllegalStateException`	If the document/page is closed before invocation.

searchText

Added in API level 35

public List<PageMatchBounds> searchText (String query)

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 ERROR(/android.annotation.WorkerThread) as it is long-running task.

Parameters
`query`	`String`: plain search string for querying the document This value cannot be `null`.

Returns
`List<PageMatchBounds>`	List of `PageMatchBounds` representing the bounds of each match on the page. This value cannot be `null`.

Throws
`IllegalStateException`	If the document/page is closed before invocation.

selectContent

Added in API level 35

public PageSelection selectContent (SelectionBoundary start, 
                SelectionBoundary stop)

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 ERROR(/android.annotation.WorkerThread) as it is long-running task.

Parameters
`start`	`SelectionBoundary`: boundary where the selection starts (inclusive) This value cannot be `null`.
`stop`	`SelectionBoundary`: boundary where the selection stops (exclusive) This value cannot be `null`.

Returns
`PageSelection`	collection of the selected content for text, images, etc.

Throws
`IllegalStateException`	If the document/page is closed before invocation.

Protected methods

finalize

Added in API level 21

protected void finalize ()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Throws
`Throwable`