java.lang.Object
- com.docusign.esign.model.TabMetadata

All Implemented Interfaces:

Serializable
```
public class TabMetadata
extends Object
implements Serializable
```
TabMetadata.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

TabMetadata()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TabMetadata`	`addItemsItem(String itemsItem)`	addItemsItem.
`TabMetadata`	`anchor(String anchor)`	anchor.
`TabMetadata`	`anchorCaseSensitive(String anchorCaseSensitive)`	anchorCaseSensitive.
`TabMetadata`	`anchorHorizontalAlignment(String anchorHorizontalAlignment)`	anchorHorizontalAlignment.
`TabMetadata`	`anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)`	anchorIgnoreIfNotPresent.
`TabMetadata`	`anchorMatchWholeWord(String anchorMatchWholeWord)`	anchorMatchWholeWord.
`TabMetadata`	`anchorUnits(String anchorUnits)`	anchorUnits.
`TabMetadata`	`anchorXOffset(String anchorXOffset)`	anchorXOffset.
`TabMetadata`	`anchorYOffset(String anchorYOffset)`	anchorYOffset.
`TabMetadata`	`bold(String bold)`	bold.
`TabMetadata`	`collaborative(String collaborative)`	collaborative.
`TabMetadata`	`concealValueOnDocument(String concealValueOnDocument)`	concealValueOnDocument.
`TabMetadata`	`createdByDisplayName(String createdByDisplayName)`	createdByDisplayName.
`TabMetadata`	`createdByUserId(String createdByUserId)`	createdByUserId.
`TabMetadata`	`customTabId(String customTabId)`	customTabId.
`TabMetadata`	`disableAutoSize(String disableAutoSize)`	disableAutoSize.
`TabMetadata`	`editable(String editable)`	editable.
`boolean`	`equals(Object o)`	Compares objects.
`TabMetadata`	`font(String font)`	font.
`TabMetadata`	`fontColor(String fontColor)`	fontColor.
`TabMetadata`	`fontSize(String fontSize)`	fontSize.
`String`	`getAnchor()`	An optional string that is used to auto-match tabs to strings located in the documents of an envelope..
`String`	`getAnchorCaseSensitive()`	When set to true, the anchor string does not consider case when matching strings in the document.
`String`	`getAnchorHorizontalAlignment()`	Specifies the alignment of anchor tabs with anchor strings.
`String`	`getAnchorIgnoreIfNotPresent()`	When set to true, this tab is ignored if anchorString is not found in the document..
`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..
`String`	`getAnchorUnits()`	Specifies units of the X and Y offset.
`String`	`getAnchorXOffset()`	Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString..
`String`	`getAnchorYOffset()`	Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString..
`String`	`getBold()`	When set to true, the information in the tab is bold..
`String`	`getCollaborative()`	.
`String`	`getConcealValueOnDocument()`	When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.
`String`	`getCreatedByDisplayName()`	The user name of the DocuSign user who created this object..
`String`	`getCreatedByUserId()`	The userId of the DocuSign user who created this object..
`String`	`getCustomTabId()`	The DocuSign generated custom tab ID for the custom tab to be applied.
`String`	`getDisableAutoSize()`	When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data.
`String`	`getEditable()`	When set to true, the custom tab is editable.
`String`	`getFont()`	The font to be used for the tab value.
`String`	`getFontColor()`	The font color used for the information in the tab.
`String`	`getFontSize()`	The font size used for the information in the tab.
`String`	`getHeight()`	Height of the tab in pixels..
`String`	`getIncludedInEmail()`	When set to true, the tab is included in e-mails related to the envelope on which it exists.
`String`	`getInitialValue()`	The original value of the tab..
`String`	`getItalic()`	When set to true, the information in the tab is italic..
`List<String>`	`getItems()`	If the tab is a list, this represents the values that are possible for the tab..
`String`	`getLastModified()`	The UTC DateTime this object was last modified.
`String`	`getLastModifiedByDisplayName()`	The User Name of the DocuSign user who last modified this object..
`String`	`getLastModifiedByUserId()`	The userId of the DocuSign user who last modified this object..
`LocalePolicyTab`	`getLocalePolicy()`	Reserved for DocuSign..
`String`	`getLocked()`	When set to true, the signer cannot change the data of the custom tab..
`String`	`getMaximumLength()`	The maximum number of entry characters supported by the custom tab..
`String`	`getMaxNumericalValue()`	.
`MergeField`	`getMergeField()`	Contains the information necessary to map the tab to a field in SalesForce..
`String`	`getMinNumericalValue()`	.
`String`	`getName()`	.
`String`	`getNumericalValue()`	.
`String`	`getPaymentItemCode()`	.
`String`	`getPaymentItemDescription()`	.
`String`	`getPaymentItemName()`	.
`String`	`getRequireAll()`	When set to true and shared is true, information must be entered in this field to complete the envelope.
`String`	`getRequired()`	When set to true, the signer is required to fill out this tab.
`String`	`getRequireInitialOnSharedChange()`	Optional element for field markup.
`String`	`getScaleValue()`	.
`String`	`getSelected()`	.
`String`	`getShared()`	When set to true, this custom tab is shared..
`String`	`getSignatureProviderId()`	.
`String`	`getStampType()`	.
`PropertyMetadata`	`getStampTypeMetadata()`	Metadata that indicates whether the `stampType` property is editable..
`String`	`getTabLabel()`	The label string associated with the tab..
`String`	`getType()`	The type of this tab.
`String`	`getUnderline()`	When set to true, the information in the tab is underlined..
`String`	`getValidationMessage()`	The message displayed if the custom tab fails input validation (either custom of embedded)..
`String`	`getValidationPattern()`	A regular expression used to validate input for the tab..
`String`	`getValidationType()`	.
`String`	`getWidth()`	Width of the tab in pixels..
`int`	`hashCode()`	Returns the HashCode.
`TabMetadata`	`height(String height)`	height.
`TabMetadata`	`includedInEmail(String includedInEmail)`	includedInEmail.
`TabMetadata`	`initialValue(String initialValue)`	initialValue.
`TabMetadata`	`italic(String italic)`	italic.
`TabMetadata`	`items(List<String> items)`	items.
`TabMetadata`	`lastModified(String lastModified)`	lastModified.
`TabMetadata`	`lastModifiedByDisplayName(String lastModifiedByDisplayName)`	lastModifiedByDisplayName.
`TabMetadata`	`lastModifiedByUserId(String lastModifiedByUserId)`	lastModifiedByUserId.
`TabMetadata`	`localePolicy(LocalePolicyTab localePolicy)`	localePolicy.
`TabMetadata`	`locked(String locked)`	locked.
`TabMetadata`	`maximumLength(String maximumLength)`	maximumLength.
`TabMetadata`	`maxNumericalValue(String maxNumericalValue)`	maxNumericalValue.
`TabMetadata`	`mergeField(MergeField mergeField)`	mergeField.
`TabMetadata`	`minNumericalValue(String minNumericalValue)`	minNumericalValue.
`TabMetadata`	`name(String name)`	name.
`TabMetadata`	`numericalValue(String numericalValue)`	numericalValue.
`TabMetadata`	`paymentItemCode(String paymentItemCode)`	paymentItemCode.
`TabMetadata`	`paymentItemDescription(String paymentItemDescription)`	paymentItemDescription.
`TabMetadata`	`paymentItemName(String paymentItemName)`	paymentItemName.
`TabMetadata`	`requireAll(String requireAll)`	requireAll.
`TabMetadata`	`required(String required)`	required.
`TabMetadata`	`requireInitialOnSharedChange(String requireInitialOnSharedChange)`	requireInitialOnSharedChange.
`TabMetadata`	`scaleValue(String scaleValue)`	scaleValue.
`TabMetadata`	`selected(String selected)`	selected.
`void`	`setAnchor(String anchor)`	setAnchor.
`void`	`setAnchorCaseSensitive(String anchorCaseSensitive)`	setAnchorCaseSensitive.
`void`	`setAnchorHorizontalAlignment(String anchorHorizontalAlignment)`	setAnchorHorizontalAlignment.
`void`	`setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)`	setAnchorIgnoreIfNotPresent.
`void`	`setAnchorMatchWholeWord(String anchorMatchWholeWord)`	setAnchorMatchWholeWord.
`void`	`setAnchorUnits(String anchorUnits)`	setAnchorUnits.
`void`	`setAnchorXOffset(String anchorXOffset)`	setAnchorXOffset.
`void`	`setAnchorYOffset(String anchorYOffset)`	setAnchorYOffset.
`void`	`setBold(String bold)`	setBold.
`void`	`setCollaborative(String collaborative)`	setCollaborative.
`void`	`setConcealValueOnDocument(String concealValueOnDocument)`	setConcealValueOnDocument.
`void`	`setCreatedByDisplayName(String createdByDisplayName)`	setCreatedByDisplayName.
`void`	`setCreatedByUserId(String createdByUserId)`	setCreatedByUserId.
`void`	`setCustomTabId(String customTabId)`	setCustomTabId.
`void`	`setDisableAutoSize(String disableAutoSize)`	setDisableAutoSize.
`void`	`setEditable(String editable)`	setEditable.
`void`	`setFont(String font)`	setFont.
`void`	`setFontColor(String fontColor)`	setFontColor.
`void`	`setFontSize(String fontSize)`	setFontSize.
`void`	`setHeight(String height)`	setHeight.
`void`	`setIncludedInEmail(String includedInEmail)`	setIncludedInEmail.
`void`	`setInitialValue(String initialValue)`	setInitialValue.
`void`	`setItalic(String italic)`	setItalic.
`void`	`setItems(List<String> items)`	setItems.
`void`	`setLastModified(String lastModified)`	setLastModified.
`void`	`setLastModifiedByDisplayName(String lastModifiedByDisplayName)`	setLastModifiedByDisplayName.
`void`	`setLastModifiedByUserId(String lastModifiedByUserId)`	setLastModifiedByUserId.
`void`	`setLocalePolicy(LocalePolicyTab localePolicy)`	setLocalePolicy.
`void`	`setLocked(String locked)`	setLocked.
`void`	`setMaximumLength(String maximumLength)`	setMaximumLength.
`void`	`setMaxNumericalValue(String maxNumericalValue)`	setMaxNumericalValue.
`void`	`setMergeField(MergeField mergeField)`	setMergeField.
`void`	`setMinNumericalValue(String minNumericalValue)`	setMinNumericalValue.
`void`	`setName(String name)`	setName.
`void`	`setNumericalValue(String numericalValue)`	setNumericalValue.
`void`	`setPaymentItemCode(String paymentItemCode)`	setPaymentItemCode.
`void`	`setPaymentItemDescription(String paymentItemDescription)`	setPaymentItemDescription.
`void`	`setPaymentItemName(String paymentItemName)`	setPaymentItemName.
`void`	`setRequireAll(String requireAll)`	setRequireAll.
`void`	`setRequired(String required)`	setRequired.
`void`	`setRequireInitialOnSharedChange(String requireInitialOnSharedChange)`	setRequireInitialOnSharedChange.
`void`	`setScaleValue(String scaleValue)`	setScaleValue.
`void`	`setSelected(String selected)`	setSelected.
`void`	`setShared(String shared)`	setShared.
`void`	`setSignatureProviderId(String signatureProviderId)`	setSignatureProviderId.
`void`	`setStampType(String stampType)`	setStampType.
`void`	`setStampTypeMetadata(PropertyMetadata stampTypeMetadata)`	setStampTypeMetadata.
`void`	`setTabLabel(String tabLabel)`	setTabLabel.
`void`	`setType(String type)`	setType.
`void`	`setUnderline(String underline)`	setUnderline.
`void`	`setValidationMessage(String validationMessage)`	setValidationMessage.
`void`	`setValidationPattern(String validationPattern)`	setValidationPattern.
`void`	`setValidationType(String validationType)`	setValidationType.
`void`	`setWidth(String width)`	setWidth.
`TabMetadata`	`shared(String shared)`	shared.
`TabMetadata`	`signatureProviderId(String signatureProviderId)`	signatureProviderId.
`TabMetadata`	`stampType(String stampType)`	stampType.
`TabMetadata`	`stampTypeMetadata(PropertyMetadata stampTypeMetadata)`	stampTypeMetadata.
`TabMetadata`	`tabLabel(String tabLabel)`	tabLabel.
`String`	`toString()`	Converts the given object to string.
`TabMetadata`	`type(String type)`	type.
`TabMetadata`	`underline(String underline)`	underline.
`TabMetadata`	`validationMessage(String validationMessage)`	validationMessage.
`TabMetadata`	`validationPattern(String validationPattern)`	validationPattern.
`TabMetadata`	`validationType(String validationType)`	validationType.
`TabMetadata`	`width(String width)`	width.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TabMetadata
```
public TabMetadata()
```
- Method Detail
  - anchor
