Constructor.

Copy Constructor.

Releases all resources used by the SignDocRenderParameters

Compare against another SignDocRenderParameters object. The exact order of SignDocRenderParameters is unspecified but consistent.

Set the height for automatic computation of the zoom factor to make the rendered image fit the specified height. This function overrides the zoom factor set by fitWidth(), fitRect(), and setZoom(). Throws SignDocInvalidArgumentException if the height is invalid.

Set the width and height for automatic computation of the zoom factor to make the rendered image fit the specified width and height. This function overrides the zoom factor set by fitWidth(), fitHeight(), and setZoom(). Throws SignDocInvalidArgumentException if the width or the height is invalid.

Set the width for automatic computation of the zoom factor to make the rendered image fit the specified width. This function overrides the zoom factor set by fitHeight(), fitRect(), and setZoom(). Throws SignDocInvalidArgumentException if the width is invalid.

Get the compression method.

Get the value set by setDecorations().

Get a value set by setDecorationState().

Get the first page number of the selected range of pages. Throws SignDocParameterNotSetException if setPage() and setPages() have not been called.

Get the height set by fitHeight(). Throws SignDocParameterNotSetException if setFitHeight() has not been called successfully.

Get the height set by fitRect(). Throws SignDocParameterNotSetException if setFitRect() has not been called successfully.

Get the width set by fitRect(). Throws SignDocParameterNotSetException if setFitRect() has not been called successfully.

Get the width set by fitWidth(). Throws SignDocParameterNotSetException if getFitWidth() has not been called successfully.

Get the image format.

Get the interlacing method.

Get the last page number of the selected range of pages. Throws SignDocParameterNotSetException if setPage() and setPages() have not been called.

Get the value set by setModificationState().

Get the number of the selected page. Throws SignDocParameterNotSetException if setPage() has not been called successfully or if multiple pages have been selected with setPages().

Get the pixel format.

Get the value set by setPrint().

Get the desired quality.

Get the horizontal resolution set by setResolution(). Throws SignDocParameterNotSetException if setResolution() has not been called successfully.

Get the vertical resolution set by setResolution(). Throws SignDocParameterNotSetException if setResolution() has not been called successfully.

Get the zoom factor set by setZoom(). This function does not retrieve the zoom factor to be computed for fitWidth(), fitHeight(), and fitRect(). Use SignDocDocument.computeZoom() for that. Throws SignDocParameterNotSetException if setZoom() has not been called successfully.

Set the compression method. The initial value is c_default.

Enable rendering of decorations. The default value is false. For PDF documents, pages may optionally be rendered with decorations: An icon visualizing the signature status will be added to each signature field: - no icon (signature field not signed) - green check mark (signature is OK) - green check mark with yellow triangle (signature is OK but the certificate is not trusted or the document has been extended, ie, modified and saved incrementally after signing) - red cross (signature broken) . You might want to call setModificationState(true) to compute the signature state more thoroughly. Enabling rendering of decorations can slow down SignDocDocument.renderPageAsImage() substantially for PDF documents as each call will validate all the signatures of the page.Moreover, long term validation(LTV) is currently not supported by SignDocDocument::renderPageAsImage().Using setDecorationState() might solve these problems. It is recommended to display the status of signatures off - page rather than using setDecorations(true), see SignDocDocument.getSignature(). For TIFF documents, this value is ignored; a red cross will be displayed in signature fields if the signature is broken.

Set the decoration state for a single signature in a PDF document. This function does not check whether the field exists. The decorations set by this function are ignored unless setDecorations(true) is in effect. #ds_auto will be assumed for all fields for which setDecorationState() has not been called. Any values set with this function will be ignored for rendering TIFF documents.

Set the image format. There is no initial value, ie, this function must be called. Currently, this function does not check the image format.

Set the interlacing method. Interlacing is used for progressive encoding. The initial value is i_off.

Enable getting the modification state. The default value is false.

Select the page to be rendered. There is no initial value, ie, either this function or setPages() must be called. Throws SignDocInvalidArgumentException if the page number is invalid.

Select a range of pages to be rendered. There is no initial value, ie, either this function or setPage() must be called.

Set the pixel format. The initial value is pf_default.

Enable rendering for printing. The default value is false (render for displaying).

Set the desired quality. This setting affects scaling of pages of TIFF documents. The initial value is q_low.

Set the resolution for rendering PDF documents. The values passed to this function will be ignored for TIFF documents as the resolution is computed automatically from the zoom factor and the document's resolution. If this function is not called, 96 DPI (subject to change) will be used for rendering PDF documents. Throws SignDocInvalidArgumentException if the resolution is invalid.

Set the zoom factor for rendering. There is no initial value, ie, this function or fitWidth() or fitHeight() or fitRect() must be called. This function overrides fitWidth(), fitHeight(), and fitRect(). Throws SignDocInvalidArgumentException if the zoom factor is invalid.