Package com.docusign.esign.model

Class FormulaTab

  • public class FormulaTab
extends Object
    FormulaTab.

    • Constructor Detail

      • FormulaTab

        public FormulaTab()

    • Method Detail

      • anchorCaseSensitive

        public FormulaTab anchorCaseSensitive​(String anchorCaseSensitive)
        anchorCaseSensitive.
        Returns:
        FormulaTab

      • 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)
        setAnchorCaseSensitive.

      • anchorHorizontalAlignment

        public FormulaTab anchorHorizontalAlignment​(String anchorHorizontalAlignment)
        anchorHorizontalAlignment.
        Returns:
        FormulaTab

      • 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)
        setAnchorHorizontalAlignment.

      • anchorIgnoreIfNotPresent

        public FormulaTab anchorIgnoreIfNotPresent​(String anchorIgnoreIfNotPresent)
        anchorIgnoreIfNotPresent.
        Returns:
        FormulaTab

      • 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)
        setAnchorIgnoreIfNotPresent.

      • anchorMatchWholeWord

        public FormulaTab anchorMatchWholeWord​(String anchorMatchWholeWord)
        anchorMatchWholeWord.
        Returns:
        FormulaTab

      • 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)
        setAnchorMatchWholeWord.

      • anchorString

        public FormulaTab anchorString​(String anchorString)
        anchorString.
        Returns:
        FormulaTab

      • getAnchorString

        public String getAnchorString()
        Anchor text information for a radio button..
        Returns:
        anchorString

      • setAnchorString

        public void setAnchorString​(String anchorString)
        setAnchorString.

      • anchorUnits

        public FormulaTab anchorUnits​(String anchorUnits)
        anchorUnits.
        Returns:
        FormulaTab

      • 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)
        setAnchorUnits.

      • anchorXOffset

        public FormulaTab anchorXOffset​(String anchorXOffset)
        anchorXOffset.
        Returns:
        FormulaTab

      • 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)
        setAnchorXOffset.

      • anchorYOffset

        public FormulaTab anchorYOffset​(String anchorYOffset)
        anchorYOffset.
        Returns:
        FormulaTab

      • 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)
        setAnchorYOffset.

      • getBold

        public String getBold()
        When set to **true**, the information in the tab is bold..
        Returns:
        bold

      • setBold

        public void setBold​(String bold)
        setBold.

      • concealValueOnDocument

        public FormulaTab concealValueOnDocument​(String concealValueOnDocument)
        concealValueOnDocument.
        Returns:
        FormulaTab

      • 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)
        setConcealValueOnDocument.

      • conditionalParentLabel

        public FormulaTab conditionalParentLabel​(String conditionalParentLabel)
        conditionalParentLabel.
        Returns:
        FormulaTab

      • 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)
        setConditionalParentLabel.

      • conditionalParentValue

        public FormulaTab conditionalParentValue​(String conditionalParentValue)
        conditionalParentValue.
        Returns:
        FormulaTab

      • 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)
        setConditionalParentValue.

      • customTabId

        public FormulaTab customTabId​(String customTabId)
        customTabId.
        Returns:
        FormulaTab

      • 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)
        setCustomTabId.

      • disableAutoSize

        public FormulaTab disableAutoSize​(String disableAutoSize)
        disableAutoSize.
        Returns:
        FormulaTab

      • 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)
        setDisableAutoSize.

      • documentId

        public FormulaTab documentId​(String documentId)
        documentId.
        Returns:
        FormulaTab

      • 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)
        setDocumentId.

      • errorDetails

        public FormulaTab errorDetails​(ErrorDetails errorDetails)
        errorDetails.
        Returns:
        FormulaTab

      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Get errorDetails.
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.

      • 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)
        setFont.

      • fontColor

        public FormulaTab fontColor​(String fontColor)
        fontColor.
        Returns:
        FormulaTab

      • 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)
        setFontColor.

      • fontSize

        public FormulaTab fontSize​(String fontSize)
        fontSize.
        Returns:
        FormulaTab

      • 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)
        setFontSize.

      • formula

        public FormulaTab formula​(String formula)
        formula.
        Returns:
        FormulaTab

      • 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)
        setFormula.

      • hidden

        public FormulaTab hidden​(String hidden)
        hidden.
        Returns:
        FormulaTab

      • getHidden

        public String getHidden()
        .
        Returns:
        hidden

      • setHidden

        public void setHidden​(String hidden)
        setHidden.

      • isPaymentAmount

        public FormulaTab isPaymentAmount​(String isPaymentAmount)
        isPaymentAmount.
        Returns:
        FormulaTab

      • 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)
        setIsPaymentAmount.

      • italic

        public FormulaTab italic​(String italic)
        italic.
        Returns:
        FormulaTab

      • getItalic

        public String getItalic()
        When set to **true**, the information in the tab is italic..
        Returns:
        italic

      • setItalic

        public void setItalic​(String italic)
        setItalic.

      • locked

        public FormulaTab locked​(String locked)
        locked.
        Returns:
        FormulaTab

      • 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)
        setLocked.

      • maxLength

        public FormulaTab maxLength​(Integer maxLength)
        maxLength.
        Returns:
        FormulaTab

      • 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)
        setMaxLength.

      • mergeField

        public FormulaTab mergeField​(MergeField mergeField)
        mergeField.
        Returns:
        FormulaTab

      • getMergeField

        public MergeField getMergeField()
        Get mergeField.
        Returns:
        mergeField

      • setMergeField

        public void setMergeField​(MergeField mergeField)
        setMergeField.

      • getName

        public String getName()
        .
        Returns:
        name

      • setName

        public void setName​(String name)
        setName.

      • originalValue

        public FormulaTab originalValue​(String originalValue)
        originalValue.
        Returns:
        FormulaTab

      • 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)
        setOriginalValue.

      • pageNumber

        public FormulaTab pageNumber​(String pageNumber)
        pageNumber.
        Returns:
        FormulaTab

      • getPageNumber

        public String getPageNumber()
        Specifies the page number on which the tab is located..
        Returns:
        pageNumber

      • setPageNumber

        public void setPageNumber​(String pageNumber)
        setPageNumber.

      • paymentDetails

        public FormulaTab paymentDetails​(PaymentDetails paymentDetails)
        paymentDetails.
        Returns:
        FormulaTab

      • getPaymentDetails

        public PaymentDetails getPaymentDetails()
        Get paymentDetails.
        Returns:
        paymentDetails

      • setPaymentDetails

        public void setPaymentDetails​(PaymentDetails paymentDetails)
        setPaymentDetails.

      • recipientId

        public FormulaTab recipientId​(String recipientId)
        recipientId.
        Returns:
        FormulaTab

      • 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)
        setRecipientId.

      • requireAll

        public FormulaTab requireAll​(String requireAll)
        requireAll.
        Returns:
        FormulaTab

      • 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)
        setRequireAll.

      • required

        public FormulaTab required​(String required)
        required.
        Returns:
        FormulaTab

      • 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)
        setRequired.

      • requireInitialOnSharedChange

        public FormulaTab requireInitialOnSharedChange​(String requireInitialOnSharedChange)
        requireInitialOnSharedChange.
        Returns:
        FormulaTab

      • 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)
        setRequireInitialOnSharedChange.

      • roundDecimalPlaces

        public FormulaTab roundDecimalPlaces​(String roundDecimalPlaces)
        roundDecimalPlaces.
        Returns:
        FormulaTab

      • getRoundDecimalPlaces

        public String getRoundDecimalPlaces()
        .
        Returns:
        roundDecimalPlaces

      • setRoundDecimalPlaces

        public void setRoundDecimalPlaces​(String roundDecimalPlaces)
        setRoundDecimalPlaces.

      • senderRequired

        public FormulaTab senderRequired​(String senderRequired)
        senderRequired.
        Returns:
        FormulaTab

      • 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)
        setSenderRequired.

      • shared

        public FormulaTab shared​(String shared)
        shared.
        Returns:
        FormulaTab

      • getShared

        public String getShared()
        When set to **true**, this custom tab is shared..
        Returns:
        shared

      • setShared

        public void setShared​(String shared)
        setShared.

      • status

        public FormulaTab status​(String status)
        status.
        Returns:
        FormulaTab

      • 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)
        setStatus.

      • tabGroupLabels

        public FormulaTab tabGroupLabels​(List<String> tabGroupLabels)
        tabGroupLabels.
        Returns:
        FormulaTab

      • addTabGroupLabelsItem

        public FormulaTab addTabGroupLabelsItem​(String tabGroupLabelsItem)
        addTabGroupLabelsItem.
        Returns:
        FormulaTab

      • getTabGroupLabels

        public List<String> getTabGroupLabels()
        .
        Returns:
        tabGroupLabels

      • setTabGroupLabels

        public void setTabGroupLabels​(List<String> tabGroupLabels)
        setTabGroupLabels.

      • 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)
        setTabId.

      • tabLabel

        public FormulaTab tabLabel​(String tabLabel)
        tabLabel.
        Returns:
        FormulaTab

      • getTabLabel

        public String getTabLabel()
        The label string associated with the tab..
        Returns:
        tabLabel

      • setTabLabel

        public void setTabLabel​(String tabLabel)
        setTabLabel.

      • tabOrder

        public FormulaTab tabOrder​(String tabOrder)
        tabOrder.
        Returns:
        FormulaTab

      • getTabOrder

        public String getTabOrder()
        .
        Returns:
        tabOrder

      • setTabOrder

        public void setTabOrder​(String tabOrder)
        setTabOrder.

      • templateLocked

        public FormulaTab templateLocked​(String templateLocked)
        templateLocked.
        Returns:
        FormulaTab

      • 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)
        setTemplateLocked.

      • templateRequired

        public FormulaTab templateRequired​(String templateRequired)
        templateRequired.
        Returns:
        FormulaTab

      • 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)
        setTemplateRequired.

      • tooltip

        public FormulaTab tooltip​(String tooltip)
        tooltip.
        Returns:
        FormulaTab

      • getTooltip

        public String getTooltip()
        .
        Returns:
        tooltip

      • setTooltip

        public void setTooltip​(String tooltip)
        setTooltip.

      • underline

        public FormulaTab underline​(String underline)
        underline.
        Returns:
        FormulaTab

      • getUnderline

        public String getUnderline()
        When set to **true**, the information in the tab is underlined..
        Returns:
        underline

      • setUnderline

        public void setUnderline​(String underline)
        setUnderline.

      • validationMessage

        public FormulaTab validationMessage​(String validationMessage)
        validationMessage.
        Returns:
        FormulaTab

      • 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)
        setValidationMessage.

      • validationPattern

        public FormulaTab validationPattern​(String validationPattern)
        validationPattern.
        Returns:
        FormulaTab

      • getValidationPattern

        public String getValidationPattern()
        A regular expression used to validate input for the tab..
        Returns:
        validationPattern

      • setValidationPattern

        public void setValidationPattern​(String validationPattern)
        setValidationPattern.

      • getValue

        public String getValue()
        Specifies the value of the tab. .
        Returns:
        value

      • setValue

        public void setValue​(String value)
        setValue.

      • getWidth

        public Integer getWidth()
        Width of the tab in pixels..
        Returns:
        width

      • setWidth

        public void setWidth​(Integer width)
        setWidth.

      • xPosition

        public FormulaTab xPosition​(String xPosition)
        xPosition.
        Returns:
        FormulaTab

      • 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)
        setXPosition.

      • yPosition

        public FormulaTab yPosition​(String yPosition)
        yPosition.
        Returns:
        FormulaTab

      • 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)
        setYPosition.

      • equals

        public boolean equals​(Object o)
        Compares objects.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object

      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object