SignatureProperties (i-net Clear Reports)

All Known Implementing Classes:

SignatureForm
```
public interface SignatureProperties
```
This class describes the look of visible signature field: which elements will be shown in certificate details, if any, whether the subject name will be written in separate part of the signature, whether the signature field must be divided into two parts. If the signature field is divided into two parts and only one 'standard' element (either certificate details or subject name) is written, then the empty part can be used to allocate some other report elements, e.g. database fields.

Since:

9.1

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`POSITION_LEFT` This value defines that the position of the text element is in the left side of the divided signature field.
`static int`	`POSITION_RIGHT` This value defines the position of the text element in the right side of the divided signature field.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`getDivideField()` Returns the flag indicating whether the signature field must be divided into two parts.
`boolean`	`getShowSubjectName()` Returns the flag indicating whether the subject common name must be written in a signature field.
`int`	`getTextPosition()` Returns the position of text-items in the divided signature field: `POSITION_LEFT`, `POSITION_RIGHT`.
`boolean`	`getWriteCertificateDate()` Returns the flag indicating whether the date of signing must be written in certificate details.
`boolean`	`getWriteCertificateDistinguishedName()` Returns the flag indicating whether the subject distinguished name must be written in certificate details.
`boolean`	`getWriteCertificateLabels()` Returns the flag indicating whether the labels of signature items must be written in certificate details.
`boolean`	`getWriteCertificateLocation()` Returns the flag indicating whether the subject location must be written in certificate details.
`boolean`	`getWriteCertificateReason()` Returns the flag indicating whether the reason of signing must be written in certificate details.
`boolean`	`getWriteCertificateSubjectName()` Returns the flag indicating whether the subject common name must be written in certificate details.
`void`	`setDivideField(boolean val)` Sets the flag indicating that the signature field must be divided into two parts.
`void`	`setShowSubjectName(boolean val)` Sets the flag indicating that the subject common name must be written in a signature field.
`void`	`setTextPosition(int pos)` Sets the position of text-items in the divided signature field: `POSITION_LEFT`, `POSITION_RIGHT`.
`void`	`setWriteCertificateDate(boolean val)` Sets the flag indicating that the date of signing must be written in certificate details.
`void`	`setWriteCertificateDistinguishedName(boolean val)` Sets the flag indicating that subject distinguished name must be written in certificate details.
`void`	`setWriteCertificateLabels(boolean val)` Sets the flag indicating that the labels of signature items must be written in certificate details.
`void`	`setWriteCertificateLocation(boolean val)` Sets the flag indicating whether the subject location must be written in certificate details.
`void`	`setWriteCertificateReason(boolean val)` Sets the flag indicating that the reason of signing must be written in certificate details.
`void`	`setWriteCertificateSubjectName(boolean val)` Sets the flag indicating that subject common name must be written in certificate details.

- Field Detail
  - POSITION_LEFT
```
static final int POSITION_LEFT
```
    This value defines that the position of the text element is in the left side of the divided signature field. If the both certificate details and the name must be written, the certificate details will be written in the left part. This is a default setting.
    
    See Also:
    
    Constant Field Values
  - POSITION_RIGHT
```
static final int POSITION_RIGHT
```
    This value defines the position of the text element in the right side of the divided signature field. If the both certificate details and the name must be written, the certificate details will be written in the right part.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setWriteCertificateSubjectName
```
void setWriteCertificateSubjectName(boolean val)
```
    Sets the flag indicating that subject common name must be written in certificate details.
    
    Parameters:
    
    val - if true the subject common name will be written in certificate details.
    
    Since:
    
    9.1
  - getWriteCertificateSubjectName
```
boolean getWriteCertificateSubjectName()
```
    Returns the flag indicating whether the subject common name must be written in certificate details.
    
    Returns:
    
    flag indicating if the subject common name will be written in certificate details.
    
    Since:
    
    9.1
  - setWriteCertificateLocation
```
void setWriteCertificateLocation(boolean val)
```
    Sets the flag indicating whether the subject location must be written in certificate details.
    
    Parameters:
    
    val - if true the subject location will be written in certificate details.
    
    Since:
    
    9.1
  - getWriteCertificateLocation
```
boolean getWriteCertificateLocation()
```
    Returns the flag indicating whether the subject location must be written in certificate details.
    
    Returns:
    
    flag indicating if the subject location will be written in certificate details.
    
    Since:
    
    9.1
  - setWriteCertificateDistinguishedName
