FieldBuilder (sdk 11.54 API)

java.lang.Object
- com.silanis.esl.sdk.builder.FieldBuilder

```
public class FieldBuilder
extends Object
```
FieldBuilder is a convenient class used to create fields.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CHECKBOX_CHECKED`
`static int`	`DEFAULT_HEIGHT`
`static FieldStyle`	`DEFAULT_STYLE`
`static int`	`DEFAULT_WIDTH`
`static String`	`RADIO_SELECTED`
`static String`	`SELECTED_VALUE`

Constructor Summary

Constructors
Constructor and Description

FieldBuilder()

Constructors
Constructor and Description
`FieldBuilder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FieldBuilder`	`atPosition(double x, double y)` Sets the field at the position in pixel relative to the original document, specified by x and y coordinates
`Field`	`build()` Builds the actual Field with the values specified.
`static FieldBuilder`	`checkBox()` Creates a field builder having set the style to UNBOUND_CHECK_BOX.
`static FieldBuilder`	`customField(String name)` Creates a field builder having set the style to UNBOUND_CUSTOM_FIELD It defines a user defined form field that may be stamped on the document.
`static FieldBuilder`	`datepicker()` Creates a field builder having set the style to DATEPICKER.
`static FieldBuilder`	`dropList()` Creates a field builder having set the style to DROP_LIST.
`static FieldBuilder`	`label()` Every bound field (Date, Title, Name) is a label.
`static FieldBuilder`	`newField()` Creates a field builder
`FieldBuilder`	`onPage(int pageNumber)` Sets the page on which the field is located.
`static FieldBuilder`	`qrCode()` Creates a field builder having set the style to BOUND_QRCODE.
`static FieldBuilder`	`radioButton(String group)` Creates a field builder having set the style to UNBOUND_RADIO_BUTTON.
`static FieldBuilder`	`signatureDate()` Creates a field builder having set the style to BOUND_DATE.
`static FieldBuilder`	`signerCompany()` Creates a field builder having set the style to BOUND_COMPANY.
`static FieldBuilder`	`signerName()` Creates a filed builder having set the style to BOUND_NAME.
`static FieldBuilder`	`signerTitle()` Creates a field builder having set the style to BOUND_TITLE.
`static FieldBuilder`	`textArea()` Creates a field builder having set the style to TEXT_AREA.
`static FieldBuilder`	`textField()` Creates a field builder having set the style to UNBOUND_TEXT_FIELD.
`FieldBuilder`	`withFontSize(Integer fontSize)` Set a field's fontSize.
`FieldBuilder`	`withId(FieldId fieldId)` Set a field's unique ID.
`FieldBuilder`	`withName(String name)` Sets the name of the field.
`FieldBuilder`	`withPositionAnchor(TextAnchor textAnchor)` Informs the eSignLive document engine that the position of the field must be defined relative to the position of a certain text string on the document.
`FieldBuilder`	`withPositionAnchor(TextAnchorBuilder builder)` Informs the eSignLive document engine that the position of the field must be defined relative to the position of a certain text string on the document.
`FieldBuilder`	`withPositionExtracted()` Informs the eSignLive document engine that the position of the field must be inferred from the position of an acrobat form field with a specified name (@see #withName(String)).
`FieldBuilder`	`withSize(double width, double height)` Sets the size, in pixel, of the field
`FieldBuilder`	`withStyle(FieldStyle style)` Sets the style of the field
`FieldBuilder`	`withTooltip(String tooltip)` Set a field's tooltip.
`FieldBuilder`	`withValidation(FieldValidator fieldValidator)` Sets a validator on the field.
`FieldBuilder`	`withValidation(FieldValidatorBuilder builder)` Sets a validator on the field that could be easily customized by the field validator builder provided as parameter.
`FieldBuilder`	`withValue(boolean value)` Set a field's value for a radio button or a checkbox
`FieldBuilder`	`withValue(String value)` Set a field's value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_WIDTH
```
public static final int DEFAULT_WIDTH
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HEIGHT
```
public static final int DEFAULT_HEIGHT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_STYLE
```
public static final FieldStyle DEFAULT_STYLE
```
  - SELECTED_VALUE
```
public static final String SELECTED_VALUE
```
    See Also:
    
    Constant Field Values
  - CHECKBOX_CHECKED
```
public static final String CHECKBOX_CHECKED
```
    See Also:
    
    Constant Field Values
  - RADIO_SELECTED
```
public static final String RADIO_SELECTED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FieldBuilder
```
public FieldBuilder()
```
- Method Detail
  - newField
```
public static FieldBuilder newField()
```
    Creates a field builder
    
    Returns:
    
    a field builder
  - signatureDate