```
public TabMetadata anchor(String anchor)
```
    anchor.
    
    Returns:
    
    TabMetadata
  - getAnchor
```
public String getAnchor()
```
    An optional string that is used to auto-match tabs to strings located in the documents of an envelope..
    
    Returns:
    
    anchor
  - setAnchor
```
public void setAnchor(String anchor)
```
    setAnchor.
  - anchorCaseSensitive
```
public TabMetadata anchorCaseSensitive(String anchorCaseSensitive)
```
    anchorCaseSensitive.
    
    Returns:
    
    TabMetadata
  - getAnchorCaseSensitive
```
public String getAnchorCaseSensitive()
```
    When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**..
    
    Returns:
    
    anchorCaseSensitive
  - setAnchorCaseSensitive
```
public void setAnchorCaseSensitive(String anchorCaseSensitive)
```
    setAnchorCaseSensitive.
  - anchorHorizontalAlignment
```
public TabMetadata anchorHorizontalAlignment(String anchorHorizontalAlignment)
```
    anchorHorizontalAlignment.
    
    Returns:
    
    TabMetadata
  - getAnchorHorizontalAlignment
```
public String getAnchorHorizontalAlignment()
```
    Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**..
    
    Returns:
    
    anchorHorizontalAlignment
  - setAnchorHorizontalAlignment
