BaseSignature

Inheritance: java.lang.Object

public abstract class BaseSignature

Describes base class for signatures.

Methods

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()

getSignatureType()

public final int getSignatureType()

Specifies the type of signature. Digital signature will have this property.

Returns: int

getPageNumber()

public final Integer getPageNumber()

Specifies the page signature was found on.

Returns: java.lang.Integer

setPageNumber(Integer value)

public final void setPageNumber(Integer value)

Specifies the page signature was found on.

Parameters:

Parameter Type Description
value java.lang.Integer

getSignatureId()

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

isSignature()

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

setSignature(boolean value)

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

getDeleted()

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

getCreatedOn()

public final Date getCreatedOn()

Get or set the signature creation date.

Returns: java.util.Date

setCreatedOn(Date value)

public final void setCreatedOn(Date value)

Get or set the signature creation date.

Parameters:

Parameter Type Description
value java.util.Date

getModifiedOn()

public final Date getModifiedOn()

Get or set the signature modification date.

Returns: java.util.Date

setModifiedOn(Date value)

public final void setModifiedOn(Date value)

Get or set the signature modification date.

Parameters:

Parameter Type Description
value java.util.Date

getTop()

public final int getTop()

Specifies top position of signature.

Returns: int

setTop(int value)

public final void setTop(int value)

Specifies top position of signature.

Parameters:

Parameter Type Description
value int

getLeft()

public final int getLeft()

Specifies left position of signature.

Returns: int

setLeft(int value)

public final void setLeft(int value)

Specifies left position of signature.

Parameters:

Parameter Type Description
value int

getWidth()

public final int getWidth()

Specifies width of signature.

Returns: int

setWidth(int value)

public final void setWidth(int value)

Specifies width of signature.

Parameters:

Parameter Type Description
value int

getHeight()

public final int getHeight()

Specifies height of signature.

Returns: int

setHeight(int value)

public final void setHeight(int value)

Specifies height of signature.

Parameters:

Parameter Type Description
value int

equals(Object signature)

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.

hashCode()

public int hashCode()

Overrides GetHashCode method

Returns: int -

supportMetaInfoLayer()

public boolean supportMetaInfoLayer()

Returns: boolean

toString()

public String toString()

Returns: java.lang.String -