Package com.docusign.esign.model

Class TabGroup

  • public class TabGroup
extends Object
    TabGroup

    • Constructor Detail

      • TabGroup

        public TabGroup()

    • Method Detail

      • anchorCaseSensitive

        public TabGroup anchorCaseSensitive​(String anchorCaseSensitive)

      • getAnchorCaseSensitive

        public String getAnchorCaseSensitive()
        When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
        Returns:
        anchorCaseSensitive

      • setAnchorCaseSensitive

        public void setAnchorCaseSensitive​(String anchorCaseSensitive)

      • anchorCaseSensitiveMetadata

        public TabGroup anchorCaseSensitiveMetadata​(PropertyMetadata anchorCaseSensitiveMetadata)

      • getAnchorCaseSensitiveMetadata

        public PropertyMetadata getAnchorCaseSensitiveMetadata()
        Get anchorCaseSensitiveMetadata
        Returns:
        anchorCaseSensitiveMetadata

      • setAnchorCaseSensitiveMetadata

        public void setAnchorCaseSensitiveMetadata​(PropertyMetadata anchorCaseSensitiveMetadata)

      • anchorHorizontalAlignment

        public TabGroup anchorHorizontalAlignment​(String anchorHorizontalAlignment)

      • getAnchorHorizontalAlignment

        public String getAnchorHorizontalAlignment()
        Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
        Returns:
        anchorHorizontalAlignment

      • setAnchorHorizontalAlignment

        public void setAnchorHorizontalAlignment​(String anchorHorizontalAlignment)

      • anchorHorizontalAlignmentMetadata

        public TabGroup anchorHorizontalAlignmentMetadata​(PropertyMetadata anchorHorizontalAlignmentMetadata)

      • getAnchorHorizontalAlignmentMetadata

        public PropertyMetadata getAnchorHorizontalAlignmentMetadata()
        Get anchorHorizontalAlignmentMetadata
        Returns:
        anchorHorizontalAlignmentMetadata

      • setAnchorHorizontalAlignmentMetadata

        public void setAnchorHorizontalAlignmentMetadata​(PropertyMetadata anchorHorizontalAlignmentMetadata)

      • anchorIgnoreIfNotPresent

        public TabGroup anchorIgnoreIfNotPresent​(String anchorIgnoreIfNotPresent)

      • getAnchorIgnoreIfNotPresent

        public String getAnchorIgnoreIfNotPresent()
        When set to **true**, this tab is ignored if anchorString is not found in the document.
        Returns:
        anchorIgnoreIfNotPresent

      • setAnchorIgnoreIfNotPresent

        public void setAnchorIgnoreIfNotPresent​(String anchorIgnoreIfNotPresent)

      • anchorIgnoreIfNotPresentMetadata

        public TabGroup anchorIgnoreIfNotPresentMetadata​(PropertyMetadata anchorIgnoreIfNotPresentMetadata)

      • getAnchorIgnoreIfNotPresentMetadata

        public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()
        Get anchorIgnoreIfNotPresentMetadata
        Returns:
        anchorIgnoreIfNotPresentMetadata

      • setAnchorIgnoreIfNotPresentMetadata

        public void setAnchorIgnoreIfNotPresentMetadata​(PropertyMetadata anchorIgnoreIfNotPresentMetadata)

      • anchorMatchWholeWord

        public TabGroup anchorMatchWholeWord​(String anchorMatchWholeWord)

      • getAnchorMatchWholeWord

        public String getAnchorMatchWholeWord()
        When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.
        Returns:
        anchorMatchWholeWord

      • setAnchorMatchWholeWord

        public void setAnchorMatchWholeWord​(String anchorMatchWholeWord)

      • anchorMatchWholeWordMetadata

        public TabGroup anchorMatchWholeWordMetadata​(PropertyMetadata anchorMatchWholeWordMetadata)

      • getAnchorMatchWholeWordMetadata

        public PropertyMetadata getAnchorMatchWholeWordMetadata()
        Get anchorMatchWholeWordMetadata
        Returns:
        anchorMatchWholeWordMetadata

      • setAnchorMatchWholeWordMetadata

        public void setAnchorMatchWholeWordMetadata​(PropertyMetadata anchorMatchWholeWordMetadata)

      • anchorString

        public TabGroup anchorString​(String anchorString)

      • getAnchorString

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

      • setAnchorString

        public void setAnchorString​(String anchorString)

      • getAnchorStringMetadata

        public PropertyMetadata getAnchorStringMetadata()
        Get anchorStringMetadata
        Returns:
        anchorStringMetadata

      • setAnchorStringMetadata

        public void setAnchorStringMetadata​(PropertyMetadata anchorStringMetadata)

      • anchorTabProcessorVersion

        public TabGroup anchorTabProcessorVersion​(String anchorTabProcessorVersion)

      • getAnchorTabProcessorVersion

        public String getAnchorTabProcessorVersion()
        Returns:
        anchorTabProcessorVersion

      • setAnchorTabProcessorVersion

        public void setAnchorTabProcessorVersion​(String anchorTabProcessorVersion)

      • anchorTabProcessorVersionMetadata

        public TabGroup anchorTabProcessorVersionMetadata​(PropertyMetadata anchorTabProcessorVersionMetadata)

      • getAnchorTabProcessorVersionMetadata

        public PropertyMetadata getAnchorTabProcessorVersionMetadata()
        Get anchorTabProcessorVersionMetadata
        Returns:
        anchorTabProcessorVersionMetadata

      • setAnchorTabProcessorVersionMetadata

        public void setAnchorTabProcessorVersionMetadata​(PropertyMetadata anchorTabProcessorVersionMetadata)

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

      • getAnchorUnitsMetadata

        public PropertyMetadata getAnchorUnitsMetadata()
        Get anchorUnitsMetadata
        Returns:
        anchorUnitsMetadata

      • setAnchorUnitsMetadata

        public void setAnchorUnitsMetadata​(PropertyMetadata anchorUnitsMetadata)

      • anchorXOffset

        public TabGroup anchorXOffset​(String anchorXOffset)

      • getAnchorXOffset

        public String getAnchorXOffset()
        Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
        Returns:
        anchorXOffset

      • setAnchorXOffset

        public void setAnchorXOffset​(String anchorXOffset)

      • getAnchorXOffsetMetadata

        public PropertyMetadata getAnchorXOffsetMetadata()
        Get anchorXOffsetMetadata
        Returns:
        anchorXOffsetMetadata

      • setAnchorXOffsetMetadata

        public void setAnchorXOffsetMetadata​(PropertyMetadata anchorXOffsetMetadata)

      • anchorYOffset

        public TabGroup anchorYOffset​(String anchorYOffset)

      • getAnchorYOffset

        public String getAnchorYOffset()
        Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
        Returns:
        anchorYOffset

      • setAnchorYOffset

        public void setAnchorYOffset​(String anchorYOffset)

      • getAnchorYOffsetMetadata

        public PropertyMetadata getAnchorYOffsetMetadata()
        Get anchorYOffsetMetadata
        Returns:
        anchorYOffsetMetadata

      • setAnchorYOffsetMetadata

        public void setAnchorYOffsetMetadata​(PropertyMetadata anchorYOffsetMetadata)

      • conditionalParentLabel

        public TabGroup conditionalParentLabel​(String conditionalParentLabel)

      • getConditionalParentLabel

        public String getConditionalParentLabel()
        For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
        Returns:
        conditionalParentLabel

      • setConditionalParentLabel

        public void setConditionalParentLabel​(String conditionalParentLabel)

      • conditionalParentLabelMetadata

        public TabGroup conditionalParentLabelMetadata​(PropertyMetadata conditionalParentLabelMetadata)

      • getConditionalParentLabelMetadata

        public PropertyMetadata getConditionalParentLabelMetadata()
        Get conditionalParentLabelMetadata
        Returns:
        conditionalParentLabelMetadata

      • setConditionalParentLabelMetadata

        public void setConditionalParentLabelMetadata​(PropertyMetadata conditionalParentLabelMetadata)

      • conditionalParentValue

        public TabGroup conditionalParentValue​(String conditionalParentValue)

      • getConditionalParentValue

        public String getConditionalParentValue()
        For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.
        Returns:
        conditionalParentValue

      • setConditionalParentValue

        public void setConditionalParentValue​(String conditionalParentValue)

      • conditionalParentValueMetadata

        public TabGroup conditionalParentValueMetadata​(PropertyMetadata conditionalParentValueMetadata)

      • getConditionalParentValueMetadata

        public PropertyMetadata getConditionalParentValueMetadata()
        Get conditionalParentValueMetadata
        Returns:
        conditionalParentValueMetadata

      • setConditionalParentValueMetadata

        public void setConditionalParentValueMetadata​(PropertyMetadata conditionalParentValueMetadata)

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

      • getCustomTabIdMetadata

        public PropertyMetadata getCustomTabIdMetadata()
        Get customTabIdMetadata
        Returns:
        customTabIdMetadata

      • setCustomTabIdMetadata

        public void setCustomTabIdMetadata​(PropertyMetadata customTabIdMetadata)

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

      • getDocumentIdMetadata

        public PropertyMetadata getDocumentIdMetadata()
        Get documentIdMetadata
        Returns:
        documentIdMetadata

      • setDocumentIdMetadata

        public void setDocumentIdMetadata​(PropertyMetadata documentIdMetadata)

      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Get errorDetails
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)

      • getFormOrder

        public String getFormOrder()
        Returns:
        formOrder

      • setFormOrder

        public void setFormOrder​(String formOrder)

      • getFormOrderMetadata

        public PropertyMetadata getFormOrderMetadata()
        Get formOrderMetadata
        Returns:
        formOrderMetadata

      • setFormOrderMetadata

        public void setFormOrderMetadata​(PropertyMetadata formOrderMetadata)

      • formPageLabel

        public TabGroup formPageLabel​(String formPageLabel)

      • getFormPageLabel

        public String getFormPageLabel()
        Returns:
        formPageLabel

      • setFormPageLabel

        public void setFormPageLabel​(String formPageLabel)

      • getFormPageLabelMetadata

        public PropertyMetadata getFormPageLabelMetadata()
        Get formPageLabelMetadata
        Returns:
        formPageLabelMetadata

      • setFormPageLabelMetadata

        public void setFormPageLabelMetadata​(PropertyMetadata formPageLabelMetadata)

      • formPageNumber

        public TabGroup formPageNumber​(String formPageNumber)

      • getFormPageNumber

        public String getFormPageNumber()
        Returns:
        formPageNumber

      • setFormPageNumber

        public void setFormPageNumber​(String formPageNumber)

      • getFormPageNumberMetadata

        public PropertyMetadata getFormPageNumberMetadata()
        Get formPageNumberMetadata
        Returns:
        formPageNumberMetadata

      • setFormPageNumberMetadata

        public void setFormPageNumberMetadata​(PropertyMetadata formPageNumberMetadata)

      • getGroupLabel

        public String getGroupLabel()
        Returns:
        groupLabel

      • setGroupLabel

        public void setGroupLabel​(String groupLabel)

      • getGroupLabelMetadata

        public PropertyMetadata getGroupLabelMetadata()
        Get groupLabelMetadata
        Returns:
        groupLabelMetadata

      • setGroupLabelMetadata

        public void setGroupLabelMetadata​(PropertyMetadata groupLabelMetadata)

      • getGroupRule

        public String getGroupRule()
        Returns:
        groupRule

      • setGroupRule

        public void setGroupRule​(String groupRule)

      • getGroupRuleMetadata

        public PropertyMetadata getGroupRuleMetadata()
        Get groupRuleMetadata
        Returns:
        groupRuleMetadata

      • setGroupRuleMetadata

        public void setGroupRuleMetadata​(PropertyMetadata groupRuleMetadata)

      • getHeight

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

      • setHeight

        public void setHeight​(String height)

      • getHeightMetadata

        public PropertyMetadata getHeightMetadata()
        Get heightMetadata
        Returns:
        heightMetadata

      • setHeightMetadata

        public void setHeightMetadata​(PropertyMetadata heightMetadata)

      • maximumAllowed

        public TabGroup maximumAllowed​(String maximumAllowed)

      • getMaximumAllowed

        public String getMaximumAllowed()
        Returns:
        maximumAllowed

      • setMaximumAllowed

        public void setMaximumAllowed​(String maximumAllowed)

      • getMaximumAllowedMetadata

        public PropertyMetadata getMaximumAllowedMetadata()
        Get maximumAllowedMetadata
        Returns:
        maximumAllowedMetadata

      • setMaximumAllowedMetadata

        public void setMaximumAllowedMetadata​(PropertyMetadata maximumAllowedMetadata)

      • getMergeField

        public MergeField getMergeField()
        Get mergeField
        Returns:
        mergeField

      • setMergeField

        public void setMergeField​(MergeField mergeField)

      • mergeFieldXml

        public TabGroup mergeFieldXml​(String mergeFieldXml)

      • getMergeFieldXml

        public String getMergeFieldXml()
        Returns:
        mergeFieldXml

      • setMergeFieldXml

        public void setMergeFieldXml​(String mergeFieldXml)

      • minimumRequired

        public TabGroup minimumRequired​(String minimumRequired)

      • getMinimumRequired

        public String getMinimumRequired()
        Returns:
        minimumRequired

      • setMinimumRequired

        public void setMinimumRequired​(String minimumRequired)

      • getMinimumRequiredMetadata

        public PropertyMetadata getMinimumRequiredMetadata()
        Get minimumRequiredMetadata
        Returns:
        minimumRequiredMetadata

      • setMinimumRequiredMetadata

        public void setMinimumRequiredMetadata​(PropertyMetadata minimumRequiredMetadata)

      • getPageNumber

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

      • setPageNumber

        public void setPageNumber​(String pageNumber)

      • getPageNumberMetadata

        public PropertyMetadata getPageNumberMetadata()
        Get pageNumberMetadata
        Returns:
        pageNumberMetadata

      • setPageNumberMetadata

        public void setPageNumberMetadata​(PropertyMetadata pageNumberMetadata)

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

      • recipientIdGuid

        public TabGroup recipientIdGuid​(String recipientIdGuid)

      • getRecipientIdGuid

        public String getRecipientIdGuid()
        Returns:
        recipientIdGuid

      • setRecipientIdGuid

        public void setRecipientIdGuid​(String recipientIdGuid)

      • getRecipientIdGuidMetadata

        public PropertyMetadata getRecipientIdGuidMetadata()
        Get recipientIdGuidMetadata
        Returns:
        recipientIdGuidMetadata

      • setRecipientIdGuidMetadata

        public void setRecipientIdGuidMetadata​(PropertyMetadata recipientIdGuidMetadata)

      • getRecipientIdMetadata

        public PropertyMetadata getRecipientIdMetadata()
        Get recipientIdMetadata
        Returns:
        recipientIdMetadata

      • setRecipientIdMetadata

        public void setRecipientIdMetadata​(PropertyMetadata recipientIdMetadata)

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

      • getStatusMetadata

        public PropertyMetadata getStatusMetadata()
        Get statusMetadata
        Returns:
        statusMetadata

      • setStatusMetadata

        public void setStatusMetadata​(PropertyMetadata statusMetadata)

      • addTabGroupLabelsItem

        public TabGroup addTabGroupLabelsItem​(String tabGroupLabelsItem)

      • getTabGroupLabels

        public List<String> getTabGroupLabels()
        Returns:
        tabGroupLabels

      • setTabGroupLabels

        public void setTabGroupLabels​(List<String> tabGroupLabels)

      • getTabGroupLabelsMetadata

        public PropertyMetadata getTabGroupLabelsMetadata()
        Get tabGroupLabelsMetadata
        Returns:
        tabGroupLabelsMetadata

      • setTabGroupLabelsMetadata

        public void setTabGroupLabelsMetadata​(PropertyMetadata tabGroupLabelsMetadata)

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

      • getTabIdMetadata

        public PropertyMetadata getTabIdMetadata()
        Get tabIdMetadata
        Returns:
        tabIdMetadata

      • setTabIdMetadata

        public void setTabIdMetadata​(PropertyMetadata tabIdMetadata)

      • getTabOrder

        public String getTabOrder()
        Returns:
        tabOrder

      • setTabOrder

        public void setTabOrder​(String tabOrder)

      • getTabOrderMetadata

        public PropertyMetadata getTabOrderMetadata()
        Get tabOrderMetadata
        Returns:
        tabOrderMetadata

      • setTabOrderMetadata

        public void setTabOrderMetadata​(PropertyMetadata tabOrderMetadata)

      • getTabScope

        public String getTabScope()
        Returns:
        tabScope

      • setTabScope

        public void setTabScope​(String tabScope)

      • getTabScopeMetadata

        public PropertyMetadata getTabScopeMetadata()
        Get tabScopeMetadata
        Returns:
        tabScopeMetadata

      • setTabScopeMetadata

        public void setTabScopeMetadata​(PropertyMetadata tabScopeMetadata)

      • getTabType

        public String getTabType()
        Returns:
        tabType

      • setTabType

        public void setTabType​(String tabType)

      • getTabTypeMetadata

        public PropertyMetadata getTabTypeMetadata()
        Get tabTypeMetadata
        Returns:
        tabTypeMetadata

      • setTabTypeMetadata

        public void setTabTypeMetadata​(PropertyMetadata tabTypeMetadata)

      • templateLocked

        public TabGroup templateLocked​(String templateLocked)

      • getTemplateLocked

        public String getTemplateLocked()
        When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
        Returns:
        templateLocked

      • setTemplateLocked

        public void setTemplateLocked​(String templateLocked)

      • getTemplateLockedMetadata

        public PropertyMetadata getTemplateLockedMetadata()
        Get templateLockedMetadata
        Returns:
        templateLockedMetadata

      • setTemplateLockedMetadata

        public void setTemplateLockedMetadata​(PropertyMetadata templateLockedMetadata)

      • templateRequired

        public TabGroup templateRequired​(String templateRequired)

      • getTemplateRequired

        public String getTemplateRequired()
        When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
        Returns:
        templateRequired

      • setTemplateRequired

        public void setTemplateRequired​(String templateRequired)

      • getTemplateRequiredMetadata

        public PropertyMetadata getTemplateRequiredMetadata()
        Get templateRequiredMetadata
        Returns:
        templateRequiredMetadata

      • setTemplateRequiredMetadata

        public void setTemplateRequiredMetadata​(PropertyMetadata templateRequiredMetadata)

      • getTooltip

        public String getTooltip()
        Returns:
        tooltip

      • setTooltip

        public void setTooltip​(String tooltip)

      • getToolTipMetadata

        public PropertyMetadata getToolTipMetadata()
        Get toolTipMetadata
        Returns:
        toolTipMetadata

      • setToolTipMetadata

        public void setToolTipMetadata​(PropertyMetadata toolTipMetadata)

      • validationMessage

        public TabGroup validationMessage​(String validationMessage)

      • getValidationMessage

        public String getValidationMessage()
        The message displayed if the custom tab fails input validation (either custom of embedded).
        Returns:
        validationMessage

      • setValidationMessage

        public void setValidationMessage​(String validationMessage)

      • getValidationMessageMetadata

        public PropertyMetadata getValidationMessageMetadata()
        Get validationMessageMetadata
        Returns:
        validationMessageMetadata

      • setValidationMessageMetadata

        public void setValidationMessageMetadata​(PropertyMetadata validationMessageMetadata)

      • getWidth

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

      • setWidth

        public void setWidth​(String width)

      • getWidthMetadata

        public PropertyMetadata getWidthMetadata()
        Get widthMetadata
        Returns:
        widthMetadata

      • setWidthMetadata

        public void setWidthMetadata​(PropertyMetadata widthMetadata)

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

      • getXPositionMetadata

        public PropertyMetadata getXPositionMetadata()
        Get xPositionMetadata
        Returns:
        xPositionMetadata

      • setXPositionMetadata

        public void setXPositionMetadata​(PropertyMetadata xPositionMetadata)

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

      • getYPositionMetadata

        public PropertyMetadata getYPositionMetadata()
        Get yPositionMetadata
        Returns:
        yPositionMetadata

      • setYPositionMetadata

        public void setYPositionMetadata​(PropertyMetadata yPositionMetadata)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object