Package com.groupdocs.cloud.signature.model

Class Signature

java.lang.Object

com.groupdocs.cloud.signature.model.Signature

Direct Known Subclasses:

BarcodeSignature, DigitalSignature, FormFieldSignature, ImageSignature, MetadataSignature, QRCodeSignature, TextSignature

public class Signature
extends Object

Describes base class for signatures

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Signature.SignatureTypeEnum	Specifies the signature type (Text, Image, Digital, Barcode, QRCode, Stamp)

Constructor Summary

Constructors

Constructor	Description
Signature()

Method Summary

Modifier and Type	Method	Description
Signature	createdOn(org.threeten.bp.OffsetDateTime createdOn)
boolean	equals(Object o)
org.threeten.bp.OffsetDateTime	getCreatedOn()	Get or set the signature creation date
Integer	getHeight()	Specifies height of signature
Boolean	getIsSignature()	Get or set flag to indicate if this component is Signature or document content.
Integer	getLeft()	Specifies left position of signature
org.threeten.bp.OffsetDateTime	getModifiedOn()	Get or set the signature modification date
Integer	getPageNumber()	Specifies the page signature was found on
String	getSignatureId()	Unique signature identifier to modify signature in the document over Update or Delete methods.
Signature.SignatureTypeEnum	getSignatureType()	Specifies the signature type (Text, Image, Digital, Barcode, QRCode, Stamp)
Integer	getTop()	Specifies top position of signature
Integer	getWidth()	Specifies width of signature
int	hashCode()
Signature	height(Integer height)
Signature	isSignature(Boolean isSignature)
Signature	left(Integer left)
Signature	modifiedOn(org.threeten.bp.OffsetDateTime modifiedOn)
Signature	pageNumber(Integer pageNumber)
void	setCreatedOn(org.threeten.bp.OffsetDateTime createdOn)
void	setHeight(Integer height)
void	setIsSignature(Boolean isSignature)
void	setLeft(Integer left)
void	setModifiedOn(org.threeten.bp.OffsetDateTime modifiedOn)
void	setPageNumber(Integer pageNumber)
void	setSignatureId(String signatureId)
void	setSignatureType(Signature.SignatureTypeEnum signatureType)
void	setTop(Integer top)
void	setWidth(Integer width)
Signature	signatureId(String signatureId)
Signature	signatureType(Signature.SignatureTypeEnum signatureType)
Signature	top(Integer top)
String	toString()
Signature	width(Integer width)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Signature

public Signature()

Method Detail

signatureType

public Signature signatureType(Signature.SignatureTypeEnum signatureType)

getSignatureType

public Signature.SignatureTypeEnum getSignatureType()

Specifies the signature type (Text, Image, Digital, Barcode, QRCode, Stamp)

Returns:

signatureType

setSignatureType

public void setSignatureType(Signature.SignatureTypeEnum signatureType)

pageNumber

public Signature pageNumber(Integer pageNumber)

getPageNumber

public Integer getPageNumber()

Specifies the page signature was found on

Returns:

pageNumber

setPageNumber

public void setPageNumber(Integer pageNumber)

signatureId

public Signature signatureId(String signatureId)

getSignatureId

public 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:

signatureId

setSignatureId

public void setSignatureId(String signatureId)

isSignature

public Signature isSignature(Boolean isSignature)

getIsSignature

public Boolean getIsSignature()

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:

isSignature

setIsSignature

public void setIsSignature(Boolean isSignature)

createdOn

public Signature createdOn(org.threeten.bp.OffsetDateTime createdOn)

getCreatedOn

public org.threeten.bp.OffsetDateTime getCreatedOn()

Get or set the signature creation date

Returns:

createdOn

setCreatedOn

public void setCreatedOn(org.threeten.bp.OffsetDateTime createdOn)

modifiedOn

public Signature modifiedOn(org.threeten.bp.OffsetDateTime modifiedOn)

getModifiedOn

public org.threeten.bp.OffsetDateTime getModifiedOn()

Get or set the signature modification date

Returns:

modifiedOn

setModifiedOn

public void setModifiedOn(org.threeten.bp.OffsetDateTime modifiedOn)

top

public Signature top(Integer top)

getTop

public Integer getTop()

Specifies top position of signature

Returns:

top

setTop

public void setTop(Integer top)

left

public Signature left(Integer left)

getLeft

public Integer getLeft()

Specifies left position of signature

Returns:

left

setLeft

public void setLeft(Integer left)

width

public Signature width(Integer width)

getWidth

public Integer getWidth()

Specifies width of signature

Returns:

width

setWidth

public void setWidth(Integer width)

height

public Signature height(Integer height)

getHeight

public Integer getHeight()

Specifies height of signature

Returns:

height

setHeight

public void setHeight(Integer height)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object