TabMetadata (docusign-esign-java 2.0.1 API)

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

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2016-04-27T11:06:30.816-07:00")
public class TabMetadata
extends Object

Constructor Summary

Constructors
Constructor and Description

TabMetadata()

Constructors
Constructor and Description
`TabMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TabMetadata`	`anchor(String anchor)` An optional string that is used to auto-match tabs to strings located in the documents of an envelope.
`TabMetadata`	`anchorCaseSensitive(String anchorCaseSensitive)` When set to true, the anchor string does not consider case when matching strings in the document.
`TabMetadata`	`anchorHorizontalAlignment(String anchorHorizontalAlignment)` Specifies the alignment of anchor tabs with anchor strings.
`TabMetadata`	`anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)` When set to true, this tab is ignored if anchorString is not found in the document.
`TabMetadata`	`anchorMatchWholeWord(String anchorMatchWholeWord)` 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.
`TabMetadata`	`anchorUnits(String anchorUnits)` Specifies units of the X and Y offset.
`TabMetadata`	`anchorXOffset(String anchorXOffset)` Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`TabMetadata`	`anchorYOffset(String anchorYOffset)` Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`TabMetadata`	`bold(String bold)` When set to true, the information in the tab is bold.
`TabMetadata`	`concealValueOnDocument(String concealValueOnDocument)` 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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
`TabMetadata`	`createdByDisplayName(String createdByDisplayName)` The user name of the DocuSign user who created this object.
`TabMetadata`	`createdByUserId(String createdByUserId)` The userId of the DocuSign user who created this object.
`TabMetadata`	`customTabId(String customTabId)` The DocuSign generated custom tab ID for the custom tab to be applied.
`TabMetadata`	`disableAutoSize(String disableAutoSize)` When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data.
`TabMetadata`	`editable(String editable)` When set to true, the custom tab is editable.
`boolean`	`equals(Object o)`
`TabMetadata`	`font(String font)` The font to be used for the tab value.
`TabMetadata`	`fontColor(String fontColor)` The font color used for the information in the tab.\n\nPossible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
`TabMetadata`	`fontSize(String fontSize)` The font size used for the information in the tab.\n\nPossible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.
`String`	`getAnchor()`
`String`	`getAnchorCaseSensitive()`
`String`	`getAnchorHorizontalAlignment()`
`String`	`getAnchorIgnoreIfNotPresent()`
`String`	`getAnchorMatchWholeWord()`
`String`	`getAnchorUnits()`
`String`	`getAnchorXOffset()`
`String`	`getAnchorYOffset()`
`String`	`getBold()`
`String`	`getConcealValueOnDocument()`
`String`	`getCreatedByDisplayName()`
`String`	`getCreatedByUserId()`
`String`	`getCustomTabId()`
`String`	`getDisableAutoSize()`
`String`	`getEditable()`
`String`	`getFont()`
`String`	`getFontColor()`
`String`	`getFontSize()`
`String`	`getHeight()`
`String`	`getIncludedInEmail()`
`String`	`getInitialValue()`
`String`	`getItalic()`
`List<String>`	`getItems()`
`String`	`getLastModified()`
`String`	`getLastModifiedByDisplayName()`
`String`	`getLastModifiedByUserId()`
`String`	`getLocked()`
`String`	`getMaximumLength()`
`MergeField`	`getMergeField()`
`String`	`getName()`
`String`	`getRequired()`
`String`	`getShared()`
`String`	`getTabLabel()`
`String`	`getType()`
`String`	`getUnderline()`
`String`	`getValidationMessage()`
`String`	`getValidationPattern()`
`String`	`getWidth()`
`int`	`hashCode()`
`TabMetadata`	`height(String height)` Height of the tab in pixels.
`TabMetadata`	`includedInEmail(String includedInEmail)` When set to true, the tab is included in e-mails related to the envelope on which it exists.
`TabMetadata`	`initialValue(String initialValue)` The original value of the tab.
`TabMetadata`	`italic(String italic)` When set to true, the information in the tab is italic.
`TabMetadata`	`items(List<String> items)` If the tab is a list, this represents the values that are possible for the tab.
`TabMetadata`	`lastModified(String lastModified)` The UTC DateTime this object was last modified.
`TabMetadata`	`lastModifiedByDisplayName(String lastModifiedByDisplayName)` The User Name of the DocuSign user who last modified this object.
`TabMetadata`	`lastModifiedByUserId(String lastModifiedByUserId)` The userId of the DocuSign user who last modified this object.
`TabMetadata`	`locked(String locked)` When set to true, the signer cannot change the data of the custom tab.
`TabMetadata`	`maximumLength(String maximumLength)` The maximum number of entry characters supported by the custom tab.
`TabMetadata`	`mergeField(MergeField mergeField)`
`TabMetadata`	`name(String name)`
`TabMetadata`	`required(String required)` When set to true, the signer is required to fill out this tab
`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`	`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`	`setRequired(String required)`
`void`	`setShared(String shared)`
`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)` When set to true, this custom tab is shared.
`TabMetadata`	`tabLabel(String tabLabel)` The label string associated with the tab.
`String`	`toString()`
`TabMetadata`	`type(String type)` The type of this tab.
`TabMetadata`	`underline(String underline)` When set to true, the information in the tab is underlined.
`TabMetadata`	`validationMessage(String validationMessage)` The message displayed if the custom tab fails input validation (either custom of embedded).
`TabMetadata`	`validationPattern(String validationPattern)` A regular expressionn used to validate input for the tab.
`TabMetadata`	`width(String width)` Width of the tab in pixels.

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

