FormulaTab (docusign-esign-java 2.9.0-beta-1 API)

java.lang.Object
- com.docusign.esign.model.FormulaTab

```
public class FormulaTab
extends Object
```
FormulaTab

Constructor Summary

Constructors
Constructor and Description

FormulaTab()

Constructors
Constructor and Description
`FormulaTab()`

Method Summary

Methods
Modifier and Type	Method and Description
`FormulaTab`	`anchorCaseSensitive(String anchorCaseSensitive)`
`FormulaTab`	`anchorHorizontalAlignment(String anchorHorizontalAlignment)`
`FormulaTab`	`anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)`
`FormulaTab`	`anchorMatchWholeWord(String anchorMatchWholeWord)`
`FormulaTab`	`anchorString(String anchorString)`
`FormulaTab`	`anchorUnits(String anchorUnits)`
`FormulaTab`	`anchorXOffset(String anchorXOffset)`
`FormulaTab`	`anchorYOffset(String anchorYOffset)`
`FormulaTab`	`bold(String bold)`
`FormulaTab`	`concealValueOnDocument(String concealValueOnDocument)`
`FormulaTab`	`conditionalParentLabel(String conditionalParentLabel)`
`FormulaTab`	`conditionalParentValue(String conditionalParentValue)`
`FormulaTab`	`customTabId(String customTabId)`
`FormulaTab`	`disableAutoSize(String disableAutoSize)`
`FormulaTab`	`documentId(String documentId)`
`boolean`	`equals(Object o)`
`FormulaTab`	`errorDetails(ErrorDetails errorDetails)`
`FormulaTab`	`font(String font)`
`FormulaTab`	`fontColor(String fontColor)`
`FormulaTab`	`fontSize(String fontSize)`
`FormulaTab`	`formula(String formula)`
`String`	`getAnchorCaseSensitive()` When set to true, the anchor string does not consider case when matching strings in the document.
`String`	`getAnchorHorizontalAlignment()` Specifies the alignment of anchor tabs with anchor strings.
`String`	`getAnchorIgnoreIfNotPresent()` When set to true, this tab is ignored if anchorString is not found in the document.
`String`	`getAnchorMatchWholeWord()` When set to true, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is true.
`String`	`getAnchorString()` Anchor text information for a radio button.
`String`	`getAnchorUnits()` Specifies units of the X and Y offset.
`String`	`getAnchorXOffset()` Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
`String`	`getAnchorYOffset()` Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
`String`	`getBold()` When set to true, the information in the tab is bold.
`String`	`getConcealValueOnDocument()` When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.
`String`	`getConditionalParentLabel()` For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`String`	`getConditionalParentValue()` For conditional fields, this is the value of the parent tab that controls the tab's visibility.
`String`	`getCustomTabId()` The DocuSign generated custom tab ID for the custom tab to be applied.
`String`	`getDisableAutoSize()` When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data.
`String`	`getDocumentId()` Specifies the document ID number that the tab is placed on.
`ErrorDetails`	`getErrorDetails()` Get errorDetails
`String`	`getFont()` The font to be used for the tab value.
`String`	`getFontColor()` The font color used for the information in the tab.
`String`	`getFontSize()` The font size used for the information in the tab.
`String`	`getFormula()` The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators.
`String`	`getHidden()`
`String`	`getIsPaymentAmount()` When set to true, sets this as a payment tab.
`String`	`getItalic()` When set to true, the information in the tab is italic.
`String`	`getLocked()` When set to true, the signer cannot change the data of the custom tab.
`Integer`	`getMaxLength()` An optional value that describes the maximum length of the property when the property is a string.
`MergeField`	`getMergeField()` Get mergeField
`String`	`getName()`
`String`	`getOriginalValue()` The initial value of the tab when it was sent to the recipient.
`String`	`getPageNumber()` Specifies the page number on which the tab is located.
`PaymentDetails`	`getPaymentDetails()` Get paymentDetails
`String`	`getRecipientId()` Unique for the recipient.
`String`	`getRequireAll()` When set to true and shared is true, information must be entered in this field to complete the envelope.
`String`	`getRequired()` When set to true, the signer is required to fill out this tab
`String`	`getRequireInitialOnSharedChange()` Optional element for field markup.
`String`	`getRoundDecimalPlaces()`
`String`	`getSenderRequired()` When set to true, the sender must populate the tab before an envelope can be sent using the template.
`String`	`getShared()` When set to true, this custom tab is shared.
`String`	`getStatus()` Indicates the envelope status.
`String`	`getTabId()` The unique identifier for the tab.
`String`	`getTabLabel()` The label string associated with the tab.
`String`	`getTabOrder()`
`String`	`getTemplateLocked()` When set to true, the sender cannot change any attributes of the recipient.
`String`	`getTemplateRequired()` When set to true, the sender may not remove the recipient.
`String`	`getUnderline()` When set to true, the information in the tab is underlined.
`String`	`getValidationMessage()` The message displayed if the custom tab fails input validation (either custom of embedded).
`String`	`getValidationPattern()` A regular expression used to validate input for the tab.
`String`	`getValue()` Specifies the value of the tab.
`Integer`	`getWidth()` Width of the tab in pixels.
`String`	`getXPosition()` This indicates the horizontal offset of the object on the page.
`String`	`getYPosition()` This indicates the vertical offset of the object on the page.
`int`	`hashCode()`
`FormulaTab`	`hidden(String hidden)`
`FormulaTab`	`isPaymentAmount(String isPaymentAmount)`
`FormulaTab`	`italic(String italic)`
`FormulaTab`	`locked(String locked)`
`FormulaTab`	`maxLength(Integer maxLength)`
`FormulaTab`	`mergeField(MergeField mergeField)`
`FormulaTab`	`name(String name)`
`FormulaTab`	`originalValue(String originalValue)`
`FormulaTab`	`pageNumber(String pageNumber)`
`FormulaTab`	`paymentDetails(PaymentDetails paymentDetails)`
`FormulaTab`	`recipientId(String recipientId)`
`FormulaTab`	`requireAll(String requireAll)`
`FormulaTab`	`required(String required)`
`FormulaTab`	`requireInitialOnSharedChange(String requireInitialOnSharedChange)`
`FormulaTab`	`roundDecimalPlaces(String roundDecimalPlaces)`
`FormulaTab`	`senderRequired(String senderRequired)`
`void`	`setAnchorCaseSensitive(String anchorCaseSensitive)`
`void`	`setAnchorHorizontalAlignment(String anchorHorizontalAlignment)`
`void`	`setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)`
`void`	`setAnchorMatchWholeWord(String anchorMatchWholeWord)`
`void`	`setAnchorString(String anchorString)`
`void`	`setAnchorUnits(String anchorUnits)`
`void`	`setAnchorXOffset(String anchorXOffset)`
`void`	`setAnchorYOffset(String anchorYOffset)`
`void`	`setBold(String bold)`
`void`	`setConcealValueOnDocument(String concealValueOnDocument)`
`void`	`setConditionalParentLabel(String conditionalParentLabel)`
`void`	`setConditionalParentValue(String conditionalParentValue)`
`void`	`setCustomTabId(String customTabId)`
`void`	`setDisableAutoSize(String disableAutoSize)`
`void`	`setDocumentId(String documentId)`
`void`	`setErrorDetails(ErrorDetails errorDetails)`
`void`	`setFont(String font)`
`void`	`setFontColor(String fontColor)`
`void`	`setFontSize(String fontSize)`
`void`	`setFormula(String formula)`
`void`	`setHidden(String hidden)`
`void`	`setIsPaymentAmount(String isPaymentAmount)`
`void`	`setItalic(String italic)`
`void`	`setLocked(String locked)`
`void`	`setMaxLength(Integer maxLength)`
`void`	`setMergeField(MergeField mergeField)`
`void`	`setName(String name)`
`void`	`setOriginalValue(String originalValue)`
`void`	`setPageNumber(String pageNumber)`
`void`	`setPaymentDetails(PaymentDetails paymentDetails)`
`void`	`setRecipientId(String recipientId)`
`void`	`setRequireAll(String requireAll)`
`void`	`setRequired(String required)`
`void`	`setRequireInitialOnSharedChange(String requireInitialOnSharedChange)`
`void`	`setRoundDecimalPlaces(String roundDecimalPlaces)`
`void`	`setSenderRequired(String senderRequired)`
`void`	`setShared(String shared)`
`void`	`setStatus(String status)`
`void`	`setTabId(String tabId)`
`void`	`setTabLabel(String tabLabel)`
`void`	`setTabOrder(String tabOrder)`
`void`	`setTemplateLocked(String templateLocked)`
`void`	`setTemplateRequired(String templateRequired)`
`void`	`setUnderline(String underline)`
`void`	`setValidationMessage(String validationMessage)`
`void`	`setValidationPattern(String validationPattern)`
`void`	`setValue(String value)`
`void`	`setWidth(Integer width)`
`void`	`setXPosition(String xPosition)`
`void`	`setYPosition(String yPosition)`
`FormulaTab`	`shared(String shared)`
`FormulaTab`	`status(String status)`
`FormulaTab`	`tabId(String tabId)`
`FormulaTab`	`tabLabel(String tabLabel)`
`FormulaTab`	`tabOrder(String tabOrder)`
`FormulaTab`	`templateLocked(String templateLocked)`
`FormulaTab`	`templateRequired(String templateRequired)`
`String`	`toString()`
`FormulaTab`	`underline(String underline)`
`FormulaTab`	`validationMessage(String validationMessage)`
`FormulaTab`	`validationPattern(String validationPattern)`
`FormulaTab`	`value(String value)`
`FormulaTab`	`width(Integer width)`
`FormulaTab`	`xPosition(String xPosition)`
`FormulaTab`	`yPosition(String yPosition)`

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