```
public void setAnchorHorizontalAlignment(String anchorHorizontalAlignment)
```
    setAnchorHorizontalAlignment.
  - anchorIgnoreIfNotPresent
```
public TabMetadata anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
```
    anchorIgnoreIfNotPresent.
    
    Returns:
    
    TabMetadata
  - getAnchorIgnoreIfNotPresent
```
public String getAnchorIgnoreIfNotPresent()
```
    When set to **true**, this tab is ignored if anchorString is not found in the document..
    
    Returns:
    
    anchorIgnoreIfNotPresent
  - setAnchorIgnoreIfNotPresent
```
public void setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
```
    setAnchorIgnoreIfNotPresent.
  - anchorMatchWholeWord
```
public TabMetadata anchorMatchWholeWord(String anchorMatchWholeWord)
```
    anchorMatchWholeWord.
    
    Returns:
    
    TabMetadata
  - 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.
  - anchorUnits
```
public TabMetadata anchorUnits(String anchorUnits)
```
    anchorUnits.
    
    Returns:
    
    TabMetadata
  - getAnchorUnits
```
public String getAnchorUnits()
```
    Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches..
    
    Returns:
    
    anchorUnits
  - setAnchorUnits
```
public void setAnchorUnits(String anchorUnits)
```
    setAnchorUnits.
  - anchorXOffset
