CustomField (HelloSign Java SDK 4.0.2 API)

java.lang.Object
- com.hellosign.sdk.resource.AbstractResource
- - com.hellosign.sdk.resource.support.CustomField

Direct Known Subclasses:

FormField
```
public class CustomField
extends AbstractResource
```
This class represents a HelloSign Custom Field. This is a field that is set up during the creation of the signature request or template and contains information that must be filled in by the requester, prior to sending. Right now, this is only applicable to text fields.

Author:

"Chris Paul ([email protected])"

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CUSTOM_FIELD_API_ID`
`static String`	`CUSTOM_FIELD_AVG_TEXT_LENGTH`
`static String`	`CUSTOM_FIELD_EDITOR`
`static String`	`CUSTOM_FIELD_HEIGHT`
`static String`	`CUSTOM_FIELD_NAME`
`static String`	`CUSTOM_FIELD_NUM_CHARS_PER_LINE`
`static String`	`CUSTOM_FIELD_NUM_LINES`
`static String`	`CUSTOM_FIELD_REQUIRED`
`static String`	`CUSTOM_FIELD_TYPE`
`static String`	`CUSTOM_FIELD_VALUE`
`static String`	`CUSTOM_FIELD_WIDTH`
`static String`	`CUSTOM_FIELD_X`
`static String`	`CUSTOM_FIELD_Y`

Fields inherited from class com.hellosign.sdk.resource.AbstractResource
dataObj, warnings

Constructor Summary

Constructors
Constructor and Description

CustomField()

CustomField(org.json.JSONObject json)

Constructors
Constructor and Description
`CustomField()`
`CustomField(org.json.JSONObject json)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getApiId()`
`String`	`getEditor()`
`Integer`	`getEstimatedCharsPerLine()` Once processed with a position, height, and width, HelloSign will estimate the number of lines a custom field can contain, along with the number of characters per line.
`Integer`	`getEstimatedTextLines()` Once processed with a position, height, and width, HelloSign will estimate the number of lines a custom field can contain, along with the number of characters per line.
`Integer`	`getHeight()` Returns the pixel height of this field.
`String`	`getName()`
`FieldType`	`getType()`
`String`	`getTypeString()`
`String`	`getValue()`
`Integer`	`getWidth()` Returns the pixel width of this field.
`Integer`	`getX()` Returns the x coordinate for this field.
`Integer`	`getY()` Returns the y coordinate for this field.
`Boolean`	`isRequired()`
`void`	`setApiId(String apiId)` Set the API ID for this custom field.
`void`	`setEditor(String editor)` Specify what signer role may edit this field.
`void`	`setHeight(int height)` Sets the pixel height for this field.
`void`	`setIsRequired(Boolean isRequired)` Specify whether this field is required.
`void`	`setName(String name)` Set the name of this custom field.
`void`	`setType(FieldType type)` Set the type for this custom field.
`void`	`setValue(String value)` Set the value for this field.
`void`	`setWidth(int width)` Sets the pixel height for this field.
`void`	`setX(int x)` Returns the x coordinate for this field.
`void`	`setY(int y)` Set the y coordinate for this field.

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

- Field Detail
  - CUSTOM_FIELD_NAME
```
public static final String CUSTOM_FIELD_NAME
```
    See Also:
    
    Constant Field Values
  - CUSTOM_FIELD_TYPE
```
public static final String CUSTOM_FIELD_TYPE
```
    See Also:
    
    Constant Field Values
  - CUSTOM_FIELD_API_ID
```
public static final String CUSTOM_FIELD_API_ID
```
    See Also:
    
    Constant Field Values
  - CUSTOM_FIELD_VALUE
```
public static final String CUSTOM_FIELD_VALUE
```
    See Also:
    
    Constant Field Values
  - CUSTOM_FIELD_EDITOR
```
public static final String CUSTOM_FIELD_EDITOR
```
    See Also:
    
    Constant Field Values
  - CUSTOM_FIELD_REQUIRED
```
public static final String CUSTOM_FIELD_REQUIRED
```
    See Also:
    
    Constant Field Values
  - CUSTOM_FIELD_X
```
public static final String CUSTOM_FIELD_X
```
    See Also:
    
    Constant Field Values
  - CUSTOM_FIELD_Y
```
public static final String CUSTOM_FIELD_Y
```
    See Also:
    
    Constant Field Values
  - CUSTOM_FIELD_WIDTH
```
public static final String CUSTOM_FIELD_WIDTH
```
    See Also:
    
    Constant Field Values
  - CUSTOM_FIELD_HEIGHT
```
public static final String CUSTOM_FIELD_HEIGHT
```
    See Also:
    
    Constant Field Values
  - CUSTOM_FIELD_AVG_TEXT_LENGTH
```
public static final String CUSTOM_FIELD_AVG_TEXT_LENGTH
```
    See Also:
    
    Constant Field Values
  - CUSTOM_FIELD_NUM_LINES
```
public static final String CUSTOM_FIELD_NUM_LINES
```
    See Also:
    
    Constant Field Values
  - CUSTOM_FIELD_NUM_CHARS_PER_LINE
```
public static final String CUSTOM_FIELD_NUM_CHARS_PER_LINE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CustomField
```
public CustomField()
```
  - CustomField