- Constructor Detail
  - FormulaTab
```
public FormulaTab()
```
- Method Detail
  - anchorCaseSensitive
```
public FormulaTab anchorCaseSensitive(String anchorCaseSensitive)
```
  - getAnchorCaseSensitive
```
public String getAnchorCaseSensitive()
```
    When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
    
    Returns:
    anchorCaseSensitive
  - setAnchorCaseSensitive
```
public void setAnchorCaseSensitive(String anchorCaseSensitive)
```
  - anchorHorizontalAlignment
```
public FormulaTab anchorHorizontalAlignment(String anchorHorizontalAlignment)
```
  - getAnchorHorizontalAlignment
```
public String getAnchorHorizontalAlignment()
```
    Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
    
    Returns:
    anchorHorizontalAlignment
  - setAnchorHorizontalAlignment
```
public void setAnchorHorizontalAlignment(String anchorHorizontalAlignment)
```
  - anchorIgnoreIfNotPresent
```
public FormulaTab anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
```
  - getAnchorIgnoreIfNotPresent
```
public String getAnchorIgnoreIfNotPresent()
```
    When set to **true**, this tab is ignored if anchorString is not found in the document.
    
    Returns:
    anchorIgnoreIfNotPresent
  - setAnchorIgnoreIfNotPresent
