Package com.docusign.esign.model
Class View
- java.lang.Object
-
- com.docusign.esign.model.View
-
public class View extends Object
This tab is used with the Approve tab to handle supplemental documents..
-
-
Constructor Summary
Constructors Constructor Description View()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description View
addTabGroupLabelsItem(String tabGroupLabelsItem)
addTabGroupLabelsItem.View
anchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
anchorAllowWhiteSpaceInCharacters.View
anchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
anchorAllowWhiteSpaceInCharactersMetadata.View
anchorCaseSensitive(String anchorCaseSensitive)
anchorCaseSensitive.View
anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
anchorCaseSensitiveMetadata.View
anchorHorizontalAlignment(String anchorHorizontalAlignment)
anchorHorizontalAlignment.View
anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
anchorHorizontalAlignmentMetadata.View
anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
anchorIgnoreIfNotPresent.View
anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
anchorIgnoreIfNotPresentMetadata.View
anchorMatchWholeWord(String anchorMatchWholeWord)
anchorMatchWholeWord.View
anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
anchorMatchWholeWordMetadata.View
anchorString(String anchorString)
anchorString.View
anchorStringMetadata(PropertyMetadata anchorStringMetadata)
anchorStringMetadata.View
anchorTabProcessorVersion(String anchorTabProcessorVersion)
anchorTabProcessorVersion.View
anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
anchorTabProcessorVersionMetadata.View
anchorUnits(String anchorUnits)
anchorUnits.View
anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
anchorUnitsMetadata.View
anchorXOffset(String anchorXOffset)
anchorXOffset.View
anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
anchorXOffsetMetadata.View
anchorYOffset(String anchorYOffset)
anchorYOffset.View
anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
anchorYOffsetMetadata.View
bold(String bold)
bold.View
boldMetadata(PropertyMetadata boldMetadata)
boldMetadata.View
buttonText(String buttonText)
buttonText.View
buttonTextMetadata(PropertyMetadata buttonTextMetadata)
buttonTextMetadata.View
caption(String caption)
caption.View
captionMetadata(PropertyMetadata captionMetadata)
captionMetadata.View
conditionalParentLabel(String conditionalParentLabel)
conditionalParentLabel.View
conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
conditionalParentLabelMetadata.View
conditionalParentValue(String conditionalParentValue)
conditionalParentValue.View
conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
conditionalParentValueMetadata.View
customTabId(String customTabId)
customTabId.View
customTabIdMetadata(PropertyMetadata customTabIdMetadata)
customTabIdMetadata.View
documentId(String documentId)
documentId.View
documentIdMetadata(PropertyMetadata documentIdMetadata)
documentIdMetadata.boolean
equals(Object o)
Compares objects.View
errorDetails(ErrorDetails errorDetails)
errorDetails.View
font(String font)
font.View
fontColor(String fontColor)
fontColor.View
fontColorMetadata(PropertyMetadata fontColorMetadata)
fontColorMetadata.View
fontMetadata(PropertyMetadata fontMetadata)
fontMetadata.View
fontSize(String fontSize)
fontSize.View
fontSizeMetadata(PropertyMetadata fontSizeMetadata)
fontSizeMetadata.View
formOrder(String formOrder)
formOrder.View
formOrderMetadata(PropertyMetadata formOrderMetadata)
formOrderMetadata.View
formPageLabel(String formPageLabel)
formPageLabel.View
formPageLabelMetadata(PropertyMetadata formPageLabelMetadata)
formPageLabelMetadata.View
formPageNumber(String formPageNumber)
formPageNumber.View
formPageNumberMetadata(PropertyMetadata formPageNumberMetadata)
formPageNumberMetadata.String
getAnchorAllowWhiteSpaceInCharacters()
.PropertyMetadata
getAnchorAllowWhiteSpaceInCharactersMetadata()
Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable..String
getAnchorCaseSensitive()
When set to **true**, the anchor string does not consider case when matching strings in the document.PropertyMetadata
getAnchorCaseSensitiveMetadata()
Metadata that indicates whether the `anchorCaseSensitive` property is editable..String
getAnchorHorizontalAlignment()
Specifies the alignment of anchor tabs with anchor strings.PropertyMetadata
getAnchorHorizontalAlignmentMetadata()
Metadata that indicates whether the `anchorHorizontalAlignment` property is editable..String
getAnchorIgnoreIfNotPresent()
When set to **true**, this tab is ignored if anchorString is not found in the document..PropertyMetadata
getAnchorIgnoreIfNotPresentMetadata()
Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable..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**..PropertyMetadata
getAnchorMatchWholeWordMetadata()
Metadata that indicates whether the `anchorMatchWholeWord` property is editable..String
getAnchorString()
Anchor text information for a radio button..PropertyMetadata
getAnchorStringMetadata()
Metadata that indicates whether the `anchorString` property is editable..String
getAnchorTabProcessorVersion()
.PropertyMetadata
getAnchorTabProcessorVersionMetadata()
Reserved for DocuSign..String
getAnchorUnits()
Specifies units of the X and Y offset.PropertyMetadata
getAnchorUnitsMetadata()
Metadata that indicates whether the `anchorUnits` property is editable..String
getAnchorXOffset()
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString..PropertyMetadata
getAnchorXOffsetMetadata()
Metadata that indicates whether the `anchorXOffset` property is editable..String
getAnchorYOffset()
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString..PropertyMetadata
getAnchorYOffsetMetadata()
Metadata that indicates whether the `anchorYOffset` property is editable..String
getBold()
When set to **true**, the information in the tab is bold..PropertyMetadata
getBoldMetadata()
Metadata that indicates whether the `bold` property is editable..String
getButtonText()
.PropertyMetadata
getButtonTextMetadata()
Metadata that indicates whether the `buttonText` property is editable..String
getCaption()
.PropertyMetadata
getCaptionMetadata()
.String
getConditionalParentLabel()
For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility..PropertyMetadata
getConditionalParentLabelMetadata()
Metadata that indicates whether the `conditionalParentLabel` property is editable..String
getConditionalParentValue()
For conditional fields, this is the value of the parent tab that controls the tab's visibility.PropertyMetadata
getConditionalParentValueMetadata()
Metadata that indicates whether the `conditionalParentValue` property is editable..String
getCustomTabId()
The DocuSign generated custom tab ID for the custom tab to be applied.PropertyMetadata
getCustomTabIdMetadata()
Metadata that indicates whether the `customTabId` property is editable..String
getDocumentId()
Specifies the document ID number that the tab is placed on.PropertyMetadata
getDocumentIdMetadata()
Metadata that indicates whether the `documentId` property is editable..ErrorDetails
getErrorDetails()
Array or errors..String
getFont()
The font to be used for the tab value.String
getFontColor()
The font color used for the information in the tab.PropertyMetadata
getFontColorMetadata()
Metadata that indicates whether the `fontColor` property is editable..PropertyMetadata
getFontMetadata()
Metadata that indicates whether the `font` property is editable..String
getFontSize()
The font size used for the information in the tab.PropertyMetadata
getFontSizeMetadata()
Metadata that indicates whether the `fontSize` property is editable..String
getFormOrder()
.PropertyMetadata
getFormOrderMetadata()
Metadata that indicates whether the `formOrder` property is editable..String
getFormPageLabel()
.PropertyMetadata
getFormPageLabelMetadata()
Metadata that indicates whether the `formPageLabel` property is editable..String
getFormPageNumber()
.PropertyMetadata
getFormPageNumberMetadata()
Metadata that indicates whether the `fromPageNumber` property is editable..String
getHeight()
Height of the tab in pixels..PropertyMetadata
getHeightMetadata()
Metadata that indicates whether the `height` property is editable..String
getItalic()
When set to **true**, the information in the tab is italic..PropertyMetadata
getItalicMetadata()
Metadata that indicates whether the `italic` property is editable..LocalePolicyTab
getLocalePolicy()
Reserved for DocuSign..MergeField
getMergeField()
Contains the information necessary to map the tab to a field in SalesForce..String
getMergeFieldXml()
.String
getPageNumber()
Specifies the page number on which the tab is located..PropertyMetadata
getPageNumberMetadata()
Metadata that indicates whether the `pageNumber` property is editable..String
getRecipientId()
Unique for the recipient.String
getRecipientIdGuid()
.PropertyMetadata
getRecipientIdGuidMetadata()
Metadata that indicates whether the `recipientIdGuid` property is editable..PropertyMetadata
getRecipientIdMetadata()
Metadata that indicates whether the `recipientId` property is editable..String
getRequired()
When set to **true**, the signer is required to fill out this tab.PropertyMetadata
getRequiredMetadata()
Metadata that indicates whether the `required` property is editable..String
getRequiredRead()
.SmartContractInformation
getSmartContractInformation()
Reserved for DocuSign..String
getSource()
.String
getStatus()
Indicates the envelope status.PropertyMetadata
getStatusMetadata()
Metadata that indicates whether the `status` property is editable..List<String>
getTabGroupLabels()
.PropertyMetadata
getTabGroupLabelsMetadata()
Metadata that indicates whether the `tabGroupLabels` property is editable..String
getTabId()
The unique identifier for the tab.PropertyMetadata
getTabIdMetadata()
Metadata that indicates whether the `tabId` property is editable..String
getTabLabel()
The label string associated with the tab..PropertyMetadata
getTabLabelMetadata()
Metadata that indicates whether the `tabLabel` property is editable..String
getTabOrder()
.PropertyMetadata
getTabOrderMetadata()
Metadata that indicates whether the `tabOrder` property is editable..String
getTabType()
.PropertyMetadata
getTabTypeMetadata()
Metadata that indicates whether the `tabType` property is editable..String
getTemplateLocked()
When set to **true**, the sender cannot change any attributes of the recipient.PropertyMetadata
getTemplateLockedMetadata()
Metadata that indicates whether the `templateLocked` property is editable..String
getTemplateRequired()
When set to **true**, the sender may not remove the recipient.PropertyMetadata
getTemplateRequiredMetadata()
Metadata that indicates whether the `templateRequired` property is editable..String
getTooltip()
.PropertyMetadata
getToolTipMetadata()
Metadata that indicates whether the `toolTip` property is editable..String
getUnderline()
When set to **true**, the information in the tab is underlined..PropertyMetadata
getUnderlineMetadata()
Metadata that indicates whether the `underline` property is editable..String
getWidth()
Width of the tab in pixels..PropertyMetadata
getWidthMetadata()
Metadata that indicates whether the `width` property is editable..String
getXPosition()
This indicates the horizontal offset of the object on the page.PropertyMetadata
getXPositionMetadata()
Metadata that indicates whether the `xPosition` property is editable..String
getYPosition()
This indicates the vertical offset of the object on the page.PropertyMetadata
getYPositionMetadata()
Metadata that indicates whether the `yPosition` property is editable..int
hashCode()
Returns the HashCode.View
height(String height)
height.View
heightMetadata(PropertyMetadata heightMetadata)
heightMetadata.View
italic(String italic)
italic.View
italicMetadata(PropertyMetadata italicMetadata)
italicMetadata.View
localePolicy(LocalePolicyTab localePolicy)
localePolicy.View
mergeField(MergeField mergeField)
mergeField.View
mergeFieldXml(String mergeFieldXml)
mergeFieldXml.View
pageNumber(String pageNumber)
pageNumber.View
pageNumberMetadata(PropertyMetadata pageNumberMetadata)
pageNumberMetadata.View
recipientId(String recipientId)
recipientId.View
recipientIdGuid(String recipientIdGuid)
recipientIdGuid.View
recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
recipientIdGuidMetadata.View
recipientIdMetadata(PropertyMetadata recipientIdMetadata)
recipientIdMetadata.View
required(String required)
required.View
requiredMetadata(PropertyMetadata requiredMetadata)
requiredMetadata.View
requiredRead(String requiredRead)
requiredRead.void
setAnchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
setAnchorAllowWhiteSpaceInCharacters.void
setAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
setAnchorAllowWhiteSpaceInCharactersMetadata.void
setAnchorCaseSensitive(String anchorCaseSensitive)
setAnchorCaseSensitive.void
setAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
setAnchorCaseSensitiveMetadata.void
setAnchorHorizontalAlignment(String anchorHorizontalAlignment)
setAnchorHorizontalAlignment.void
setAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
setAnchorHorizontalAlignmentMetadata.void
setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
setAnchorIgnoreIfNotPresent.void
setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
setAnchorIgnoreIfNotPresentMetadata.void
setAnchorMatchWholeWord(String anchorMatchWholeWord)
setAnchorMatchWholeWord.void
setAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
setAnchorMatchWholeWordMetadata.void
setAnchorString(String anchorString)
setAnchorString.void
setAnchorStringMetadata(PropertyMetadata anchorStringMetadata)
setAnchorStringMetadata.void
setAnchorTabProcessorVersion(String anchorTabProcessorVersion)
setAnchorTabProcessorVersion.void
setAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
setAnchorTabProcessorVersionMetadata.void
setAnchorUnits(String anchorUnits)
setAnchorUnits.void
setAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
setAnchorUnitsMetadata.void
setAnchorXOffset(String anchorXOffset)
setAnchorXOffset.void
setAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
setAnchorXOffsetMetadata.void
setAnchorYOffset(String anchorYOffset)
setAnchorYOffset.void
setAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
setAnchorYOffsetMetadata.void
setBold(String bold)
setBold.void
setBoldMetadata(PropertyMetadata boldMetadata)
setBoldMetadata.void
setButtonText(String buttonText)
setButtonText.void
setButtonTextMetadata(PropertyMetadata buttonTextMetadata)
setButtonTextMetadata.void
setCaption(String caption)
setCaption.void
setCaptionMetadata(PropertyMetadata captionMetadata)
setCaptionMetadata.void
setConditionalParentLabel(String conditionalParentLabel)
setConditionalParentLabel.void
setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
setConditionalParentLabelMetadata.void
setConditionalParentValue(String conditionalParentValue)
setConditionalParentValue.void
setConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
setConditionalParentValueMetadata.void
setCustomTabId(String customTabId)
setCustomTabId.void
setCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)
setCustomTabIdMetadata.void
setDocumentId(String documentId)
setDocumentId.void
setDocumentIdMetadata(PropertyMetadata documentIdMetadata)
setDocumentIdMetadata.void
setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.void
setFont(String font)
setFont.void
setFontColor(String fontColor)
setFontColor.void
setFontColorMetadata(PropertyMetadata fontColorMetadata)
setFontColorMetadata.void
setFontMetadata(PropertyMetadata fontMetadata)
setFontMetadata.void
setFontSize(String fontSize)
setFontSize.void
setFontSizeMetadata(PropertyMetadata fontSizeMetadata)
setFontSizeMetadata.void
setFormOrder(String formOrder)
setFormOrder.void
setFormOrderMetadata(PropertyMetadata formOrderMetadata)
setFormOrderMetadata.void
setFormPageLabel(String formPageLabel)
setFormPageLabel.void
setFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)
setFormPageLabelMetadata.void
setFormPageNumber(String formPageNumber)
setFormPageNumber.void
setFormPageNumberMetadata(PropertyMetadata formPageNumberMetadata)
setFormPageNumberMetadata.void
setHeight(String height)
setHeight.void
setHeightMetadata(PropertyMetadata heightMetadata)
setHeightMetadata.void
setItalic(String italic)
setItalic.void
setItalicMetadata(PropertyMetadata italicMetadata)
setItalicMetadata.void
setLocalePolicy(LocalePolicyTab localePolicy)
setLocalePolicy.void
setMergeField(MergeField mergeField)
setMergeField.void
setMergeFieldXml(String mergeFieldXml)
setMergeFieldXml.void
setPageNumber(String pageNumber)
setPageNumber.void
setPageNumberMetadata(PropertyMetadata pageNumberMetadata)
setPageNumberMetadata.void
setRecipientId(String recipientId)
setRecipientId.void
setRecipientIdGuid(String recipientIdGuid)
setRecipientIdGuid.void
setRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
setRecipientIdGuidMetadata.void
setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)
setRecipientIdMetadata.void
setRequired(String required)
setRequired.void
setRequiredMetadata(PropertyMetadata requiredMetadata)
setRequiredMetadata.void
setRequiredRead(String requiredRead)
setRequiredRead.void
setSmartContractInformation(SmartContractInformation smartContractInformation)
setSmartContractInformation.void
setSource(String source)
setSource.void
setStatus(String status)
setStatus.void
setStatusMetadata(PropertyMetadata statusMetadata)
setStatusMetadata.void
setTabGroupLabels(List<String> tabGroupLabels)
setTabGroupLabels.void
setTabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)
setTabGroupLabelsMetadata.void
setTabId(String tabId)
setTabId.void
setTabIdMetadata(PropertyMetadata tabIdMetadata)
setTabIdMetadata.void
setTabLabel(String tabLabel)
setTabLabel.void
setTabLabelMetadata(PropertyMetadata tabLabelMetadata)
setTabLabelMetadata.void
setTabOrder(String tabOrder)
setTabOrder.void
setTabOrderMetadata(PropertyMetadata tabOrderMetadata)
setTabOrderMetadata.void
setTabType(String tabType)
setTabType.void
setTabTypeMetadata(PropertyMetadata tabTypeMetadata)
setTabTypeMetadata.void
setTemplateLocked(String templateLocked)
setTemplateLocked.void
setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)
setTemplateLockedMetadata.void
setTemplateRequired(String templateRequired)
setTemplateRequired.void
setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
setTemplateRequiredMetadata.void
setTooltip(String tooltip)
setTooltip.void
setToolTipMetadata(PropertyMetadata toolTipMetadata)
setToolTipMetadata.void
setUnderline(String underline)
setUnderline.void
setUnderlineMetadata(PropertyMetadata underlineMetadata)
setUnderlineMetadata.void
setWidth(String width)
setWidth.void
setWidthMetadata(PropertyMetadata widthMetadata)
setWidthMetadata.void
setXPosition(String xPosition)
setXPosition.void
setXPositionMetadata(PropertyMetadata xPositionMetadata)
setXPositionMetadata.void
setYPosition(String yPosition)
setYPosition.void
setYPositionMetadata(PropertyMetadata yPositionMetadata)
setYPositionMetadata.View
smartContractInformation(SmartContractInformation smartContractInformation)
smartContractInformation.View
source(String source)
source.View
status(String status)
status.View
statusMetadata(PropertyMetadata statusMetadata)
statusMetadata.View
tabGroupLabels(List<String> tabGroupLabels)
tabGroupLabels.View
tabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)
tabGroupLabelsMetadata.View
tabId(String tabId)
tabId.View
tabIdMetadata(PropertyMetadata tabIdMetadata)
tabIdMetadata.View
tabLabel(String tabLabel)
tabLabel.View
tabLabelMetadata(PropertyMetadata tabLabelMetadata)
tabLabelMetadata.View
tabOrder(String tabOrder)
tabOrder.View
tabOrderMetadata(PropertyMetadata tabOrderMetadata)
tabOrderMetadata.View
tabType(String tabType)
tabType.View
tabTypeMetadata(PropertyMetadata tabTypeMetadata)
tabTypeMetadata.View
templateLocked(String templateLocked)
templateLocked.View
templateLockedMetadata(PropertyMetadata templateLockedMetadata)
templateLockedMetadata.View
templateRequired(String templateRequired)
templateRequired.View
templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
templateRequiredMetadata.View
tooltip(String tooltip)
tooltip.View
toolTipMetadata(PropertyMetadata toolTipMetadata)
toolTipMetadata.String
toString()
Converts the given object to string.View
underline(String underline)
underline.View
underlineMetadata(PropertyMetadata underlineMetadata)
underlineMetadata.View
width(String width)
width.View
widthMetadata(PropertyMetadata widthMetadata)
widthMetadata.View
xPosition(String xPosition)
xPosition.View
xPositionMetadata(PropertyMetadata xPositionMetadata)
xPositionMetadata.View
yPosition(String yPosition)
yPosition.View
yPositionMetadata(PropertyMetadata yPositionMetadata)
yPositionMetadata.
-
-
-
Method Detail
-
anchorAllowWhiteSpaceInCharacters
public View anchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
anchorAllowWhiteSpaceInCharacters.- Returns:
- View
-
getAnchorAllowWhiteSpaceInCharacters
public String getAnchorAllowWhiteSpaceInCharacters()
.- Returns:
- anchorAllowWhiteSpaceInCharacters
-
setAnchorAllowWhiteSpaceInCharacters
public void setAnchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
setAnchorAllowWhiteSpaceInCharacters.
-
anchorAllowWhiteSpaceInCharactersMetadata
public View anchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
anchorAllowWhiteSpaceInCharactersMetadata.- Returns:
- View
-
getAnchorAllowWhiteSpaceInCharactersMetadata
public PropertyMetadata getAnchorAllowWhiteSpaceInCharactersMetadata()
Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable..- Returns:
- anchorAllowWhiteSpaceInCharactersMetadata
-
setAnchorAllowWhiteSpaceInCharactersMetadata
public void setAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
setAnchorAllowWhiteSpaceInCharactersMetadata.
-
anchorCaseSensitive
public View anchorCaseSensitive(String anchorCaseSensitive)
anchorCaseSensitive.- Returns:
- View
-
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 View anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
anchorCaseSensitiveMetadata.- Returns:
- View
-
getAnchorCaseSensitiveMetadata
public PropertyMetadata getAnchorCaseSensitiveMetadata()
Metadata that indicates whether the `anchorCaseSensitive` property is editable..- Returns:
- anchorCaseSensitiveMetadata
-
setAnchorCaseSensitiveMetadata
public void setAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
setAnchorCaseSensitiveMetadata.
-
anchorHorizontalAlignment
public View anchorHorizontalAlignment(String anchorHorizontalAlignment)
anchorHorizontalAlignment.- Returns:
- View
-
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 View anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
anchorHorizontalAlignmentMetadata.- Returns:
- View
-
getAnchorHorizontalAlignmentMetadata
public PropertyMetadata getAnchorHorizontalAlignmentMetadata()
Metadata that indicates whether the `anchorHorizontalAlignment` property is editable..- Returns:
- anchorHorizontalAlignmentMetadata
-
setAnchorHorizontalAlignmentMetadata
public void setAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
setAnchorHorizontalAlignmentMetadata.
-
anchorIgnoreIfNotPresent
public View anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
anchorIgnoreIfNotPresent.- Returns:
- View
-
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 View anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
anchorIgnoreIfNotPresentMetadata.- Returns:
- View
-
getAnchorIgnoreIfNotPresentMetadata
public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()
Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable..- Returns:
- anchorIgnoreIfNotPresentMetadata
-
setAnchorIgnoreIfNotPresentMetadata
public void setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
setAnchorIgnoreIfNotPresentMetadata.
-
anchorMatchWholeWord
public View anchorMatchWholeWord(String anchorMatchWholeWord)
anchorMatchWholeWord.- Returns:
- View
-
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 View anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
anchorMatchWholeWordMetadata.- Returns:
- View
-
getAnchorMatchWholeWordMetadata
public PropertyMetadata getAnchorMatchWholeWordMetadata()
Metadata that indicates whether the `anchorMatchWholeWord` property is editable..- Returns:
- anchorMatchWholeWordMetadata
-
setAnchorMatchWholeWordMetadata
public void setAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
setAnchorMatchWholeWordMetadata.
-
getAnchorString
public String getAnchorString()
Anchor text information for a radio button..- Returns:
- anchorString
-
setAnchorString
public void setAnchorString(String anchorString)
setAnchorString.
-
anchorStringMetadata
public View anchorStringMetadata(PropertyMetadata anchorStringMetadata)
anchorStringMetadata.- Returns:
- View
-
getAnchorStringMetadata
public PropertyMetadata getAnchorStringMetadata()
Metadata that indicates whether the `anchorString` property is editable..- Returns:
- anchorStringMetadata
-
setAnchorStringMetadata
public void setAnchorStringMetadata(PropertyMetadata anchorStringMetadata)
setAnchorStringMetadata.
-
anchorTabProcessorVersion
public View anchorTabProcessorVersion(String anchorTabProcessorVersion)
anchorTabProcessorVersion.- Returns:
- View
-
getAnchorTabProcessorVersion
public String getAnchorTabProcessorVersion()
.- Returns:
- anchorTabProcessorVersion
-
setAnchorTabProcessorVersion
public void setAnchorTabProcessorVersion(String anchorTabProcessorVersion)
setAnchorTabProcessorVersion.
-
anchorTabProcessorVersionMetadata
public View anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
anchorTabProcessorVersionMetadata.- Returns:
- View
-
getAnchorTabProcessorVersionMetadata
public PropertyMetadata getAnchorTabProcessorVersionMetadata()
Reserved for DocuSign..- Returns:
- anchorTabProcessorVersionMetadata
-
setAnchorTabProcessorVersionMetadata
public void setAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
setAnchorTabProcessorVersionMetadata.
-
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 View anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
anchorUnitsMetadata.- Returns:
- View
-
getAnchorUnitsMetadata
public PropertyMetadata getAnchorUnitsMetadata()
Metadata that indicates whether the `anchorUnits` property is editable..- Returns:
- anchorUnitsMetadata
-
setAnchorUnitsMetadata
public void setAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
setAnchorUnitsMetadata.
-
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 View anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
anchorXOffsetMetadata.- Returns:
- View
-
getAnchorXOffsetMetadata
public PropertyMetadata getAnchorXOffsetMetadata()
Metadata that indicates whether the `anchorXOffset` property is editable..- Returns:
- anchorXOffsetMetadata
-
setAnchorXOffsetMetadata
public void setAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
setAnchorXOffsetMetadata.
-
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 View anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
anchorYOffsetMetadata.- Returns:
- View
-
getAnchorYOffsetMetadata
public PropertyMetadata getAnchorYOffsetMetadata()
Metadata that indicates whether the `anchorYOffset` property is editable..- 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.
-
boldMetadata
public View boldMetadata(PropertyMetadata boldMetadata)
boldMetadata.- Returns:
- View
-
getBoldMetadata
public PropertyMetadata getBoldMetadata()
Metadata that indicates whether the `bold` property is editable..- Returns:
- boldMetadata
-
setBoldMetadata
public void setBoldMetadata(PropertyMetadata boldMetadata)
setBoldMetadata.
-
getButtonText
public String getButtonText()
.- Returns:
- buttonText
-
setButtonText
public void setButtonText(String buttonText)
setButtonText.
-
buttonTextMetadata
public View buttonTextMetadata(PropertyMetadata buttonTextMetadata)
buttonTextMetadata.- Returns:
- View
-
getButtonTextMetadata
public PropertyMetadata getButtonTextMetadata()
Metadata that indicates whether the `buttonText` property is editable..- Returns:
- buttonTextMetadata
-
setButtonTextMetadata
public void setButtonTextMetadata(PropertyMetadata buttonTextMetadata)
setButtonTextMetadata.
-
getCaption
public String getCaption()
.- Returns:
- caption
-
setCaption
public void setCaption(String caption)
setCaption.
-
captionMetadata
public View captionMetadata(PropertyMetadata captionMetadata)
captionMetadata.- Returns:
- View
-
getCaptionMetadata
public PropertyMetadata getCaptionMetadata()
.- Returns:
- captionMetadata
-
setCaptionMetadata
public void setCaptionMetadata(PropertyMetadata captionMetadata)
setCaptionMetadata.
-
conditionalParentLabel
public View conditionalParentLabel(String conditionalParentLabel)
conditionalParentLabel.- Returns:
- View
-
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 View conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
conditionalParentLabelMetadata.- Returns:
- View
-
getConditionalParentLabelMetadata
public PropertyMetadata getConditionalParentLabelMetadata()
Metadata that indicates whether the `conditionalParentLabel` property is editable..- Returns:
- conditionalParentLabelMetadata
-
setConditionalParentLabelMetadata
public void setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
setConditionalParentLabelMetadata.
-
conditionalParentValue
public View conditionalParentValue(String conditionalParentValue)
conditionalParentValue.- Returns:
- View
-
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 View conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
conditionalParentValueMetadata.- Returns:
- View
-
getConditionalParentValueMetadata
public PropertyMetadata getConditionalParentValueMetadata()
Metadata that indicates whether the `conditionalParentValue` property is editable..- Returns:
- conditionalParentValueMetadata
-
setConditionalParentValueMetadata
public void setConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
setConditionalParentValueMetadata.
-
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 View customTabIdMetadata(PropertyMetadata customTabIdMetadata)
customTabIdMetadata.- Returns:
- View
-
getCustomTabIdMetadata
public PropertyMetadata getCustomTabIdMetadata()
Metadata that indicates whether the `customTabId` property is editable..- Returns:
- customTabIdMetadata
-
setCustomTabIdMetadata
public void setCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)
setCustomTabIdMetadata.
-
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 View documentIdMetadata(PropertyMetadata documentIdMetadata)
documentIdMetadata.- Returns:
- View
-
getDocumentIdMetadata
public PropertyMetadata getDocumentIdMetadata()
Metadata that indicates whether the `documentId` property is editable..- Returns:
- documentIdMetadata
-
setDocumentIdMetadata
public void setDocumentIdMetadata(PropertyMetadata documentIdMetadata)
setDocumentIdMetadata.
-
errorDetails
public View errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- View
-
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.
-
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 View fontColorMetadata(PropertyMetadata fontColorMetadata)
fontColorMetadata.- Returns:
- View
-
getFontColorMetadata
public PropertyMetadata getFontColorMetadata()
Metadata that indicates whether the `fontColor` property is editable..- Returns:
- fontColorMetadata
-
setFontColorMetadata
public void setFontColorMetadata(PropertyMetadata fontColorMetadata)
setFontColorMetadata.
-
fontMetadata
public View fontMetadata(PropertyMetadata fontMetadata)
fontMetadata.- Returns:
- View
-
getFontMetadata
public PropertyMetadata getFontMetadata()
Metadata that indicates whether the `font` property is editable..- Returns:
- fontMetadata
-
setFontMetadata
public void setFontMetadata(PropertyMetadata fontMetadata)
setFontMetadata.
-
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 View fontSizeMetadata(PropertyMetadata fontSizeMetadata)
fontSizeMetadata.- Returns:
- View
-
getFontSizeMetadata
public PropertyMetadata getFontSizeMetadata()
Metadata that indicates whether the `fontSize` property is editable..- Returns:
- fontSizeMetadata
-
setFontSizeMetadata
public void setFontSizeMetadata(PropertyMetadata fontSizeMetadata)
setFontSizeMetadata.
-
getFormOrder
public String getFormOrder()
.- Returns:
- formOrder
-
setFormOrder
public void setFormOrder(String formOrder)
setFormOrder.
-
formOrderMetadata
public View formOrderMetadata(PropertyMetadata formOrderMetadata)
formOrderMetadata.- Returns:
- View
-
getFormOrderMetadata
public PropertyMetadata getFormOrderMetadata()
Metadata that indicates whether the `formOrder` property is editable..- Returns:
- formOrderMetadata
-
setFormOrderMetadata
public void setFormOrderMetadata(PropertyMetadata formOrderMetadata)
setFormOrderMetadata.
-
getFormPageLabel
public String getFormPageLabel()
.- Returns:
- formPageLabel
-
setFormPageLabel
public void setFormPageLabel(String formPageLabel)
setFormPageLabel.
-
formPageLabelMetadata
public View formPageLabelMetadata(PropertyMetadata formPageLabelMetadata)
formPageLabelMetadata.- Returns:
- View
-
getFormPageLabelMetadata
public PropertyMetadata getFormPageLabelMetadata()
Metadata that indicates whether the `formPageLabel` property is editable..- Returns:
- formPageLabelMetadata
-
setFormPageLabelMetadata
public void setFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)
setFormPageLabelMetadata.
-
getFormPageNumber
public String getFormPageNumber()
.- Returns:
- formPageNumber
-
setFormPageNumber
public void setFormPageNumber(String formPageNumber)
setFormPageNumber.
-
formPageNumberMetadata
public View formPageNumberMetadata(PropertyMetadata formPageNumberMetadata)
formPageNumberMetadata.- Returns:
- View
-
getFormPageNumberMetadata
public PropertyMetadata getFormPageNumberMetadata()
Metadata that indicates whether the `fromPageNumber` property is editable..- Returns:
- formPageNumberMetadata
-
setFormPageNumberMetadata
public void setFormPageNumberMetadata(PropertyMetadata formPageNumberMetadata)
setFormPageNumberMetadata.
-
getHeight
public String getHeight()
Height of the tab in pixels..- Returns:
- height
-
setHeight
public void setHeight(String height)
setHeight.
-
heightMetadata
public View heightMetadata(PropertyMetadata heightMetadata)
heightMetadata.- Returns:
- View
-
getHeightMetadata
public PropertyMetadata getHeightMetadata()
Metadata that indicates whether the `height` property is editable..- Returns:
- heightMetadata
-
setHeightMetadata
public void setHeightMetadata(PropertyMetadata heightMetadata)
setHeightMetadata.
-
getItalic
public String getItalic()
When set to **true**, the information in the tab is italic..- Returns:
- italic
-
setItalic
public void setItalic(String italic)
setItalic.
-
italicMetadata
public View italicMetadata(PropertyMetadata italicMetadata)
italicMetadata.- Returns:
- View
-
getItalicMetadata
public PropertyMetadata getItalicMetadata()
Metadata that indicates whether the `italic` property is editable..- Returns:
- italicMetadata
-
setItalicMetadata
public void setItalicMetadata(PropertyMetadata italicMetadata)
setItalicMetadata.
-
localePolicy
public View localePolicy(LocalePolicyTab localePolicy)
localePolicy.- Returns:
- View
-
getLocalePolicy
public LocalePolicyTab getLocalePolicy()
Reserved for DocuSign..- Returns:
- localePolicy
-
setLocalePolicy
public void setLocalePolicy(LocalePolicyTab localePolicy)
setLocalePolicy.
-
mergeField
public View mergeField(MergeField mergeField)
mergeField.- Returns:
- View
-
getMergeField
public MergeField getMergeField()
Contains the information necessary to map the tab to a field in SalesForce..- Returns:
- mergeField
-
setMergeField
public void setMergeField(MergeField mergeField)
setMergeField.
-
getMergeFieldXml
public String getMergeFieldXml()
.- Returns:
- mergeFieldXml
-
setMergeFieldXml
public void setMergeFieldXml(String mergeFieldXml)
setMergeFieldXml.
-
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 View pageNumberMetadata(PropertyMetadata pageNumberMetadata)
pageNumberMetadata.- Returns:
- View
-
getPageNumberMetadata
public PropertyMetadata getPageNumberMetadata()
Metadata that indicates whether the `pageNumber` property is editable..- Returns:
- pageNumberMetadata
-
setPageNumberMetadata
public void setPageNumberMetadata(PropertyMetadata pageNumberMetadata)
setPageNumberMetadata.
-
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.
-
getRecipientIdGuid
public String getRecipientIdGuid()
.- Returns:
- recipientIdGuid
-
setRecipientIdGuid
public void setRecipientIdGuid(String recipientIdGuid)
setRecipientIdGuid.
-
recipientIdGuidMetadata
public View recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
recipientIdGuidMetadata.- Returns:
- View
-
getRecipientIdGuidMetadata
public PropertyMetadata getRecipientIdGuidMetadata()
Metadata that indicates whether the `recipientIdGuid` property is editable..- Returns:
- recipientIdGuidMetadata
-
setRecipientIdGuidMetadata
public void setRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
setRecipientIdGuidMetadata.
-
recipientIdMetadata
public View recipientIdMetadata(PropertyMetadata recipientIdMetadata)
recipientIdMetadata.- Returns:
- View
-
getRecipientIdMetadata
public PropertyMetadata getRecipientIdMetadata()
Metadata that indicates whether the `recipientId` property is editable..- Returns:
- recipientIdMetadata
-
setRecipientIdMetadata
public void setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)
setRecipientIdMetadata.
-
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 View requiredMetadata(PropertyMetadata requiredMetadata)
requiredMetadata.- Returns:
- View
-
getRequiredMetadata
public PropertyMetadata getRequiredMetadata()
Metadata that indicates whether the `required` property is editable..- Returns:
- requiredMetadata
-
setRequiredMetadata
public void setRequiredMetadata(PropertyMetadata requiredMetadata)
setRequiredMetadata.
-
getRequiredRead
public String getRequiredRead()
.- Returns:
- requiredRead
-
setRequiredRead
public void setRequiredRead(String requiredRead)
setRequiredRead.
-
smartContractInformation
public View smartContractInformation(SmartContractInformation smartContractInformation)
smartContractInformation.- Returns:
- View
-
getSmartContractInformation
public SmartContractInformation getSmartContractInformation()
Reserved for DocuSign..- Returns:
- smartContractInformation
-
setSmartContractInformation
public void setSmartContractInformation(SmartContractInformation smartContractInformation)
setSmartContractInformation.
-
getSource
public String getSource()
.- Returns:
- source
-
setSource
public void setSource(String source)
setSource.
-
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.
-
statusMetadata
public View statusMetadata(PropertyMetadata statusMetadata)
statusMetadata.- Returns:
- View
-
getStatusMetadata
public PropertyMetadata getStatusMetadata()
Metadata that indicates whether the `status` property is editable..- Returns:
- statusMetadata
-
setStatusMetadata
public void setStatusMetadata(PropertyMetadata statusMetadata)
setStatusMetadata.
-
tabGroupLabels
public View tabGroupLabels(List<String> tabGroupLabels)
tabGroupLabels.- Returns:
- View
-
addTabGroupLabelsItem
public View addTabGroupLabelsItem(String tabGroupLabelsItem)
addTabGroupLabelsItem.- Returns:
- View
-
tabGroupLabelsMetadata
public View tabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)
tabGroupLabelsMetadata.- Returns:
- View
-
getTabGroupLabelsMetadata
public PropertyMetadata getTabGroupLabelsMetadata()
Metadata that indicates whether the `tabGroupLabels` property is editable..- Returns:
- tabGroupLabelsMetadata
-
setTabGroupLabelsMetadata
public void setTabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)
setTabGroupLabelsMetadata.
-
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.
-
tabIdMetadata
public View tabIdMetadata(PropertyMetadata tabIdMetadata)
tabIdMetadata.- Returns:
- View
-
getTabIdMetadata
public PropertyMetadata getTabIdMetadata()
Metadata that indicates whether the `tabId` property is editable..- Returns:
- tabIdMetadata
-
setTabIdMetadata
public void setTabIdMetadata(PropertyMetadata tabIdMetadata)
setTabIdMetadata.
-
getTabLabel
public String getTabLabel()
The label string associated with the tab..- Returns:
- tabLabel
-
setTabLabel
public void setTabLabel(String tabLabel)
setTabLabel.
-
tabLabelMetadata
public View tabLabelMetadata(PropertyMetadata tabLabelMetadata)
tabLabelMetadata.- Returns:
- View
-
getTabLabelMetadata
public PropertyMetadata getTabLabelMetadata()
Metadata that indicates whether the `tabLabel` property is editable..- Returns:
- tabLabelMetadata
-
setTabLabelMetadata
public void setTabLabelMetadata(PropertyMetadata tabLabelMetadata)
setTabLabelMetadata.
-
getTabOrder
public String getTabOrder()
.- Returns:
- tabOrder
-
setTabOrder
public void setTabOrder(String tabOrder)
setTabOrder.
-
tabOrderMetadata
public View tabOrderMetadata(PropertyMetadata tabOrderMetadata)
tabOrderMetadata.- Returns:
- View
-
getTabOrderMetadata
public PropertyMetadata getTabOrderMetadata()
Metadata that indicates whether the `tabOrder` property is editable..- Returns:
- tabOrderMetadata
-
setTabOrderMetadata
public void setTabOrderMetadata(PropertyMetadata tabOrderMetadata)
setTabOrderMetadata.
-
getTabType
public String getTabType()
.- Returns:
- tabType
-
setTabType
public void setTabType(String tabType)
setTabType.
-
tabTypeMetadata
public View tabTypeMetadata(PropertyMetadata tabTypeMetadata)
tabTypeMetadata.- Returns:
- View
-
getTabTypeMetadata
public PropertyMetadata getTabTypeMetadata()
Metadata that indicates whether the `tabType` property is editable..- Returns:
- tabTypeMetadata
-
setTabTypeMetadata
public void setTabTypeMetadata(PropertyMetadata tabTypeMetadata)
setTabTypeMetadata.
-
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 View templateLockedMetadata(PropertyMetadata templateLockedMetadata)
templateLockedMetadata.- Returns:
- View
-
getTemplateLockedMetadata
public PropertyMetadata getTemplateLockedMetadata()
Metadata that indicates whether the `templateLocked` property is editable..- Returns:
- templateLockedMetadata
-
setTemplateLockedMetadata
public void setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)
setTemplateLockedMetadata.
-
templateRequired
public View templateRequired(String templateRequired)
templateRequired.- Returns:
- View
-
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 View templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
templateRequiredMetadata.- Returns:
- View
-
getTemplateRequiredMetadata
public PropertyMetadata getTemplateRequiredMetadata()
Metadata that indicates whether the `templateRequired` property is editable..- Returns:
- templateRequiredMetadata
-
setTemplateRequiredMetadata
public void setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
setTemplateRequiredMetadata.
-
getTooltip
public String getTooltip()
.- Returns:
- tooltip
-
setTooltip
public void setTooltip(String tooltip)
setTooltip.
-
toolTipMetadata
public View toolTipMetadata(PropertyMetadata toolTipMetadata)
toolTipMetadata.- Returns:
- View
-
getToolTipMetadata
public PropertyMetadata getToolTipMetadata()
Metadata that indicates whether the `toolTip` property is editable..- Returns:
- toolTipMetadata
-
setToolTipMetadata
public void setToolTipMetadata(PropertyMetadata toolTipMetadata)
setToolTipMetadata.
-
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 View underlineMetadata(PropertyMetadata underlineMetadata)
underlineMetadata.- Returns:
- View
-
getUnderlineMetadata
public PropertyMetadata getUnderlineMetadata()
Metadata that indicates whether the `underline` property is editable..- Returns:
- underlineMetadata
-
setUnderlineMetadata
public void setUnderlineMetadata(PropertyMetadata underlineMetadata)
setUnderlineMetadata.
-
getWidth
public String getWidth()
Width of the tab in pixels..- Returns:
- width
-
setWidth
public void setWidth(String width)
setWidth.
-
widthMetadata
public View widthMetadata(PropertyMetadata widthMetadata)
widthMetadata.- Returns:
- View
-
getWidthMetadata
public PropertyMetadata getWidthMetadata()
Metadata that indicates whether the `width` property is editable..- Returns:
- widthMetadata
-
setWidthMetadata
public void setWidthMetadata(PropertyMetadata widthMetadata)
setWidthMetadata.
-
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 View xPositionMetadata(PropertyMetadata xPositionMetadata)
xPositionMetadata.- Returns:
- View
-
getXPositionMetadata
public PropertyMetadata getXPositionMetadata()
Metadata that indicates whether the `xPosition` property is editable..- Returns:
- xPositionMetadata
-
setXPositionMetadata
public void setXPositionMetadata(PropertyMetadata xPositionMetadata)
setXPositionMetadata.
-
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 View yPositionMetadata(PropertyMetadata yPositionMetadata)
yPositionMetadata.- Returns:
- View
-
getYPositionMetadata
public PropertyMetadata getYPositionMetadata()
Metadata that indicates whether the `yPosition` property is editable..- Returns:
- yPositionMetadata
-
setYPositionMetadata
public void setYPositionMetadata(PropertyMetadata yPositionMetadata)
setYPositionMetadata.
-
equals
public boolean equals(Object o)
Compares objects.
-
-