SignatureBuilder (sdk 11.50 API)

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

```
public final class SignatureBuilder
extends Object
```
This builder class is used to create and customize a signature

Field Summary

Fields
Modifier and Type Field and Description

static double DEFAULT_HEIGHT

static SignatureStyle DEFAULT_STYLE

static double DEFAULT_WIDTH

Fields
Modifier and Type	Field and Description
`static double`	`DEFAULT_HEIGHT`
`static SignatureStyle`	`DEFAULT_STYLE`
`static double`	`DEFAULT_WIDTH`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SignatureBuilder`	`acceptanceFor(GroupId groupId)` Creates a SignatureBuilder instance for any members of the group provided as parameter.
`static SignatureBuilder`	`acceptanceFor(Placeholder roleId)` Creates an acceptance consent for the signer having the placeholder's id provided
`static SignatureBuilder`	`acceptanceFor(String signerEmail)` Creates an acceptance consent for the signer having the email address provided.
`SignatureBuilder`	`atPosition(double x, double y)` Sets the pixel coordinates, relative to the original document, where this signature will be placed at inside the page.
`Signature`	`build()` This method actually builds the Signature object
`static SignatureBuilder`	`captureFor(GroupId groupId)` Creates a SignatureBuilder instance for the signer with the group id provided as parameter The signature style will be also set to SignatureStyle.HAND_DRAWN
`static SignatureBuilder`	`captureFor(Placeholder roleId)` Creates a SignatureBuilder instance for the signer with the placeholder's id provided as parameter The signature style will be also set to SignatureStyle.HAND_DRAWN
`static SignatureBuilder`	`captureFor(String signerEmail)` Creates a SignatureBuilder instance for the signer with the email address provided as parameter.
`SignatureBuilder`	`disabled()` Marks the signature as disabled.
`SignatureBuilder`	`enableEnforceCaptureSignature()` Enables the signature level enforceCaptureSignature setting.
`static SignatureBuilder`	`initialsFor(GroupId groupId)` Creates a SignatureBuilder instance for any members of the group provided as parameter.
`static SignatureBuilder`	`initialsFor(Placeholder roleId)` Creates a SignatureBuilder instance for the signer with the placeholder's id provided as parameter The signature style will be also set toSignatureStyle.INITIALS
`static SignatureBuilder`	`initialsFor(String signerEmail)` Creates a SignatureBuilder instance for the signer with the email address provided as parameter.
`SignatureBuilder`	`makeOptional()` Marks the signature as optional.
`static SignatureBuilder`	`mobileCaptureFor(GroupId groupId)` Creates a SignatureBuilder instance for the signer with the group id provided as parameter The signature style will be also set to SignatureStyle.MOBILE_CAPTURE
`static SignatureBuilder`	`mobileCaptureFor(Placeholder roleId)` Creates a SignatureBuilder instance for the signer with the placeholder's id provided as parameter The signature style will be also set to SignatureStyle.MOBILE_CAPTURE
`static SignatureBuilder`	`mobileCaptureFor(String signerEmail)` Creates a SignatureBuilder instance for the signer with the email address provided as parameter.
`SignatureBuilder`	`onPage(int pageNumber)` Sets the page number where this signature will be placed on.
`SignatureBuilder`	`setFromFile(boolean fromFile)` Enable capture signature to be from file
`static SignatureBuilder`	`signatureFor(GroupId groupId)` Creates a SignatureBuilder instance for any members of the group provided as parameter.
`static SignatureBuilder`	`signatureFor(Placeholder roleId)` Creates a SignatureBuilder instance for the placeholder having the role id as parameter
`static SignatureBuilder`	`signatureFor(String signerEmail)` Creates a SignatureBuilder instance for the signer having the email address provided as parameter
`SignatureBuilder`	`withField(Field field)` Adds a field to the signature
`SignatureBuilder`	`withField(FieldBuilder builder)` Adds a field bound to the signature
`SignatureBuilder`	`withFontSize(Integer fontSize)` Set a fontSize.
`SignatureBuilder`	`withId(SignatureId id)` Set a custom ID for the signature.
`SignatureBuilder`	`withName(String name)` Sets the name of the signature form field on the original PDF document.
`SignatureBuilder`	`withPositionAnchor(TextAnchor textAnchor)` Enables positioning the signature relative to a text string in the original document.
`SignatureBuilder`	`withPositionAnchor(TextAnchorBuilder builder)` Enables positioning the signature relative to a text string in the original document.
`SignatureBuilder`	`withPositionExtracted()` Enables signature extraction.
`SignatureBuilder`	`withSize(double width, double height)` Sets the size, in pixel, of the signature
`SignatureBuilder`	`withStyle(SignatureStyle style)` Sets the style of the signature.

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 double DEFAULT_WIDTH
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HEIGHT
```
public static final double DEFAULT_HEIGHT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_STYLE
```
public static final SignatureStyle DEFAULT_STYLE
```
- Method Detail
  - signatureFor
