@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen", date="2016-04-27T11:06:30.816-07:00") public class Text extends Object
| Constructor and Description |
|---|
Text() |
| Modifier and Type | Method and Description |
|---|---|
Text |
anchorCaseSensitive(String anchorCaseSensitive)
When set to **true**, the anchor string does not consider case when matching strings in the document.
|
Text |
anchorHorizontalAlignment(String anchorHorizontalAlignment)
Specifies the alignment of anchor tabs with anchor strings.
|
Text |
anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
When set to **true**, this tab is ignored if anchorString is not found in the document.
|
Text |
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**.
|
Text |
anchorString(String anchorString)
Anchor text information for a radio button.
|
Text |
anchorUnits(String anchorUnits)
Specifies units of the X and Y offset.
|
Text |
anchorXOffset(String anchorXOffset)
Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
|
Text |
anchorYOffset(String anchorYOffset)
Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
|
Text |
bold(String bold)
When set to **true**, the information in the tab is bold.
|
Text |
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.
|
Text |
conditionalParentLabel(String conditionalParentLabel)
For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
|
Text |
conditionalParentValue(String conditionalParentValue)
For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n
|
Text |
customTabId(String customTabId)
The DocuSign generated custom tab ID for the custom tab to be applied.
|
Text |
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.
|
Text |
documentId(String documentId)
Specifies the document ID number that the tab is placed on.
|
boolean |
equals(Object o) |
Text |
errorDetails(ErrorDetails errorDetails) |
Text |
font(String font)
The font to be used for the tab value.
|
Text |
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.
|
Text |
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.
|
Text |
formula(String formula)
The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators.
|
String |
getAnchorCaseSensitive() |
String |
getAnchorHorizontalAlignment() |
String |
getAnchorIgnoreIfNotPresent() |
String |
getAnchorMatchWholeWord() |
String |
getAnchorString() |
String |
getAnchorUnits() |
String |
getAnchorXOffset() |
String |
getAnchorYOffset() |
String |
getBold() |
String |
getConcealValueOnDocument() |
String |
getConditionalParentLabel() |
String |
getConditionalParentValue() |
String |
getCustomTabId() |
String |
getDisableAutoSize() |
String |
getDocumentId() |
ErrorDetails |
getErrorDetails() |
String |
getFont() |
String |
getFontColor() |
String |
getFontSize() |
String |
getFormula() |
Integer |
getHeight() |
String |
getIsPaymentAmount() |
String |
getItalic() |
String |
getLocked() |
Integer |
getMaxLength() |
MergeField |
getMergeField() |
String |
getName() |
String |
getOriginalValue() |
String |
getPageNumber() |
String |
getRecipientId() |
String |
getRequireAll() |
String |
getRequired() |
String |
getRequireInitialOnSharedChange() |
String |
getSenderRequired() |
String |
getShared() |
String |
getStatus() |
String |
getTabId() |
String |
getTabLabel() |
String |
getTemplateLocked() |
String |
getTemplateRequired() |
String |
getUnderline() |
String |
getValidationMessage() |
String |
getValidationPattern() |
String |
getValue() |
Integer |
getWidth() |
String |
getXPosition() |
String |
getYPosition() |
int |
hashCode() |
Text |
height(Integer height)
Height of the tab in pixels.
|
Text |
isPaymentAmount(String isPaymentAmount)
When set to **true**, sets this as a payment tab.
|
Text |
italic(String italic)
When set to **true**, the information in the tab is italic.
|
Text |
locked(String locked)
When set to **true**, the signer cannot change the data of the custom tab.
|
Text |
maxLength(Integer maxLength)
An optional value that describes the maximum length of the property when the property is a string.
|
Text |
mergeField(MergeField mergeField) |
Text |
name(String name)
Specifies the tool tip text for the tab.
|
Text |
originalValue(String originalValue)
The initial value of the tab when it was sent to the recipient.
|
Text |
pageNumber(String pageNumber)
Specifies the page number on which the tab is located.
|
Text |
recipientId(String recipientId)
Unique for the recipient.
|
Text |
requireAll(String requireAll)
When set to **true** and shared is true, information must be entered in this field to complete the envelope.
|
Text |
required(String required)
When set to **true**, the signer is required to fill out this tab
|
Text |
requireInitialOnSharedChange(String requireInitialOnSharedChange)
Optional element for field markup.
|
Text |
senderRequired(String senderRequired)
When set to **true**, the sender must populate the tab before an envelope can be sent using the template.
|
void |
setAnchorCaseSensitive(String anchorCaseSensitive) |
void |
setAnchorHorizontalAlignment(String anchorHorizontalAlignment) |
void |
setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent) |
void |
setAnchorMatchWholeWord(String anchorMatchWholeWord) |
void |
setAnchorString(String anchorString) |
void |
setAnchorUnits(String anchorUnits) |
void |
setAnchorXOffset(String anchorXOffset) |
void |
setAnchorYOffset(String anchorYOffset) |
void |
setBold(String bold) |
void |
setConcealValueOnDocument(String concealValueOnDocument) |
void |
setConditionalParentLabel(String conditionalParentLabel) |
void |
setConditionalParentValue(String conditionalParentValue) |
void |
setCustomTabId(String customTabId) |
void |
setDisableAutoSize(String disableAutoSize) |
void |
setDocumentId(String documentId) |
void |
setErrorDetails(ErrorDetails errorDetails) |
void |
setFont(String font) |
void |
setFontColor(String fontColor) |
void |
setFontSize(String fontSize) |
void |
setFormula(String formula) |
void |
setHeight(Integer height) |
void |
setIsPaymentAmount(String isPaymentAmount) |
void |
setItalic(String italic) |
void |
setLocked(String locked) |
void |
setMaxLength(Integer maxLength) |
void |
setMergeField(MergeField mergeField) |
void |
setName(String name) |
void |
setOriginalValue(String originalValue) |
void |
setPageNumber(String pageNumber) |
void |
setRecipientId(String recipientId) |
void |
setRequireAll(String requireAll) |
void |
setRequired(String required) |
void |
setRequireInitialOnSharedChange(String requireInitialOnSharedChange) |
void |
setSenderRequired(String senderRequired) |
void |
setShared(String shared) |
void |
setStatus(String status) |
void |
setTabId(String tabId) |
void |
setTabLabel(String tabLabel) |
void |
setTemplateLocked(String templateLocked) |
void |
setTemplateRequired(String templateRequired) |
void |
setUnderline(String underline) |
void |
setValidationMessage(String validationMessage) |
void |
setValidationPattern(String validationPattern) |
void |
setValue(String value) |
void |
setWidth(Integer width) |
void |
setXPosition(String xPosition) |
void |
setYPosition(String yPosition) |
Text |
shared(String shared)
When set to **true**, this custom tab is shared.
|
Text |
status(String status)
Indicates the envelope status.
|
Text |
tabId(String tabId)
The unique identifier for the tab.
|
Text |
tabLabel(String tabLabel)
The label string associated with the tab.
|
Text |
templateLocked(String templateLocked)
When set to **true**, the sender cannot change any attributes of the recipient.
|
Text |
templateRequired(String templateRequired)
When set to **true**, the sender may not remove the recipient.
|
String |
toString() |
Text |
underline(String underline)
When set to **true**, the information in the tab is underlined.
|
Text |
validationMessage(String validationMessage)
The message displayed if the custom tab fails input validation (either custom of embedded).
|
Text |
validationPattern(String validationPattern)
A regular expressionn used to validate input for the tab.
|
Text |
value(String value)
Specifies the value of the tab.
|
Text |
width(Integer width)
Width of the tab in pixels.
|
Text |
xPosition(String xPosition)
This indicates the horizontal offset of the object on the page.
|
Text |
yPosition(String yPosition)
This indicates the vertical offset of the object on the page.
|
public Integer getHeight()
public void setHeight(Integer height)
public Text isPaymentAmount(String isPaymentAmount)
public String getIsPaymentAmount()
public void setIsPaymentAmount(String isPaymentAmount)
public Text formula(String formula)
public String getFormula()
public void setFormula(String formula)
public Text validationPattern(String validationPattern)
public String getValidationPattern()
public void setValidationPattern(String validationPattern)
public Text validationMessage(String validationMessage)
public String getValidationMessage()
public void setValidationMessage(String validationMessage)
public String getShared()
public void setShared(String shared)
public Text requireInitialOnSharedChange(String requireInitialOnSharedChange)
public String getRequireInitialOnSharedChange()
public void setRequireInitialOnSharedChange(String requireInitialOnSharedChange)
public Text senderRequired(String senderRequired)
public String getSenderRequired()
public void setSenderRequired(String senderRequired)
public Text requireAll(String requireAll)
public String getRequireAll()
public void setRequireAll(String requireAll)
public String getName()
public void setName(String name)
public String getValue()
public void setValue(String value)
public Text originalValue(String originalValue)
public String getOriginalValue()
public void setOriginalValue(String originalValue)
public Integer getWidth()
public void setWidth(Integer width)
public Text required(String required)
public String getRequired()
public void setRequired(String required)
public Text locked(String locked)
public String getLocked()
public void setLocked(String locked)
public Text concealValueOnDocument(String concealValueOnDocument)
public String getConcealValueOnDocument()
public void setConcealValueOnDocument(String concealValueOnDocument)
public Text disableAutoSize(String disableAutoSize)
public String getDisableAutoSize()
public void setDisableAutoSize(String disableAutoSize)
public Text maxLength(Integer maxLength)
public Integer getMaxLength()
public void setMaxLength(Integer maxLength)
public String getTabLabel()
public void setTabLabel(String tabLabel)
public Text font(String font)
public String getFont()
public void setFont(String font)
public String getBold()
public void setBold(String bold)
public Text italic(String italic)
public String getItalic()
public void setItalic(String italic)
public Text underline(String underline)
public String getUnderline()
public void setUnderline(String underline)
public Text fontColor(String fontColor)
public String getFontColor()
public void setFontColor(String fontColor)
public Text fontSize(String fontSize)
public String getFontSize()
public void setFontSize(String fontSize)
public Text documentId(String documentId)
public String getDocumentId()
public void setDocumentId(String documentId)
public Text recipientId(String recipientId)
public String getRecipientId()
public void setRecipientId(String recipientId)
public Text pageNumber(String pageNumber)
public String getPageNumber()
public void setPageNumber(String pageNumber)
public Text xPosition(String xPosition)
public String getXPosition()
public void setXPosition(String xPosition)
public Text yPosition(String yPosition)
public String getYPosition()
public void setYPosition(String yPosition)
public Text anchorString(String anchorString)
public String getAnchorString()
public void setAnchorString(String anchorString)
public Text anchorXOffset(String anchorXOffset)
public String getAnchorXOffset()
public void setAnchorXOffset(String anchorXOffset)
public Text anchorYOffset(String anchorYOffset)
public String getAnchorYOffset()
public void setAnchorYOffset(String anchorYOffset)
public Text anchorUnits(String anchorUnits)
public String getAnchorUnits()
public void setAnchorUnits(String anchorUnits)
public Text anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
public String getAnchorIgnoreIfNotPresent()
public void setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
public Text anchorCaseSensitive(String anchorCaseSensitive)
public String getAnchorCaseSensitive()
public void setAnchorCaseSensitive(String anchorCaseSensitive)
public Text anchorMatchWholeWord(String anchorMatchWholeWord)
public String getAnchorMatchWholeWord()
public void setAnchorMatchWholeWord(String anchorMatchWholeWord)
public Text anchorHorizontalAlignment(String anchorHorizontalAlignment)
public String getAnchorHorizontalAlignment()
public void setAnchorHorizontalAlignment(String anchorHorizontalAlignment)
public Text tabId(String tabId)
public String getTabId()
public void setTabId(String tabId)
public Text templateLocked(String templateLocked)
public String getTemplateLocked()
public void setTemplateLocked(String templateLocked)
public Text templateRequired(String templateRequired)
public String getTemplateRequired()
public void setTemplateRequired(String templateRequired)
public Text conditionalParentLabel(String conditionalParentLabel)
public String getConditionalParentLabel()
public void setConditionalParentLabel(String conditionalParentLabel)
public Text conditionalParentValue(String conditionalParentValue)
public String getConditionalParentValue()
public void setConditionalParentValue(String conditionalParentValue)
public Text customTabId(String customTabId)
public String getCustomTabId()
public void setCustomTabId(String customTabId)
public Text mergeField(MergeField mergeField)
public MergeField getMergeField()
public void setMergeField(MergeField mergeField)
public Text status(String status)
public String getStatus()
public void setStatus(String status)
public Text errorDetails(ErrorDetails errorDetails)
public ErrorDetails getErrorDetails()
public void setErrorDetails(ErrorDetails errorDetails)
Copyright © 2016. All rights reserved.