```
public void setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
```
  - anchorMatchWholeWord
```
public FormulaTab anchorMatchWholeWord(String anchorMatchWholeWord)
```
  - getAnchorMatchWholeWord
```
public String getAnchorMatchWholeWord()
```
    When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.
    
    Returns:
    anchorMatchWholeWord
  - setAnchorMatchWholeWord
```
public void setAnchorMatchWholeWord(String anchorMatchWholeWord)
```
  - anchorString
```
public FormulaTab anchorString(String anchorString)
```
  - getAnchorString
```
public String getAnchorString()
```
    Anchor text information for a radio button.
    
    Returns:
    anchorString
  - setAnchorString
```
public void setAnchorString(String anchorString)
```
  - anchorUnits
```
public FormulaTab anchorUnits(String anchorUnits)
```
  - getAnchorUnits
```
public String getAnchorUnits()
```
    Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
    
    Returns:
    anchorUnits
  - setAnchorUnits
```
public void setAnchorUnits(String anchorUnits)
```
  - anchorXOffset
```
public FormulaTab anchorXOffset(String anchorXOffset)
```
  - getAnchorXOffset
```
public String getAnchorXOffset()
```
    Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
    
    Returns:
    anchorXOffset
  - setAnchorXOffset
```
public void setAnchorXOffset(String anchorXOffset)
```
  - anchorYOffset
```
public FormulaTab anchorYOffset(String anchorYOffset)
```
  - getAnchorYOffset
```
public String getAnchorYOffset()
```
    Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
    
    Returns:
    anchorYOffset
  - setAnchorYOffset
```
public void setAnchorYOffset(String anchorYOffset)
```
  - bold
```
public FormulaTab bold(String bold)
```
  - getBold
