RenderParams.Builder


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.

Inherited methods

Public constructors

Builder

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

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

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

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

Returns
RenderParams.Builder This value cannot be null.

setRenderFlags

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

Returns
RenderParams.Builder This value cannot be null.