Added in API level 35
Also in S Extensions 13

Summary: Nested Classes | Constants | Methods | Inherited Methods

RenderParams

Kotlin |Java

public final class RenderParams
extends Object

java.lang.Object
↳	android.graphics.pdf.RenderParams

Represents a set of parameters that will be used to render a page of the PDF document.

Summary

Nested classes
`class`	`RenderParams.Builder` Builder for constructing `RenderParams`.

Constants
`int`	`FLAG_RENDER_FREETEXT_ANNOTATIONS` Flag to enable rendering of freetext annotation on the page.
`int`	`FLAG_RENDER_HIGHLIGHT_ANNOTATIONS` Flag to enable rendering of highlight annotation on the page.
`int`	`FLAG_RENDER_STAMP_ANNOTATIONS` Flag to enable rendering of stamp annotation on the page.
`int`	`FLAG_RENDER_TEXT_ANNOTATIONS` Flag to enable rendering of text annotation on the page.
`int`	`RENDER_FORM_CONTENT_DEFAULT` Mode to rely on the default behavior with respect to including PDF form content in rendered PDF bitmaps.
`int`	`RENDER_FORM_CONTENT_DISABLED` Mode to exclude PDF form content from rendered PDF bitmaps.
`int`	`RENDER_FORM_CONTENT_ENABLED` Mode to include PDF form content in rendered PDF bitmaps.
`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
`int`	`getRenderFlags()` Returns the bitmask of the render flags.
`int`	`getRenderFormContentMode()` Returns the mode for rendering PDF form content, one of: `RENDER_FORM_CONTENT_ENABLED`, `RENDER_FORM_CONTENT_DISABLED`, or `RENDER_FORM_CONTENT_DEFAULT`
`int`	`getRenderMode()` Returns the render mode.

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.

Constants

FLAG_RENDER_FREETEXT_ANNOTATIONS

Added in S Extensions 18

public static final int FLAG_RENDER_FREETEXT_ANNOTATIONS

Flag to enable rendering of freetext annotation on the page.

See also:

Constant Value: 16 (0x00000010)

FLAG_RENDER_HIGHLIGHT_ANNOTATIONS

Added in API level 35
Also in S Extensions 13

public static final int FLAG_RENDER_HIGHLIGHT_ANNOTATIONS

Flag to enable rendering of highlight annotation on the page.

See also:

Constant Value: 4 (0x00000004)

FLAG_RENDER_STAMP_ANNOTATIONS

Added in S Extensions 18

public static final int FLAG_RENDER_STAMP_ANNOTATIONS

Flag to enable rendering of stamp annotation on the page.

See also:

Constant Value: 8 (0x00000008)

FLAG_RENDER_TEXT_ANNOTATIONS

Added in API level 35
Also in S Extensions 13

public static final int FLAG_RENDER_TEXT_ANNOTATIONS

Flag to enable rendering of text annotation on the page.

See also:

Constant Value: 2 (0x00000002)

RENDER_FORM_CONTENT_DEFAULT

Added in S Extensions 19

public static final int RENDER_FORM_CONTENT_DEFAULT

Mode to rely on the default behavior with respect to including PDF form content in rendered PDF bitmaps.

PdfRenderer will render form content by default if the application is targeting SDK version Build.VERSION_CODES.VANILLA_ICE_CREAM or higher.

PdfRendererPreV will always render form content by default.

Constant Value: 3 (0x00000003)

RENDER_FORM_CONTENT_DISABLED

Added in S Extensions 19

public static final int RENDER_FORM_CONTENT_DISABLED

Mode to exclude PDF form content from rendered PDF bitmaps.

Constant Value: 2 (0x00000002)

RENDER_FORM_CONTENT_ENABLED

Added in S Extensions 19

public static final int RENDER_FORM_CONTENT_ENABLED

Mode to include PDF form content in rendered PDF bitmaps.

Constant Value: 1 (0x00000001)

RENDER_MODE_FOR_DISPLAY

Added in API level 35
Also in S Extensions 13

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 35
Also in S Extensions 13

public static final int RENDER_MODE_FOR_PRINT

Mode to render the content for printing.

Constant Value: 2 (0x00000002)

Public methods

getRenderFlags

Added in API level 35
Also in S Extensions 13

public int getRenderFlags ()

Returns the bitmask of the render flags.

Returns
`int`	Value is either `0` or a combination of `FLAG_RENDER_TEXT_ANNOTATIONS`, `FLAG_RENDER_HIGHLIGHT_ANNOTATIONS`, `FLAG_RENDER_STAMP_ANNOTATIONS`, and `FLAG_RENDER_FREETEXT_ANNOTATIONS`

getRenderFormContentMode

Added in S Extensions 19

public int getRenderFormContentMode ()

Returns the mode for rendering PDF form content, one of: RENDER_FORM_CONTENT_ENABLED, RENDER_FORM_CONTENT_DISABLED, or RENDER_FORM_CONTENT_DEFAULT

Returns
`int`	Value is `RENDER_FORM_CONTENT_ENABLED`, `RENDER_FORM_CONTENT_DISABLED`, or `RENDER_FORM_CONTENT_DEFAULT`

getRenderMode

Added in API level 35
Also in S Extensions 13

public int getRenderMode ()

Returns the render mode.

Returns
`int`	Value is `RENDER_MODE_FOR_DISPLAY`, or `RENDER_MODE_FOR_PRINT`

RenderParams

Summary

Nested classes

Constants

Public methods

Inherited methods

Constants

FLAG_RENDER_FREETEXT_ANNOTATIONS

FLAG_RENDER_HIGHLIGHT_ANNOTATIONS

FLAG_RENDER_STAMP_ANNOTATIONS

FLAG_RENDER_TEXT_ANNOTATIONS

RENDER_FORM_CONTENT_DEFAULT

RENDER_FORM_CONTENT_DISABLED

RENDER_FORM_CONTENT_ENABLED

RENDER_MODE_FOR_DISPLAY

RENDER_MODE_FOR_PRINT

Public methods

getRenderFlags

getRenderFormContentMode

getRenderMode