```
void setWriteCertificateDistinguishedName(boolean val)
```
    Sets the flag indicating that subject distinguished name must be written in certificate details.
    
    Parameters:
    
    val - if true the subject distinguished name will be written in certificate details.
    
    Since:
    
    9.1
  - getWriteCertificateDistinguishedName
```
boolean getWriteCertificateDistinguishedName()
```
    Returns the flag indicating whether the subject distinguished name must be written in certificate details.
    
    Returns:
    
    flag indicating if the subject distinguished name will be written in certificate details.
    
    Since:
    
    9.1
  - setWriteCertificateDate
```
void setWriteCertificateDate(boolean val)
```
    Sets the flag indicating that the date of signing must be written in certificate details.
    
    Parameters:
    
    val - if true the date of signing will be written in certificate details.
    
    Since:
    
    9.1
  - getWriteCertificateDate
```
boolean getWriteCertificateDate()
```
    Returns the flag indicating whether the date of signing must be written in certificate details.
    
    Returns:
    
    flag indicating if the date of signing will be written in certificate details.
    
    Since:
    
    9.1
  - setWriteCertificateReason
```
void setWriteCertificateReason(boolean val)
```
    Sets the flag indicating that the reason of signing must be written in certificate details.
    
    Parameters:
    
    val - if true the reason of signing will be written in certificate details.
    
    Since:
    
    9.1
  - getWriteCertificateReason
```
boolean getWriteCertificateReason()
```
    Returns the flag indicating whether the reason of signing must be written in certificate details.
    
    Returns:
    
    flag indicating if the reason of signing will be written in certificate details.
    
    Since:
    
    9.1
  - setWriteCertificateLabels
```
void setWriteCertificateLabels(boolean val)
```
    Sets the flag indicating that the labels of signature items must be written in certificate details.
    
    Parameters:
    
    val - if true the labels of signature items will be written in certificate details.
    
    Since:
    
    9.1
  - getWriteCertificateLabels
```
boolean getWriteCertificateLabels()
```
    Returns the flag indicating whether the labels of signature items must be written in certificate details.
    
    Returns:
    
    flag indicating if the labels of signature items will be written in certificate details.
    
    Since:
    
    9.1
  - setShowSubjectName
```
void setShowSubjectName(boolean val)
```
    Sets the flag indicating that the subject common name must be written in a signature field. In this case this item will duplicate the item in certificate details.
    
    Parameters:
    
    val - if true the subject common name will be written in a signature fields.
    
    Since:
    
    9.1
  - getShowSubjectName
```
boolean getShowSubjectName()
```
    Returns the flag indicating whether the subject common name must be written in a signature field. In this case this item will duplicate the item in certificate details.
    
    Returns:
    
    flag indicating if the subject common name will be written in a signature field.
    
    Since:
    
    9.1
  - setDivideField
```
void setDivideField(boolean val)
```
    Sets the flag indicating that the signature field must be divided into two parts. At least one part must contains either certificate details items or subject common name. otherwise this flag must be set to false. If both certificate details and common name are present then this flag must be set to true.
    
    Parameters:
    
    val - if true the the signature field must be divided into two parts.
    
    Since:
    
    9.1
  - getDivideField
```
boolean getDivideField()
```
    Returns the flag indicating whether the signature field must be divided into two parts.
    
    Returns:
    
    flag indicating if the signature field will be divided into two parts.
    
    Since:
    
    9.1
  - setTextPosition
```
void setTextPosition(int pos)
```
    Sets the position of text-items in the divided signature field: POSITION_LEFT, POSITION_RIGHT. If both certificate details and common name are present, this value describes the position of certificate details.
    
    Parameters:
    
    pos - the position of text-items in the divided signature field.
    
    Since:
    
    9.1
  - getTextPosition
```
int getTextPosition()
```
    Returns the position of text-items in the divided signature field: POSITION_LEFT, POSITION_RIGHT. If both certificate details and common name are present, this value describes the position of certificate details.
    
    Returns:
    
    the position of text-items in the divided signature field.
    
    Since:
    
    9.1

Interface SignatureProperties

Field Summary

Method Summary

Field Detail

POSITION_LEFT

POSITION_RIGHT

Method Detail

setWriteCertificateSubjectName

getWriteCertificateSubjectName

setWriteCertificateLocation

getWriteCertificateLocation

setWriteCertificateDistinguishedName

getWriteCertificateDistinguishedName

setWriteCertificateDate

getWriteCertificateDate

setWriteCertificateReason

getWriteCertificateReason

setWriteCertificateLabels

getWriteCertificateLabels

setShowSubjectName

getShowSubjectName

setDivideField

getDivideField

setTextPosition

getTextPosition