PdfRenderer.Page

RENDER_MODE_FOR_DISPLAY

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

public static final int RENDER_MODE_FOR_PRINT

Mode to render the content for printing.

Constant Value: 2 (0x00000002)

addPageAnnotation

public int addPageAnnotation (PdfAnnotation annotation)

Adds the given annotation to the page. The annotation should be of supported type. See PdfAnnotationType for the supported types

PdfRenderer.write needs to be called to get the updated PDF stream after calling this method. PdfRenderer.Page instance can be closed before calling PdfRenderer.write.

addPageObject

public int addPageObject (PdfPageObject pageObject)

Adds the given PdfPageObject to the page.

PdfRenderer.write needs to be called to get the updated PDF stream after calling this method. PdfRenderer.Page instance can be closed before calling PdfRenderer.write.

applyEdit

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.

close

public void close ()

Closes this page.

getFormWidgetInfoAtIndex

public FormWidgetInfo getFormWidgetInfoAtIndex (int widgetIndex)

Returns information about the widget with widgetIndex.

getFormWidgetInfoAtPosition

public FormWidgetInfo getFormWidgetInfoAtPosition (int x, 
                int y)

Returns information about the widget at the given point.

getFormWidgetInfos

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.

getFormWidgetInfos

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.

getGotoLinks

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.

getHeight

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.

getImageContents

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.

getIndex

public int getIndex ()

Gets the page index.

getLinkContents

public List<PdfPageLinkContent> getLinkContents ()

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

getPageAnnotations

public List<Pair<Integer, PdfAnnotation>> getPageAnnotations ()

Returns a list of pairs, where each pair consists of a supported PdfAnnotation and its corresponding ID on the specified page. ID of the annotation will be required for updatePageAnnotation(int, android.graphics.pdf.component.PdfAnnotation) and removePageAnnotation(int) and will remain same without mutate operations.

The returned list will be empty if no supported annotations are present on the page, even if the page contains other annotation types. Refer to PdfAnnotationType for the supported annotation types.

getPageObjects

public List<Pair<Integer, PdfPageObject>> getPageObjects ()

Returns List of Pair objects, where each pair contains: - An Integer representing the object ID, which is required for updatePageObject(int, android.graphics.pdf.component.PdfPageObject) and removePageObject(int). Object ID will remain same without mutate operations. - A PdfPageObject representing the page object.

The list will be empty if there are no supported page objects present on the page, even if the page contains other page object types.

getTextContents

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.

getTopPageObjectAtPosition

public Pair<Integer, PdfPageObject> getTopPageObjectAtPosition (PointF point, 
                int[] types)

Retrieves the top-most page object at a specified position.

getWidth

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.

removePageAnnotation

public void removePageAnnotation (int annotationId)

Removes the annotation with the specified id.

PdfRenderer.write needs to be called to get the updated PDF stream after calling this method. PdfRenderer.Page instance can be closed before calling PdfRenderer.write.

removePageObject

public void removePageObject (int objectId)

Removes the PdfPageObject with the specified ID.

PdfRenderer.write needs to be called to get the updated PDF stream after calling this method. PdfRenderer.Page instance can be closed before calling PdfRenderer.write.

render

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.

render

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.

searchText

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.

selectContent

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.

updatePageAnnotation

public boolean updatePageAnnotation (int annotationId, 
                PdfAnnotation annotation)

Update the given PdfAnnotation to the page.

Note: The PdfAnnotationType of the provided annotation must be the same as the original annotation being updated.

PdfRenderer.write needs to be called to get the updated PDF stream after calling this method. PdfRenderer.Page instance can be closed before calling PdfRenderer.write.

updatePageObject

public boolean updatePageObject (int objectId, 
                PdfPageObject pageObject)

Update the given PdfPageObject to the page.

Note: This method only updates the parameters of the PageObject whose setters are available. Attempting to update fields with no corresponding setters will have no effect. Furthermore, the PdfPageObjectType of the provided pageObject must be the same as the original pageObject being updated.

PdfRenderer.write needs to be called to get the updated PDF stream after calling this method. PdfRenderer.Page instance can be closed before calling PdfRenderer.write.

finalize

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.