![]() |
SignDoc SDK (Java)
5.0.0
|
Parameters for SignDocDocument.renderPageAsImage() and SignDocDocument.renderPageAsSignDocImage(). More...
Public Member Functions | |
SignDocRenderParameters () throws SignDocException | |
Constructor. More... | |
synchronized void | clear () throws SignDocException |
Reset all parameters to their initial values. More... | |
synchronized void | setBoolean (String aName, boolean aValue) throws SignDocException |
Set a boolean parameter. More... | |
synchronized void | setInteger (String aName, int aValue) throws SignDocException |
Set an integer parameter. More... | |
synchronized void | setNumber (String aName, double aValue) throws SignDocException |
Set a floating-point number parameter. More... | |
synchronized void | setString (String aName, String aValue) throws SignDocException |
Set a string parameter. More... | |
synchronized void | setString2 (String aName, String aName2, String aValue) throws SignDocException |
Set a string parameter with two parameter names. More... | |
synchronized Boolean | getBoolean (String aName) throws SignDocException |
Get the value of a boolean parameter. More... | |
synchronized Integer | getInteger (String aName) throws SignDocException |
Get the value of an integer parameter. More... | |
synchronized Double | getNumber (String aName) throws SignDocException |
Get the value of a floating-point number parameter. More... | |
synchronized String | getString (String aName) throws SignDocException |
Get the value of a string parameter. More... | |
synchronized String | getString2 (String aName, String aName2) throws SignDocException |
Get the value of a string parameter with two parameter names. More... | |
synchronized String | getErrorMessage () throws SignDocException |
Get an error message for the last function call. More... | |
synchronized boolean | equals (SignDocRenderParameters aRHS) throws SignDocException |
Compare against another SignDocRenderParameters object. More... | |
synchronized void | close () |
Destroy the underlying native object (for java.lang.AutoCloseable). More... | |
Static Public Member Functions | |
static int | getType (String aName) throws SignDocException |
Get the type of a parameter. More... | |
Static Public Attributes | |
static final int | t_undefined = 0 |
Return value of getType(): The specified parameter is not defined. More... | |
static final int | t_boolean = 1 |
Return value of getType(): Boolean. More... | |
static final int | t_integer = 2 |
Return value of getType(): Integer. More... | |
static final int | t_number = 3 |
Return value of getType(): Floating-point number. More... | |
static final int | t_string = 4 |
Return value of getType(): String. More... | |
static final int | t_string2 = 6 |
Return value of getType(): String (two parameter names). More... | |
Protected Member Functions | |
void | finalize () throws Throwable |
Finalize this object. More... | |
Parameters for SignDocDocument.renderPageAsImage() and SignDocDocument.renderPageAsSignDocImage().
SignDocRenderParameters | ( | ) | throws SignDocException |
Constructor.
No parameters will be set.
synchronized void clear | ( | ) | throws SignDocException |
Reset all parameters to their initial values.
synchronized void close | ( | ) |
Destroy the underlying native object (for java.lang.AutoCloseable).
After calling this method, all methods but close() will throw SignDocUnexpectedErrorException.
synchronized boolean equals | ( | SignDocRenderParameters | aRHS | ) | throws SignDocException |
Compare against another SignDocRenderParameters object.
[in] | aRHS | The object to compare against. |
|
protected |
Finalize this object.
Do not call this method unless you know what you are doing.
synchronized Boolean getBoolean | ( | String | aName | ) | throws SignDocException |
Get the value of a boolean parameter.
This function does not set an error message.
[in] | aName | The name of the parameter (case-sensitive). |
synchronized String getErrorMessage | ( | ) | throws SignDocException |
Get an error message for the last function call.
synchronized Integer getInteger | ( | String | aName | ) | throws SignDocException |
Get the value of an integer parameter.
This function does not set an error message.
[in] | aName | The name of the parameter (case-sensitive). |
synchronized Double getNumber | ( | String | aName | ) | throws SignDocException |
Get the value of a floating-point number parameter.
This function does not set an error message.
[in] | aName | The name of the parameter (case-sensitive). |
synchronized String getString | ( | String | aName | ) | throws SignDocException |
Get the value of a string parameter.
This function does not set an error message.
[in] | aName | The name of the parameter (case-sensitive). |
synchronized String getString2 | ( | String | aName, |
String | aName2 | ||
) | throws SignDocException |
Get the value of a string parameter with two parameter names.
This function does not set an error message.
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aName2 | The second name of the parameter (case-sensitive). |
|
static |
Get the type of a parameter.
[in] | aName | The name of the parameter (case-sensitive). |
synchronized void setBoolean | ( | String | aName, |
boolean | aValue | ||
) | throws SignDocException |
Set a boolean parameter.
The following boolean parameters are available:
AddDecorations: Enable rendering of decorations of signature fields of PDF documents. If true, an icon visualizing the signature status will be added to each signature field:
You might want to set boolean parameter "UseModificationState" to true to compute the signature state more thoroughly.
Enabling rendering of decorations can slow down SignDocDocument.renderPageAsImage() and SignDocDocument.renderPageAsSignDocImage() 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() and SignDocDocument.renderPageAsSignDocImage(). Setting string parameter (with two parameter names) "DecorationState" might solve these problems.
It is recommended to display the status of signatures off-page rather than using this parameter, see SignDocDocument.getSignature().
For TIFF documents, this parameter is ignored; a red cross will be displayed in signature fields if the signature is broken.
This function throws SignDocUnkownParameterException if aName is not the name of a boolean parameter.
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
synchronized void setInteger | ( | String | aName, |
int | aValue | ||
) | throws SignDocException |
Set an integer parameter.
The following integer parameters are available:
This function throws SignDocUnkownParameterException if aName is not the name of an integer parameter, SignDocInvalidValueException if aValue is invalid.
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
synchronized void setNumber | ( | String | aName, |
double | aValue | ||
) | throws SignDocException |
Set a floating-point number parameter.
The following floating-point number parameters are available:
This function throws SignDocUnkownParameterException if aName is not the name of a floating-point number parameter, SignDocInvalidValueException if aValue is invalid.
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
synchronized void setString | ( | String | aName, |
String | aValue | ||
) | throws SignDocException |
Set a string parameter.
The following string parameters are available:
This function throws SignDocUnkownParameterException if aName is not the name of a string parameter, SignDocInvalidValueException if aValue is invalid.
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
synchronized void setString2 | ( | String | aName, |
String | aName2, | ||
String | aValue | ||
) | throws SignDocException |
Set a string parameter with two parameter names.
The following string parameters with two parameter names are available:
This function throws SignDocUnkownParameterException if aName is not the name of a string parameter with two parameter names, SignDocInvalidValueException if aValue is invalid.
[in] | aName | The name of the parameter (case-sensitive). |
[in] | aName2 | The second name of the parameter (case-sensitive). |
[in] | aValue | The value of the parameter. |
|
static |
Return value of getType(): Boolean.
|
static |
Return value of getType(): Integer.
|
static |
Return value of getType(): Floating-point number.
|
static |
Return value of getType(): String.
|
static |
Return value of getType(): String (two parameter names).
|
static |
Return value of getType(): The specified parameter is not defined.