com.hellosign.sdk.resource.support

Class FormField

java.lang.Object

com.hellosign.sdk.resource.AbstractResource

com.hellosign.sdk.resource.support.CustomField

com.hellosign.sdk.resource.support.FormField

public class FormField
extends CustomField

This class represents a HelloSign Form Field object.

Author:

"Chris Paul (chris@hellosign.com)"

Field Summary

Fields inherited from class com.hellosign.sdk.resource.support.CustomField

CUSTOM_FIELD_API_ID, CUSTOM_FIELD_AVG_TEXT_LENGTH, CUSTOM_FIELD_EDITOR, CUSTOM_FIELD_HEIGHT, CUSTOM_FIELD_NAME, CUSTOM_FIELD_NUM_CHARS_PER_LINE, CUSTOM_FIELD_NUM_LINES, CUSTOM_FIELD_REQUIRED, CUSTOM_FIELD_TYPE, CUSTOM_FIELD_VALUE, CUSTOM_FIELD_WIDTH, CUSTOM_FIELD_X, CUSTOM_FIELD_Y

Fields inherited from class com.hellosign.sdk.resource.AbstractResource

dataObj, warnings

Constructor Summary

Constructors

Constructor and Description
FormField()
FormField(FieldType type, String name, int signer, int x, int y, int height, int width, int page) Constructor to be used when creating a new FormField object.
FormField(org.json.JSONObject json)

Method Summary

Modifier and Type	Method and Description
Integer	getPage() Returns the page number this component is on.
Integer	getSigner() Returns the signer index for this form field.
ValidationType	getValidationType() Return the validation rule being used for this field
String	getValidationTypeString() Return the validation rule being used for this field as a string
void	setPage(Integer page) Set the page number for this component.
void	setRequired(boolean isRequired) Deprecated. Use CustomField.setIsRequired(Boolean)
void	setSigner(Integer signer) Set the signer index that should complete this form field.
void	setValidationType(ValidationType type) Set the validation rule for this field.

Methods inherited from class com.hellosign.sdk.resource.support.CustomField

getApiId, getEditor, getEstimatedCharsPerLine, getEstimatedTextLines, getHeight, getName, getType, getTypeString, getValue, getWidth, getX, getY, isRequired, setApiId, setEditor, setHeight, setIsRequired, setName, setType, setValue, setWidth, setX, setY

Methods inherited from class com.hellosign.sdk.resource.AbstractResource

add, addToList, clearList, get, getBoolean, getConstructor, getDate, getInteger, getJSONObject, getList, getList, getLong, getString, getWarnings, has, hasString, set, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FormField

public FormField()

FormField

public FormField(org.json.JSONObject json)
          throws HelloSignException

Throws:

HelloSignException

FormField

public FormField(FieldType type,
                 String name,
                 int signer,
                 int x,
                 int y,
                 int height,
                 int width,
                 int page)

Constructor to be used when creating a new FormField object.

Parameters:

type - FormField type

name - String Field Label that will be displayed to the signer

signer - int index of the signer that should complete this field (0-based index)

x - int x coordinate location of this field in pixels

y - int y coordinate location of this field in pixels

height - int height of this field in pixels

width - int width of this field in pixels

page - int page number of the document in which this field will be placed (1-based index)

Method Detail

getSigner

public Integer getSigner()

Returns the signer index for this form field.

Returns:

Integer signer index or null if not set

setSigner

public void setSigner(Integer signer)

Set the signer index that should complete this form field.

Parameters:

signer - Integer index

setPage

public void setPage(Integer page)

Set the page number for this component. The (x, y) coordinates will be relative to the top left corner of that page.

Parameters:

page - Integer page number

getPage

public Integer getPage()

Returns the page number this component is on.

Returns:

Integer page number, or null if not set

setValidationType

public void setValidationType(ValidationType type)

Set the validation rule for this field. This will force the signer to enter data that conforms to the validation rule.

Parameters:

type - ValidationType

getValidationType

public ValidationType getValidationType()

Return the validation rule being used for this field

Returns:

ValidationType validation type, null if not set

getValidationTypeString

public String getValidationTypeString()

Return the validation rule being used for this field as a string

Returns:

String validation type, null if not set

setRequired

public void setRequired(boolean isRequired)

Deprecated. Use CustomField.setIsRequired(Boolean)

Set this field as required.

Parameters:

isRequired - boolean true if field is required by signer