```
public static FieldBuilder signatureDate()
```
    Creates a field builder having set the style to BOUND_DATE. A date string will be displayed at the location defined for the field when the signer signs the associated signature field.
    
    Returns:
    
    a BOUND_DATE styled field builder
    
    See Also:
    
    FieldStyle
  - signerName
```
public static FieldBuilder signerName()
```
    Creates a filed builder having set the style to BOUND_NAME. The signer's name will be displayed at the location defined for the field when the signer signs the associated signature field.
    
    Returns:
    
    a BOUND_NAME styled field builder
    
    See Also:
    
    FieldStyle
  - signerTitle
```
public static FieldBuilder signerTitle()
```
    Creates a field builder having set the style to BOUND_TITLE. The signer's title string will be displayed at the location defined for the field when the signer signs the associated signature field.
    
    Returns:
    
    a BOUND_TITLE styled field builder
    
    See Also:
    
    FieldStyle
  - signerCompany
```
public static FieldBuilder signerCompany()
```
    Creates a field builder having set the style to BOUND_COMPANY. The signer's company string will be displayed at the location defined for the field when the signer signs the associated signature field.
    
    Returns:
    
    a BOUND_COMPANY styled field builder
    
    See Also:
    
    FieldStyle
  - textField
```
public static FieldBuilder textField()
```
    Creates a field builder having set the style to UNBOUND_TEXT_FIELD. It defines a text field at the location defined that the signer may be required to fill prior to signing the its associated signature.
    
    Returns:
    
    a UNBOUND_TEXT_FIELD styled field builder
    
    See Also:
    
    FieldStyle
  - customField
```
public static FieldBuilder customField(String name)
```
    Creates a field builder having set the style to UNBOUND_CUSTOM_FIELD It defines a user defined form field that may be stamped on the document.
    E.g.: user's pharmacist license number.
    
    Returns:
    
    a UNBOUND_CUSTOM_FIELD styled field builder
    
    See Also:
    
    FieldStyle
  - checkBox
```
public static FieldBuilder checkBox()
```
    Creates a field builder having set the style to UNBOUND_CHECK_BOX. It defines a checkbox field at the location defined that the signer may be required to check prior to signing the its associated signature.
    
    Returns:
    
    a UNBOUND_CHECK_BOX styled field builder
    
    See Also:
    
    FieldStyle
  - radioButton
```
public static FieldBuilder radioButton(String group)
```
    Creates a field builder having set the style to UNBOUND_RADIO_BUTTON. It defines a radio button field in a group specified by the user. Only one radio button from a group can be selected at a time.
    
    Parameters:
    
    group - the radio button group
    
    Returns:
    
    a UNBOUND_RADIO_BUTTON styled field builder
    
    See Also:
    
    FieldStyle
  - dropList
```
public static FieldBuilder dropList()
```
    Creates a field builder having set the style to DROP_LIST. It defines a drop list field at the location defined that the signer may be required to select prior to signing the its associated signature
    
    Returns:
    
    a DROP_LIST styled field builder
    
    See Also:
    
    FieldStyle
  - textArea
```
public static FieldBuilder textArea()
```
    Creates a field builder having set the style to TEXT_AREA. It defines a text area field at the location defined that the signer may be required to fill prior to signing the its associated signature
    
    Returns:
    
    a TEXT_AREA styled field builder
    
    See Also:
    
    FieldStyle
  - label
```
public static FieldBuilder label()
```
    Every bound field (Date, Title, Name) is a label. The user should not have to set a field style to label.
    
    Returns:
    
    a LABEL styled field builder
    
    See Also:
    
    FieldStyle
  - datepicker
```
public static FieldBuilder datepicker()
```
    Creates a field builder having set the style to DATEPICKER. It defines a datepicker field at the location defined that the signer may be required to fill prior to signing the its associated signature
    
    Returns:
    
    a DATEPICKER styled field builder
    
    See Also:
    
    FieldStyle
  - qrCode
```
public static FieldBuilder qrCode()
```
    Creates a field builder having set the style to BOUND_QRCODE. A QR code field will be displayed at the location defined with a default size of width=77 and height=77.
    
    Returns:
    
    a BOUND_QRCODE styled field builder
    
    See Also:
    
    FieldStyle
  - onPage
```
public FieldBuilder onPage(int pageNumber)
```
    Sets the page on which the field is located.
    
    Parameters:
    
    pageNumber - the page number
    
    Returns:
    
    the field builder itself
  - atPosition
```
public FieldBuilder atPosition(double x,
                               double y)
```
    Sets the field at the position in pixel relative to the original document, specified by x and y coordinates
    
    Parameters:
    
    x - the x coordinate of the top-left corner @min="0"
    
    y - the y coordinate of the top-left corner @min="0"
    
    Returns:
    
    the field builder itself
  - withSize