```
public String getBold()
```
    When set to **true**, the information in the tab is bold.
    
    Returns:
    bold
  - setBold
```
public void setBold(String bold)
```
  - concealValueOnDocument
```
public FormulaTab concealValueOnDocument(String concealValueOnDocument)
```
  - getConcealValueOnDocument
```
public String getConcealValueOnDocument()
```
    When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
    
    Returns:
    concealValueOnDocument
  - setConcealValueOnDocument
```
public void setConcealValueOnDocument(String concealValueOnDocument)
```
  - conditionalParentLabel
```
public FormulaTab conditionalParentLabel(String conditionalParentLabel)
```
  - getConditionalParentLabel
```
public String getConditionalParentLabel()
```
    For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
    
    Returns:
    conditionalParentLabel
  - setConditionalParentLabel
```
public void setConditionalParentLabel(String conditionalParentLabel)
```
  - conditionalParentValue
```
public FormulaTab conditionalParentValue(String conditionalParentValue)
```
  - getConditionalParentValue
```
public String getConditionalParentValue()
```
    For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.
    
    Returns:
    conditionalParentValue
  - setConditionalParentValue
```
public void setConditionalParentValue(String conditionalParentValue)
```
  - customTabId
```
public FormulaTab customTabId(String customTabId)
```
  - getCustomTabId
```
public String getCustomTabId()
```
    The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
    
    Returns:
    customTabId
  - setCustomTabId
```
public void setCustomTabId(String customTabId)
```
  - disableAutoSize
```
public FormulaTab disableAutoSize(String disableAutoSize)
```
  - getDisableAutoSize
```
public String getDisableAutoSize()
```
    When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.
    
    Returns:
    disableAutoSize
  - setDisableAutoSize
```
public void setDisableAutoSize(String disableAutoSize)
```
  - documentId
```
public FormulaTab documentId(String documentId)
```
  - getDocumentId
```
public String getDocumentId()
```
    Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
    
    Returns:
    documentId
  - setDocumentId
```
public void setDocumentId(String documentId)
```
  - errorDetails
```
public FormulaTab errorDetails(ErrorDetails errorDetails)
```
  - getErrorDetails
```
public ErrorDetails getErrorDetails()
```
    Get errorDetails
    
    Returns:
    errorDetails
  - setErrorDetails
```
public void setErrorDetails(ErrorDetails errorDetails)
```
  - font
```
public FormulaTab font(String font)
```
  - getFont
```
public String getFont()
```
    The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
    
    Returns:
    font
  - setFont
```
public void setFont(String font)
```
  - fontColor
```
public FormulaTab fontColor(String fontColor)
```
  - getFontColor
```
public String getFontColor()
```
    The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
    
    Returns:
    fontColor
  - setFontColor
```
public void setFontColor(String fontColor)
```
  - fontSize
```
public FormulaTab fontSize(String fontSize)
```
  - getFontSize
```
public String getFontSize()
```
    The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.
    
    Returns:
    fontSize
  - setFontSize
```
public void setFontSize(String fontSize)
```
  - formula
```
public FormulaTab formula(String formula)
```
  - getFormula
```
public String getFormula()
```
    The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. *Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax]
    
    Returns:
    formula
  - setFormula
```
public void setFormula(String formula)
```
  - hidden
```
public FormulaTab hidden(String hidden)
```
  - getHidden
```
public String getHidden()
```
    Returns:
    hidden
  - setHidden
```
public void setHidden(String hidden)
```
  - isPaymentAmount
```
public FormulaTab isPaymentAmount(String isPaymentAmount)
```
  - getIsPaymentAmount
```
public String getIsPaymentAmount()
```
    When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number.
    
    Returns:
    isPaymentAmount
  - setIsPaymentAmount
```
public void setIsPaymentAmount(String isPaymentAmount)
```
  - italic
```
public FormulaTab italic(String italic)
```
  - getItalic
```
public String getItalic()
```
    When set to **true**, the information in the tab is italic.
    
    Returns:
    italic
  - setItalic
```
public void setItalic(String italic)
```
  - locked
```
public FormulaTab locked(String locked)
```
  - getLocked
```
public String getLocked()
```
    When set to **true**, the signer cannot change the data of the custom tab.
    
    Returns:
    locked
  - setLocked
```
public void setLocked(String locked)
```
  - maxLength