```
public TabMetadata anchorXOffset(String anchorXOffset)
```
    anchorXOffset.
    
    Returns:
    
    TabMetadata
  - getAnchorXOffset
```
public String getAnchorXOffset()
```
    Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString..
    
    Returns:
    
    anchorXOffset
  - setAnchorXOffset
```
public void setAnchorXOffset(String anchorXOffset)
```
    setAnchorXOffset.
  - anchorYOffset
```
public TabMetadata anchorYOffset(String anchorYOffset)
```
    anchorYOffset.
    
    Returns:
    
    TabMetadata
  - 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.
  - bold
```
public TabMetadata bold(String bold)
```
    bold.
    
    Returns:
    
    TabMetadata
  - getBold
```
public String getBold()
```
    When set to **true**, the information in the tab is bold..
    
    Returns:
    
    bold
  - setBold
```
public void setBold(String bold)
```
    setBold.
  - collaborative
```
public TabMetadata collaborative(String collaborative)
```
    collaborative.
    
    Returns:
    
    TabMetadata
  - getCollaborative
```
public String getCollaborative()
```
    .
    
    Returns:
    
    collaborative
  - setCollaborative
```
public void setCollaborative(String collaborative)
```
    setCollaborative.
  - concealValueOnDocument
```
public TabMetadata concealValueOnDocument(String concealValueOnDocument)
```
    concealValueOnDocument.
    
    Returns:
    
    TabMetadata
  - getConcealValueOnDocument
```
public String getConcealValueOnDocument()
```
    When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes..
    
    Returns:
    
    concealValueOnDocument
  - setConcealValueOnDocument
```
public void setConcealValueOnDocument(String concealValueOnDocument)
```
    setConcealValueOnDocument.
  - createdByDisplayName
```
public TabMetadata createdByDisplayName(String createdByDisplayName)
```
    createdByDisplayName.
    
    Returns:
    
    TabMetadata
  - getCreatedByDisplayName