```
public CustomField(org.json.JSONObject json)
            throws HelloSignException
```
    Throws:
    
    HelloSignException
- Method Detail
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
    Set the name of this custom field.
    
    Parameters:
    
    name - String
  - getType
```
public FieldType getType()
```
  - getTypeString
```
public String getTypeString()
```
  - setType
```
public void setType(FieldType type)
```
    Set the type for this custom field.
    
    Parameters:
    
    type - FieldType
  - getValue
```
public String getValue()
```
  - setValue
```
public void setValue(String value)
```
    Set the value for this field.
    
    Parameters:
    
    value - String
  - getApiId
```
public String getApiId()
```
  - setApiId
```
public void setApiId(String apiId)
```
    Set the API ID for this custom field.
    
    Parameters:
    
    apiId - String
  - getEditor
```
public String getEditor()
```
  - setEditor
```
public void setEditor(String editor)
```
    Specify what signer role may edit this field.
    
    Parameters:
    
    editor - String
  - isRequired
```
public Boolean isRequired()
```
  - setIsRequired
```
public void setIsRequired(Boolean isRequired)
```
    Specify whether this field is required.
    
    Parameters:
    
    isRequired - Boolean
  - getX
```
public Integer getX()
```
    Returns the x coordinate for this field.
    
    Returns:
    
    Integer or null if not set
  - getY
```
public Integer getY()
```
    Returns the y coordinate for this field.
    
    Returns:
    
    Integer or null if not set
  - setX
```
public void setX(int x)
```
    Returns the x coordinate for this field.
    
    Parameters:
    
    x - int pixel coordinate
  - setY
```
public void setY(int y)
```
    Set the y coordinate for this field.
    
    Parameters:
    
    y - int pixel coordinate
  - getWidth
```
public Integer getWidth()
```
    Returns the pixel width of this field.
    
    Returns:
    
    Integer or null if not set
  - setWidth
```
public void setWidth(int width)
```
    Sets the pixel height for this field.
    
    Parameters:
    
    width - int pixel height
  - getHeight
```
public Integer getHeight()
```
    Returns the pixel height of this field.
    
    Returns:
    
    Integer or null if not set
  - setHeight
```
public void setHeight(int height)
```
    Sets the pixel height for this field.
    
    Parameters:
    
    height - int pixel height
  - getEstimatedTextLines
```
public Integer getEstimatedTextLines()
```
    Once processed with a position, height, and width, HelloSign will estimate the number of lines a custom field can contain, along with the number of characters per line. This method will return the estimated average number of lines of text this field can hold.
    
    Returns:
    
    Integer or null if not set
  - getEstimatedCharsPerLine
```
public Integer getEstimatedCharsPerLine()
```
    Once processed with a position, height, and width, HelloSign will estimate the number of lines a custom field can contain, along with the number of characters per line. This method will return the estimated average number of characters per line this field can hold.
    
    Returns:
    
    Integer or null if not set

Class CustomField

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

CUSTOM_FIELD_NAME

CUSTOM_FIELD_TYPE

CUSTOM_FIELD_API_ID

CUSTOM_FIELD_VALUE

CUSTOM_FIELD_EDITOR

CUSTOM_FIELD_REQUIRED

CUSTOM_FIELD_X

CUSTOM_FIELD_Y

CUSTOM_FIELD_WIDTH

CUSTOM_FIELD_HEIGHT

CUSTOM_FIELD_AVG_TEXT_LENGTH

CUSTOM_FIELD_NUM_LINES

CUSTOM_FIELD_NUM_CHARS_PER_LINE

Constructor Detail

CustomField

CustomField

Method Detail

getName

setName

getType

getTypeString

setType

getValue

setValue

getApiId

setApiId

getEditor

setEditor

isRequired

setIsRequired

getX

getY

setX

setY

getWidth

setWidth

getHeight

setHeight

getEstimatedTextLines

getEstimatedCharsPerLine