Class Numerical

    • Constructor Detail

      • Numerical

        public Numerical()
    • Method Detail

      • anchorAllowWhiteSpaceInCharacters

        public Numerical anchorAllowWhiteSpaceInCharacters​(String anchorAllowWhiteSpaceInCharacters)
        anchorAllowWhiteSpaceInCharacters.
        Returns:
        Numerical
      • getAnchorAllowWhiteSpaceInCharacters

        public String getAnchorAllowWhiteSpaceInCharacters()
        .
        Returns:
        anchorAllowWhiteSpaceInCharacters
      • setAnchorAllowWhiteSpaceInCharacters

        public void setAnchorAllowWhiteSpaceInCharacters​(String anchorAllowWhiteSpaceInCharacters)
        setAnchorAllowWhiteSpaceInCharacters.
      • anchorAllowWhiteSpaceInCharactersMetadata

        public Numerical anchorAllowWhiteSpaceInCharactersMetadata​(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
        anchorAllowWhiteSpaceInCharactersMetadata.
        Returns:
        Numerical
      • getAnchorAllowWhiteSpaceInCharactersMetadata

        public PropertyMetadata getAnchorAllowWhiteSpaceInCharactersMetadata()
        .
        Returns:
        anchorAllowWhiteSpaceInCharactersMetadata
      • setAnchorAllowWhiteSpaceInCharactersMetadata

        public void setAnchorAllowWhiteSpaceInCharactersMetadata​(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
        setAnchorAllowWhiteSpaceInCharactersMetadata.
      • anchorCaseSensitive

        public Numerical anchorCaseSensitive​(String anchorCaseSensitive)
        anchorCaseSensitive.
        Returns:
        Numerical
      • 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.
      • anchorCaseSensitiveMetadata

        public Numerical anchorCaseSensitiveMetadata​(PropertyMetadata anchorCaseSensitiveMetadata)
        anchorCaseSensitiveMetadata.
        Returns:
        Numerical
      • getAnchorCaseSensitiveMetadata

        public PropertyMetadata getAnchorCaseSensitiveMetadata()
        .
        Returns:
        anchorCaseSensitiveMetadata
      • setAnchorCaseSensitiveMetadata

        public void setAnchorCaseSensitiveMetadata​(PropertyMetadata anchorCaseSensitiveMetadata)
        setAnchorCaseSensitiveMetadata.
      • anchorHorizontalAlignment

        public Numerical anchorHorizontalAlignment​(String anchorHorizontalAlignment)
        anchorHorizontalAlignment.
        Returns:
        Numerical
      • 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.
      • anchorHorizontalAlignmentMetadata

        public Numerical anchorHorizontalAlignmentMetadata​(PropertyMetadata anchorHorizontalAlignmentMetadata)
        anchorHorizontalAlignmentMetadata.
        Returns:
        Numerical
      • getAnchorHorizontalAlignmentMetadata

        public PropertyMetadata getAnchorHorizontalAlignmentMetadata()
        .
        Returns:
        anchorHorizontalAlignmentMetadata
      • setAnchorHorizontalAlignmentMetadata

        public void setAnchorHorizontalAlignmentMetadata​(PropertyMetadata anchorHorizontalAlignmentMetadata)
        setAnchorHorizontalAlignmentMetadata.
      • anchorIgnoreIfNotPresent

        public Numerical anchorIgnoreIfNotPresent​(String anchorIgnoreIfNotPresent)
        anchorIgnoreIfNotPresent.
        Returns:
        Numerical
      • 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.
      • anchorIgnoreIfNotPresentMetadata

        public Numerical anchorIgnoreIfNotPresentMetadata​(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
        anchorIgnoreIfNotPresentMetadata.
        Returns:
        Numerical
      • getAnchorIgnoreIfNotPresentMetadata

        public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()
        .
        Returns:
        anchorIgnoreIfNotPresentMetadata
      • setAnchorIgnoreIfNotPresentMetadata

        public void setAnchorIgnoreIfNotPresentMetadata​(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
        setAnchorIgnoreIfNotPresentMetadata.
      • anchorMatchWholeWord

        public Numerical anchorMatchWholeWord​(String anchorMatchWholeWord)
        anchorMatchWholeWord.
        Returns:
        Numerical
      • 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.
      • anchorMatchWholeWordMetadata

        public Numerical anchorMatchWholeWordMetadata​(PropertyMetadata anchorMatchWholeWordMetadata)
        anchorMatchWholeWordMetadata.
        Returns:
        Numerical
      • getAnchorMatchWholeWordMetadata

        public PropertyMetadata getAnchorMatchWholeWordMetadata()
        .
        Returns:
        anchorMatchWholeWordMetadata
      • setAnchorMatchWholeWordMetadata

        public void setAnchorMatchWholeWordMetadata​(PropertyMetadata anchorMatchWholeWordMetadata)
        setAnchorMatchWholeWordMetadata.
      • anchorString

        public Numerical anchorString​(String anchorString)
        anchorString.
        Returns:
        Numerical
      • getAnchorString

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

        public void setAnchorString​(String anchorString)
        setAnchorString.
      • anchorStringMetadata

        public Numerical anchorStringMetadata​(PropertyMetadata anchorStringMetadata)
        anchorStringMetadata.
        Returns:
        Numerical
      • getAnchorStringMetadata

        public PropertyMetadata getAnchorStringMetadata()
        .
        Returns:
        anchorStringMetadata
      • setAnchorStringMetadata

        public void setAnchorStringMetadata​(PropertyMetadata anchorStringMetadata)
        setAnchorStringMetadata.
      • anchorTabProcessorVersion

        public Numerical anchorTabProcessorVersion​(String anchorTabProcessorVersion)
        anchorTabProcessorVersion.
        Returns:
        Numerical
      • getAnchorTabProcessorVersion

        public String getAnchorTabProcessorVersion()
        .
        Returns:
        anchorTabProcessorVersion
      • setAnchorTabProcessorVersion

        public void setAnchorTabProcessorVersion​(String anchorTabProcessorVersion)
        setAnchorTabProcessorVersion.
      • anchorTabProcessorVersionMetadata

        public Numerical anchorTabProcessorVersionMetadata​(PropertyMetadata anchorTabProcessorVersionMetadata)
        anchorTabProcessorVersionMetadata.
        Returns:
        Numerical
      • getAnchorTabProcessorVersionMetadata

        public PropertyMetadata getAnchorTabProcessorVersionMetadata()
        .
        Returns:
        anchorTabProcessorVersionMetadata
      • setAnchorTabProcessorVersionMetadata

        public void setAnchorTabProcessorVersionMetadata​(PropertyMetadata anchorTabProcessorVersionMetadata)
        setAnchorTabProcessorVersionMetadata.
      • anchorUnits

        public Numerical anchorUnits​(String anchorUnits)
        anchorUnits.
        Returns:
        Numerical
      • 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.
      • anchorUnitsMetadata

        public Numerical anchorUnitsMetadata​(PropertyMetadata anchorUnitsMetadata)
        anchorUnitsMetadata.
        Returns:
        Numerical
      • getAnchorUnitsMetadata

        public PropertyMetadata getAnchorUnitsMetadata()
        .
        Returns:
        anchorUnitsMetadata
      • setAnchorUnitsMetadata

        public void setAnchorUnitsMetadata​(PropertyMetadata anchorUnitsMetadata)
        setAnchorUnitsMetadata.
      • anchorXOffset

        public Numerical anchorXOffset​(String anchorXOffset)
        anchorXOffset.
        Returns:
        Numerical
      • 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.
      • anchorXOffsetMetadata

        public Numerical anchorXOffsetMetadata​(PropertyMetadata anchorXOffsetMetadata)
        anchorXOffsetMetadata.
        Returns:
        Numerical
      • getAnchorXOffsetMetadata

        public PropertyMetadata getAnchorXOffsetMetadata()
        .
        Returns:
        anchorXOffsetMetadata
      • setAnchorXOffsetMetadata

        public void setAnchorXOffsetMetadata​(PropertyMetadata anchorXOffsetMetadata)
        setAnchorXOffsetMetadata.
      • anchorYOffset

        public Numerical anchorYOffset​(String anchorYOffset)
        anchorYOffset.
        Returns:
        Numerical
      • 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.
      • anchorYOffsetMetadata

        public Numerical anchorYOffsetMetadata​(PropertyMetadata anchorYOffsetMetadata)
        anchorYOffsetMetadata.
        Returns:
        Numerical
      • getAnchorYOffsetMetadata

        public PropertyMetadata getAnchorYOffsetMetadata()
        .
        Returns:
        anchorYOffsetMetadata
      • setAnchorYOffsetMetadata

        public void setAnchorYOffsetMetadata​(PropertyMetadata anchorYOffsetMetadata)
        setAnchorYOffsetMetadata.
      • getBold

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

        public void setBold​(String bold)
        setBold.
      • getBoldMetadata

        public PropertyMetadata getBoldMetadata()
        .
        Returns:
        boldMetadata
      • setBoldMetadata

        public void setBoldMetadata​(PropertyMetadata boldMetadata)
        setBoldMetadata.
      • caption

        public Numerical caption​(String caption)
        caption.
        Returns:
        Numerical
      • getCaption

        public String getCaption()
        .
        Returns:
        caption
      • setCaption

        public void setCaption​(String caption)
        setCaption.
      • captionMetadata

        public Numerical captionMetadata​(PropertyMetadata captionMetadata)
        captionMetadata.
        Returns:
        Numerical
      • getCaptionMetadata

        public PropertyMetadata getCaptionMetadata()
        .
        Returns:
        captionMetadata
      • setCaptionMetadata

        public void setCaptionMetadata​(PropertyMetadata captionMetadata)
        setCaptionMetadata.
      • concealValueOnDocument

        public Numerical concealValueOnDocument​(String concealValueOnDocument)
        concealValueOnDocument.
        Returns:
        Numerical
      • 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.
      • concealValueOnDocumentMetadata

        public Numerical concealValueOnDocumentMetadata​(PropertyMetadata concealValueOnDocumentMetadata)
        concealValueOnDocumentMetadata.
        Returns:
        Numerical
      • getConcealValueOnDocumentMetadata

        public PropertyMetadata getConcealValueOnDocumentMetadata()
        .
        Returns:
        concealValueOnDocumentMetadata
      • setConcealValueOnDocumentMetadata

        public void setConcealValueOnDocumentMetadata​(PropertyMetadata concealValueOnDocumentMetadata)
        setConcealValueOnDocumentMetadata.
      • conditionalParentLabel

        public Numerical conditionalParentLabel​(String conditionalParentLabel)
        conditionalParentLabel.
        Returns:
        Numerical
      • 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.
      • conditionalParentLabelMetadata

        public Numerical conditionalParentLabelMetadata​(PropertyMetadata conditionalParentLabelMetadata)
        conditionalParentLabelMetadata.
        Returns:
        Numerical
      • getConditionalParentLabelMetadata

        public PropertyMetadata getConditionalParentLabelMetadata()
        .
        Returns:
        conditionalParentLabelMetadata
      • setConditionalParentLabelMetadata

        public void setConditionalParentLabelMetadata​(PropertyMetadata conditionalParentLabelMetadata)
        setConditionalParentLabelMetadata.
      • conditionalParentValue

        public Numerical conditionalParentValue​(String conditionalParentValue)
        conditionalParentValue.
        Returns:
        Numerical
      • 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.
      • conditionalParentValueMetadata

        public Numerical conditionalParentValueMetadata​(PropertyMetadata conditionalParentValueMetadata)
        conditionalParentValueMetadata.
        Returns:
        Numerical
      • getConditionalParentValueMetadata

        public PropertyMetadata getConditionalParentValueMetadata()
        .
        Returns:
        conditionalParentValueMetadata
      • setConditionalParentValueMetadata

        public void setConditionalParentValueMetadata​(PropertyMetadata conditionalParentValueMetadata)
        setConditionalParentValueMetadata.
      • customTabId

        public Numerical customTabId​(String customTabId)
        customTabId.
        Returns:
        Numerical
      • 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.
      • customTabIdMetadata

        public Numerical customTabIdMetadata​(PropertyMetadata customTabIdMetadata)
        customTabIdMetadata.
        Returns:
        Numerical
      • getCustomTabIdMetadata

        public PropertyMetadata getCustomTabIdMetadata()
        .
        Returns:
        customTabIdMetadata
      • setCustomTabIdMetadata

        public void setCustomTabIdMetadata​(PropertyMetadata customTabIdMetadata)
        setCustomTabIdMetadata.
      • disableAutoSize

        public Numerical disableAutoSize​(String disableAutoSize)
        disableAutoSize.
        Returns:
        Numerical
      • 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.
      • disableAutoSizeMetadata

        public Numerical disableAutoSizeMetadata​(PropertyMetadata disableAutoSizeMetadata)
        disableAutoSizeMetadata.
        Returns:
        Numerical
      • getDisableAutoSizeMetadata

        public PropertyMetadata getDisableAutoSizeMetadata()
        .
        Returns:
        disableAutoSizeMetadata
      • setDisableAutoSizeMetadata

        public void setDisableAutoSizeMetadata​(PropertyMetadata disableAutoSizeMetadata)
        setDisableAutoSizeMetadata.
      • documentId

        public Numerical documentId​(String documentId)
        documentId.
        Returns:
        Numerical
      • 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.
      • documentIdMetadata

        public Numerical documentIdMetadata​(PropertyMetadata documentIdMetadata)
        documentIdMetadata.
        Returns:
        Numerical
      • getDocumentIdMetadata

        public PropertyMetadata getDocumentIdMetadata()
        .
        Returns:
        documentIdMetadata
      • setDocumentIdMetadata

        public void setDocumentIdMetadata​(PropertyMetadata documentIdMetadata)
        setDocumentIdMetadata.
      • errorDetails

        public Numerical errorDetails​(ErrorDetails errorDetails)
        errorDetails.
        Returns:
        Numerical
      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Array or errors..
        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 Numerical fontColor​(String fontColor)
        fontColor.
        Returns:
        Numerical
      • 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.
      • fontColorMetadata

        public Numerical fontColorMetadata​(PropertyMetadata fontColorMetadata)
        fontColorMetadata.
        Returns:
        Numerical
      • getFontColorMetadata

        public PropertyMetadata getFontColorMetadata()
        .
        Returns:
        fontColorMetadata
      • setFontColorMetadata

        public void setFontColorMetadata​(PropertyMetadata fontColorMetadata)
        setFontColorMetadata.
      • getFontMetadata

        public PropertyMetadata getFontMetadata()
        .
        Returns:
        fontMetadata
      • setFontMetadata

        public void setFontMetadata​(PropertyMetadata fontMetadata)
        setFontMetadata.
      • fontSize

        public Numerical fontSize​(String fontSize)
        fontSize.
        Returns:
        Numerical
      • 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.
      • fontSizeMetadata

        public Numerical fontSizeMetadata​(PropertyMetadata fontSizeMetadata)
        fontSizeMetadata.
        Returns:
        Numerical
      • getFontSizeMetadata

        public PropertyMetadata getFontSizeMetadata()
        .
        Returns:
        fontSizeMetadata
      • setFontSizeMetadata

        public void setFontSizeMetadata​(PropertyMetadata fontSizeMetadata)
        setFontSizeMetadata.
      • formOrder

        public Numerical formOrder​(String formOrder)
        formOrder.
        Returns:
        Numerical
      • getFormOrder

        public String getFormOrder()
        .
        Returns:
        formOrder
      • setFormOrder

        public void setFormOrder​(String formOrder)
        setFormOrder.
      • formOrderMetadata

        public Numerical formOrderMetadata​(PropertyMetadata formOrderMetadata)
        formOrderMetadata.
        Returns:
        Numerical
      • getFormOrderMetadata

        public PropertyMetadata getFormOrderMetadata()
        .
        Returns:
        formOrderMetadata
      • setFormOrderMetadata

        public void setFormOrderMetadata​(PropertyMetadata formOrderMetadata)
        setFormOrderMetadata.
      • formPageLabel

        public Numerical formPageLabel​(String formPageLabel)
        formPageLabel.
        Returns:
        Numerical
      • getFormPageLabel

        public String getFormPageLabel()
        .
        Returns:
        formPageLabel
      • setFormPageLabel

        public void setFormPageLabel​(String formPageLabel)
        setFormPageLabel.
      • formPageLabelMetadata

        public Numerical formPageLabelMetadata​(PropertyMetadata formPageLabelMetadata)
        formPageLabelMetadata.
        Returns:
        Numerical
      • getFormPageLabelMetadata

        public PropertyMetadata getFormPageLabelMetadata()
        .
        Returns:
        formPageLabelMetadata
      • setFormPageLabelMetadata

        public void setFormPageLabelMetadata​(PropertyMetadata formPageLabelMetadata)
        setFormPageLabelMetadata.
      • formPageNumber

        public Numerical formPageNumber​(String formPageNumber)
        formPageNumber.
        Returns:
        Numerical
      • getFormPageNumber

        public String getFormPageNumber()
        .
        Returns:
        formPageNumber
      • setFormPageNumber

        public void setFormPageNumber​(String formPageNumber)
        setFormPageNumber.
      • formPageNumberMetadata

        public Numerical formPageNumberMetadata​(PropertyMetadata formPageNumberMetadata)
        formPageNumberMetadata.
        Returns:
        Numerical
      • getFormPageNumberMetadata

        public PropertyMetadata getFormPageNumberMetadata()
        .
        Returns:
        formPageNumberMetadata
      • setFormPageNumberMetadata

        public void setFormPageNumberMetadata​(PropertyMetadata formPageNumberMetadata)
        setFormPageNumberMetadata.
      • height

        public Numerical height​(String height)
        height.
        Returns:
        Numerical
      • getHeight

        public String getHeight()
        Height of the tab in pixels..
        Returns:
        height
      • setHeight

        public void setHeight​(String height)
        setHeight.
      • getHeightMetadata

        public PropertyMetadata getHeightMetadata()
        .
        Returns:
        heightMetadata
      • setHeightMetadata

        public void setHeightMetadata​(PropertyMetadata heightMetadata)
        setHeightMetadata.
      • italic

        public Numerical italic​(String italic)
        italic.
        Returns:
        Numerical
      • getItalic

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

        public void setItalic​(String italic)
        setItalic.
      • getItalicMetadata

        public PropertyMetadata getItalicMetadata()
        .
        Returns:
        italicMetadata
      • setItalicMetadata

        public void setItalicMetadata​(PropertyMetadata italicMetadata)
        setItalicMetadata.
      • getLocalePolicy

        public LocalePolicyTab getLocalePolicy()
        .
        Returns:
        localePolicy
      • setLocalePolicy

        public void setLocalePolicy​(LocalePolicyTab localePolicy)
        setLocalePolicy.
      • locked

        public Numerical locked​(String locked)
        locked.
        Returns:
        Numerical
      • 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.
      • getLockedMetadata

        public PropertyMetadata getLockedMetadata()
        .
        Returns:
        lockedMetadata
      • setLockedMetadata

        public void setLockedMetadata​(PropertyMetadata lockedMetadata)
        setLockedMetadata.
      • maxLength

        public Numerical maxLength​(String maxLength)
        maxLength.
        Returns:
        Numerical
      • getMaxLength

        public String getMaxLength()
        An optional value that describes the maximum length of the property when the property is a string..
        Returns:
        maxLength
      • setMaxLength

        public void setMaxLength​(String maxLength)
        setMaxLength.
      • maxLengthMetadata

        public Numerical maxLengthMetadata​(PropertyMetadata maxLengthMetadata)
        maxLengthMetadata.
        Returns:
        Numerical
      • getMaxLengthMetadata

        public PropertyMetadata getMaxLengthMetadata()
        .
        Returns:
        maxLengthMetadata
      • setMaxLengthMetadata

        public void setMaxLengthMetadata​(PropertyMetadata maxLengthMetadata)
        setMaxLengthMetadata.
      • maxNumericalValue

        public Numerical maxNumericalValue​(String maxNumericalValue)
        maxNumericalValue.
        Returns:
        Numerical
      • getMaxNumericalValue

        public String getMaxNumericalValue()
        .
        Returns:
        maxNumericalValue
      • setMaxNumericalValue

        public void setMaxNumericalValue​(String maxNumericalValue)
        setMaxNumericalValue.
      • mergeField

        public Numerical mergeField​(MergeField mergeField)
        mergeField.
        Returns:
        Numerical
      • getMergeField

        public MergeField getMergeField()
        .
        Returns:
        mergeField
      • setMergeField

        public void setMergeField​(MergeField mergeField)
        setMergeField.
      • mergeFieldXml

        public Numerical mergeFieldXml​(String mergeFieldXml)
        mergeFieldXml.
        Returns:
        Numerical
      • getMergeFieldXml

        public String getMergeFieldXml()
        .
        Returns:
        mergeFieldXml
      • setMergeFieldXml

        public void setMergeFieldXml​(String mergeFieldXml)
        setMergeFieldXml.
      • minNumericalValue

        public Numerical minNumericalValue​(String minNumericalValue)
        minNumericalValue.
        Returns:
        Numerical
      • getMinNumericalValue

        public String getMinNumericalValue()
        .
        Returns:
        minNumericalValue
      • setMinNumericalValue

        public void setMinNumericalValue​(String minNumericalValue)
        setMinNumericalValue.
      • getName

        public String getName()
        .
        Returns:
        name
      • setName

        public void setName​(String name)
        setName.
      • getNameMetadata

        public PropertyMetadata getNameMetadata()
        .
        Returns:
        nameMetadata
      • setNameMetadata

        public void setNameMetadata​(PropertyMetadata nameMetadata)
        setNameMetadata.
      • numericalValue

        public Numerical numericalValue​(String numericalValue)
        numericalValue.
        Returns:
        Numerical
      • getNumericalValue

        public String getNumericalValue()
        .
        Returns:
        numericalValue
      • setNumericalValue

        public void setNumericalValue​(String numericalValue)
        setNumericalValue.
      • originalNumericalValue

        public Numerical originalNumericalValue​(String originalNumericalValue)
        originalNumericalValue.
        Returns:
        Numerical
      • getOriginalNumericalValue

        public String getOriginalNumericalValue()
        .
        Returns:
        originalNumericalValue
      • setOriginalNumericalValue

        public void setOriginalNumericalValue​(String originalNumericalValue)
        setOriginalNumericalValue.
      • originalValue

        public Numerical originalValue​(String originalValue)
        originalValue.
        Returns:
        Numerical
      • 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.
      • originalValueMetadata

        public Numerical originalValueMetadata​(PropertyMetadata originalValueMetadata)
        originalValueMetadata.
        Returns:
        Numerical
      • getOriginalValueMetadata

        public PropertyMetadata getOriginalValueMetadata()
        .
        Returns:
        originalValueMetadata
      • setOriginalValueMetadata

        public void setOriginalValueMetadata​(PropertyMetadata originalValueMetadata)
        setOriginalValueMetadata.
      • pageNumber

        public Numerical pageNumber​(String pageNumber)
        pageNumber.
        Returns:
        Numerical
      • getPageNumber

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

        public void setPageNumber​(String pageNumber)
        setPageNumber.
      • pageNumberMetadata

        public Numerical pageNumberMetadata​(PropertyMetadata pageNumberMetadata)
        pageNumberMetadata.
        Returns:
        Numerical
      • getPageNumberMetadata

        public PropertyMetadata getPageNumberMetadata()
        .
        Returns:
        pageNumberMetadata
      • setPageNumberMetadata

        public void setPageNumberMetadata​(PropertyMetadata pageNumberMetadata)
        setPageNumberMetadata.
      • recipientId

        public Numerical recipientId​(String recipientId)
        recipientId.
        Returns:
        Numerical
      • 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.
      • recipientIdGuid

        public Numerical recipientIdGuid​(String recipientIdGuid)
        recipientIdGuid.
        Returns:
        Numerical
      • getRecipientIdGuid

        public String getRecipientIdGuid()
        .
        Returns:
        recipientIdGuid
      • setRecipientIdGuid

        public void setRecipientIdGuid​(String recipientIdGuid)
        setRecipientIdGuid.
      • recipientIdGuidMetadata

        public Numerical recipientIdGuidMetadata​(PropertyMetadata recipientIdGuidMetadata)
        recipientIdGuidMetadata.
        Returns:
        Numerical
      • getRecipientIdGuidMetadata

        public PropertyMetadata getRecipientIdGuidMetadata()
        .
        Returns:
        recipientIdGuidMetadata
      • setRecipientIdGuidMetadata

        public void setRecipientIdGuidMetadata​(PropertyMetadata recipientIdGuidMetadata)
        setRecipientIdGuidMetadata.
      • recipientIdMetadata

        public Numerical recipientIdMetadata​(PropertyMetadata recipientIdMetadata)
        recipientIdMetadata.
        Returns:
        Numerical
      • getRecipientIdMetadata

        public PropertyMetadata getRecipientIdMetadata()
        .
        Returns:
        recipientIdMetadata
      • setRecipientIdMetadata

        public void setRecipientIdMetadata​(PropertyMetadata recipientIdMetadata)
        setRecipientIdMetadata.
      • requireAll

        public Numerical requireAll​(String requireAll)
        requireAll.
        Returns:
        Numerical
      • 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.
      • requireAllMetadata

        public Numerical requireAllMetadata​(PropertyMetadata requireAllMetadata)
        requireAllMetadata.
        Returns:
        Numerical
      • getRequireAllMetadata

        public PropertyMetadata getRequireAllMetadata()
        .
        Returns:
        requireAllMetadata
      • setRequireAllMetadata

        public void setRequireAllMetadata​(PropertyMetadata requireAllMetadata)
        setRequireAllMetadata.
      • required

        public Numerical required​(String required)
        required.
        Returns:
        Numerical
      • 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.
      • requiredMetadata

        public Numerical requiredMetadata​(PropertyMetadata requiredMetadata)
        requiredMetadata.
        Returns:
        Numerical
      • getRequiredMetadata

        public PropertyMetadata getRequiredMetadata()
        .
        Returns:
        requiredMetadata
      • setRequiredMetadata

        public void setRequiredMetadata​(PropertyMetadata requiredMetadata)
        setRequiredMetadata.
      • requireInitialOnSharedChange

        public Numerical requireInitialOnSharedChange​(String requireInitialOnSharedChange)
        requireInitialOnSharedChange.
        Returns:
        Numerical
      • 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.
      • requireInitialOnSharedChangeMetadata

        public Numerical requireInitialOnSharedChangeMetadata​(PropertyMetadata requireInitialOnSharedChangeMetadata)
        requireInitialOnSharedChangeMetadata.
        Returns:
        Numerical
      • getRequireInitialOnSharedChangeMetadata

        public PropertyMetadata getRequireInitialOnSharedChangeMetadata()
        .
        Returns:
        requireInitialOnSharedChangeMetadata
      • setRequireInitialOnSharedChangeMetadata

        public void setRequireInitialOnSharedChangeMetadata​(PropertyMetadata requireInitialOnSharedChangeMetadata)
        setRequireInitialOnSharedChangeMetadata.
      • senderRequired

        public Numerical senderRequired​(String senderRequired)
        senderRequired.
        Returns:
        Numerical
      • 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.
      • senderRequiredMetadata

        public Numerical senderRequiredMetadata​(PropertyMetadata senderRequiredMetadata)
        senderRequiredMetadata.
        Returns:
        Numerical
      • getSenderRequiredMetadata

        public PropertyMetadata getSenderRequiredMetadata()
        .
        Returns:
        senderRequiredMetadata
      • setSenderRequiredMetadata

        public void setSenderRequiredMetadata​(PropertyMetadata senderRequiredMetadata)
        setSenderRequiredMetadata.
      • shared

        public Numerical shared​(String shared)
        shared.
        Returns:
        Numerical
      • getShared

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

        public void setShared​(String shared)
        setShared.
      • getSharedMetadata

        public PropertyMetadata getSharedMetadata()
        .
        Returns:
        sharedMetadata
      • setSharedMetadata

        public void setSharedMetadata​(PropertyMetadata sharedMetadata)
        setSharedMetadata.
      • shareToRecipients

        public Numerical shareToRecipients​(String shareToRecipients)
        shareToRecipients.
        Returns:
        Numerical
      • getShareToRecipients

        public String getShareToRecipients()
        .
        Returns:
        shareToRecipients
      • setShareToRecipients

        public void setShareToRecipients​(String shareToRecipients)
        setShareToRecipients.
      • shareToRecipientsMetadata

        public Numerical shareToRecipientsMetadata​(PropertyMetadata shareToRecipientsMetadata)
        shareToRecipientsMetadata.
        Returns:
        Numerical
      • getShareToRecipientsMetadata

        public PropertyMetadata getShareToRecipientsMetadata()
        .
        Returns:
        shareToRecipientsMetadata
      • setShareToRecipientsMetadata

        public void setShareToRecipientsMetadata​(PropertyMetadata shareToRecipientsMetadata)
        setShareToRecipientsMetadata.
      • smartContractInformation

        public Numerical smartContractInformation​(SmartContractInformation smartContractInformation)
        smartContractInformation.
        Returns:
        Numerical
      • getSmartContractInformation

        public SmartContractInformation getSmartContractInformation()
        .
        Returns:
        smartContractInformation
      • setSmartContractInformation

        public void setSmartContractInformation​(SmartContractInformation smartContractInformation)
        setSmartContractInformation.
      • source

        public Numerical source​(String source)
        source.
        Returns:
        Numerical
      • getSource

        public String getSource()
        .
        Returns:
        source
      • setSource

        public void setSource​(String source)
        setSource.
      • status

        public Numerical status​(String status)
        status.
        Returns:
        Numerical
      • 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.
      • getStatusMetadata

        public PropertyMetadata getStatusMetadata()
        .
        Returns:
        statusMetadata
      • setStatusMetadata

        public void setStatusMetadata​(PropertyMetadata statusMetadata)
        setStatusMetadata.
      • tabGroupLabels

        public Numerical tabGroupLabels​(List<String> tabGroupLabels)
        tabGroupLabels.
        Returns:
        Numerical
      • addTabGroupLabelsItem

        public Numerical addTabGroupLabelsItem​(String tabGroupLabelsItem)
        addTabGroupLabelsItem.
        Returns:
        Numerical
      • getTabGroupLabels

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

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

        public Numerical tabGroupLabelsMetadata​(PropertyMetadata tabGroupLabelsMetadata)
        tabGroupLabelsMetadata.
        Returns:
        Numerical
      • getTabGroupLabelsMetadata

        public PropertyMetadata getTabGroupLabelsMetadata()
        .
        Returns:
        tabGroupLabelsMetadata
      • setTabGroupLabelsMetadata

        public void setTabGroupLabelsMetadata​(PropertyMetadata tabGroupLabelsMetadata)
        setTabGroupLabelsMetadata.
      • tabId

        public Numerical tabId​(String tabId)
        tabId.
        Returns:
        Numerical
      • 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.
      • getTabIdMetadata

        public PropertyMetadata getTabIdMetadata()
        .
        Returns:
        tabIdMetadata
      • setTabIdMetadata

        public void setTabIdMetadata​(PropertyMetadata tabIdMetadata)
        setTabIdMetadata.
      • tabLabel

        public Numerical tabLabel​(String tabLabel)
        tabLabel.
        Returns:
        Numerical
      • getTabLabel

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

        public void setTabLabel​(String tabLabel)
        setTabLabel.
      • tabLabelMetadata

        public Numerical tabLabelMetadata​(PropertyMetadata tabLabelMetadata)
        tabLabelMetadata.
        Returns:
        Numerical
      • getTabLabelMetadata

        public PropertyMetadata getTabLabelMetadata()
        .
        Returns:
        tabLabelMetadata
      • setTabLabelMetadata

        public void setTabLabelMetadata​(PropertyMetadata tabLabelMetadata)
        setTabLabelMetadata.
      • tabOrder

        public Numerical tabOrder​(String tabOrder)
        tabOrder.
        Returns:
        Numerical
      • getTabOrder

        public String getTabOrder()
        .
        Returns:
        tabOrder
      • setTabOrder

        public void setTabOrder​(String tabOrder)
        setTabOrder.
      • tabOrderMetadata

        public Numerical tabOrderMetadata​(PropertyMetadata tabOrderMetadata)
        tabOrderMetadata.
        Returns:
        Numerical
      • getTabOrderMetadata

        public PropertyMetadata getTabOrderMetadata()
        .
        Returns:
        tabOrderMetadata
      • setTabOrderMetadata

        public void setTabOrderMetadata​(PropertyMetadata tabOrderMetadata)
        setTabOrderMetadata.
      • tabType

        public Numerical tabType​(String tabType)
        tabType.
        Returns:
        Numerical
      • getTabType

        public String getTabType()
        .
        Returns:
        tabType
      • setTabType

        public void setTabType​(String tabType)
        setTabType.
      • tabTypeMetadata

        public Numerical tabTypeMetadata​(PropertyMetadata tabTypeMetadata)
        tabTypeMetadata.
        Returns:
        Numerical
      • getTabTypeMetadata

        public PropertyMetadata getTabTypeMetadata()
        .
        Returns:
        tabTypeMetadata
      • setTabTypeMetadata

        public void setTabTypeMetadata​(PropertyMetadata tabTypeMetadata)
        setTabTypeMetadata.
      • templateLocked

        public Numerical templateLocked​(String templateLocked)
        templateLocked.
        Returns:
        Numerical
      • 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.
      • templateLockedMetadata

        public Numerical templateLockedMetadata​(PropertyMetadata templateLockedMetadata)
        templateLockedMetadata.
        Returns:
        Numerical
      • getTemplateLockedMetadata

        public PropertyMetadata getTemplateLockedMetadata()
        .
        Returns:
        templateLockedMetadata
      • setTemplateLockedMetadata

        public void setTemplateLockedMetadata​(PropertyMetadata templateLockedMetadata)
        setTemplateLockedMetadata.
      • templateRequired

        public Numerical templateRequired​(String templateRequired)
        templateRequired.
        Returns:
        Numerical
      • 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.
      • templateRequiredMetadata

        public Numerical templateRequiredMetadata​(PropertyMetadata templateRequiredMetadata)
        templateRequiredMetadata.
        Returns:
        Numerical
      • getTemplateRequiredMetadata

        public PropertyMetadata getTemplateRequiredMetadata()
        .
        Returns:
        templateRequiredMetadata
      • setTemplateRequiredMetadata

        public void setTemplateRequiredMetadata​(PropertyMetadata templateRequiredMetadata)
        setTemplateRequiredMetadata.
      • tooltip

        public Numerical tooltip​(String tooltip)
        tooltip.
        Returns:
        Numerical
      • getTooltip

        public String getTooltip()
        .
        Returns:
        tooltip
      • setTooltip

        public void setTooltip​(String tooltip)
        setTooltip.
      • toolTipMetadata

        public Numerical toolTipMetadata​(PropertyMetadata toolTipMetadata)
        toolTipMetadata.
        Returns:
        Numerical
      • getToolTipMetadata

        public PropertyMetadata getToolTipMetadata()
        .
        Returns:
        toolTipMetadata
      • setToolTipMetadata

        public void setToolTipMetadata​(PropertyMetadata toolTipMetadata)
        setToolTipMetadata.
      • underline

        public Numerical underline​(String underline)
        underline.
        Returns:
        Numerical
      • getUnderline

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

        public void setUnderline​(String underline)
        setUnderline.
      • underlineMetadata

        public Numerical underlineMetadata​(PropertyMetadata underlineMetadata)
        underlineMetadata.
        Returns:
        Numerical
      • getUnderlineMetadata

        public PropertyMetadata getUnderlineMetadata()
        .
        Returns:
        underlineMetadata
      • setUnderlineMetadata

        public void setUnderlineMetadata​(PropertyMetadata underlineMetadata)
        setUnderlineMetadata.
      • validationType

        public Numerical validationType​(String validationType)
        validationType.
        Returns:
        Numerical
      • getValidationType

        public String getValidationType()
        .
        Returns:
        validationType
      • setValidationType

        public void setValidationType​(String validationType)
        setValidationType.
      • value

        public Numerical value​(String value)
        value.
        Returns:
        Numerical
      • getValue

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

        public void setValue​(String value)
        setValue.
      • getValueMetadata

        public PropertyMetadata getValueMetadata()
        .
        Returns:
        valueMetadata
      • setValueMetadata

        public void setValueMetadata​(PropertyMetadata valueMetadata)
        setValueMetadata.
      • width

        public Numerical width​(String width)
        width.
        Returns:
        Numerical
      • getWidth

        public String getWidth()
        Width of the tab in pixels..
        Returns:
        width
      • setWidth

        public void setWidth​(String width)
        setWidth.
      • getWidthMetadata

        public PropertyMetadata getWidthMetadata()
        .
        Returns:
        widthMetadata
      • setWidthMetadata

        public void setWidthMetadata​(PropertyMetadata widthMetadata)
        setWidthMetadata.
      • xPosition

        public Numerical xPosition​(String xPosition)
        xPosition.
        Returns:
        Numerical
      • 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.
      • xPositionMetadata

        public Numerical xPositionMetadata​(PropertyMetadata xPositionMetadata)
        xPositionMetadata.
        Returns:
        Numerical
      • getXPositionMetadata

        public PropertyMetadata getXPositionMetadata()
        .
        Returns:
        xPositionMetadata
      • setXPositionMetadata

        public void setXPositionMetadata​(PropertyMetadata xPositionMetadata)
        setXPositionMetadata.
      • yPosition

        public Numerical yPosition​(String yPosition)
        yPosition.
        Returns:
        Numerical
      • 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.
      • yPositionMetadata

        public Numerical yPositionMetadata​(PropertyMetadata yPositionMetadata)
        yPositionMetadata.
        Returns:
        Numerical
      • getYPositionMetadata

        public PropertyMetadata getYPositionMetadata()
        .
        Returns:
        yPositionMetadata
      • setYPositionMetadata

        public void setYPositionMetadata​(PropertyMetadata yPositionMetadata)
        setYPositionMetadata.
      • 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