com.silanis.esl.sdk

Class Field

java.lang.Object

com.silanis.esl.sdk.Field

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConditionalField

public class Field
extends Object
implements Serializable

Field class allows to place additional data into the document at the time of signing.

It is important to know that they are linked to a signature.

Once that signature has been signed, the value in the field is locked in and can not be further changed.

Only the signer to whom the signature is assigned will be able to place values in the field.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Field()

Method Summary

Modifier and Type	Method and Description
String	getBinding()
FieldValidator	getFieldValidator() Gets the field validator if any.
Integer	getFontSize()
double	getHeight()
FieldId	getId()
String	getName() Gets the name of the field
int	getPage()
FieldStyle	getStyle()
TextAnchor	getTextAnchor()
String	getValue() Gets the value entered into the field
double	getWidth()
double	getX()
double	getY()
boolean	isExtraction()
void	setExtraction(boolean extraction)
void	setFieldValidator(FieldValidator fieldValidator) Sets a field validator.
void	setFontSize(Integer fontSize)
void	setHeight(double height)
void	setId(FieldId id)
void	setName(String name) Sets the name of the field
void	setPage(int page)
void	setStyle(FieldStyle style)
void	setTextAnchor(TextAnchor textAnchor)
void	setValue(String value) Sets the value of the field
void	setWidth(double width)
void	setX(double x)
void	setY(double y)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Field

public Field()

Method Detail

getX

public double getX()

setX

public void setX(double x)

getWidth

public double getWidth()

setWidth

public void setWidth(double width)

getY

public double getY()

setY

public void setY(double y)

getHeight

public double getHeight()

setHeight

public void setHeight(double height)

getPage

public int getPage()

setPage

public void setPage(int page)

getStyle

public FieldStyle getStyle()

setStyle

public void setStyle(FieldStyle style)

getValue

public String getValue()

Gets the value entered into the field

Returns:

the value entered into the field

setValue

public void setValue(String value)

Sets the value of the field

Parameters:

value -

setName

public void setName(String name)

Sets the name of the field

Parameters:

name -

getName

public String getName()

Gets the name of the field

Returns:

the name of the field

setExtraction

public void setExtraction(boolean extraction)

isExtraction

public boolean isExtraction()

getBinding

public String getBinding()

setFieldValidator

public void setFieldValidator(FieldValidator fieldValidator)

Sets a field validator. The value entered into the field has to match the provided validator.

Parameters:

fieldValidator -

getFieldValidator

public FieldValidator getFieldValidator()

Gets the field validator if any.

Returns:

the field validator if any

setId

public void setId(FieldId id)

getId

public FieldId getId()

getTextAnchor

public TextAnchor getTextAnchor()

setTextAnchor

public void setTextAnchor(TextAnchor textAnchor)

getFontSize

public Integer getFontSize()

setFontSize

public void setFontSize(Integer fontSize)