```
public String getCreatedByDisplayName()
```
    The user name of the DocuSign user who created this object..
    
    Returns:
    
    createdByDisplayName
  - setCreatedByDisplayName
```
public void setCreatedByDisplayName(String createdByDisplayName)
```
    setCreatedByDisplayName.
  - createdByUserId
```
public TabMetadata createdByUserId(String createdByUserId)
```
    createdByUserId.
    
    Returns:
    
    TabMetadata
  - getCreatedByUserId
```
public String getCreatedByUserId()
```
    The userId of the DocuSign user who created this object..
    
    Returns:
    
    createdByUserId
  - setCreatedByUserId
```
public void setCreatedByUserId(String createdByUserId)
```
    setCreatedByUserId.
  - customTabId
```
public TabMetadata customTabId(String customTabId)
```
    customTabId.
    
    Returns:
    
    TabMetadata
  - getCustomTabId
```
public String getCustomTabId()
```
    The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties..
    
    Returns:
    
    customTabId
  - setCustomTabId
```
public void setCustomTabId(String customTabId)
```
    setCustomTabId.
  - disableAutoSize
```
public TabMetadata disableAutoSize(String disableAutoSize)
```
    disableAutoSize.
    
    Returns:
    
    TabMetadata
  - getDisableAutoSize
```
public String getDisableAutoSize()
```
    When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes..
    
    Returns:
    
    disableAutoSize
  - setDisableAutoSize
```
public void setDisableAutoSize(String disableAutoSize)
```
    setDisableAutoSize.
  - editable
```
public TabMetadata editable(String editable)
```
    editable.
    
    Returns:
    
    TabMetadata
  - getEditable
```
public String getEditable()
```
    When set to **true**, the custom tab is editable. Otherwise the custom tab cannot be modified..
    
    Returns:
    
    editable
  - setEditable
```
public void setEditable(String editable)
```
    setEditable.
  - font
```
public TabMetadata font(String font)
```
    font.
    
    Returns:
    
    TabMetadata
  - getFont
```
public String getFont()
```
    The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default..
    
    Returns:
    
    font
  - setFont
```
public void setFont(String font)
```
    setFont.
  - fontColor
```
public TabMetadata fontColor(String fontColor)
```
    fontColor.
    
    Returns:
    
    TabMetadata
  - getFontColor
```
public String getFontColor()
```
    The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White..
    
    Returns:
    
    fontColor
  - setFontColor
```
public void setFontColor(String fontColor)
```
    setFontColor.
  - fontSize
```
public TabMetadata fontSize(String fontSize)
```
    fontSize.
    
    Returns:
    
    TabMetadata
  - 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.
  - height
```
public TabMetadata height(String height)
```
    height.
    
    Returns:
    
    TabMetadata
  - getHeight
```
public String getHeight()
```
    Height of the tab in pixels..
    
    Returns:
    
    height
  - setHeight
```
public void setHeight(String height)
```
    setHeight.
  - includedInEmail
```
public TabMetadata includedInEmail(String includedInEmail)
```
    includedInEmail.
    
    Returns:
    
    TabMetadata
  - getIncludedInEmail
```
public String getIncludedInEmail()
```
    When set to **true**, the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs..
    
    Returns:
    
    includedInEmail
  - setIncludedInEmail
```
public void setIncludedInEmail(String includedInEmail)
```
    setIncludedInEmail.
  - initialValue
```
public TabMetadata initialValue(String initialValue)
```
    initialValue.
    
    Returns:
    
    TabMetadata
  - getInitialValue
```
public String getInitialValue()
```
    The original value of the tab..
    
    Returns:
    
    initialValue
  - setInitialValue
```
public void setInitialValue(String initialValue)
```
    setInitialValue.
  - italic
```
public TabMetadata italic(String italic)
```
    italic.
    
    Returns:
    
    TabMetadata
  - getItalic
```
public String getItalic()
```
    When set to **true**, the information in the tab is italic..
    
    Returns:
    
    italic
  - setItalic
```
public void setItalic(String italic)
```
    setItalic.
  - items
```
public TabMetadata items(List<String> items)
```
    items.
    
    Returns:
    
    TabMetadata
  - addItemsItem
```
public TabMetadata addItemsItem(String itemsItem)
```
    addItemsItem.
    
    Returns:
    
    TabMetadata
  - getItems
