TabMetadata (docusign-esign-java 3.6.0 API)

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

```
public class TabMetadata
extends Object
```
TabMetadata

Constructor Summary

Constructors
Constructor and Description

TabMetadata()

Constructors
Constructor and Description
`TabMetadata()`

Method Summary

Methods
Modifier and Type	Method and Description
`TabMetadata`	`addItemsItem(String itemsItem)`
`TabMetadata`	`anchor(String anchor)`
`TabMetadata`	`anchorCaseSensitive(String anchorCaseSensitive)`
`TabMetadata`	`anchorHorizontalAlignment(String anchorHorizontalAlignment)`
`TabMetadata`	`anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)`
`TabMetadata`	`anchorMatchWholeWord(String anchorMatchWholeWord)`
`TabMetadata`	`anchorUnits(String anchorUnits)`
`TabMetadata`	`anchorXOffset(String anchorXOffset)`
`TabMetadata`	`anchorYOffset(String anchorYOffset)`
`TabMetadata`	`bold(String bold)`
`TabMetadata`	`collaborative(String collaborative)`
`TabMetadata`	`concealValueOnDocument(String concealValueOnDocument)`
`TabMetadata`	`createdByDisplayName(String createdByDisplayName)`
`TabMetadata`	`createdByUserId(String createdByUserId)`
`TabMetadata`	`customTabId(String customTabId)`
`TabMetadata`	`disableAutoSize(String disableAutoSize)`
`TabMetadata`	`editable(String editable)`
`boolean`	`equals(Object o)`
`TabMetadata`	`font(String font)`
`TabMetadata`	`fontColor(String fontColor)`
`TabMetadata`	`fontSize(String 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.
`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.
`MergeField`	`getMergeField()` Get mergeField
`String`	`getName()`
`String`	`getPaymentItemCode()`
`String`	`getPaymentItemDescription()`
`String`	`getPaymentItemName()`
`String`	`getRequired()` When set to true, the signer is required to fill out this tab
`String`	`getScaleValue()`
`String`	`getSelected()`
`String`	`getShared()` When set to true, this custom tab is shared.
`String`	`getStampType()`
`PropertyMetadata`	`getStampTypeMetadata()` Get stampTypeMetadata
`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`	`getWidth()` Width of the tab in pixels.
`int`	`hashCode()`
`TabMetadata`	`height(String height)`
`TabMetadata`	`includedInEmail(String includedInEmail)`
`TabMetadata`	`initialValue(String initialValue)`
`TabMetadata`	`italic(String italic)`
`TabMetadata`	`items(List<String> items)`
`TabMetadata`	`lastModified(String lastModified)`
`TabMetadata`	`lastModifiedByDisplayName(String lastModifiedByDisplayName)`
`TabMetadata`	`lastModifiedByUserId(String lastModifiedByUserId)`
`TabMetadata`	`locked(String locked)`
`TabMetadata`	`maximumLength(String maximumLength)`
`TabMetadata`	`mergeField(MergeField mergeField)`
`TabMetadata`	`name(String name)`
`TabMetadata`	`paymentItemCode(String paymentItemCode)`
`TabMetadata`	`paymentItemDescription(String paymentItemDescription)`
`TabMetadata`	`paymentItemName(String paymentItemName)`
`TabMetadata`	`required(String required)`
`TabMetadata`	`scaleValue(String scaleValue)`
`TabMetadata`	`selected(String selected)`
`void`	`setAnchor(String anchor)`
`void`	`setAnchorCaseSensitive(String anchorCaseSensitive)`
`void`	`setAnchorHorizontalAlignment(String anchorHorizontalAlignment)`
`void`	`setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)`
`void`	`setAnchorMatchWholeWord(String anchorMatchWholeWord)`
`void`	`setAnchorUnits(String anchorUnits)`
`void`	`setAnchorXOffset(String anchorXOffset)`
`void`	`setAnchorYOffset(String anchorYOffset)`
`void`	`setBold(String bold)`
`void`	`setCollaborative(String collaborative)`
`void`	`setConcealValueOnDocument(String concealValueOnDocument)`
`void`	`setCreatedByDisplayName(String createdByDisplayName)`
`void`	`setCreatedByUserId(String createdByUserId)`
`void`	`setCustomTabId(String customTabId)`
`void`	`setDisableAutoSize(String disableAutoSize)`
`void`	`setEditable(String editable)`
`void`	`setFont(String font)`
`void`	`setFontColor(String fontColor)`
`void`	`setFontSize(String fontSize)`
`void`	`setHeight(String height)`
`void`	`setIncludedInEmail(String includedInEmail)`
`void`	`setInitialValue(String initialValue)`
`void`	`setItalic(String italic)`
`void`	`setItems(List<String> items)`
`void`	`setLastModified(String lastModified)`
`void`	`setLastModifiedByDisplayName(String lastModifiedByDisplayName)`
`void`	`setLastModifiedByUserId(String lastModifiedByUserId)`
`void`	`setLocked(String locked)`
`void`	`setMaximumLength(String maximumLength)`
`void`	`setMergeField(MergeField mergeField)`
`void`	`setName(String name)`
`void`	`setPaymentItemCode(String paymentItemCode)`
`void`	`setPaymentItemDescription(String paymentItemDescription)`
`void`	`setPaymentItemName(String paymentItemName)`
`void`	`setRequired(String required)`
`void`	`setScaleValue(String scaleValue)`
`void`	`setSelected(String selected)`
`void`	`setShared(String shared)`
`void`	`setStampType(String stampType)`
`void`	`setStampTypeMetadata(PropertyMetadata stampTypeMetadata)`
`void`	`setTabLabel(String tabLabel)`
`void`	`setType(String type)`
`void`	`setUnderline(String underline)`
`void`	`setValidationMessage(String validationMessage)`
`void`	`setValidationPattern(String validationPattern)`
`void`	`setWidth(String width)`
`TabMetadata`	`shared(String shared)`
`TabMetadata`	`stampType(String stampType)`
`TabMetadata`	`stampTypeMetadata(PropertyMetadata stampTypeMetadata)`
`TabMetadata`	`tabLabel(String tabLabel)`
`String`	`toString()`
`TabMetadata`	`type(String type)`
`TabMetadata`	`underline(String underline)`
`TabMetadata`	`validationMessage(String validationMessage)`
`TabMetadata`	`validationPattern(String validationPattern)`
`TabMetadata`	`width(String 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)

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

anchorCaseSensitive

public TabMetadata anchorCaseSensitive(String anchorCaseSensitive)

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

Returns:
anchorCaseSensitive

setAnchorCaseSensitive

public void setAnchorCaseSensitive(String anchorCaseSensitive)

anchorHorizontalAlignment

public TabMetadata anchorHorizontalAlignment(String anchorHorizontalAlignment)

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

Returns:
anchorHorizontalAlignment

setAnchorHorizontalAlignment

public void setAnchorHorizontalAlignment(String anchorHorizontalAlignment)

anchorIgnoreIfNotPresent

public TabMetadata anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)

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

Returns:
anchorIgnoreIfNotPresent

setAnchorIgnoreIfNotPresent

public void setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)

anchorMatchWholeWord

public TabMetadata anchorMatchWholeWord(String anchorMatchWholeWord)

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

Returns:
anchorMatchWholeWord

setAnchorMatchWholeWord

public void setAnchorMatchWholeWord(String anchorMatchWholeWord)

anchorUnits

public TabMetadata anchorUnits(String anchorUnits)

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)

anchorXOffset

public TabMetadata anchorXOffset(String anchorXOffset)

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

Returns:
anchorXOffset

setAnchorXOffset

public void setAnchorXOffset(String anchorXOffset)

anchorYOffset

public TabMetadata anchorYOffset(String anchorYOffset)

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

Returns:
anchorYOffset

setAnchorYOffset

public void setAnchorYOffset(String anchorYOffset)

bold
```
public TabMetadata bold(String bold)
```

getBold
```
public String getBold()
```
When set to **true**, the information in the tab is bold.

Returns:
bold

setBold
```
public void setBold(String bold)
```

collaborative

public TabMetadata collaborative(String collaborative)

getCollaborative
```
public String getCollaborative()
```
Returns:
collaborative

setCollaborative

public void setCollaborative(String collaborative)

concealValueOnDocument

public TabMetadata concealValueOnDocument(String concealValueOnDocument)

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)

createdByDisplayName

public TabMetadata createdByDisplayName(String createdByDisplayName)

getCreatedByDisplayName
```
public String getCreatedByDisplayName()
```
The user name of the DocuSign user who created this object.

Returns:
createdByDisplayName

setCreatedByDisplayName

public void setCreatedByDisplayName(String createdByDisplayName)

createdByUserId

public TabMetadata createdByUserId(String createdByUserId)

getCreatedByUserId
```
public String getCreatedByUserId()
```
The userId of the DocuSign user who created this object.

Returns:
createdByUserId

setCreatedByUserId

public void setCreatedByUserId(String createdByUserId)

customTabId

public TabMetadata customTabId(String customTabId)

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)

disableAutoSize

public TabMetadata disableAutoSize(String disableAutoSize)

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)

editable

public TabMetadata editable(String editable)

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)

font
```
public TabMetadata font(String font)
```

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

fontColor

public TabMetadata fontColor(String fontColor)

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)

setFontSize

public void setFontSize(String fontSize)

height

public TabMetadata height(String height)

getHeight
```
public String getHeight()
```
Height of the tab in pixels.

Returns:
height

setHeight
```
public void setHeight(String height)
```

includedInEmail

public TabMetadata includedInEmail(String includedInEmail)

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)

initialValue

public TabMetadata initialValue(String initialValue)

getInitialValue
```
public String getInitialValue()
```
The original value of the tab.

Returns:
initialValue

setInitialValue

public void setInitialValue(String initialValue)

italic

public TabMetadata italic(String italic)

getItalic
```
public String getItalic()
```
When set to **true**, the information in the tab is italic.

Returns:
italic

setItalic
```
public void setItalic(String italic)
```

items

public TabMetadata items(List<String> items)

addItemsItem

public TabMetadata addItemsItem(String itemsItem)

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)

lastModified

public TabMetadata lastModified(String lastModified)

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)

lastModifiedByDisplayName

public TabMetadata lastModifiedByDisplayName(String lastModifiedByDisplayName)

getLastModifiedByDisplayName
```
public String getLastModifiedByDisplayName()
```
The User Name of the DocuSign user who last modified this object.

Returns:
lastModifiedByDisplayName

setLastModifiedByDisplayName

public void setLastModifiedByDisplayName(String lastModifiedByDisplayName)

lastModifiedByUserId

public TabMetadata lastModifiedByUserId(String lastModifiedByUserId)

getLastModifiedByUserId
```
public String getLastModifiedByUserId()
```
The userId of the DocuSign user who last modified this object.

Returns:
lastModifiedByUserId

setLastModifiedByUserId

public void setLastModifiedByUserId(String lastModifiedByUserId)

locked

public TabMetadata locked(String locked)

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

maximumLength

public TabMetadata maximumLength(String maximumLength)

getMaximumLength
```
public String getMaximumLength()
```
The maximum number of entry characters supported by the custom tab.

Returns:
maximumLength

setMaximumLength

public void setMaximumLength(String maximumLength)

mergeField

public TabMetadata mergeField(MergeField mergeField)

getMergeField
```
public MergeField getMergeField()
```
Get mergeField

Returns:
mergeField

setMergeField

public void setMergeField(MergeField mergeField)

name
```
public TabMetadata name(String name)
```

getName
```
public String getName()
```
Returns:
name

setName
```
public void setName(String name)
```

paymentItemCode

public TabMetadata paymentItemCode(String paymentItemCode)

getPaymentItemCode
```
public String getPaymentItemCode()
```
Returns:
paymentItemCode

setPaymentItemCode

public void setPaymentItemCode(String paymentItemCode)

paymentItemDescription

public TabMetadata paymentItemDescription(String paymentItemDescription)

getPaymentItemDescription
```
public String getPaymentItemDescription()
```
Returns:
paymentItemDescription

setPaymentItemDescription

public void setPaymentItemDescription(String paymentItemDescription)

paymentItemName

public TabMetadata paymentItemName(String paymentItemName)

getPaymentItemName
```
public String getPaymentItemName()
```
Returns:
paymentItemName

setPaymentItemName

public void setPaymentItemName(String paymentItemName)

required

public TabMetadata required(String required)

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)

scaleValue

public TabMetadata scaleValue(String scaleValue)

getScaleValue
```
public String getScaleValue()
```
Returns:
scaleValue

setScaleValue

public void setScaleValue(String scaleValue)

selected

public TabMetadata selected(String selected)

getSelected
```
public String getSelected()
```
Returns:
selected

setSelected

public void setSelected(String selected)

shared

public TabMetadata shared(String shared)

getShared
```
public String getShared()
```
When set to **true**, this custom tab is shared.

Returns:
shared

setShared
```
public void setShared(String shared)
```

stampType

public TabMetadata stampType(String stampType)

getStampType
```
public String getStampType()
```
Returns:
stampType

setStampType

public void setStampType(String stampType)

stampTypeMetadata

public TabMetadata stampTypeMetadata(PropertyMetadata stampTypeMetadata)

getStampTypeMetadata
```
public PropertyMetadata getStampTypeMetadata()
```
Get stampTypeMetadata

Returns:
stampTypeMetadata

setStampTypeMetadata

public void setStampTypeMetadata(PropertyMetadata stampTypeMetadata)

tabLabel

public TabMetadata tabLabel(String tabLabel)

getTabLabel
```
public String getTabLabel()
```
The label string associated with the tab.

Returns:
tabLabel

setTabLabel

public void setTabLabel(String tabLabel)

type
```
public TabMetadata type(String type)
```

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

underline

public TabMetadata underline(String underline)

getUnderline
```
public String getUnderline()
```
When set to **true**, the information in the tab is underlined.

Returns:
underline

setUnderline

public void setUnderline(String underline)

validationMessage

public TabMetadata validationMessage(String validationMessage)

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

Returns:
validationMessage

setValidationMessage

public void setValidationMessage(String validationMessage)

validationPattern

public TabMetadata validationPattern(String validationPattern)

getValidationPattern
```
public String getValidationPattern()
```
A regular expression used to validate input for the tab.

Returns:
validationPattern

setValidationPattern

public void setValidationPattern(String validationPattern)

width

public TabMetadata width(String width)

getWidth
```
public String getWidth()
```
Width of the tab in pixels.

Returns:
width

setWidth
```
public void setWidth(String width)
```

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
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