Constructor Detail
- TabMetadata
```
public TabMetadata()
```

Method Detail

font
```
public TabMetadata font(String font)
```
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.

getFont
```
public String getFont()
```

setFont
```
public void setFont(String font)
```

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

getBold
```
public String getBold()
```

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

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

getItalic
```
public String getItalic()
```

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

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

getUnderline
```
public String getUnderline()
```

setUnderline

public void setUnderline(String underline)

fontColor
```
public TabMetadata fontColor(String fontColor)
```
The font color used for the information in the tab.\n\nPossible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.

getFontColor
```
public String getFontColor()
```

setFontColor

public void setFontColor(String fontColor)

fontSize
```
public TabMetadata fontSize(String fontSize)
```
The font size used for the information in the tab.\n\nPossible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.

getFontSize
```
public String getFontSize()
```

setFontSize

public void setFontSize(String fontSize)

height

public TabMetadata height(String height)

Height of the tab in pixels.

getHeight
```
public String getHeight()
```

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

width

public TabMetadata width(String width)

Width of the tab in pixels.

getWidth
```
public String getWidth()
```

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

customTabId
```
public TabMetadata customTabId(String customTabId)
```
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.

getCustomTabId
```
public String getCustomTabId()
```

setCustomTabId

public void setCustomTabId(String customTabId)

initialValue

public TabMetadata initialValue(String initialValue)

The original value of the tab.

getInitialValue
```
public String getInitialValue()
```

setInitialValue

public void setInitialValue(String initialValue)

includedInEmail
```
public TabMetadata includedInEmail(String includedInEmail)
```
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.

getIncludedInEmail
```
public String getIncludedInEmail()
```

setIncludedInEmail

public void setIncludedInEmail(String includedInEmail)

disableAutoSize
```
public TabMetadata disableAutoSize(String disableAutoSize)
```
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.

getDisableAutoSize
```
public String getDisableAutoSize()
```

setDisableAutoSize

public void setDisableAutoSize(String disableAutoSize)

concealValueOnDocument
```
public TabMetadata concealValueOnDocument(String concealValueOnDocument)
```
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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

getConcealValueOnDocument

public String getConcealValueOnDocument()

setConcealValueOnDocument

public void setConcealValueOnDocument(String concealValueOnDocument)

locked
```
public TabMetadata locked(String locked)
```
When set to **true**, the signer cannot change the data of the custom tab.

getLocked
```
public String getLocked()
```

setLocked
```
public void setLocked(String locked)
```

required
```
public TabMetadata required(String required)
```
When set to **true**, the signer is required to fill out this tab

getRequired
```
public String getRequired()
```

setRequired

public void setRequired(String required)

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

getShared
```
public String getShared()
```

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

items
```
public TabMetadata items(List<String> items)
```
If the tab is a list, this represents the values that are possible for the tab.

getItems
```
public List<String> getItems()
```

setItems

public void setItems(List<String> items)

tabLabel

public TabMetadata tabLabel(String tabLabel)

The label string associated with the tab.

getTabLabel
```
public String getTabLabel()
```

setTabLabel

public void setTabLabel(String tabLabel)

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

getMaximumLength
```
public String getMaximumLength()
```

setMaximumLength

public void setMaximumLength(String maximumLength)

anchor
```
public TabMetadata anchor(String anchor)
```
An optional string that is used to auto-match tabs to strings located in the documents of an envelope.

getAnchor
```
public String getAnchor()
```

setAnchor
```
public void setAnchor(String anchor)
```

anchorXOffset
```
public TabMetadata anchorXOffset(String anchorXOffset)
```
Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.

getAnchorXOffset
```
public String getAnchorXOffset()
```

setAnchorXOffset

public void setAnchorXOffset(String anchorXOffset)

anchorYOffset
```
public TabMetadata anchorYOffset(String anchorYOffset)
```
Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.