```
public List<String> getItems()
```
    If the tab is a list, this represents the values that are possible for the tab..
    
    Returns:
    
    items
  - setItems
```
public void setItems(List<String> items)
```
    setItems.
  - lastModified
```
public TabMetadata lastModified(String lastModified)
```
    lastModified.
    
    Returns:
    
    TabMetadata
  - getLastModified
```
public String getLastModified()
```
    The UTC DateTime this object was last modified. This is in ISO8601 format..
    
    Returns:
    
    lastModified
  - setLastModified
```
public void setLastModified(String lastModified)
```
    setLastModified.
  - lastModifiedByDisplayName
```
public TabMetadata lastModifiedByDisplayName(String lastModifiedByDisplayName)
```
    lastModifiedByDisplayName.
    
    Returns:
    
    TabMetadata
  - getLastModifiedByDisplayName
```
public String getLastModifiedByDisplayName()
```
    The User Name of the DocuSign user who last modified this object..
    
    Returns:
    
    lastModifiedByDisplayName
  - setLastModifiedByDisplayName
```
public void setLastModifiedByDisplayName(String lastModifiedByDisplayName)
```
    setLastModifiedByDisplayName.
  - lastModifiedByUserId
```
public TabMetadata lastModifiedByUserId(String lastModifiedByUserId)
```
    lastModifiedByUserId.
    
    Returns:
    
    TabMetadata
  - getLastModifiedByUserId
```
public String getLastModifiedByUserId()
```
    The userId of the DocuSign user who last modified this object..
    
    Returns:
    
    lastModifiedByUserId
  - setLastModifiedByUserId
```
public void setLastModifiedByUserId(String lastModifiedByUserId)
```
    setLastModifiedByUserId.
  - localePolicy
```
public TabMetadata localePolicy(LocalePolicyTab localePolicy)
```
    localePolicy.
    
    Returns:
    
    TabMetadata
  - getLocalePolicy
```
public LocalePolicyTab getLocalePolicy()
```
    Reserved for DocuSign..
    
    Returns:
    
    localePolicy
  - setLocalePolicy
```
public void setLocalePolicy(LocalePolicyTab localePolicy)
```
    setLocalePolicy.
  - locked
```
public TabMetadata locked(String locked)
```
    locked.
    
    Returns:
    
    TabMetadata
  - 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.
  - maximumLength
```
public TabMetadata maximumLength(String maximumLength)
```
    maximumLength.
    
    Returns:
    
    TabMetadata
  - getMaximumLength
```
public String getMaximumLength()
```
    The maximum number of entry characters supported by the custom tab..
    
    Returns:
    
    maximumLength
  - setMaximumLength
```
public void setMaximumLength(String maximumLength)
```
    setMaximumLength.
  - maxNumericalValue
```
public TabMetadata maxNumericalValue(String maxNumericalValue)
```
    maxNumericalValue.
    
    Returns:
    
    TabMetadata
  - getMaxNumericalValue
```
public String getMaxNumericalValue()
```
    .
    
    Returns:
    
    maxNumericalValue
  - setMaxNumericalValue
```
public void setMaxNumericalValue(String maxNumericalValue)
```
    setMaxNumericalValue.
  - mergeField
```
public TabMetadata mergeField(MergeField mergeField)
```
    mergeField.
    
    Returns:
    
    TabMetadata
  - 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.
  - minNumericalValue
```
public TabMetadata minNumericalValue(String minNumericalValue)
```
    minNumericalValue.
    
    Returns:
    
    TabMetadata
  - getMinNumericalValue
```
public String getMinNumericalValue()
```
    .
    
    Returns:
    
    minNumericalValue
  - setMinNumericalValue
```
public void setMinNumericalValue(String minNumericalValue)
```
    setMinNumericalValue.
  - name
```
public TabMetadata name(String name)
```
    name.
    
    Returns:
    
    TabMetadata
  - getName
```
public String getName()
```
    .
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
    setName.
  - numericalValue
```
public TabMetadata numericalValue(String numericalValue)
```
    numericalValue.
    
    Returns:
    
    TabMetadata
  - getNumericalValue
```
public String getNumericalValue()
```
    .
    
    Returns:
    
    numericalValue
  - setNumericalValue
```
public void setNumericalValue(String numericalValue)
```
    setNumericalValue.
  - paymentItemCode
```
public TabMetadata paymentItemCode(String paymentItemCode)
```
    paymentItemCode.
    
    Returns:
    
    TabMetadata
  - getPaymentItemCode
