FormulaTab (docusign-esign-java 2.2.0 API)

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

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-03-06T16:42:36.211-08:00")
public class FormulaTab
extends Object

Constructor Summary

Constructors
Constructor and Description

FormulaTab()

Constructors
Constructor and Description
`FormulaTab()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`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 achorUnits, relative to the anchorString.
`String`	`getAnchorYOffset()` Specifies the Y axis location of the tab, in achorUnits, 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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
`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.\n\nIf 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.
`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()`
`String`	`getFont()` The font to be used for the tab value.
`String`	`getFontColor()` The font color used for the information in the tab.\n\nPossible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
`String`	`getFontSize()` The font size used for the information in the tab.\n\nPossible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.
`String`	`getFormula()` The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators.
`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()`
`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()`
`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 expressionn 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()`
`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`	`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)`
`String`	`toString()`

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

- Constructor Detail
  - FormulaTab
```
public FormulaTab()
```
- Method Detail
  - 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**.
  - setAnchorCaseSensitive
```
public void setAnchorCaseSensitive(String anchorCaseSensitive)
```
  - getAnchorHorizontalAlignment
```
public String getAnchorHorizontalAlignment()
```
    Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
  - setAnchorHorizontalAlignment
```
public void setAnchorHorizontalAlignment(String anchorHorizontalAlignment)
```
  - getAnchorIgnoreIfNotPresent
```
public String getAnchorIgnoreIfNotPresent()
```
    When set to **true**, this tab is ignored if anchorString is not found in the document.
  - setAnchorIgnoreIfNotPresent
```
public void setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
```
  - 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**.
  - setAnchorMatchWholeWord
```
public void setAnchorMatchWholeWord(String anchorMatchWholeWord)
```
  - getAnchorString
```
public String getAnchorString()
```
    Anchor text information for a radio button.
  - setAnchorString
```
public void setAnchorString(String anchorString)
```
  - getAnchorUnits
```
public String getAnchorUnits()
```
    Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
  - setAnchorUnits
```
public void setAnchorUnits(String anchorUnits)
```
  - getAnchorXOffset
```
public String getAnchorXOffset()
```
    Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
  - setAnchorXOffset
```
public void setAnchorXOffset(String anchorXOffset)
```
  - getAnchorYOffset
```
public String getAnchorYOffset()
```
    Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
  - setAnchorYOffset
```
public void setAnchorYOffset(String anchorYOffset)
```
  - getBold
```
public String getBold()
```
    When set to **true**, the information in the tab is bold.
  - setBold
```
public void setBold(String bold)
```
  - 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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
  - setConcealValueOnDocument
```
public void setConcealValueOnDocument(String concealValueOnDocument)
```
  - getConditionalParentLabel
```
public String getConditionalParentLabel()
```
    For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
  - setConditionalParentLabel
```
public void setConditionalParentLabel(String conditionalParentLabel)
```
  - getConditionalParentValue
```
public String getConditionalParentValue()
```
    For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.
  - setConditionalParentValue
```
public void setConditionalParentValue(String conditionalParentValue)
```
  - 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.
  - setCustomTabId
```
public void setCustomTabId(String customTabId)
```
  - 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.
  - setDisableAutoSize
```
public void setDisableAutoSize(String disableAutoSize)
```
  - 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.
  - setDocumentId
```
public void setDocumentId(String documentId)
```
  - getErrorDetails
```
public ErrorDetails getErrorDetails()
```
  - setErrorDetails
```
public void setErrorDetails(ErrorDetails errorDetails)
```
  - 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.
  - setFont
```
public void setFont(String font)
```
  - getFontColor
```
public String getFontColor()
```
    The font color used for the information in the tab.\n\nPossible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
  - setFontColor
```
public void setFontColor(String fontColor)
```
  - getFontSize
```
public String getFontSize()
```
    The font size used for the information in the tab.\n\nPossible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.
  - setFontSize
```
public void setFontSize(String fontSize)
```
  - 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. \nMaximum Length: 2000 characters.\n\n*Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: \n\n[Line1]+[Line2]+[Tax]
  - setFormula
```
public void setFormula(String formula)
```
  - 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.
  - setIsPaymentAmount
```
public void setIsPaymentAmount(String isPaymentAmount)
```
  - getItalic
```
public String getItalic()
```
    When set to **true**, the information in the tab is italic.
  - setItalic
```
public void setItalic(String italic)
```
  - getLocked
```
public String getLocked()
```
    When set to **true**, the signer cannot change the data of the custom tab.
  - setLocked
```
public void setLocked(String locked)
```
  - getMaxLength
```
public Integer getMaxLength()
```
    An optional value that describes the maximum length of the property when the property is a string.
  - setMaxLength
```
public void setMaxLength(Integer maxLength)
```
  - getMergeField
```
public MergeField getMergeField()
```
  - setMergeField
```
public void setMergeField(MergeField mergeField)
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - getOriginalValue
```
public String getOriginalValue()
```
    The initial value of the tab when it was sent to the recipient.
  - setOriginalValue
