Package com.docusign.esign.model
Class Checkbox
- java.lang.Object
-
- com.docusign.esign.model.Checkbox
-
public class Checkbox extends Object
A tab that allows the recipient to select a yes/no (on/off) option. .
-
-
Constructor Summary
Constructors Constructor Description Checkbox()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CheckboxaddTabGroupLabelsItem(String tabGroupLabelsItem)addTabGroupLabelsItem.CheckboxanchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)anchorAllowWhiteSpaceInCharacters.CheckboxanchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)anchorAllowWhiteSpaceInCharactersMetadata.CheckboxanchorCaseSensitive(String anchorCaseSensitive)anchorCaseSensitive.CheckboxanchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)anchorCaseSensitiveMetadata.CheckboxanchorHorizontalAlignment(String anchorHorizontalAlignment)anchorHorizontalAlignment.CheckboxanchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)anchorHorizontalAlignmentMetadata.CheckboxanchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)anchorIgnoreIfNotPresent.CheckboxanchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)anchorIgnoreIfNotPresentMetadata.CheckboxanchorMatchWholeWord(String anchorMatchWholeWord)anchorMatchWholeWord.CheckboxanchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)anchorMatchWholeWordMetadata.CheckboxanchorString(String anchorString)anchorString.CheckboxanchorStringMetadata(PropertyMetadata anchorStringMetadata)anchorStringMetadata.CheckboxanchorTabProcessorVersion(String anchorTabProcessorVersion)anchorTabProcessorVersion.CheckboxanchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)anchorTabProcessorVersionMetadata.CheckboxanchorUnits(String anchorUnits)anchorUnits.CheckboxanchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)anchorUnitsMetadata.CheckboxanchorXOffset(String anchorXOffset)anchorXOffset.CheckboxanchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)anchorXOffsetMetadata.CheckboxanchorYOffset(String anchorYOffset)anchorYOffset.CheckboxanchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)anchorYOffsetMetadata.Checkboxbold(String bold)bold.CheckboxboldMetadata(PropertyMetadata boldMetadata)boldMetadata.Checkboxcaption(String caption)caption.CheckboxcaptionMetadata(PropertyMetadata captionMetadata)captionMetadata.CheckboxconditionalParentLabel(String conditionalParentLabel)conditionalParentLabel.CheckboxconditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)conditionalParentLabelMetadata.CheckboxconditionalParentValue(String conditionalParentValue)conditionalParentValue.CheckboxconditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)conditionalParentValueMetadata.CheckboxcustomTabId(String customTabId)customTabId.CheckboxcustomTabIdMetadata(PropertyMetadata customTabIdMetadata)customTabIdMetadata.CheckboxdocumentId(String documentId)documentId.CheckboxdocumentIdMetadata(PropertyMetadata documentIdMetadata)documentIdMetadata.booleanequals(Object o)Compares objects.CheckboxerrorDetails(ErrorDetails errorDetails)errorDetails.Checkboxfont(String font)font.CheckboxfontColor(String fontColor)fontColor.CheckboxfontColorMetadata(PropertyMetadata fontColorMetadata)fontColorMetadata.CheckboxfontMetadata(PropertyMetadata fontMetadata)fontMetadata.CheckboxfontSize(String fontSize)fontSize.CheckboxfontSizeMetadata(PropertyMetadata fontSizeMetadata)fontSizeMetadata.CheckboxformOrder(String formOrder)formOrder.CheckboxformOrderMetadata(PropertyMetadata formOrderMetadata)formOrderMetadata.CheckboxformPageLabel(String formPageLabel)formPageLabel.CheckboxformPageLabelMetadata(PropertyMetadata formPageLabelMetadata)formPageLabelMetadata.CheckboxformPageNumber(String formPageNumber)formPageNumber.CheckboxformPageNumberMetadata(PropertyMetadata formPageNumberMetadata)formPageNumberMetadata.StringgetAnchorAllowWhiteSpaceInCharacters().PropertyMetadatagetAnchorAllowWhiteSpaceInCharactersMetadata()Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable..StringgetAnchorCaseSensitive()When set to **true**, the anchor string does not consider case when matching strings in the document.PropertyMetadatagetAnchorCaseSensitiveMetadata()Metadata that indicates whether the `anchorCaseSensitive` property is editable..StringgetAnchorHorizontalAlignment()Specifies the alignment of anchor tabs with anchor strings.PropertyMetadatagetAnchorHorizontalAlignmentMetadata()Metadata that indicates whether the `anchorHorizontalAlignment` property is editable..StringgetAnchorIgnoreIfNotPresent()When set to **true**, this tab is ignored if anchorString is not found in the document..PropertyMetadatagetAnchorIgnoreIfNotPresentMetadata()Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable..StringgetAnchorMatchWholeWord()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**..PropertyMetadatagetAnchorMatchWholeWordMetadata()Metadata that indicates whether the `anchorMatchWholeWord` property is editable..StringgetAnchorString()Anchor text information for a radio button..PropertyMetadatagetAnchorStringMetadata()Metadata that indicates whether the `anchorString` property is editable..StringgetAnchorTabProcessorVersion().PropertyMetadatagetAnchorTabProcessorVersionMetadata()Reserved for DocuSign..StringgetAnchorUnits()Specifies units of the X and Y offset.PropertyMetadatagetAnchorUnitsMetadata()Metadata that indicates whether the `anchorUnits` property is editable..StringgetAnchorXOffset()Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString..PropertyMetadatagetAnchorXOffsetMetadata()Metadata that indicates whether the `anchorXOffset` property is editable..StringgetAnchorYOffset()Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString..PropertyMetadatagetAnchorYOffsetMetadata()Metadata that indicates whether the `anchorYOffset` property is editable..StringgetBold()When set to **true**, the information in the tab is bold..PropertyMetadatagetBoldMetadata()Metadata that indicates whether the `bold` property is editable..StringgetCaption().PropertyMetadatagetCaptionMetadata()Get captionMetadata.StringgetConditionalParentLabel()For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility..PropertyMetadatagetConditionalParentLabelMetadata()Metadata that indicates whether the `conditionalParentLabel` property is editable..StringgetConditionalParentValue()For conditional fields, this is the value of the parent tab that controls the tab's visibility.PropertyMetadatagetConditionalParentValueMetadata()Metadata that indicates whether the `conditionalParentValue` property is editable..StringgetCustomTabId()The DocuSign generated custom tab ID for the custom tab to be applied.PropertyMetadatagetCustomTabIdMetadata()Metadata that indicates whether the `customTabId` property is editable..StringgetDocumentId()Specifies the document ID number that the tab is placed on.PropertyMetadatagetDocumentIdMetadata()Metadata that indicates whether the `documentId` property is editable..ErrorDetailsgetErrorDetails()This object describes errors that occur.StringgetFont()The font to be used for the tab value.StringgetFontColor()The font color used for the information in the tab.PropertyMetadatagetFontColorMetadata()Metadata that indicates whether the `fontColor` property is editable..PropertyMetadatagetFontMetadata()Metadata that indicates whether the `font` property is editable..StringgetFontSize()The font size used for the information in the tab.PropertyMetadatagetFontSizeMetadata()Metadata that indicates whether the `fontSize` property is editable..StringgetFormOrder().PropertyMetadatagetFormOrderMetadata()Metadata that indicates whether the `formOrder` property is editable..StringgetFormPageLabel().PropertyMetadatagetFormPageLabelMetadata()Metadata that indicates whether the `formPageLabel` property is editable..StringgetFormPageNumber().PropertyMetadatagetFormPageNumberMetadata()Metadata that indicates whether the `fromPageNumber` property is editable..StringgetHeight()Height of the tab in pixels..PropertyMetadatagetHeightMetadata()Metadata that indicates whether the `height` property is editable..StringgetItalic()When set to **true**, the information in the tab is italic..PropertyMetadatagetItalicMetadata()Metadata that indicates whether the `italic` property is editable..StringgetLocked()When set to **true**, the signer cannot change the data of the custom tab..PropertyMetadatagetLockedMetadata()Metadata that indicates whether the `locked` property is editable..MergeFieldgetMergeField()Contains the information necessary to map the tab to a field in SalesForce..StringgetMergeFieldXml().StringgetName()Specifies the tool tip text for the tab..PropertyMetadatagetNameMetadata()Metadata that indicates whether the `name` property is editable.StringgetPageNumber()Specifies the page number on which the tab is located..PropertyMetadatagetPageNumberMetadata()Metadata that indicates whether the `pageNumber` property is editable..StringgetRecipientId()Unique for the recipient.StringgetRecipientIdGuid().PropertyMetadatagetRecipientIdGuidMetadata()Metadata that indicates whether the `recipientIdGuid` property is editable..PropertyMetadatagetRecipientIdMetadata()Metadata that indicates whether the `recipientId` property is editable..StringgetRequired()When set to **true**, the signer is required to fill out this tab.PropertyMetadatagetRequiredMetadata()Metadata that indicates whether the `required` property is editable..StringgetRequireInitialOnSharedChange()Optional element for field markup.PropertyMetadatagetRequireInitialOnSharedChangeMetadata()Metadata that indicates whether the `requireInitialOnSharedChange` property is editable..StringgetSelected()When set to **true**, the checkbox is selected..PropertyMetadatagetSelectedMetadata()Metadata that indicates whether the `selected` property is editable..StringgetSelectedOriginal().PropertyMetadatagetSelectedOriginalMetadata().StringgetShared()When set to **true**, this custom tab is shared..PropertyMetadatagetSharedMetadata()Metadata that indicates whether the `shared` property is editable.StringgetShareToRecipients().PropertyMetadatagetShareToRecipientsMetadata()Reserved for DocuSign..SmartContractInformationgetSmartContractInformation()Reserved for DocuSign..StringgetSource().StringgetStatus()Indicates the envelope status.PropertyMetadatagetStatusMetadata()Metadata that indicates whether the `status` property is editable..List<String>getTabGroupLabels().PropertyMetadatagetTabGroupLabelsMetadata()Metadata that indicates whether the `tabGroupLabels` property is editable..StringgetTabId()The unique identifier for the tab.PropertyMetadatagetTabIdMetadata()Metadata that indicates whether the `tabId` property is editable..StringgetTabLabel()The label string associated with the tab..PropertyMetadatagetTabLabelMetadata()Metadata that indicates whether the `tabLabel` property is editable..StringgetTabOrder().PropertyMetadatagetTabOrderMetadata()Metadata that indicates whether the `tabOrder` property is editable..StringgetTabType().PropertyMetadatagetTabTypeMetadata()Metadata that indicates whether the `tabType` property is editable..StringgetTemplateLocked()When set to **true**, the sender cannot change any attributes of the recipient.PropertyMetadatagetTemplateLockedMetadata()Metadata that indicates whether the `templateLocked` property is editable..StringgetTemplateRequired()When set to **true**, the sender may not remove the recipient.PropertyMetadatagetTemplateRequiredMetadata()Metadata that indicates whether the `templateRequired` property is editable..StringgetTooltip().PropertyMetadatagetToolTipMetadata()Metadata that indicates whether the `toolTip` property is editable..StringgetUnderline()When set to **true**, the information in the tab is underlined..PropertyMetadatagetUnderlineMetadata()Metadata that indicates whether the `underline` property is editable..StringgetWidth()Width of the tab in pixels..PropertyMetadatagetWidthMetadata()Metadata that indicates whether the `width` property is editable..StringgetXPosition()This indicates the horizontal offset of the object on the page.PropertyMetadatagetXPositionMetadata()Metadata that indicates whether the `xPosition` property is editable..StringgetYPosition()This indicates the vertical offset of the object on the page.PropertyMetadatagetYPositionMetadata()Metadata that indicates whether the `yPosition` property is editable..inthashCode()Returns the HashCode.Checkboxheight(String height)height.CheckboxheightMetadata(PropertyMetadata heightMetadata)heightMetadata.Checkboxitalic(String italic)italic.CheckboxitalicMetadata(PropertyMetadata italicMetadata)italicMetadata.Checkboxlocked(String locked)locked.CheckboxlockedMetadata(PropertyMetadata lockedMetadata)lockedMetadata.CheckboxmergeField(MergeField mergeField)mergeField.CheckboxmergeFieldXml(String mergeFieldXml)mergeFieldXml.Checkboxname(String name)name.CheckboxnameMetadata(PropertyMetadata nameMetadata)nameMetadata.CheckboxpageNumber(String pageNumber)pageNumber.CheckboxpageNumberMetadata(PropertyMetadata pageNumberMetadata)pageNumberMetadata.CheckboxrecipientId(String recipientId)recipientId.CheckboxrecipientIdGuid(String recipientIdGuid)recipientIdGuid.CheckboxrecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)recipientIdGuidMetadata.CheckboxrecipientIdMetadata(PropertyMetadata recipientIdMetadata)recipientIdMetadata.Checkboxrequired(String required)required.CheckboxrequiredMetadata(PropertyMetadata requiredMetadata)requiredMetadata.CheckboxrequireInitialOnSharedChange(String requireInitialOnSharedChange)requireInitialOnSharedChange.CheckboxrequireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)requireInitialOnSharedChangeMetadata.Checkboxselected(String selected)selected.CheckboxselectedMetadata(PropertyMetadata selectedMetadata)selectedMetadata.CheckboxselectedOriginal(String selectedOriginal)selectedOriginal.CheckboxselectedOriginalMetadata(PropertyMetadata selectedOriginalMetadata)selectedOriginalMetadata.voidsetAnchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)setAnchorAllowWhiteSpaceInCharacters.voidsetAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)setAnchorAllowWhiteSpaceInCharactersMetadata.voidsetAnchorCaseSensitive(String anchorCaseSensitive)setAnchorCaseSensitive.voidsetAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)setAnchorCaseSensitiveMetadata.voidsetAnchorHorizontalAlignment(String anchorHorizontalAlignment)setAnchorHorizontalAlignment.voidsetAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)setAnchorHorizontalAlignmentMetadata.voidsetAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)setAnchorIgnoreIfNotPresent.voidsetAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)setAnchorIgnoreIfNotPresentMetadata.voidsetAnchorMatchWholeWord(String anchorMatchWholeWord)setAnchorMatchWholeWord.voidsetAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)setAnchorMatchWholeWordMetadata.voidsetAnchorString(String anchorString)setAnchorString.voidsetAnchorStringMetadata(PropertyMetadata anchorStringMetadata)setAnchorStringMetadata.voidsetAnchorTabProcessorVersion(String anchorTabProcessorVersion)setAnchorTabProcessorVersion.voidsetAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)setAnchorTabProcessorVersionMetadata.voidsetAnchorUnits(String anchorUnits)setAnchorUnits.voidsetAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)setAnchorUnitsMetadata.voidsetAnchorXOffset(String anchorXOffset)setAnchorXOffset.voidsetAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)setAnchorXOffsetMetadata.voidsetAnchorYOffset(String anchorYOffset)setAnchorYOffset.voidsetAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)setAnchorYOffsetMetadata.voidsetBold(String bold)setBold.voidsetBoldMetadata(PropertyMetadata boldMetadata)setBoldMetadata.voidsetCaption(String caption)setCaption.voidsetCaptionMetadata(PropertyMetadata captionMetadata)setCaptionMetadata.voidsetConditionalParentLabel(String conditionalParentLabel)setConditionalParentLabel.voidsetConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)setConditionalParentLabelMetadata.voidsetConditionalParentValue(String conditionalParentValue)setConditionalParentValue.voidsetConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)setConditionalParentValueMetadata.voidsetCustomTabId(String customTabId)setCustomTabId.voidsetCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)setCustomTabIdMetadata.voidsetDocumentId(String documentId)setDocumentId.voidsetDocumentIdMetadata(PropertyMetadata documentIdMetadata)setDocumentIdMetadata.voidsetErrorDetails(ErrorDetails errorDetails)setErrorDetails.voidsetFont(String font)setFont.voidsetFontColor(String fontColor)setFontColor.voidsetFontColorMetadata(PropertyMetadata fontColorMetadata)setFontColorMetadata.voidsetFontMetadata(PropertyMetadata fontMetadata)setFontMetadata.voidsetFontSize(String fontSize)setFontSize.voidsetFontSizeMetadata(PropertyMetadata fontSizeMetadata)setFontSizeMetadata.voidsetFormOrder(String formOrder)setFormOrder.voidsetFormOrderMetadata(PropertyMetadata formOrderMetadata)setFormOrderMetadata.voidsetFormPageLabel(String formPageLabel)setFormPageLabel.voidsetFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)setFormPageLabelMetadata.voidsetFormPageNumber(String formPageNumber)setFormPageNumber.voidsetFormPageNumberMetadata(PropertyMetadata formPageNumberMetadata)setFormPageNumberMetadata.voidsetHeight(String height)setHeight.voidsetHeightMetadata(PropertyMetadata heightMetadata)setHeightMetadata.voidsetItalic(String italic)setItalic.voidsetItalicMetadata(PropertyMetadata italicMetadata)setItalicMetadata.voidsetLocked(String locked)setLocked.voidsetLockedMetadata(PropertyMetadata lockedMetadata)setLockedMetadata.voidsetMergeField(MergeField mergeField)setMergeField.voidsetMergeFieldXml(String mergeFieldXml)setMergeFieldXml.voidsetName(String name)setName.voidsetNameMetadata(PropertyMetadata nameMetadata)setNameMetadata.voidsetPageNumber(String pageNumber)setPageNumber.voidsetPageNumberMetadata(PropertyMetadata pageNumberMetadata)setPageNumberMetadata.voidsetRecipientId(String recipientId)setRecipientId.voidsetRecipientIdGuid(String recipientIdGuid)setRecipientIdGuid.voidsetRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)setRecipientIdGuidMetadata.voidsetRecipientIdMetadata(PropertyMetadata recipientIdMetadata)setRecipientIdMetadata.voidsetRequired(String required)setRequired.voidsetRequiredMetadata(PropertyMetadata requiredMetadata)setRequiredMetadata.voidsetRequireInitialOnSharedChange(String requireInitialOnSharedChange)setRequireInitialOnSharedChange.voidsetRequireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)setRequireInitialOnSharedChangeMetadata.voidsetSelected(String selected)setSelected.voidsetSelectedMetadata(PropertyMetadata selectedMetadata)setSelectedMetadata.voidsetSelectedOriginal(String selectedOriginal)setSelectedOriginal.voidsetSelectedOriginalMetadata(PropertyMetadata selectedOriginalMetadata)setSelectedOriginalMetadata.voidsetShared(String shared)setShared.voidsetSharedMetadata(PropertyMetadata sharedMetadata)setSharedMetadata.voidsetShareToRecipients(String shareToRecipients)setShareToRecipients.voidsetShareToRecipientsMetadata(PropertyMetadata shareToRecipientsMetadata)setShareToRecipientsMetadata.voidsetSmartContractInformation(SmartContractInformation smartContractInformation)setSmartContractInformation.voidsetSource(String source)setSource.voidsetStatus(String status)setStatus.voidsetStatusMetadata(PropertyMetadata statusMetadata)setStatusMetadata.voidsetTabGroupLabels(List<String> tabGroupLabels)setTabGroupLabels.voidsetTabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)setTabGroupLabelsMetadata.voidsetTabId(String tabId)setTabId.voidsetTabIdMetadata(PropertyMetadata tabIdMetadata)setTabIdMetadata.voidsetTabLabel(String tabLabel)setTabLabel.voidsetTabLabelMetadata(PropertyMetadata tabLabelMetadata)setTabLabelMetadata.voidsetTabOrder(String tabOrder)setTabOrder.voidsetTabOrderMetadata(PropertyMetadata tabOrderMetadata)setTabOrderMetadata.voidsetTabType(String tabType)setTabType.voidsetTabTypeMetadata(PropertyMetadata tabTypeMetadata)setTabTypeMetadata.voidsetTemplateLocked(String templateLocked)setTemplateLocked.voidsetTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)setTemplateLockedMetadata.voidsetTemplateRequired(String templateRequired)setTemplateRequired.voidsetTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)setTemplateRequiredMetadata.voidsetTooltip(String tooltip)setTooltip.voidsetToolTipMetadata(PropertyMetadata toolTipMetadata)setToolTipMetadata.voidsetUnderline(String underline)setUnderline.voidsetUnderlineMetadata(PropertyMetadata underlineMetadata)setUnderlineMetadata.voidsetWidth(String width)setWidth.voidsetWidthMetadata(PropertyMetadata widthMetadata)setWidthMetadata.voidsetXPosition(String xPosition)setXPosition.voidsetXPositionMetadata(PropertyMetadata xPositionMetadata)setXPositionMetadata.voidsetYPosition(String yPosition)setYPosition.voidsetYPositionMetadata(PropertyMetadata yPositionMetadata)setYPositionMetadata.Checkboxshared(String shared)shared.CheckboxsharedMetadata(PropertyMetadata sharedMetadata)sharedMetadata.CheckboxshareToRecipients(String shareToRecipients)shareToRecipients.CheckboxshareToRecipientsMetadata(PropertyMetadata shareToRecipientsMetadata)shareToRecipientsMetadata.CheckboxsmartContractInformation(SmartContractInformation smartContractInformation)smartContractInformation.Checkboxsource(String source)source.Checkboxstatus(String status)status.CheckboxstatusMetadata(PropertyMetadata statusMetadata)statusMetadata.CheckboxtabGroupLabels(List<String> tabGroupLabels)tabGroupLabels.CheckboxtabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)tabGroupLabelsMetadata.CheckboxtabId(String tabId)tabId.CheckboxtabIdMetadata(PropertyMetadata tabIdMetadata)tabIdMetadata.CheckboxtabLabel(String tabLabel)tabLabel.CheckboxtabLabelMetadata(PropertyMetadata tabLabelMetadata)tabLabelMetadata.CheckboxtabOrder(String tabOrder)tabOrder.CheckboxtabOrderMetadata(PropertyMetadata tabOrderMetadata)tabOrderMetadata.CheckboxtabType(String tabType)tabType.CheckboxtabTypeMetadata(PropertyMetadata tabTypeMetadata)tabTypeMetadata.CheckboxtemplateLocked(String templateLocked)templateLocked.CheckboxtemplateLockedMetadata(PropertyMetadata templateLockedMetadata)templateLockedMetadata.CheckboxtemplateRequired(String templateRequired)templateRequired.CheckboxtemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)templateRequiredMetadata.Checkboxtooltip(String tooltip)tooltip.CheckboxtoolTipMetadata(PropertyMetadata toolTipMetadata)toolTipMetadata.StringtoString()Converts the given object to string.Checkboxunderline(String underline)underline.CheckboxunderlineMetadata(PropertyMetadata underlineMetadata)underlineMetadata.Checkboxwidth(String width)width.CheckboxwidthMetadata(PropertyMetadata widthMetadata)widthMetadata.CheckboxxPosition(String xPosition)xPosition.CheckboxxPositionMetadata(PropertyMetadata xPositionMetadata)xPositionMetadata.CheckboxyPosition(String yPosition)yPosition.CheckboxyPositionMetadata(PropertyMetadata yPositionMetadata)yPositionMetadata.
-
-
-
Method Detail
-
anchorAllowWhiteSpaceInCharacters
public Checkbox anchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
anchorAllowWhiteSpaceInCharacters.- Returns:
- Checkbox
-
getAnchorAllowWhiteSpaceInCharacters
public String getAnchorAllowWhiteSpaceInCharacters()
.- Returns:
- anchorAllowWhiteSpaceInCharacters
-
setAnchorAllowWhiteSpaceInCharacters
public void setAnchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
setAnchorAllowWhiteSpaceInCharacters.
-
anchorAllowWhiteSpaceInCharactersMetadata
public Checkbox anchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
anchorAllowWhiteSpaceInCharactersMetadata.- Returns:
- Checkbox
-
getAnchorAllowWhiteSpaceInCharactersMetadata
public PropertyMetadata getAnchorAllowWhiteSpaceInCharactersMetadata()
Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable..- Returns:
- anchorAllowWhiteSpaceInCharactersMetadata
-
setAnchorAllowWhiteSpaceInCharactersMetadata
public void setAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
setAnchorAllowWhiteSpaceInCharactersMetadata.
-
anchorCaseSensitive
public Checkbox anchorCaseSensitive(String anchorCaseSensitive)
anchorCaseSensitive.- Returns:
- Checkbox
-
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 Checkbox anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
anchorCaseSensitiveMetadata.- Returns:
- Checkbox
-
getAnchorCaseSensitiveMetadata
public PropertyMetadata getAnchorCaseSensitiveMetadata()
Metadata that indicates whether the `anchorCaseSensitive` property is editable..- Returns:
- anchorCaseSensitiveMetadata
-
setAnchorCaseSensitiveMetadata
public void setAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
setAnchorCaseSensitiveMetadata.
-
anchorHorizontalAlignment
public Checkbox anchorHorizontalAlignment(String anchorHorizontalAlignment)
anchorHorizontalAlignment.- Returns:
- Checkbox
-
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 Checkbox anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
anchorHorizontalAlignmentMetadata.- Returns:
- Checkbox
-
getAnchorHorizontalAlignmentMetadata
public PropertyMetadata getAnchorHorizontalAlignmentMetadata()
Metadata that indicates whether the `anchorHorizontalAlignment` property is editable..- Returns:
- anchorHorizontalAlignmentMetadata
-
setAnchorHorizontalAlignmentMetadata
public void setAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
setAnchorHorizontalAlignmentMetadata.
-
anchorIgnoreIfNotPresent
public Checkbox anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
anchorIgnoreIfNotPresent.- Returns:
- Checkbox
-
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 Checkbox anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
anchorIgnoreIfNotPresentMetadata.- Returns:
- Checkbox
-
getAnchorIgnoreIfNotPresentMetadata
public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()
Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable..- Returns:
- anchorIgnoreIfNotPresentMetadata
-
setAnchorIgnoreIfNotPresentMetadata
public void setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
setAnchorIgnoreIfNotPresentMetadata.
-
anchorMatchWholeWord
public Checkbox anchorMatchWholeWord(String anchorMatchWholeWord)
anchorMatchWholeWord.- Returns:
- Checkbox
-
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 Checkbox anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
anchorMatchWholeWordMetadata.- Returns:
- Checkbox
-
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 Checkbox anchorStringMetadata(PropertyMetadata anchorStringMetadata)
anchorStringMetadata.- Returns:
- Checkbox
-
getAnchorStringMetadata
public PropertyMetadata getAnchorStringMetadata()
Metadata that indicates whether the `anchorString` property is editable..- Returns:
- anchorStringMetadata
-
setAnchorStringMetadata
public void setAnchorStringMetadata(PropertyMetadata anchorStringMetadata)
setAnchorStringMetadata.
-
anchorTabProcessorVersion
public Checkbox anchorTabProcessorVersion(String anchorTabProcessorVersion)
anchorTabProcessorVersion.- Returns:
- Checkbox
-
getAnchorTabProcessorVersion
public String getAnchorTabProcessorVersion()
.- Returns:
- anchorTabProcessorVersion
-
setAnchorTabProcessorVersion
public void setAnchorTabProcessorVersion(String anchorTabProcessorVersion)
setAnchorTabProcessorVersion.
-
anchorTabProcessorVersionMetadata
public Checkbox anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
anchorTabProcessorVersionMetadata.- Returns:
- Checkbox
-
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 Checkbox anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
anchorUnitsMetadata.- Returns:
- Checkbox
-
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 Checkbox anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
anchorXOffsetMetadata.- Returns:
- Checkbox
-
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 Checkbox anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
anchorYOffsetMetadata.- Returns:
- Checkbox
-
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 Checkbox boldMetadata(PropertyMetadata boldMetadata)
boldMetadata.- Returns:
- Checkbox
-
getBoldMetadata
public PropertyMetadata getBoldMetadata()
Metadata that indicates whether the `bold` property is editable..- Returns:
- boldMetadata
-
setBoldMetadata
public void setBoldMetadata(PropertyMetadata boldMetadata)
setBoldMetadata.
-
getCaption
public String getCaption()
.- Returns:
- caption
-
setCaption
public void setCaption(String caption)
setCaption.
-
captionMetadata
public Checkbox captionMetadata(PropertyMetadata captionMetadata)
captionMetadata.- Returns:
- Checkbox
-
getCaptionMetadata
public PropertyMetadata getCaptionMetadata()
Get captionMetadata.- Returns:
- captionMetadata
-
setCaptionMetadata
public void setCaptionMetadata(PropertyMetadata captionMetadata)
setCaptionMetadata.
-
conditionalParentLabel
public Checkbox conditionalParentLabel(String conditionalParentLabel)
conditionalParentLabel.- Returns:
- Checkbox
-
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 Checkbox conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
conditionalParentLabelMetadata.- Returns:
- Checkbox
-
getConditionalParentLabelMetadata
public PropertyMetadata getConditionalParentLabelMetadata()
Metadata that indicates whether the `conditionalParentLabel` property is editable..- Returns:
- conditionalParentLabelMetadata
-
setConditionalParentLabelMetadata
public void setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
setConditionalParentLabelMetadata.
-
conditionalParentValue
public Checkbox conditionalParentValue(String conditionalParentValue)
conditionalParentValue.- Returns:
- Checkbox
-
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 Checkbox conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
conditionalParentValueMetadata.- Returns:
- Checkbox
-
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 Checkbox customTabIdMetadata(PropertyMetadata customTabIdMetadata)
customTabIdMetadata.- Returns:
- Checkbox
-
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 Checkbox documentIdMetadata(PropertyMetadata documentIdMetadata)
documentIdMetadata.- Returns:
- Checkbox
-
getDocumentIdMetadata
public PropertyMetadata getDocumentIdMetadata()
Metadata that indicates whether the `documentId` property is editable..- Returns:
- documentIdMetadata
-
setDocumentIdMetadata
public void setDocumentIdMetadata(PropertyMetadata documentIdMetadata)
setDocumentIdMetadata.
-
errorDetails
public Checkbox errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- Checkbox
-
getErrorDetails
public ErrorDetails getErrorDetails()
This object describes errors that occur. It is only valid for responses and ignored in requests..- 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 Checkbox fontColorMetadata(PropertyMetadata fontColorMetadata)
fontColorMetadata.- Returns:
- Checkbox
-
getFontColorMetadata
public PropertyMetadata getFontColorMetadata()
Metadata that indicates whether the `fontColor` property is editable..- Returns:
- fontColorMetadata
-
setFontColorMetadata
public void setFontColorMetadata(PropertyMetadata fontColorMetadata)
setFontColorMetadata.
-
fontMetadata
public Checkbox fontMetadata(PropertyMetadata fontMetadata)
fontMetadata.- Returns:
- Checkbox
-
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 Checkbox fontSizeMetadata(PropertyMetadata fontSizeMetadata)
fontSizeMetadata.- Returns:
- Checkbox
-
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 Checkbox formOrderMetadata(PropertyMetadata formOrderMetadata)
formOrderMetadata.- Returns:
- Checkbox
-
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 Checkbox formPageLabelMetadata(PropertyMetadata formPageLabelMetadata)
formPageLabelMetadata.- Returns:
- Checkbox
-
getFormPageLabelMetadata
public PropertyMetadata getFormPageLabelMetadata()
Metadata that indicates whether the `formPageLabel` property is editable..- Returns:
- formPageLabelMetadata
-
setFormPageLabelMetadata
public void setFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)
setFormPageLabelMetadata.
-
formPageNumber
public Checkbox formPageNumber(String formPageNumber)
formPageNumber.- Returns:
- Checkbox
-
getFormPageNumber
public String getFormPageNumber()
.- Returns:
- formPageNumber
-
setFormPageNumber
public void setFormPageNumber(String formPageNumber)
setFormPageNumber.
-
formPageNumberMetadata
public Checkbox formPageNumberMetadata(PropertyMetadata formPageNumberMetadata)
formPageNumberMetadata.- Returns:
- Checkbox
-
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 Checkbox heightMetadata(PropertyMetadata heightMetadata)
heightMetadata.- Returns:
- Checkbox
-
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 Checkbox italicMetadata(PropertyMetadata italicMetadata)
italicMetadata.- Returns:
- Checkbox
-
getItalicMetadata
public PropertyMetadata getItalicMetadata()
Metadata that indicates whether the `italic` property is editable..- Returns:
- italicMetadata
-
setItalicMetadata
public void setItalicMetadata(PropertyMetadata italicMetadata)
setItalicMetadata.
-
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.
-
lockedMetadata
public Checkbox lockedMetadata(PropertyMetadata lockedMetadata)
lockedMetadata.- Returns:
- Checkbox
-
getLockedMetadata
public PropertyMetadata getLockedMetadata()
Metadata that indicates whether the `locked` property is editable..- Returns:
- lockedMetadata
-
setLockedMetadata
public void setLockedMetadata(PropertyMetadata lockedMetadata)
setLockedMetadata.
-
mergeField
public Checkbox mergeField(MergeField mergeField)
mergeField.- Returns:
- Checkbox
-
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.
-
getName
public String getName()
Specifies the tool tip text for the tab..- Returns:
- name
-
setName
public void setName(String name)
setName.
-
nameMetadata
public Checkbox nameMetadata(PropertyMetadata nameMetadata)
nameMetadata.- Returns:
- Checkbox
-
getNameMetadata
public PropertyMetadata getNameMetadata()
Metadata that indicates whether the `name` property is editable. This property is read-only..- Returns:
- nameMetadata
-
setNameMetadata
public void setNameMetadata(PropertyMetadata nameMetadata)
setNameMetadata.
-
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 Checkbox pageNumberMetadata(PropertyMetadata pageNumberMetadata)
pageNumberMetadata.- Returns:
- Checkbox
-
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.
-
recipientIdGuid
public Checkbox recipientIdGuid(String recipientIdGuid)
recipientIdGuid.- Returns:
- Checkbox
-
getRecipientIdGuid
public String getRecipientIdGuid()
.- Returns:
- recipientIdGuid
-
setRecipientIdGuid
public void setRecipientIdGuid(String recipientIdGuid)
setRecipientIdGuid.
-
recipientIdGuidMetadata
public Checkbox recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
recipientIdGuidMetadata.- Returns:
- Checkbox
-
getRecipientIdGuidMetadata
public PropertyMetadata getRecipientIdGuidMetadata()
Metadata that indicates whether the `recipientIdGuid` property is editable..- Returns:
- recipientIdGuidMetadata
-
setRecipientIdGuidMetadata
public void setRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
setRecipientIdGuidMetadata.
-
recipientIdMetadata
public Checkbox recipientIdMetadata(PropertyMetadata recipientIdMetadata)
recipientIdMetadata.- Returns:
- Checkbox
-
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 Checkbox requiredMetadata(PropertyMetadata requiredMetadata)
requiredMetadata.- Returns:
- Checkbox
-
getRequiredMetadata
public PropertyMetadata getRequiredMetadata()
Metadata that indicates whether the `required` property is editable..- Returns:
- requiredMetadata
-
setRequiredMetadata
public void setRequiredMetadata(PropertyMetadata requiredMetadata)
setRequiredMetadata.
-
requireInitialOnSharedChange
public Checkbox requireInitialOnSharedChange(String requireInitialOnSharedChange)
requireInitialOnSharedChange.- Returns:
- Checkbox
-
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 Checkbox requireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)
requireInitialOnSharedChangeMetadata.- Returns:
- Checkbox
-
getRequireInitialOnSharedChangeMetadata
public PropertyMetadata getRequireInitialOnSharedChangeMetadata()
Metadata that indicates whether the `requireInitialOnSharedChange` property is editable..- Returns:
- requireInitialOnSharedChangeMetadata
-
setRequireInitialOnSharedChangeMetadata
public void setRequireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)
setRequireInitialOnSharedChangeMetadata.
-
getSelected
public String getSelected()
When set to **true**, the checkbox is selected..- Returns:
- selected
-
setSelected
public void setSelected(String selected)
setSelected.
-
selectedMetadata
public Checkbox selectedMetadata(PropertyMetadata selectedMetadata)
selectedMetadata.- Returns:
- Checkbox
-
getSelectedMetadata
public PropertyMetadata getSelectedMetadata()
Metadata that indicates whether the `selected` property is editable..- Returns:
- selectedMetadata
-
setSelectedMetadata
public void setSelectedMetadata(PropertyMetadata selectedMetadata)
setSelectedMetadata.
-
selectedOriginal
public Checkbox selectedOriginal(String selectedOriginal)
selectedOriginal.- Returns:
- Checkbox
-
getSelectedOriginal
public String getSelectedOriginal()
.- Returns:
- selectedOriginal
-
setSelectedOriginal
public void setSelectedOriginal(String selectedOriginal)
setSelectedOriginal.
-
selectedOriginalMetadata
public Checkbox selectedOriginalMetadata(PropertyMetadata selectedOriginalMetadata)
selectedOriginalMetadata.- Returns:
- Checkbox
-
getSelectedOriginalMetadata
public PropertyMetadata getSelectedOriginalMetadata()
.- Returns:
- selectedOriginalMetadata
-
setSelectedOriginalMetadata
public void setSelectedOriginalMetadata(PropertyMetadata selectedOriginalMetadata)
setSelectedOriginalMetadata.
-
getShared
public String getShared()
When set to **true**, this custom tab is shared..- Returns:
- shared
-
setShared
public void setShared(String shared)
setShared.
-
sharedMetadata
public Checkbox sharedMetadata(PropertyMetadata sharedMetadata)
sharedMetadata.- Returns:
- Checkbox
-
getSharedMetadata
public PropertyMetadata getSharedMetadata()
Metadata that indicates whether the `shared` property is editable. .- Returns:
- sharedMetadata
-
setSharedMetadata
public void setSharedMetadata(PropertyMetadata sharedMetadata)
setSharedMetadata.
-
shareToRecipients
public Checkbox shareToRecipients(String shareToRecipients)
shareToRecipients.- Returns:
- Checkbox
-
getShareToRecipients
public String getShareToRecipients()
.- Returns:
- shareToRecipients
-
setShareToRecipients
public void setShareToRecipients(String shareToRecipients)
setShareToRecipients.
-
shareToRecipientsMetadata
public Checkbox shareToRecipientsMetadata(PropertyMetadata shareToRecipientsMetadata)
shareToRecipientsMetadata.- Returns:
- Checkbox
-
getShareToRecipientsMetadata
public PropertyMetadata getShareToRecipientsMetadata()
Reserved for DocuSign..- Returns:
- shareToRecipientsMetadata
-
setShareToRecipientsMetadata
public void setShareToRecipientsMetadata(PropertyMetadata shareToRecipientsMetadata)
setShareToRecipientsMetadata.
-
smartContractInformation
public Checkbox smartContractInformation(SmartContractInformation smartContractInformation)
smartContractInformation.- Returns:
- Checkbox
-
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 Checkbox statusMetadata(PropertyMetadata statusMetadata)
statusMetadata.- Returns:
- Checkbox
-
getStatusMetadata
public PropertyMetadata getStatusMetadata()
Metadata that indicates whether the `status` property is editable..- Returns:
- statusMetadata
-
setStatusMetadata
public void setStatusMetadata(PropertyMetadata statusMetadata)
setStatusMetadata.
-
tabGroupLabels
public Checkbox tabGroupLabels(List<String> tabGroupLabels)
tabGroupLabels.- Returns:
- Checkbox
-
addTabGroupLabelsItem
public Checkbox addTabGroupLabelsItem(String tabGroupLabelsItem)
addTabGroupLabelsItem.- Returns:
- Checkbox
-
tabGroupLabelsMetadata
public Checkbox tabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)
tabGroupLabelsMetadata.- Returns:
- Checkbox
-
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 Checkbox tabIdMetadata(PropertyMetadata tabIdMetadata)
tabIdMetadata.- Returns:
- Checkbox
-
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 Checkbox tabLabelMetadata(PropertyMetadata tabLabelMetadata)
tabLabelMetadata.- Returns:
- Checkbox
-
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 Checkbox tabOrderMetadata(PropertyMetadata tabOrderMetadata)
tabOrderMetadata.- Returns:
- Checkbox
-
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 Checkbox tabTypeMetadata(PropertyMetadata tabTypeMetadata)
tabTypeMetadata.- Returns:
- Checkbox
-
getTabTypeMetadata
public PropertyMetadata getTabTypeMetadata()
Metadata that indicates whether the `tabType` property is editable..- Returns:
- tabTypeMetadata
-
setTabTypeMetadata
public void setTabTypeMetadata(PropertyMetadata tabTypeMetadata)
setTabTypeMetadata.
-
templateLocked
public Checkbox templateLocked(String templateLocked)
templateLocked.- Returns:
- Checkbox
-
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 Checkbox templateLockedMetadata(PropertyMetadata templateLockedMetadata)
templateLockedMetadata.- Returns:
- Checkbox
-
getTemplateLockedMetadata
public PropertyMetadata getTemplateLockedMetadata()
Metadata that indicates whether the `templateLocked` property is editable..- Returns:
- templateLockedMetadata
-
setTemplateLockedMetadata
public void setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)
setTemplateLockedMetadata.
-
templateRequired
public Checkbox templateRequired(String templateRequired)
templateRequired.- Returns:
- Checkbox
-
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 Checkbox templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
templateRequiredMetadata.- Returns:
- Checkbox
-
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 Checkbox toolTipMetadata(PropertyMetadata toolTipMetadata)
toolTipMetadata.- Returns:
- Checkbox
-
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 Checkbox underlineMetadata(PropertyMetadata underlineMetadata)
underlineMetadata.- Returns:
- Checkbox
-
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 Checkbox widthMetadata(PropertyMetadata widthMetadata)
widthMetadata.- Returns:
- Checkbox
-
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 Checkbox xPositionMetadata(PropertyMetadata xPositionMetadata)
xPositionMetadata.- Returns:
- Checkbox
-
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 Checkbox yPositionMetadata(PropertyMetadata yPositionMetadata)
yPositionMetadata.- Returns:
- Checkbox
-
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.
-
-