```
public String getPaymentItemCode()
```
    .
    
    Returns:
    
    paymentItemCode
  - setPaymentItemCode
```
public void setPaymentItemCode(String paymentItemCode)
```
    setPaymentItemCode.
  - paymentItemDescription
```
public TabMetadata paymentItemDescription(String paymentItemDescription)
```
    paymentItemDescription.
    
    Returns:
    
    TabMetadata
  - getPaymentItemDescription
```
public String getPaymentItemDescription()
```
    .
    
    Returns:
    
    paymentItemDescription
  - setPaymentItemDescription
```
public void setPaymentItemDescription(String paymentItemDescription)
```
    setPaymentItemDescription.
  - paymentItemName
```
public TabMetadata paymentItemName(String paymentItemName)
```
    paymentItemName.
    
    Returns:
    
    TabMetadata
  - getPaymentItemName
```
public String getPaymentItemName()
```
    .
    
    Returns:
    
    paymentItemName
  - setPaymentItemName
```
public void setPaymentItemName(String paymentItemName)
```
    setPaymentItemName.
  - requireAll
```
public TabMetadata requireAll(String requireAll)
```
    requireAll.
    
    Returns:
    
    TabMetadata
  - getRequireAll
```
public String getRequireAll()
```
    When set to **true** and shared is true, information must be entered in this field to complete the envelope. .
    
    Returns:
    
    requireAll
  - setRequireAll
```
public void setRequireAll(String requireAll)
```
    setRequireAll.
  - required
```
public TabMetadata required(String required)
```
    required.
    
    Returns:
    
    TabMetadata
  - getRequired
```
public String getRequired()
```
    When set to **true**, the signer is required to fill out this tab.
    
    Returns:
    
    required
  - setRequired
```
public void setRequired(String required)
```
    setRequired.
  - requireInitialOnSharedChange
```
public TabMetadata requireInitialOnSharedChange(String requireInitialOnSharedChange)
```
    requireInitialOnSharedChange.
    
    Returns:
    
    TabMetadata
  - 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.
  - scaleValue
```
public TabMetadata scaleValue(String scaleValue)
```
    scaleValue.
    
    Returns:
    
    TabMetadata
  - getScaleValue
```
public String getScaleValue()
```
    .
    
    Returns:
    
    scaleValue
  - setScaleValue
```
public void setScaleValue(String scaleValue)
```
    setScaleValue.
  - selected
```
public TabMetadata selected(String selected)
```
    selected.
    
    Returns:
    
    TabMetadata
  - getSelected
```
public String getSelected()
```
    .
    
    Returns:
    
    selected
  - setSelected
```
public void setSelected(String selected)
```
    setSelected.
  - shared
```
public TabMetadata shared(String shared)
```
    shared.
    
    Returns:
    
    TabMetadata
  - getShared
```
public String getShared()
```
    When set to **true**, this custom tab is shared..
    
    Returns:
    
    shared
  - setShared
```
public void setShared(String shared)
```
    setShared.
  - signatureProviderId
```
public TabMetadata signatureProviderId(String signatureProviderId)
```
    signatureProviderId.
    
    Returns:
    
    TabMetadata
  - getSignatureProviderId
```
public String getSignatureProviderId()
```
    .
    
    Returns:
    
    signatureProviderId
  - setSignatureProviderId
```
public void setSignatureProviderId(String signatureProviderId)
```
    setSignatureProviderId.
  - stampType
```
public TabMetadata stampType(String stampType)
```
    stampType.
    
    Returns:
    
    TabMetadata
  - getStampType
```
public String getStampType()
```
    .
    
    Returns:
    
    stampType
  - setStampType
```
public void setStampType(String stampType)
```
    setStampType.
  - stampTypeMetadata
```
public TabMetadata stampTypeMetadata(PropertyMetadata stampTypeMetadata)
```
    stampTypeMetadata.
    
    Returns:
    
    TabMetadata
  - getStampTypeMetadata
```
public PropertyMetadata getStampTypeMetadata()
```
    Metadata that indicates whether the `stampType` property is editable..
    
    Returns:
    
    stampTypeMetadata
  - setStampTypeMetadata
```
public void setStampTypeMetadata(PropertyMetadata stampTypeMetadata)
```
    setStampTypeMetadata.
  - tabLabel
```
public TabMetadata tabLabel(String tabLabel)
```
    tabLabel.
    
    Returns:
    
    TabMetadata
  - getTabLabel