getAnchorYOffset
```
public String getAnchorYOffset()
```

setAnchorYOffset

public void setAnchorYOffset(String anchorYOffset)

anchorUnits
```
public TabMetadata anchorUnits(String anchorUnits)
```
Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

getAnchorUnits
```
public String getAnchorUnits()
```

setAnchorUnits

public void setAnchorUnits(String anchorUnits)

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

getAnchorIgnoreIfNotPresent

public String getAnchorIgnoreIfNotPresent()

setAnchorIgnoreIfNotPresent

public void setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)

anchorMatchWholeWord
```
public TabMetadata anchorMatchWholeWord(String anchorMatchWholeWord)
```
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**.

getAnchorMatchWholeWord

public String getAnchorMatchWholeWord()

setAnchorMatchWholeWord

public void setAnchorMatchWholeWord(String anchorMatchWholeWord)

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

getAnchorCaseSensitive

public String getAnchorCaseSensitive()

setAnchorCaseSensitive

public void setAnchorCaseSensitive(String anchorCaseSensitive)

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

getAnchorHorizontalAlignment

public String getAnchorHorizontalAlignment()

setAnchorHorizontalAlignment

public void setAnchorHorizontalAlignment(String anchorHorizontalAlignment)

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

getName
```
public String getName()
```

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

type
```
public TabMetadata type(String type)
```
The type of this tab. Values are: Approve, CheckBox, Company, Date, DateSigned,\tDecline, Email,\tEmailAddress, EnvelopeId, FirstName, Formula, FullName,\tInitialHere, InitialHereOptional, LastName, List, Note, Number,\tRadio, SignerAttachment, SignHere, SignHereOptional, Ssn, Text, Title, Zip5, or Zip5Dash4.

getType
```
public String getType()
```

setType
```
public void setType(String type)
```

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

getValidationMessage
```
public String getValidationMessage()
```

setValidationMessage

public void setValidationMessage(String validationMessage)

validationPattern
```
public TabMetadata validationPattern(String validationPattern)
```
A regular expressionn used to validate input for the tab.

getValidationPattern
```
public String getValidationPattern()
```

setValidationPattern

public void setValidationPattern(String validationPattern)

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

getLastModifiedByUserId

public String getLastModifiedByUserId()

setLastModifiedByUserId

public void setLastModifiedByUserId(String lastModifiedByUserId)

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

getLastModifiedByDisplayName

public String getLastModifiedByDisplayName()

setLastModifiedByDisplayName

public void setLastModifiedByDisplayName(String lastModifiedByDisplayName)

lastModified
```
public TabMetadata lastModified(String lastModified)
```
The UTC DateTime this object was last modified. This is in ISO8601 format.

getLastModified
```
public String getLastModified()
```

setLastModified

public void setLastModified(String lastModified)

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

getCreatedByUserId
```
public String getCreatedByUserId()
```

setCreatedByUserId

public void setCreatedByUserId(String createdByUserId)

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

getCreatedByDisplayName

public String getCreatedByDisplayName()

setCreatedByDisplayName

public void setCreatedByDisplayName(String createdByDisplayName)

editable
```
public TabMetadata editable(String editable)
```
When set to **true**, the custom tab is editable. Otherwise the custom tab cannot be modified.

getEditable
```
public String getEditable()
```

setEditable

public void setEditable(String editable)

mergeField

public TabMetadata mergeField(MergeField mergeField)

getMergeField
```
public MergeField getMergeField()
```

setMergeField

public void setMergeField(MergeField mergeField)

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

font

getFont

setFont

bold

getBold

setBold

italic

getItalic

setItalic

underline

getUnderline

setUnderline

fontColor

getFontColor

setFontColor

fontSize

getFontSize

setFontSize

height

getHeight

setHeight

width

getWidth

setWidth

customTabId

getCustomTabId

setCustomTabId

initialValue

getInitialValue

setInitialValue

includedInEmail

getIncludedInEmail

setIncludedInEmail

disableAutoSize

getDisableAutoSize

setDisableAutoSize

concealValueOnDocument

getConcealValueOnDocument

setConcealValueOnDocument

locked

getLocked

setLocked

required

getRequired

setRequired

shared

getShared

setShared

items

getItems

setItems

tabLabel

getTabLabel

setTabLabel

maximumLength

getMaximumLength

setMaximumLength

anchor

getAnchor

setAnchor

anchorXOffset

getAnchorXOffset

setAnchorXOffset

anchorYOffset

getAnchorYOffset

setAnchorYOffset

anchorUnits

getAnchorUnits

setAnchorUnits

anchorIgnoreIfNotPresent

getAnchorIgnoreIfNotPresent

setAnchorIgnoreIfNotPresent

anchorMatchWholeWord