Package com.groupdocs.cloud.signature.model

Class UpdateOptions

java.lang.Object

com.groupdocs.cloud.signature.model.UpdateOptions

public class UpdateOptions
extends Object

Base container class for update signature options

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UpdateOptions.SignatureTypeEnum	Specifies the type of signature

Constructor Summary

Constructors

Constructor	Description
UpdateOptions()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
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
String	getSignatureId()	Unique signature identifier to modify signature in the document over Update or Delete methods.
UpdateOptions.SignatureTypeEnum	getSignatureType()	Specifies the type of signature
String	getText()	The text to update text signature
Integer	getTop()	Specifies top position of signature
Integer	getWidth()	Specifies width of signature
int	hashCode()
UpdateOptions	height(Integer height)
UpdateOptions	isSignature(Boolean isSignature)
UpdateOptions	left(Integer left)
void	setHeight(Integer height)
void	setIsSignature(Boolean isSignature)
void	setLeft(Integer left)
void	setSignatureId(String signatureId)
void	setSignatureType(UpdateOptions.SignatureTypeEnum signatureType)
void	setText(String text)
void	setTop(Integer top)
void	setWidth(Integer width)
UpdateOptions	signatureId(String signatureId)
UpdateOptions	signatureType(UpdateOptions.SignatureTypeEnum signatureType)
UpdateOptions	text(String text)
UpdateOptions	top(Integer top)
String	toString()
UpdateOptions	width(Integer width)

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateOptions

public UpdateOptions()

Method Detail

signatureType

public UpdateOptions signatureType(UpdateOptions.SignatureTypeEnum signatureType)

getSignatureType

public UpdateOptions.SignatureTypeEnum getSignatureType()

Specifies the type of signature

Returns:

signatureType

setSignatureType

public void setSignatureType(UpdateOptions.SignatureTypeEnum signatureType)

signatureId

public UpdateOptions 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)

left

public UpdateOptions left(Integer left)

getLeft

public Integer getLeft()

Specifies left position of signature

Returns:

left

setLeft

public void setLeft(Integer left)

top

public UpdateOptions top(Integer top)

getTop

public Integer getTop()

Specifies top position of signature

Returns:

top

setTop

public void setTop(Integer top)

width

public UpdateOptions width(Integer width)

getWidth

public Integer getWidth()

Specifies width of signature

Returns:

width

setWidth

public void setWidth(Integer width)

height

public UpdateOptions height(Integer height)

getHeight

public Integer getHeight()

Specifies height of signature

Returns:

height

setHeight

public void setHeight(Integer height)

isSignature

public UpdateOptions 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)

text

public UpdateOptions text(String text)

getText

public String getText()

The text to update text signature

Returns:

text

setText

public void setText(String text)

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