```
public FormulaTab maxLength(Integer maxLength)
```
  - getMaxLength
```
public Integer getMaxLength()
```
    An optional value that describes the maximum length of the property when the property is a string.
    
    Returns:
    maxLength
  - setMaxLength
```
public void setMaxLength(Integer maxLength)
```
  - mergeField
```
public FormulaTab mergeField(MergeField mergeField)
```
  - getMergeField
```
public MergeField getMergeField()
```
    Get mergeField
    
    Returns:
    mergeField
  - setMergeField
```
public void setMergeField(MergeField mergeField)
```
  - name
```
public FormulaTab name(String name)
```
  - getName
```
public String getName()
```
    Returns:
    name
  - setName
```
public void setName(String name)
```
  - originalValue
```
public FormulaTab originalValue(String originalValue)
```
  - getOriginalValue
```
public String getOriginalValue()
```
    The initial value of the tab when it was sent to the recipient.
    
    Returns:
    originalValue
  - setOriginalValue
```
public void setOriginalValue(String originalValue)
```
  - pageNumber
```
public FormulaTab pageNumber(String pageNumber)
```
  - getPageNumber
```
public String getPageNumber()
```
    Specifies the page number on which the tab is located.
    
    Returns:
    pageNumber
  - setPageNumber
```
public void setPageNumber(String pageNumber)
```
  - paymentDetails
```
public FormulaTab paymentDetails(PaymentDetails paymentDetails)
```
  - getPaymentDetails
```
public PaymentDetails getPaymentDetails()
```
    Get paymentDetails
    
    Returns:
    paymentDetails
  - setPaymentDetails
```
public void setPaymentDetails(PaymentDetails paymentDetails)
```
  - recipientId
```
public FormulaTab recipientId(String recipientId)
```
  - getRecipientId
```
public String getRecipientId()
```
    Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
    
    Returns:
    recipientId
  - setRecipientId
```
public void setRecipientId(String recipientId)
```
  - requireAll
```
public FormulaTab requireAll(String requireAll)
```
  - getRequireAll
```
public String getRequireAll()
```
    When set to **true** and shared is true, information must be entered in this field to complete the envelope.
    
    Returns:
    requireAll
  - setRequireAll
```
public void setRequireAll(String requireAll)
```
  - required
```
public FormulaTab required(String required)
```
  - getRequired
```
public String getRequired()
```
    When set to **true**, the signer is required to fill out this tab
    
    Returns:
    required
  - setRequired
```
public void setRequired(String required)
```
  - requireInitialOnSharedChange
```
public FormulaTab requireInitialOnSharedChange(String requireInitialOnSharedChange)
```
  - getRequireInitialOnSharedChange
```
public String getRequireInitialOnSharedChange()
```
    Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
    
    Returns:
    requireInitialOnSharedChange
  - setRequireInitialOnSharedChange
```
public void setRequireInitialOnSharedChange(String requireInitialOnSharedChange)
```
  - roundDecimalPlaces
```
public FormulaTab roundDecimalPlaces(String roundDecimalPlaces)
```
  - getRoundDecimalPlaces
```
public String getRoundDecimalPlaces()
```
    Returns:
    roundDecimalPlaces
  - setRoundDecimalPlaces
```
public void setRoundDecimalPlaces(String roundDecimalPlaces)
```
  - senderRequired
```
public FormulaTab senderRequired(String senderRequired)
```
  - getSenderRequired
```
public String getSenderRequired()
```
    When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
    
    Returns:
    senderRequired
  - setSenderRequired
```
public void setSenderRequired(String senderRequired)
```
  - shared
```
public FormulaTab shared(String shared)
```
  - getShared
```
public String getShared()
```
    When set to **true**, this custom tab is shared.
    
    Returns:
    shared
  - setShared
```
public void setShared(String shared)
```
  - status
```
public FormulaTab status(String status)
```
  - getStatus
```
public String getStatus()
```
    Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
    
    Returns:
    status
  - setStatus
```
public void setStatus(String status)
```
  - tabId
```
public FormulaTab tabId(String tabId)
```
  - getTabId
```
public String getTabId()
```
    The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
    
    Returns:
    tabId
  - setTabId
```
public void setTabId(String tabId)
```
  - tabLabel
```
public FormulaTab tabLabel(String tabLabel)
```
  - getTabLabel