```
public FieldBuilder withSize(double width,
                             double height)
```
    Sets the size, in pixel, of the field
    
    Parameters:
    
    width - the width of the field @min="0"
    
    height - the height of the field @min="0"
    
    Returns:
    
    the field builder itself
  - withStyle
```
public FieldBuilder withStyle(FieldStyle style)
```
    Sets the style of the field
    
    Parameters:
    
    style - the style of the field
    
    Returns:
    
    the field builder itself
    
    See Also:
    
    FieldStyle
  - withName
```
public FieldBuilder withName(String name)
```
    Sets the name of the field. The name corresponds to the id of the corresponding acrobat form field. This name is used when positioning form fields based on their original position on the PDF document.
    
    Parameters:
    
    name - the name of the field @size(max="255")
    
    Returns:
    
    the field builder itself
  - withPositionExtracted
```
public FieldBuilder withPositionExtracted()
```
    Informs the eSignLive document engine that the position of the field must be inferred from the position of an acrobat form field with a specified name (@see #withName(String)).
    When using withPositionExtracted() you must not use withSize(double, double) and atPosition(double, double).
    
    Returns:
    
    the field builder itself
  - withPositionAnchor
```
public FieldBuilder withPositionAnchor(TextAnchorBuilder builder)
```
    Informs the eSignLive document engine that the position of the field must be defined relative to the position of a certain text string on the document.
    When using withPositionAnchor(TextAnchorBuilder) you must not use withSize(double, double).
    
    Parameters:
    
    builder -
    
    Returns:
    
    the field builder itself
  - withPositionAnchor
```
public FieldBuilder withPositionAnchor(TextAnchor textAnchor)
```
    Informs the eSignLive document engine that the position of the field must be defined relative to the position of a certain text string on the document.
    When using withPositionAnchor(TextAnchorBuilder) you must not use withSize(double, double).
    
    Parameters:
    
    textAnchor -
    
    Returns:
    
    the field builder itself
    
    See Also:
    
    withPositionAnchor(TextAnchorBuilder)
  - withValidation
```
public FieldBuilder withValidation(FieldValidator fieldValidator)
```
    Sets a validator on the field. So, the values of the field should be matched by the provided validator. It is necessary only for the radio button field to have a FieldValidator that defines its group. It is up to the user to decide which validators they want to set to put constrains on the field. Leave blank otherwise.
    
    Parameters:
    
    fieldValidator - the field validator
    
    Returns:
    
    the field builder itself
  - withValidation
```
public FieldBuilder withValidation(FieldValidatorBuilder builder)
```
    Sets a validator on the field that could be easily customized by the field validator builder provided as parameter.
    
    Parameters:
    
    builder - the field validator builder
    
    Returns:
    
    the field builder itself
  - withValue
```
public FieldBuilder withValue(boolean value)
```
    Set a field's value for a radio button or a checkbox
    
    Parameters:
    
    value - true for checked and false for unchecked
    
    Returns:
    
    the field builder itself
  - withValue
```
public FieldBuilder withValue(String value)
```
    Set a field's value.
    
    Parameters:
    
    value - String value of the field @size(max="255")
    
    Returns:
    
    the field builder itself
  - withFontSize
```
public FieldBuilder withFontSize(Integer fontSize)
```
    Set a field's fontSize.
    
    Parameters:
    
    fontSize - Integer fontSize of the field)
    
    Returns:
    
    the field builder itself
  - withTooltip
```
public FieldBuilder withTooltip(String tooltip)
```
    Set a field's tooltip.
    
    Parameters:
    
    tooltip - String tooltip of the field)
    
    Returns:
    
    the field builder itself
  - withId
```
public FieldBuilder withId(FieldId fieldId)
```
    Set a field's unique ID. This id allows the field value to be retrieved when querying a package for information.
    
    Parameters:
    
    fieldId -
    
    Returns:
    
    the field builder itself
  - build
```
public Field build()
```
    Builds the actual Field with the values specified.
    
    Returns:
    
    the built Field

Class FieldBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_WIDTH

DEFAULT_HEIGHT

DEFAULT_STYLE

SELECTED_VALUE

CHECKBOX_CHECKED

RADIO_SELECTED

Constructor Detail

FieldBuilder

Method Detail

newField

signatureDate

signerName

signerTitle

signerCompany

textField

customField

checkBox

radioButton

dropList

textArea

label

datepicker

qrCode

onPage

atPosition

withSize

withStyle

withName

withPositionExtracted

withPositionAnchor

withPositionAnchor

withValidation

withValidation

withValue

withValue

withFontSize

withTooltip

withId

build