TabMetadata (docusign-esign-java 2.2.0 API)

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

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-03-06T16:42:36.211-08:00")
public class TabMetadata
extends Object

Constructor Summary

Constructors
Constructor and Description

TabMetadata()

Constructors
Constructor and Description
`TabMetadata()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`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 achorUnits, relative to the anchorString.
`String`	`getAnchorYOffset()` Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`String`	`getBold()` When set to true, the information in the tab is bold.
`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.\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.
`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.\n\nPossible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
`String`	`getFontSize()` 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`	`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()`
`String`	`getName()`
`String`	`getRequired()` When set to true, the signer is required to fill out this tab
`String`	`getScaleValue()`
`String`	`getShared()` When set to true, this custom tab is shared.
`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 expressionn used to validate input for the tab.
`String`	`getWidth()` Width of the tab in pixels.
`int`	`hashCode()`
`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`	`setScaleValue(String scaleValue)`
`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)`
`String`	`toString()`

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

- Constructor Detail
  - TabMetadata
```
public TabMetadata()
```
- Method Detail
  - getAnchor
```
public String getAnchor()
```
    An optional string that is used to auto-match tabs to strings located in the documents of an envelope.
  - setAnchor
```
public void setAnchor(String anchor)
```
  - 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**.
  - setAnchorCaseSensitive
```
public void setAnchorCaseSensitive(String anchorCaseSensitive)
```
  - getAnchorHorizontalAlignment
```
public String getAnchorHorizontalAlignment()
```
    Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
  - setAnchorHorizontalAlignment
```
public void setAnchorHorizontalAlignment(String anchorHorizontalAlignment)
```
  - getAnchorIgnoreIfNotPresent
```
public String getAnchorIgnoreIfNotPresent()
```
    When set to **true**, this tab is ignored if anchorString is not found in the document.
  - setAnchorIgnoreIfNotPresent
```
public void setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
```
  - 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**.
  - setAnchorMatchWholeWord
```
public void setAnchorMatchWholeWord(String anchorMatchWholeWord)
```
  - getAnchorUnits
```
public String getAnchorUnits()
```
    Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
  - setAnchorUnits
```
public void setAnchorUnits(String anchorUnits)
```
  - getAnchorXOffset
```
public String getAnchorXOffset()
```
    Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
  - setAnchorXOffset
```
public void setAnchorXOffset(String anchorXOffset)
```
  - getAnchorYOffset
```
public String getAnchorYOffset()
```
    Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
  - setAnchorYOffset
```
public void setAnchorYOffset(String anchorYOffset)
```
  - getBold
```
public String getBold()
```
    When set to **true**, the information in the tab is bold.
  - setBold
```
public void setBold(String bold)
```
  - 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.\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.
  - setConcealValueOnDocument
```
public void setConcealValueOnDocument(String concealValueOnDocument)
```
  - getCreatedByDisplayName
```
public String getCreatedByDisplayName()
```
    The user name of the DocuSign user who created this object.
  - setCreatedByDisplayName
```
public void setCreatedByDisplayName(String createdByDisplayName)
```
  - getCreatedByUserId
```
public String getCreatedByUserId()
```
    The userId of the DocuSign user who created this object.
  - setCreatedByUserId
```
public void setCreatedByUserId(String createdByUserId)
```
  - 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.
  - setCustomTabId
```
public void setCustomTabId(String customTabId)
```
  - 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.
  - setDisableAutoSize
```
public void setDisableAutoSize(String disableAutoSize)
```
  - getEditable
```
public String getEditable()
```
    When set to **true**, the custom tab is editable. Otherwise the custom tab cannot be modified.
  - setEditable
```
public void setEditable(String editable)
```
  - 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.
  - setFont
```
public void setFont(String font)
```
  - getFontColor
```
public String getFontColor()
```
    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.
  - setFontColor
```
public void setFontColor(String fontColor)
```
  - getFontSize
```
public String getFontSize()
```
    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.
  - setFontSize
```
public void setFontSize(String fontSize)
```
  - getHeight
```
public String getHeight()
```
    Height of the tab in pixels.
  - setHeight
```
public void setHeight(String height)
```
  - 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.
  - setIncludedInEmail
```
public void setIncludedInEmail(String includedInEmail)
```
  - getInitialValue
```
public String getInitialValue()
```
    The original value of the tab.
  - setInitialValue
