Skip to content

Most visited

Recently visited

navigation

PdfRenderer.Page

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

void close()

Closes this page.

int getHeight()

Gets the page height in points (1/72").

int getIndex()

Gets the page index.

int getWidth()

Gets the page width in points (1/72").

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

Renders a page to a bitmap.

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
From interface java.lang.AutoCloseable

Constants

RENDER_MODE_FOR_DISPLAY

added in API level 21
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
int RENDER_MODE_FOR_PRINT

Mode to render the content for printing.

Constant Value: 2 (0x00000002)

Public methods

close

added in API level 21
void close ()

Closes this page.

See also:

getHeight

added in API level 21
int getHeight ()

Gets the page height in points (1/72").

Returns
int The height in points.

getIndex

added in API level 21
int getIndex ()

Gets the page index.

Returns
int The index.

getWidth

added in API level 21
int getWidth ()

Gets the page width in points (1/72").

Returns
int The width in points.

render

added in API level 21
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.
destClip Rect: Optional clip in the bitmap bounds.
transform Matrix: Optional transformation to apply when rendering.
renderMode int: The render mode.

See also:

Protected methods

finalize

added in API level 21
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
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.