```
public static SignatureBuilder signatureFor(String signerEmail)
```
    Creates a SignatureBuilder instance for the signer having the email address provided as parameter
    
    Parameters:
    
    signerEmail - the signer's email address @size(min="6", max="255", valid email address)
    
    Returns:
    
    the signature builder itself
  - signatureFor
```
public static SignatureBuilder signatureFor(GroupId groupId)
```
    Creates a SignatureBuilder instance for any members of the group provided as parameter.
    
    Parameters:
    
    groupId - id of the group for which any of its members can sign.
    
    Returns:
    
    the signature builder itself
  - signatureFor
```
public static SignatureBuilder signatureFor(Placeholder roleId)
```
    Creates a SignatureBuilder instance for the placeholder having the role id as parameter
    
    Parameters:
    
    roleId - the placeholder's id
    
    Returns:
    
    the signature builder itself
  - acceptanceFor
```
public static SignatureBuilder acceptanceFor(String signerEmail)
```
    Creates an acceptance consent for the signer having the email address provided.
    
    Parameters:
    
    signerEmail - the signer's email address @size(min="6", max="255", valid email address)
    
    Returns:
    
    the signature builder itself
  - acceptanceFor
```
public static SignatureBuilder acceptanceFor(GroupId groupId)
```
    Creates a SignatureBuilder instance for any members of the group provided as parameter.
    
    Parameters:
    
    groupId - id of the group for which any of its members can sign.
    
    Returns:
    
    the signature builder itself
  - acceptanceFor
```
public static SignatureBuilder acceptanceFor(Placeholder roleId)
```
    Creates an acceptance consent for the signer having the placeholder's id provided
    
    Parameters:
    
    roleId - the placeholder's id
    
    Returns:
    
    the signature builder itself
  - initialsFor
```
public static SignatureBuilder initialsFor(String signerEmail)
```
    Creates a SignatureBuilder instance for the signer with the email address provided as parameter. The signature style will be also set to SignatureStyle.INITIALS
    
    Parameters:
    
    signerEmail - the signer's email address @size(min="6", max="255", valid email address)
    
    Returns:
    
    the signature builder itself
  - initialsFor
```
public static SignatureBuilder initialsFor(GroupId groupId)
```
    Creates a SignatureBuilder instance for any members of the group provided as parameter. The signature style will be also set toSignatureStyle.INITIALS
    
    Parameters:
    
    groupId - id of the group for which any of its members can sign.
    
    Returns:
    
    the signature builder itself
  - initialsFor
```
public static SignatureBuilder initialsFor(Placeholder roleId)
```
    Creates a SignatureBuilder instance for the signer with the placeholder's id provided as parameter The signature style will be also set toSignatureStyle.INITIALS
    
    Parameters:
    
    roleId - the placeholder's id
    
    Returns:
    
    the signature builder itself
  - captureFor
```
public static SignatureBuilder captureFor(String signerEmail)
```
    Creates a SignatureBuilder instance for the signer with the email address provided as parameter. The signature style will be also set to SignatureStyle.HAND_DRAWN
    
    Parameters:
    
    signerEmail - the signer's email address @size(min="6", max="255", valid email address)
    
    Returns:
    
    the signature builder itself
  - captureFor
```
public static SignatureBuilder captureFor(GroupId groupId)
```
    Creates a SignatureBuilder instance for the signer with the group id provided as parameter The signature style will be also set to SignatureStyle.HAND_DRAWN
    
    Parameters:
    
    groupId - id of the group for which any of its members can sign.
    
    Returns:
    
    the signature builder itself
  - captureFor
```
public static SignatureBuilder captureFor(Placeholder roleId)
```
    Creates a SignatureBuilder instance for the signer with the placeholder's id provided as parameter The signature style will be also set to SignatureStyle.HAND_DRAWN
    
    Parameters:
    
    roleId - the placeholder's id
    
    Returns:
    
    the signature builder itself
  - mobileCaptureFor
```
public static SignatureBuilder mobileCaptureFor(String signerEmail)
```
    Creates a SignatureBuilder instance for the signer with the email address provided as parameter. The signature style will be also set to SignatureStyle.MOBILE_CAPTURE
    
    Parameters:
    
    signerEmail - the signer's email address @size(min="6", max="255", valid email address)
    
    Returns:
    
    the signature builder itself
  - mobileCaptureFor
```
public static SignatureBuilder mobileCaptureFor(GroupId groupId)
```
    Creates a SignatureBuilder instance for the signer with the group id provided as parameter The signature style will be also set to SignatureStyle.MOBILE_CAPTURE
    
    Parameters:
    
    groupId - id of the group for which any of its members can sign.
    
    Returns:
    
    the signature builder itself
  - mobileCaptureFor
```
public static SignatureBuilder mobileCaptureFor(Placeholder roleId)
```
    Creates a SignatureBuilder instance for the signer with the placeholder's id provided as parameter The signature style will be also set to SignatureStyle.MOBILE_CAPTURE
    
    Parameters:
    
    roleId - the placeholder's id
    
    Returns:
    
    the signature builder itself
  - withId