```
public String getTabLabel()
```
    The label string associated with the tab..
    
    Returns:
    
    tabLabel
  - setTabLabel
```
public void setTabLabel(String tabLabel)
```
    setTabLabel.
  - type
```
public TabMetadata type(String type)
```
    type.
    
    Returns:
    
    TabMetadata
  - getType
```
public String getType()
```
    The type of this tab. Values are: Approve, CheckBox, Company, Date, DateSigned, Decline, Email, EmailAddress, EnvelopeId, FirstName, Formula, FullName, InitialHere, InitialHereOptional, LastName, List, Note, Number, Radio, SignerAttachment, SignHere, SignHereOptional, Ssn, Text, Title, Zip5, or Zip5Dash4..
    
    Returns:
    
    type
  - setType
```
public void setType(String type)
```
    setType.
  - underline
```
public TabMetadata underline(String underline)
```
    underline.
    
    Returns:
    
    TabMetadata
  - getUnderline
```
public String getUnderline()
```
    When set to **true**, the information in the tab is underlined..
    
    Returns:
    
    underline
  - setUnderline
```
public void setUnderline(String underline)
```
    setUnderline.
  - validationMessage
```
public TabMetadata validationMessage(String validationMessage)
```
    validationMessage.
    
    Returns:
    
    TabMetadata
  - getValidationMessage
```
public String getValidationMessage()
```
    The message displayed if the custom tab fails input validation (either custom of embedded)..
    
    Returns:
    
    validationMessage
  - setValidationMessage
```
public void setValidationMessage(String validationMessage)
```
    setValidationMessage.
  - validationPattern
```
public TabMetadata validationPattern(String validationPattern)
```
    validationPattern.
    
    Returns:
    
    TabMetadata
  - getValidationPattern
```
public String getValidationPattern()
```
    A regular expression used to validate input for the tab..
    
    Returns:
    
    validationPattern
  - setValidationPattern
```
public void setValidationPattern(String validationPattern)
```
    setValidationPattern.
  - validationType
```
public TabMetadata validationType(String validationType)
```
    validationType.
    
    Returns:
    
    TabMetadata
  - getValidationType
```
public String getValidationType()
```
    .
    
    Returns:
    
    validationType
  - setValidationType
```
public void setValidationType(String validationType)
```
    setValidationType.
  - width
```
public TabMetadata width(String width)
```
    width.
    
    Returns:
    
    TabMetadata
  - getWidth
```
public String getWidth()
```
    Width of the tab in pixels..
    
    Returns:
    
    width
  - setWidth
```
public void setWidth(String width)
```
    setWidth.
  - equals
```
public boolean equals(Object o)
```
    Compares objects.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true or false depending on comparison result.
  - hashCode
```
public int hashCode()
```
    Returns the HashCode.
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Converts the given object to string.
    
    Overrides:
    
    toString in class Object

Class TabMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TabMetadata

Method Detail

anchor

getAnchor

setAnchor

anchorCaseSensitive

getAnchorCaseSensitive

setAnchorCaseSensitive

anchorHorizontalAlignment

getAnchorHorizontalAlignment

setAnchorHorizontalAlignment

anchorIgnoreIfNotPresent

getAnchorIgnoreIfNotPresent

setAnchorIgnoreIfNotPresent

anchorMatchWholeWord

getAnchorMatchWholeWord

setAnchorMatchWholeWord

anchorUnits

getAnchorUnits

setAnchorUnits

anchorXOffset

getAnchorXOffset

setAnchorXOffset

anchorYOffset

getAnchorYOffset

setAnchorYOffset

bold

getBold

setBold

collaborative

getCollaborative

setCollaborative

concealValueOnDocument

getConcealValueOnDocument

setConcealValueOnDocument

createdByDisplayName

getCreatedByDisplayName

setCreatedByDisplayName

createdByUserId

getCreatedByUserId

setCreatedByUserId

customTabId

getCustomTabId

setCustomTabId

disableAutoSize

getDisableAutoSize

setDisableAutoSize

editable

getEditable

setEditable

font

getFont

setFont

fontColor

getFontColor

setFontColor

fontSize

getFontSize

setFontSize

height

getHeight

setHeight

includedInEmail

getIncludedInEmail

setIncludedInEmail

initialValue

getInitialValue

setInitialValue

italic

getItalic

setItalic

items

addItemsItem

getItems

setItems