Added in API level 35
Also in S Extensions 13

Builder

class Builder
kotlin.Any
   ↳ android.graphics.pdf.RenderParams.Builder

Builder for constructing RenderParams.

Summary

Public constructors
Builder(renderMode: Int)

Create a builder for constructing a RenderParams object with the render mode.
Public methods
RenderParams

Builds the RenderParams after the optional values has been set.
RenderParams.Builder
setRenderFlags(renderFlags: Int)

Sets the state of the render flag.
RenderParams.Builder
setRenderFlags(renderFlags: Int, mask: Int)

Sets the state of the render flag specified by the mask.
RenderParams.Builder
setRenderFormContentMode(renderFormContentMode: Int)

Sets the mode to include or exclude form content in rendered PDF bitmaps.

Public constructors

Builder

Added in API level 35
Also in S Extensions 13
Builder(renderMode: Int)

Create a builder for constructing a RenderParams object with the render mode.

Parameters
renderMode Int: render mode for the content. Value is android.graphics.pdf.RenderParams#RENDER_MODE_FOR_DISPLAY, or android.graphics.pdf.RenderParams#RENDER_MODE_FOR_PRINT

Public methods

build

Added in API level 35
Also in S Extensions 13
fun build(): RenderParams

Builds the RenderParams after the optional values has been set.

Return
RenderParams the newly constructed RenderParams object This value cannot be null.

setRenderFlags

Added in API level 35
Also in S Extensions 13
fun setRenderFlags(renderFlags: Int): RenderParams.Builder

Sets the state of the render flag. See setRenderFlags(int,int) for usage information.

Parameters
renderFlags Int: the bitmask of the render flag should be enabled, or 0 to disable all flags. Value is either 0 or a combination of android.graphics.pdf.RenderParams#FLAG_RENDER_TEXT_ANNOTATIONS, android.graphics.pdf.RenderParams#FLAG_RENDER_HIGHLIGHT_ANNOTATIONS, android.graphics.pdf.RenderParams#FLAG_RENDER_STAMP_ANNOTATIONS, and android.graphics.pdf.RenderParams#FLAG_RENDER_FREETEXT_ANNOTATIONS
Return
RenderParams.Builder This value cannot be null.

setRenderFlags

Added in API level 35
Also in S Extensions 13
fun setRenderFlags(
    renderFlags: Int, 
    mask: Int
): RenderParams.Builder

Sets the state of the render flag specified by the mask. To change all render flags at once, see setRenderFlags(int).

When a render flag is enabled, it will be displayed on the updated android.graphics.Bitmap of the renderer.

Multiple indicator types may be enabled or disabled by passing the logical OR of the desired flags. If multiple flags are specified, they will all be set to the same enabled state.

For example, to enable the render text annotations flag: setRenderFlags(FLAG_RENDER_TEXT_ANNOTATIONS, FLAG_RENDER_TEXT_ANNOTATIONS)

To disable the render text annotations flag: setRenderFlags(0, FLAG_RENDER_TEXT_ANNOTATIONS)

Parameters
renderFlags Int: the render flag, or the logical OR of multiple render flags. One or more of: Value is either 0 or a combination of android.graphics.pdf.RenderParams#FLAG_RENDER_TEXT_ANNOTATIONS, android.graphics.pdf.RenderParams#FLAG_RENDER_HIGHLIGHT_ANNOTATIONS, android.graphics.pdf.RenderParams#FLAG_RENDER_STAMP_ANNOTATIONS, and android.graphics.pdf.RenderParams#FLAG_RENDER_FREETEXT_ANNOTATIONS
mask Int: Value is either 0 or a combination of android.graphics.pdf.RenderParams#FLAG_RENDER_TEXT_ANNOTATIONS, android.graphics.pdf.RenderParams#FLAG_RENDER_HIGHLIGHT_ANNOTATIONS, android.graphics.pdf.RenderParams#FLAG_RENDER_STAMP_ANNOTATIONS, and android.graphics.pdf.RenderParams#FLAG_RENDER_FREETEXT_ANNOTATIONS
Return
RenderParams.Builder This value cannot be null.

setRenderFormContentMode

Added in S Extensions 19
fun setRenderFormContentMode(renderFormContentMode: Int): RenderParams.Builder

Sets the mode to include or exclude form content in rendered PDF bitmaps. One of: RENDER_FORM_CONTENT_ENABLED, RENDER_FORM_CONTENT_DISABLED, or RENDER_FORM_CONTENT_DEFAULT.

In PdfRenderer form content is rendered by default for applications targeting android.os.Build.VERSION_CODES#VANILLA_ICE_CREAM or higher. This option can be used to enable this behavior when targeting lower SDK versions, or to disable this behavior when targeting higher SDK versions.

In PdfRendererPreV form content is always rendered by default. This option can be used to disable this behavior.

Parameters
renderFormContentMode Int: Value is android.graphics.pdf.RenderParams#RENDER_FORM_CONTENT_ENABLED, android.graphics.pdf.RenderParams#RENDER_FORM_CONTENT_DISABLED, or android.graphics.pdf.RenderParams#RENDER_FORM_CONTENT_DEFAULT
Return
RenderParams.Builder This value cannot be null.