```
public String getTabLabel()
```
    The label string associated with the tab.
    
    Returns:
    tabLabel
  - setTabLabel
```
public void setTabLabel(String tabLabel)
```
  - tabOrder
```
public FormulaTab tabOrder(String tabOrder)
```
  - getTabOrder
```
public String getTabOrder()
```
    Returns:
    tabOrder
  - setTabOrder
```
public void setTabOrder(String tabOrder)
```
  - templateLocked
```
public FormulaTab templateLocked(String templateLocked)
```
  - getTemplateLocked
```
public String getTemplateLocked()
```
    When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
    
    Returns:
    templateLocked
  - setTemplateLocked
```
public void setTemplateLocked(String templateLocked)
```
  - templateRequired
```
public FormulaTab templateRequired(String templateRequired)
```
  - getTemplateRequired
```
public String getTemplateRequired()
```
    When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
    
    Returns:
    templateRequired
  - setTemplateRequired
```
public void setTemplateRequired(String templateRequired)
```
  - underline
```
public FormulaTab underline(String underline)
```
  - getUnderline
```
public String getUnderline()
```
    When set to **true**, the information in the tab is underlined.
    
    Returns:
    underline
  - setUnderline
```
public void setUnderline(String underline)
```
  - validationMessage
```
public FormulaTab validationMessage(String validationMessage)
```
  - getValidationMessage
```
public String getValidationMessage()
```
    The message displayed if the custom tab fails input validation (either custom of embedded).
    
    Returns:
    validationMessage
  - setValidationMessage
```
public void setValidationMessage(String validationMessage)
```
  - validationPattern
```
public FormulaTab validationPattern(String validationPattern)
```
  - getValidationPattern
```
public String getValidationPattern()
```
    A regular expression used to validate input for the tab.
    
    Returns:
    validationPattern
  - setValidationPattern
```
public void setValidationPattern(String validationPattern)
```
  - value
```
public FormulaTab value(String value)
```
  - getValue
```
public String getValue()
```
    Specifies the value of the tab.
    
    Returns:
    value
  - setValue
```
public void setValue(String value)
```
  - width
```
public FormulaTab width(Integer width)
```
  - getWidth
```
public Integer getWidth()
```
    Width of the tab in pixels.
    
    Returns:
    width
  - setWidth
```
public void setWidth(Integer width)
```
  - xPosition
```
public FormulaTab xPosition(String xPosition)
```
  - getXPosition
```
public String getXPosition()
```
    This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
    
    Returns:
    xPosition
  - setXPosition
```
public void setXPosition(String xPosition)
```
  - yPosition
```
public FormulaTab yPosition(String yPosition)
```
  - getYPosition
```
public String getYPosition()
```
    This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
    
    Returns:
    yPosition
  - setYPosition
```
public void setYPosition(String yPosition)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class FormulaTab

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FormulaTab

Method Detail

anchorCaseSensitive

getAnchorCaseSensitive

setAnchorCaseSensitive

anchorHorizontalAlignment

getAnchorHorizontalAlignment

setAnchorHorizontalAlignment

anchorIgnoreIfNotPresent

getAnchorIgnoreIfNotPresent

setAnchorIgnoreIfNotPresent

anchorMatchWholeWord

getAnchorMatchWholeWord

setAnchorMatchWholeWord

anchorString

getAnchorString

setAnchorString

anchorUnits

getAnchorUnits

setAnchorUnits

anchorXOffset

getAnchorXOffset

setAnchorXOffset

anchorYOffset

getAnchorYOffset

setAnchorYOffset

bold

getBold

setBold

concealValueOnDocument

getConcealValueOnDocument

setConcealValueOnDocument

conditionalParentLabel

getConditionalParentLabel

setConditionalParentLabel

conditionalParentValue

getConditionalParentValue

setConditionalParentValue

customTabId

getCustomTabId

setCustomTabId

disableAutoSize

getDisableAutoSize

setDisableAutoSize

documentId

getDocumentId

setDocumentId

errorDetails

getErrorDetails

setErrorDetails

font

getFont

setFont

fontColor

getFontColor

setFontColor

fontSize

getFontSize

setFontSize

formula

getFormula

setFormula

hidden

getHidden

setHidden

isPaymentAmount

getIsPaymentAmount

setIsPaymentAmount

italic

getItalic

setItalic

locked

getLocked

setLocked

maxLength