```
public void setInitialValue(String initialValue)
```
  - getItalic
```
public String getItalic()
```
    When set to **true**, the information in the tab is italic.
  - setItalic
```
public void setItalic(String italic)
```
  - getItems
```
public List<String> getItems()
```
    If the tab is a list, this represents the values that are possible for the tab.
  - setItems
```
public void setItems(List<String> items)
```
  - getLastModified
```
public String getLastModified()
```
    The UTC DateTime this object was last modified. This is in ISO8601 format.
  - setLastModified
```
public void setLastModified(String lastModified)
```
  - getLastModifiedByDisplayName
```
public String getLastModifiedByDisplayName()
```
    The User Name of the DocuSign user who last modified this object.
  - setLastModifiedByDisplayName
```
public void setLastModifiedByDisplayName(String lastModifiedByDisplayName)
```
  - getLastModifiedByUserId
```
public String getLastModifiedByUserId()
```
    The userId of the DocuSign user who last modified this object.
  - setLastModifiedByUserId
```
public void setLastModifiedByUserId(String lastModifiedByUserId)
```
  - getLocked
```
public String getLocked()
```
    When set to **true**, the signer cannot change the data of the custom tab.
  - setLocked
```
public void setLocked(String locked)
```
  - getMaximumLength
```
public String getMaximumLength()
```
    The maximum number of entry characters supported by the custom tab.
  - setMaximumLength
```
public void setMaximumLength(String maximumLength)
```
  - getMergeField
```
public MergeField getMergeField()
```
  - setMergeField
```
public void setMergeField(MergeField mergeField)
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - getRequired
```
public String getRequired()
```
    When set to **true**, the signer is required to fill out this tab
  - setRequired
```
public void setRequired(String required)
```
  - getScaleValue
```
public String getScaleValue()
```
  - setScaleValue
```
public void setScaleValue(String scaleValue)
```
  - getShared
```
public String getShared()
```
    When set to **true**, this custom tab is shared.
  - setShared
```
public void setShared(String shared)
```
  - getTabLabel
```
public String getTabLabel()
```
    The label string associated with the tab.
  - setTabLabel
```
public void setTabLabel(String tabLabel)
```
  - 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.
  - setType
```
public void setType(String type)
```
  - getUnderline
```
public String getUnderline()
```
    When set to **true**, the information in the tab is underlined.
  - setUnderline
```
public void setUnderline(String underline)
```
  - getValidationMessage
```
public String getValidationMessage()
```
    The message displayed if the custom tab fails input validation (either custom of embedded).
  - setValidationMessage
```
public void setValidationMessage(String validationMessage)
```
  - getValidationPattern
```
public String getValidationPattern()
```
    A regular expressionn used to validate input for the tab.
  - setValidationPattern
```
public void setValidationPattern(String validationPattern)
```
  - getWidth
```
public String getWidth()
```
    Width of the tab in pixels.
  - 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

getAnchor

setAnchor

getAnchorCaseSensitive

setAnchorCaseSensitive

getAnchorHorizontalAlignment

setAnchorHorizontalAlignment

getAnchorIgnoreIfNotPresent

setAnchorIgnoreIfNotPresent

getAnchorMatchWholeWord

setAnchorMatchWholeWord

getAnchorUnits

setAnchorUnits

getAnchorXOffset

setAnchorXOffset

getAnchorYOffset

setAnchorYOffset

getBold

setBold

getConcealValueOnDocument

setConcealValueOnDocument

getCreatedByDisplayName

setCreatedByDisplayName

getCreatedByUserId

setCreatedByUserId

getCustomTabId

setCustomTabId

getDisableAutoSize

setDisableAutoSize

getEditable

setEditable

getFont

setFont

getFontColor

setFontColor

getFontSize

setFontSize

getHeight

setHeight

getIncludedInEmail

setIncludedInEmail

getInitialValue

setInitialValue

getItalic

setItalic

getItems

setItems

getLastModified

setLastModified

getLastModifiedByDisplayName

setLastModifiedByDisplayName

getLastModifiedByUserId

setLastModifiedByUserId

getLocked

setLocked

getMaximumLength

setMaximumLength

getMergeField

setMergeField

getName

setName

getRequired

setRequired

getScaleValue

setScaleValue

getShared

setShared

getTabLabel

setTabLabel

getType

setType

getUnderline

setUnderline

getValidationMessage