BaseSignature Leave feedback
On this page
Inheritance: java.lang.Object
public abstract class BaseSignature
Describes base class for signatures.
| Method | Description |
|---|---|
| getSignatureType() | Specifies the type of signature. |
| getPageNumber() | Specifies the page signature was found on. |
| setPageNumber(Integer value) | Specifies the page signature was found on. |
| getSignatureId() | Unique signature identifier to modify signature in the document over Update or Delete methods. |
| isSignature() | Get or set flag to indicate if this component is Signature or document content. |
| setSignature(boolean value) | Get or set flag to indicate if this component is Signature or document content. |
| getDeleted() | Get or set flag to indicate if this signature was deleted from the document. |
| getCreatedOn() | Get or set the signature creation date. |
| setCreatedOn(Date value) | Get or set the signature creation date. |
| getModifiedOn() | Get or set the signature modification date. |
| setModifiedOn(Date value) | Get or set the signature modification date. |
| getTop() | Specifies top position of signature. |
| setTop(int value) | Specifies top position of signature. |
| getLeft() | Specifies left position of signature. |
| setLeft(int value) | Specifies left position of signature. |
| getWidth() | Specifies width of signature. |
| setWidth(int value) | Specifies width of signature. |
| getHeight() | Specifies height of signature. |
| setHeight(int value) | Specifies height of signature. |
| equals(Object signature) | Overwrites Equals method to compare signature properties |
| hashCode() | Overrides GetHashCode method |
| supportMetaInfoLayer() | |
| toString() |
|
public final int getSignatureType()
Specifies the type of signature. Digital signature will have this property.
Returns: int
public final Integer getPageNumber()
Specifies the page signature was found on.
Returns: java.lang.Integer
public final void setPageNumber(Integer value)
Specifies the page signature was found on.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.Integer |
public final String getSignatureId()
Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
Returns: java.lang.String
public final boolean isSignature()
Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
Returns: boolean
public final void setSignature(boolean value)
Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final boolean getDeleted()
Get or set flag to indicate if this signature was deleted from the document. This property is being used only for document history log records to keep the list of deleted signatures.
Returns: boolean
public final Date getCreatedOn()
Get or set the signature creation date.
Returns: java.util.Date
public final void setCreatedOn(Date value)
Get or set the signature creation date.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.util.Date |
public final Date getModifiedOn()
Get or set the signature modification date.
Returns: java.util.Date
public final void setModifiedOn(Date value)
Get or set the signature modification date.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.util.Date |
public final int getTop()
Specifies top position of signature.
Returns: int
public final void setTop(int value)
Specifies top position of signature.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public final int getLeft()
Specifies left position of signature.
Returns: int
public final void setLeft(int value)
Specifies left position of signature.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public final int getWidth()
Specifies width of signature.
Returns: int
public final void setWidth(int value)
Specifies width of signature.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public final int getHeight()
Specifies height of signature.
Returns: int
public final void setHeight(int value)
Specifies height of signature.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public boolean equals(Object signature)
Overwrites Equals method to compare signature properties
Parameters:
| Parameter | Type | Description |
|---|---|---|
| signature | java.lang.Object | Signature object to compare with. |
Returns: boolean - Returns true if passed signature object has same type and all its properties are equal to this instance properties.
public int hashCode()
Overrides GetHashCode method
Returns: int -
public boolean supportMetaInfoLayer()
Returns: boolean
public String toString()
Returns: java.lang.String -
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.