Added in API level 35
Also in S Extensions 13

Summary: Ctors | Methods | Inherited Methods

RenderParams.Builder

Kotlin |Java

public static final class RenderParams.Builder
extends Object

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

Builder for constructing RenderParams.

Summary

Public constructors
`Builder(int renderMode)` Create a builder for constructing a `RenderParams` object with the render mode.

Public methods
`RenderParams`	`build()` Builds the `RenderParams` after the optional values has been set.
`RenderParams.Builder`	`setRenderFlags(int renderFlags, int mask)` Sets the state of the render flag specified by the mask.
`RenderParams.Builder`	`setRenderFlags(int renderFlags)` Sets the state of the render flag.
`RenderParams.Builder`	`setRenderFormContentMode(int renderFormContentMode)` Sets the mode to include or exclude form content in rendered PDF bitmaps.

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.

Public constructors

Builder

Added in API level 35
Also in S Extensions 13

public Builder (int renderMode)

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

Parameters
`renderMode`	`int`: render mode for the content. Value is `RenderParams.RENDER_MODE_FOR_DISPLAY`, or `RenderParams.RENDER_MODE_FOR_PRINT`

Public methods

build

Added in API level 35
Also in S Extensions 13

public RenderParams build ()

Builds the RenderParams after the optional values has been set.

Returns
`RenderParams`	the newly constructed `RenderParams` object This value cannot be `null`.

setRenderFlags

Added in API level 35
Also in S Extensions 13

public RenderParams.Builder setRenderFlags (int renderFlags, 
                int mask)

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 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

Parameters
`renderFlags`	`int`: the render flag, or the logical OR of multiple render flags. One or more of: `RenderParams.FLAG_RENDER_TEXT_ANNOTATIONS` `RenderParams.FLAG_RENDER_HIGHLIGHT_ANNOTATIONS` Value is either `0` or a combination of `RenderParams.FLAG_RENDER_TEXT_ANNOTATIONS`, `RenderParams.FLAG_RENDER_HIGHLIGHT_ANNOTATIONS`, `RenderParams.FLAG_RENDER_STAMP_ANNOTATIONS`, and `RenderParams.FLAG_RENDER_FREETEXT_ANNOTATIONS`
`mask`	`int`: Value is either `0` or a combination of `RenderParams.FLAG_RENDER_TEXT_ANNOTATIONS`, `RenderParams.FLAG_RENDER_HIGHLIGHT_ANNOTATIONS`, `RenderParams.FLAG_RENDER_STAMP_ANNOTATIONS`, and `RenderParams.FLAG_RENDER_FREETEXT_ANNOTATIONS`

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 RenderParams.FLAG_RENDER_TEXT_ANNOTATIONS, RenderParams.FLAG_RENDER_HIGHLIGHT_ANNOTATIONS, RenderParams.FLAG_RENDER_STAMP_ANNOTATIONS, and RenderParams.FLAG_RENDER_FREETEXT_ANNOTATIONS

mask

int: Value is either 0 or a combination of RenderParams.FLAG_RENDER_TEXT_ANNOTATIONS, RenderParams.FLAG_RENDER_HIGHLIGHT_ANNOTATIONS, RenderParams.FLAG_RENDER_STAMP_ANNOTATIONS, and RenderParams.FLAG_RENDER_FREETEXT_ANNOTATIONS

Returns
`RenderParams.Builder`	This value cannot be `null`.

See also:

setRenderFlags

Added in API level 35
Also in S Extensions 13

public RenderParams.Builder setRenderFlags (int renderFlags)

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 `RenderParams.FLAG_RENDER_TEXT_ANNOTATIONS`, `RenderParams.FLAG_RENDER_HIGHLIGHT_ANNOTATIONS`, `RenderParams.FLAG_RENDER_STAMP_ANNOTATIONS`, and `RenderParams.FLAG_RENDER_FREETEXT_ANNOTATIONS`

Returns
`RenderParams.Builder`	This value cannot be `null`.

See also:

setRenderFormContentMode

Added in S Extensions 19

public RenderParams.Builder setRenderFormContentMode (int renderFormContentMode)

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

In PdfRenderer form content is rendered by default for applications targeting 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 `RenderParams.RENDER_FORM_CONTENT_ENABLED`, `RenderParams.RENDER_FORM_CONTENT_DISABLED`, or `RenderParams.RENDER_FORM_CONTENT_DEFAULT`

Returns
`RenderParams.Builder`	This value cannot be `null`.