PreviewSignatureOptions
Contents
[
Hide
]
Inheritance: java.lang.Object
public class PreviewSignatureOptions
Represents signature preview options.
Constructors
| Constructor | Description |
|---|---|
| PreviewSignatureOptions(SignOptions signOptions, PageSignatureStreamFactory pageStreamFactory) | Initializes PreviewSignatureOptions object. |
Methods
| Method | Description |
|---|---|
| getSignatureId() | Unique value to distinct the signature. |
| setSignatureId(String value) | Unique value to distinct the signature. |
| getSignOptions() | Signature Options for generate preview. |
| setSignOptions(SignOptions value) | Signature Options for generate preview. |
| getPreviewFormat() | Gets or sets preview images format. |
| setPreviewFormat(int value) | Gets or sets preview images format. |
PreviewSignatureOptions(SignOptions signOptions, PageSignatureStreamFactory pageStreamFactory)
public PreviewSignatureOptions(SignOptions signOptions, PageSignatureStreamFactory pageStreamFactory)
Initializes PreviewSignatureOptions object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| signOptions | SignOptions | The signature options to generate preview for. |
| pageStreamFactory | PageSignatureStreamFactory | Interface which defines method to create output page preview stream. |
getSignatureId()
public final String getSignatureId()
Unique value to distinct the signature. Use SignatureId to identify the preview options.
Returns: java.lang.String
setSignatureId(String value)
public final void setSignatureId(String value)
Unique value to distinct the signature. Use SignatureId to identify the preview options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getSignOptions()
public final SignOptions getSignOptions()
Signature Options for generate preview.
Returns: SignOptions
setSignOptions(SignOptions value)
public final void setSignOptions(SignOptions value)
Signature Options for generate preview.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | SignOptions |
getPreviewFormat()
public final int getPreviewFormat()
Gets or sets preview images format. Default value is PNG
Returns: int
setPreviewFormat(int value)
public final void setPreviewFormat(int value)
Gets or sets preview images format. Default value is PNG
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |