RenderParams

Kotlin |Java

public final class RenderParams implements Parcelable

The set of parameters that will be used to render the page of a PDF Document. It can be tuned to set the render mode, render flags and render form content mode.

Note: renderFlags defaults to FLAG_RENDER_NONE which means that no annotations will be rendered on the bitmap. renderFormContentMode defaults to RENDER_FORM_CONTENT_ENABLED which means that PDF form widgets (if present) will be rendered on the bitmap.

See also
`RenderParams.RenderMode`
`RenderParams.RenderFlags`
`RenderParams.RenderFormContentMode`

Summary

Constants
`static final int`	`FLAG_RENDER_FREETEXT` Flag to enable rendering of freetext annotation on the page.
`static final int`	`FLAG_RENDER_HIGHLIGHT_ANNOTATIONS` Flag to enable rendering of highlight annotation on the page.
`static final int`	`FLAG_RENDER_NONE = 0` Flag to disable rendering of all types of annotations on the page.
`static final int`	`FLAG_RENDER_STAMP_ANNOTATIONS` Flag to enable rendering of stamp annotation on the page.
`static final int`	`FLAG_RENDER_TEXT_ANNOTATIONS` Flag to enable rendering of text annotation on the page.
`static final int`	`RENDER_FORM_CONTENT_DISABLED = 2` Mode to exclude PDF form content in rendered PDF bitmaps.
`static final int`	`RENDER_FORM_CONTENT_ENABLED = 1` Mode to include PDF form content in rendered PDF bitmaps.
`static final int`	`RENDER_MODE_FOR_DISPLAY = 1` Mode to render the content for display on a screen.
`static final int`	`RENDER_MODE_FOR_PRINT = 2` Mode to render the content for printing.

Public fields
`static final @NonNull Parcelable.Creator<@NonNull RenderParams>`	`CREATOR`

Public constructors
`RenderParams(int renderMode, int renderFlags, int renderFormContentMode)`

Public methods
`int`	`describeContents()`
`boolean`	`equals(Object other)`
`final int`	`getRenderFlags()`
`final int`	`getRenderFormContentMode()`
`final int`	`getRenderMode()`
`int`	`hashCode()`
`void`	`writeToParcel(@NonNull Parcel dest, int flags)`

Constants

FLAG_RENDER_FREETEXT

public static final int FLAG_RENDER_FREETEXT

Flag to enable rendering of freetext annotation on the page.

FLAG_RENDER_HIGHLIGHT_ANNOTATIONS

public static final int FLAG_RENDER_HIGHLIGHT_ANNOTATIONS

Flag to enable rendering of highlight annotation on the page.

FLAG_RENDER_NONE

public static final int FLAG_RENDER_NONE = 0

Flag to disable rendering of all types of annotations on the page.

FLAG_RENDER_STAMP_ANNOTATIONS

public static final int FLAG_RENDER_STAMP_ANNOTATIONS

Flag to enable rendering of stamp annotation on the page.

FLAG_RENDER_TEXT_ANNOTATIONS

public static final int FLAG_RENDER_TEXT_ANNOTATIONS

Flag to enable rendering of text annotation on the page.

RENDER_FORM_CONTENT_DISABLED

public static final int RENDER_FORM_CONTENT_DISABLED = 2

Mode to exclude PDF form content in rendered PDF bitmaps.

RENDER_FORM_CONTENT_ENABLED

public static final int RENDER_FORM_CONTENT_ENABLED = 1

Mode to include PDF form content in rendered PDF bitmaps.

RENDER_MODE_FOR_DISPLAY

public static final int RENDER_MODE_FOR_DISPLAY = 1

Mode to render the content for display on a screen.

RENDER_MODE_FOR_PRINT

public static final int RENDER_MODE_FOR_PRINT = 2

Mode to render the content for printing.

Public fields

CREATOR

public static final @NonNull Parcelable.Creator<@NonNull RenderParams> CREATOR

Public constructors

RenderParams

Added in 1.0.0-alpha13

public RenderParams(int renderMode, int renderFlags, int renderFormContentMode)

Public methods

describeContents

Added in 1.0.0-alpha13

public int describeContents()

equals

public boolean equals(Object other)

getRenderFlags

Added in 1.0.0-alpha13

public final int getRenderFlags()

getRenderFormContentMode

Added in 1.0.0-alpha13

public final int getRenderFormContentMode()

getRenderMode

Added in 1.0.0-alpha13

public final int getRenderMode()

hashCode

public int hashCode()

writeToParcel

Added in 1.0.0-alpha13

public void writeToParcel(@NonNull Parcel dest, int flags)