```
public SignatureBuilder withId(SignatureId id)
```
    Set a custom ID for the signature. If none is provided, the system will assign one by default. This package id needs to be unique per document.
    
    Parameters:
    
    id - the signature ID @size(min="1", max="255")
    
    Returns:
  - onPage
```
public SignatureBuilder onPage(int pageNumber)
```
    Sets the page number where this signature will be placed on.
    
    Parameters:
    
    pageNumber - the page number the signature will be placed on @min="0"
    
    Returns:
    
    the signature builder itself
  - atPosition
```
public SignatureBuilder atPosition(double x,
                                   double y)
```
    Sets the pixel coordinates, relative to the original document, where this signature will be placed at inside the page.
    
    Parameters:
    
    x - x-coordinate of the signature's top-left corner @min="0"
    
    y - y-coordinate of the signature's top-;eft corner @min="0"
    
    Returns:
    
    the signature builder itself
  - withSize
```
public SignatureBuilder withSize(double width,
                                 double height)
```
    Sets the size, in pixel, of the signature
    
    Parameters:
    
    width - the width of the signature @min="0"
    
    height - the height of the signature @min="0"
    
    Returns:
    
    the signature builder itself
  - withFontSize
```
public SignatureBuilder withFontSize(Integer fontSize)
```
    Set a fontSize.
    
    Parameters:
    
    fontSize - Integer fontSize of the field)
    
    Returns:
    
    the field builder itself
  - withStyle
```
public SignatureBuilder withStyle(SignatureStyle style)
```
    Sets the style of the signature. E.g.: hand-drawn, full name, initial, etc...
    
    Parameters:
    
    style - the style of the signature
    
    Returns:
    
    the signature builder itself
  - withField
```
public SignatureBuilder withField(FieldBuilder builder)
```
    Adds a field bound to the signature
    
    Parameters:
    
    builder - a convenient field builder
    
    Returns:
    
    the signature builder itself
  - withField
```
public SignatureBuilder withField(Field field)
```
    Adds a field to the signature
    
    Parameters:
    
    field - the field
    
    Returns:
    
    the signature builder itself
  - withName
```
public SignatureBuilder withName(String name)
```
    Sets the name of the signature form field on the original PDF document. This is used in conjunction with withPositionExtracted().
    
    Parameters:
    
    name - the signature's name @size(min="1", max="255")
    
    Returns:
    
    the signature builder itself
  - withPositionExtracted
```
public SignatureBuilder withPositionExtracted()
```
    Enables signature extraction. Indicates to the eSignLive document engine to position and size this signature block based on the size and coordinates of the corresponding PDF form field. withName(String).
    When using this method, you must not also use atPosition(double, double) and withSize(double, double)}
    
    Returns:
    
    the signature builder itself
  - withPositionAnchor
```
public SignatureBuilder withPositionAnchor(TextAnchorBuilder builder)
```
    Enables positioning the signature relative to a text string in the original document. When using this method, you must not also use atPosition(double, double).
    
    Parameters:
    
    builder - the text anchor builder
    
    Returns:
    
    the signature builder itself
  - withPositionAnchor
```
public SignatureBuilder withPositionAnchor(TextAnchor textAnchor)
```
    Enables positioning the signature relative to a text string in the original document. When using this method, you must not also use atPosition(double, double).
    
    Parameters:
    
    textAnchor - the text anchor
    
    Returns:
    
    the signature builder itself
  - setFromFile
```
public SignatureBuilder setFromFile(boolean fromFile)
```
    Enable capture signature to be from file
    
    Parameters:
    
    fromFile - is from file data
    
    Returns:
    
    the signature builder itself
  - makeOptional
```
public SignatureBuilder makeOptional()
```
    Marks the signature as optional. Optional signatures don't have to be signed and can be left empty if the user chooses to.
    
    Returns:
    
    the signature builder itself
  - disabled
```
public SignatureBuilder disabled()
```
    Marks the signature as disabled. Disabled signatures cannot be signed and will be left empty.
    
    Returns:
    
    the signature builder itself
  - enableEnforceCaptureSignature
```
public SignatureBuilder enableEnforceCaptureSignature()
```
    Enables the signature level enforceCaptureSignature setting.
    
    Returns:
    
    the signature builder itself
  - build
```
public Signature build()
```
    This method actually builds the Signature object
    
    Returns:
    
    the signature

Class SignatureBuilder

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_WIDTH

DEFAULT_HEIGHT

DEFAULT_STYLE

Method Detail

signatureFor

signatureFor

signatureFor

acceptanceFor

acceptanceFor

acceptanceFor

initialsFor

initialsFor

initialsFor

captureFor

captureFor

captureFor

mobileCaptureFor

mobileCaptureFor

mobileCaptureFor

withId

onPage

atPosition

withSize

withFontSize

withStyle

withField

withField

withName

withPositionExtracted

withPositionAnchor

withPositionAnchor

setFromFile

makeOptional

disabled

enableEnforceCaptureSignature

build