```
public void setOriginalValue(String originalValue)
```
  - getPageNumber
```
public String getPageNumber()
```
    Specifies the page number on which the tab is located.
  - setPageNumber
```
public void setPageNumber(String pageNumber)
```
  - getPaymentDetails
```
public PaymentDetails getPaymentDetails()
```
  - setPaymentDetails
```
public void setPaymentDetails(PaymentDetails paymentDetails)
```
  - getRecipientId
```
public String getRecipientId()
```
    Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
  - setRecipientId
```
public void setRecipientId(String recipientId)
```
  - getRequireAll
```
public String getRequireAll()
```
    When set to **true** and shared is true, information must be entered in this field to complete the envelope.
  - setRequireAll
```
public void setRequireAll(String requireAll)
```
  - getRequired
```
public String getRequired()
```
    When set to **true**, the signer is required to fill out this tab
  - setRequired
```
public void setRequired(String required)
```
  - 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.
  - setRequireInitialOnSharedChange
```
public void setRequireInitialOnSharedChange(String requireInitialOnSharedChange)
```
  - getRoundDecimalPlaces
```
public String getRoundDecimalPlaces()
```
  - setRoundDecimalPlaces
```
public void setRoundDecimalPlaces(String roundDecimalPlaces)
```
  - getSenderRequired
```
public String getSenderRequired()
```
    When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.
  - setSenderRequired
```
public void setSenderRequired(String senderRequired)
```
  - getShared
```
public String getShared()
```
    When set to **true**, this custom tab is shared.
  - setShared
```
public void setShared(String shared)
```
  - getStatus
```
public String getStatus()
```
    Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.
  - setStatus
```
public void setStatus(String status)
```
  - getTabId
```
public String getTabId()
```
    The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
  - setTabId
```
public void setTabId(String tabId)
```
  - getTabLabel
```
public String getTabLabel()
```
    The label string associated with the tab.
  - setTabLabel
```
public void setTabLabel(String tabLabel)
```
  - getTabOrder
```
public String getTabOrder()
```
  - setTabOrder
```
public void setTabOrder(String tabOrder)
```
  - getTemplateLocked
```
public String getTemplateLocked()
```
    When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
  - setTemplateLocked
```
public void setTemplateLocked(String templateLocked)
```
  - getTemplateRequired
```
public String getTemplateRequired()
```
    When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
  - setTemplateRequired
```
public void setTemplateRequired(String templateRequired)
```
  - getUnderline
```
public String getUnderline()
```
    When set to **true**, the information in the tab is underlined.
  - setUnderline
```
public void setUnderline(String underline)
```
  - getValidationMessage
```
public String getValidationMessage()
```
    The message displayed if the custom tab fails input validation (either custom of embedded).
  - setValidationMessage
```
public void setValidationMessage(String validationMessage)
```
  - getValidationPattern
```
public String getValidationPattern()
```
    A regular expressionn used to validate input for the tab.
  - setValidationPattern
```
public void setValidationPattern(String validationPattern)
```
  - getValue
```
public String getValue()
```
    Specifies the value of the tab.
  - setValue
```
public void setValue(String value)
```
  - getWidth
```
public Integer getWidth()
```
    Width of the tab in pixels.
  - setWidth
```
public void setWidth(Integer width)
```
  - getXPosition
```
public String getXPosition()
```
    This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
  - setXPosition
```
public void setXPosition(String xPosition)
```
  - getYPosition
```
public String getYPosition()
```
    This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
  - 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

getAnchorCaseSensitive

setAnchorCaseSensitive

getAnchorHorizontalAlignment

setAnchorHorizontalAlignment

getAnchorIgnoreIfNotPresent

setAnchorIgnoreIfNotPresent

getAnchorMatchWholeWord

setAnchorMatchWholeWord

getAnchorString

setAnchorString

getAnchorUnits

setAnchorUnits

getAnchorXOffset

setAnchorXOffset

getAnchorYOffset

setAnchorYOffset

getBold

setBold

getConcealValueOnDocument

setConcealValueOnDocument

getConditionalParentLabel

setConditionalParentLabel

getConditionalParentValue

setConditionalParentValue

getCustomTabId

setCustomTabId

getDisableAutoSize

setDisableAutoSize

getDocumentId

setDocumentId

getErrorDetails

setErrorDetails

getFont

setFont

getFontColor

setFontColor

getFontSize

setFontSize

getFormula

setFormula

getIsPaymentAmount

setIsPaymentAmount

getItalic

setItalic

getLocked

setLocked

getMaxLength

setMaxLength

getMergeField

setMergeField

getName

setName

getOriginalValue

setOriginalValue

getPageNumber

setPageNumber

getPaymentDetails

setPaymentDetails

getRecipientId

setRecipientId

getRequireAll

setRequireAll

getRequired

setRequired

getRequireInitialOnSharedChange

setRequireInitialOnSharedChange

getRoundDecimalPlaces

setRoundDecimalPlaces

getSenderRequired

setSenderRequired

getShared

setShared

getStatus