Package com.docusign.esign.model
Class Radio
- java.lang.Object
-
- com.docusign.esign.model.Radio
-
public class Radio extends Object
One of the selectable radio buttons in the `radios` property of a [`radioGroup`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) tab. .
-
-
Constructor Summary
Constructors Constructor Description Radio()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Radio
anchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
anchorAllowWhiteSpaceInCharacters.Radio
anchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
anchorAllowWhiteSpaceInCharactersMetadata.Radio
anchorCaseSensitive(String anchorCaseSensitive)
anchorCaseSensitive.Radio
anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
anchorCaseSensitiveMetadata.Radio
anchorHorizontalAlignment(String anchorHorizontalAlignment)
anchorHorizontalAlignment.Radio
anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
anchorHorizontalAlignmentMetadata.Radio
anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
anchorIgnoreIfNotPresent.Radio
anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
anchorIgnoreIfNotPresentMetadata.Radio
anchorMatchWholeWord(String anchorMatchWholeWord)
anchorMatchWholeWord.Radio
anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
anchorMatchWholeWordMetadata.Radio
anchorString(String anchorString)
anchorString.Radio
anchorStringMetadata(PropertyMetadata anchorStringMetadata)
anchorStringMetadata.Radio
anchorTabProcessorVersion(String anchorTabProcessorVersion)
anchorTabProcessorVersion.Radio
anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
anchorTabProcessorVersionMetadata.Radio
anchorUnits(String anchorUnits)
anchorUnits.Radio
anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
anchorUnitsMetadata.Radio
anchorXOffset(String anchorXOffset)
anchorXOffset.Radio
anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
anchorXOffsetMetadata.Radio
anchorYOffset(String anchorYOffset)
anchorYOffset.Radio
anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
anchorYOffsetMetadata.Radio
bold(String bold)
bold.Radio
boldMetadata(PropertyMetadata boldMetadata)
boldMetadata.Radio
caption(String caption)
caption.Radio
captionMetadata(PropertyMetadata captionMetadata)
captionMetadata.boolean
equals(Object o)
Compares objects.Radio
errorDetails(ErrorDetails errorDetails)
errorDetails.Radio
font(String font)
font.Radio
fontColor(String fontColor)
fontColor.Radio
fontColorMetadata(PropertyMetadata fontColorMetadata)
fontColorMetadata.Radio
fontMetadata(PropertyMetadata fontMetadata)
fontMetadata.Radio
fontSize(String fontSize)
fontSize.Radio
fontSizeMetadata(PropertyMetadata fontSizeMetadata)
fontSizeMetadata.String
getAnchorAllowWhiteSpaceInCharacters()
.PropertyMetadata
getAnchorAllowWhiteSpaceInCharactersMetadata()
Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable..String
getAnchorCaseSensitive()
When set to **true**, the anchor string does not consider case when matching strings in the document.PropertyMetadata
getAnchorCaseSensitiveMetadata()
Metadata that indicates whether the `anchorCaseSensitive` property is editable..String
getAnchorHorizontalAlignment()
Specifies the alignment of anchor tabs with anchor strings.PropertyMetadata
getAnchorHorizontalAlignmentMetadata()
Metadata that indicates whether the `anchorHorizontalAlignment` property is editable..String
getAnchorIgnoreIfNotPresent()
When set to **true**, this tab is ignored if anchorString is not found in the document..PropertyMetadata
getAnchorIgnoreIfNotPresentMetadata()
Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable..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**..PropertyMetadata
getAnchorMatchWholeWordMetadata()
Metadata that indicates whether the `anchorMatchWholeWord` property is editable..String
getAnchorString()
Anchor text information for a radio button..PropertyMetadata
getAnchorStringMetadata()
Metadata that indicates whether the `anchorString` property is editable..String
getAnchorTabProcessorVersion()
.PropertyMetadata
getAnchorTabProcessorVersionMetadata()
Reserved for DocuSign..String
getAnchorUnits()
Specifies units of the X and Y offset.PropertyMetadata
getAnchorUnitsMetadata()
Metadata that indicates whether the `anchorUnits` property is editable..String
getAnchorXOffset()
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString..PropertyMetadata
getAnchorXOffsetMetadata()
Metadata that indicates whether the `anchorXOffset` property is editable..String
getAnchorYOffset()
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString..PropertyMetadata
getAnchorYOffsetMetadata()
Metadata that indicates whether the `anchorYOffset` property is editable..String
getBold()
When set to **true**, the information in the tab is bold..PropertyMetadata
getBoldMetadata()
Metadata that indicates whether the `bold` property is editable..String
getCaption()
.PropertyMetadata
getCaptionMetadata()
.ErrorDetails
getErrorDetails()
Array or errors..String
getFont()
The font to be used for the tab value.String
getFontColor()
The font color used for the information in the tab.PropertyMetadata
getFontColorMetadata()
Metadata that indicates whether the `fontColor` property is editable..PropertyMetadata
getFontMetadata()
Metadata that indicates whether the `font` property is editable..String
getFontSize()
The font size used for the information in the tab.PropertyMetadata
getFontSizeMetadata()
Metadata that indicates whether the `fontSize` property is editable..String
getItalic()
When set to **true**, the information in the tab is italic..PropertyMetadata
getItalicMetadata()
Metadata that indicates whether the `italic` property is editable..String
getLocked()
When set to **true**, the signer cannot change the data of the custom tab..PropertyMetadata
getLockedMetadata()
Metadata that indicates whether the `locked` property is editable..String
getMergeFieldXml()
.String
getPageNumber()
Specifies the page number on which the tab is located..PropertyMetadata
getPageNumberMetadata()
Metadata that indicates whether the `pageNumber` property is editable..String
getRequired()
When set to **true**, the signer is required to fill out this tab.PropertyMetadata
getRequiredMetadata()
Metadata that indicates whether the `required` property is editable..String
getSelected()
When set to **true**, the radio button is selected..PropertyMetadata
getSelectedMetadata()
Metadata that indicates whether the `selected` property is editable..String
getStatus()
Indicates the envelope status.PropertyMetadata
getStatusMetadata()
Metadata that indicates whether the `status` property is editable..String
getTabId()
The unique identifier for the tab.PropertyMetadata
getTabIdMetadata()
Metadata that indicates whether the `tabId` property is editable..String
getTabOrder()
.PropertyMetadata
getTabOrderMetadata()
Metadata that indicates whether the `tabOrder` property is editable..String
getUnderline()
When set to **true**, the information in the tab is underlined..PropertyMetadata
getUnderlineMetadata()
Metadata that indicates whether the `underline` property is editable..String
getValue()
Specifies the value of the tab.PropertyMetadata
getValueMetadata()
Metadata that indicates whether the `value` property is editable..String
getXPosition()
This indicates the horizontal offset of the object on the page.PropertyMetadata
getXPositionMetadata()
Metadata that indicates whether the `xPosition` property is editable..String
getYPosition()
This indicates the vertical offset of the object on the page.PropertyMetadata
getYPositionMetadata()
Metadata that indicates whether the `yPosition` property is editable..int
hashCode()
Returns the HashCode.Radio
italic(String italic)
italic.Radio
italicMetadata(PropertyMetadata italicMetadata)
italicMetadata.Radio
locked(String locked)
locked.Radio
lockedMetadata(PropertyMetadata lockedMetadata)
lockedMetadata.Radio
mergeFieldXml(String mergeFieldXml)
mergeFieldXml.Radio
pageNumber(String pageNumber)
pageNumber.Radio
pageNumberMetadata(PropertyMetadata pageNumberMetadata)
pageNumberMetadata.Radio
required(String required)
required.Radio
requiredMetadata(PropertyMetadata requiredMetadata)
requiredMetadata.Radio
selected(String selected)
selected.Radio
selectedMetadata(PropertyMetadata selectedMetadata)
selectedMetadata.void
setAnchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
setAnchorAllowWhiteSpaceInCharacters.void
setAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
setAnchorAllowWhiteSpaceInCharactersMetadata.void
setAnchorCaseSensitive(String anchorCaseSensitive)
setAnchorCaseSensitive.void
setAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
setAnchorCaseSensitiveMetadata.void
setAnchorHorizontalAlignment(String anchorHorizontalAlignment)
setAnchorHorizontalAlignment.void
setAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
setAnchorHorizontalAlignmentMetadata.void
setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
setAnchorIgnoreIfNotPresent.void
setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
setAnchorIgnoreIfNotPresentMetadata.void
setAnchorMatchWholeWord(String anchorMatchWholeWord)
setAnchorMatchWholeWord.void
setAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
setAnchorMatchWholeWordMetadata.void
setAnchorString(String anchorString)
setAnchorString.void
setAnchorStringMetadata(PropertyMetadata anchorStringMetadata)
setAnchorStringMetadata.void
setAnchorTabProcessorVersion(String anchorTabProcessorVersion)
setAnchorTabProcessorVersion.void
setAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
setAnchorTabProcessorVersionMetadata.void
setAnchorUnits(String anchorUnits)
setAnchorUnits.void
setAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
setAnchorUnitsMetadata.void
setAnchorXOffset(String anchorXOffset)
setAnchorXOffset.void
setAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
setAnchorXOffsetMetadata.void
setAnchorYOffset(String anchorYOffset)
setAnchorYOffset.void
setAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
setAnchorYOffsetMetadata.void
setBold(String bold)
setBold.void
setBoldMetadata(PropertyMetadata boldMetadata)
setBoldMetadata.void
setCaption(String caption)
setCaption.void
setCaptionMetadata(PropertyMetadata captionMetadata)
setCaptionMetadata.void
setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.void
setFont(String font)
setFont.void
setFontColor(String fontColor)
setFontColor.void
setFontColorMetadata(PropertyMetadata fontColorMetadata)
setFontColorMetadata.void
setFontMetadata(PropertyMetadata fontMetadata)
setFontMetadata.void
setFontSize(String fontSize)
setFontSize.void
setFontSizeMetadata(PropertyMetadata fontSizeMetadata)
setFontSizeMetadata.void
setItalic(String italic)
setItalic.void
setItalicMetadata(PropertyMetadata italicMetadata)
setItalicMetadata.void
setLocked(String locked)
setLocked.void
setLockedMetadata(PropertyMetadata lockedMetadata)
setLockedMetadata.void
setMergeFieldXml(String mergeFieldXml)
setMergeFieldXml.void
setPageNumber(String pageNumber)
setPageNumber.void
setPageNumberMetadata(PropertyMetadata pageNumberMetadata)
setPageNumberMetadata.void
setRequired(String required)
setRequired.void
setRequiredMetadata(PropertyMetadata requiredMetadata)
setRequiredMetadata.void
setSelected(String selected)
setSelected.void
setSelectedMetadata(PropertyMetadata selectedMetadata)
setSelectedMetadata.void
setStatus(String status)
setStatus.void
setStatusMetadata(PropertyMetadata statusMetadata)
setStatusMetadata.void
setTabId(String tabId)
setTabId.void
setTabIdMetadata(PropertyMetadata tabIdMetadata)
setTabIdMetadata.void
setTabOrder(String tabOrder)
setTabOrder.void
setTabOrderMetadata(PropertyMetadata tabOrderMetadata)
setTabOrderMetadata.void
setUnderline(String underline)
setUnderline.void
setUnderlineMetadata(PropertyMetadata underlineMetadata)
setUnderlineMetadata.void
setValue(String value)
setValue.void
setValueMetadata(PropertyMetadata valueMetadata)
setValueMetadata.void
setXPosition(String xPosition)
setXPosition.void
setXPositionMetadata(PropertyMetadata xPositionMetadata)
setXPositionMetadata.void
setYPosition(String yPosition)
setYPosition.void
setYPositionMetadata(PropertyMetadata yPositionMetadata)
setYPositionMetadata.Radio
status(String status)
status.Radio
statusMetadata(PropertyMetadata statusMetadata)
statusMetadata.Radio
tabId(String tabId)
tabId.Radio
tabIdMetadata(PropertyMetadata tabIdMetadata)
tabIdMetadata.Radio
tabOrder(String tabOrder)
tabOrder.Radio
tabOrderMetadata(PropertyMetadata tabOrderMetadata)
tabOrderMetadata.String
toString()
Converts the given object to string.Radio
underline(String underline)
underline.Radio
underlineMetadata(PropertyMetadata underlineMetadata)
underlineMetadata.Radio
value(String value)
value.Radio
valueMetadata(PropertyMetadata valueMetadata)
valueMetadata.Radio
xPosition(String xPosition)
xPosition.Radio
xPositionMetadata(PropertyMetadata xPositionMetadata)
xPositionMetadata.Radio
yPosition(String yPosition)
yPosition.Radio
yPositionMetadata(PropertyMetadata yPositionMetadata)
yPositionMetadata.
-
-
-
Method Detail
-
anchorAllowWhiteSpaceInCharacters
public Radio anchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
anchorAllowWhiteSpaceInCharacters.- Returns:
- Radio
-
getAnchorAllowWhiteSpaceInCharacters
public String getAnchorAllowWhiteSpaceInCharacters()
.- Returns:
- anchorAllowWhiteSpaceInCharacters
-
setAnchorAllowWhiteSpaceInCharacters
public void setAnchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
setAnchorAllowWhiteSpaceInCharacters.
-
anchorAllowWhiteSpaceInCharactersMetadata
public Radio anchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
anchorAllowWhiteSpaceInCharactersMetadata.- Returns:
- Radio
-
getAnchorAllowWhiteSpaceInCharactersMetadata
public PropertyMetadata getAnchorAllowWhiteSpaceInCharactersMetadata()
Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable..- Returns:
- anchorAllowWhiteSpaceInCharactersMetadata
-
setAnchorAllowWhiteSpaceInCharactersMetadata
public void setAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
setAnchorAllowWhiteSpaceInCharactersMetadata.
-
anchorCaseSensitive
public Radio anchorCaseSensitive(String anchorCaseSensitive)
anchorCaseSensitive.- Returns:
- Radio
-
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.
-
anchorCaseSensitiveMetadata
public Radio anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
anchorCaseSensitiveMetadata.- Returns:
- Radio
-
getAnchorCaseSensitiveMetadata
public PropertyMetadata getAnchorCaseSensitiveMetadata()
Metadata that indicates whether the `anchorCaseSensitive` property is editable..- Returns:
- anchorCaseSensitiveMetadata
-
setAnchorCaseSensitiveMetadata
public void setAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
setAnchorCaseSensitiveMetadata.
-
anchorHorizontalAlignment
public Radio anchorHorizontalAlignment(String anchorHorizontalAlignment)
anchorHorizontalAlignment.- Returns:
- Radio
-
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.
-
anchorHorizontalAlignmentMetadata
public Radio anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
anchorHorizontalAlignmentMetadata.- Returns:
- Radio
-
getAnchorHorizontalAlignmentMetadata
public PropertyMetadata getAnchorHorizontalAlignmentMetadata()
Metadata that indicates whether the `anchorHorizontalAlignment` property is editable..- Returns:
- anchorHorizontalAlignmentMetadata
-
setAnchorHorizontalAlignmentMetadata
public void setAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
setAnchorHorizontalAlignmentMetadata.
-
anchorIgnoreIfNotPresent
public Radio anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
anchorIgnoreIfNotPresent.- Returns:
- Radio
-
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.
-
anchorIgnoreIfNotPresentMetadata
public Radio anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
anchorIgnoreIfNotPresentMetadata.- Returns:
- Radio
-
getAnchorIgnoreIfNotPresentMetadata
public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()
Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable..- Returns:
- anchorIgnoreIfNotPresentMetadata
-
setAnchorIgnoreIfNotPresentMetadata
public void setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
setAnchorIgnoreIfNotPresentMetadata.
-
anchorMatchWholeWord
public Radio anchorMatchWholeWord(String anchorMatchWholeWord)
anchorMatchWholeWord.- Returns:
- Radio
-
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.
-
anchorMatchWholeWordMetadata
public Radio anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
anchorMatchWholeWordMetadata.- Returns:
- Radio
-
getAnchorMatchWholeWordMetadata
public PropertyMetadata getAnchorMatchWholeWordMetadata()
Metadata that indicates whether the `anchorMatchWholeWord` property is editable..- Returns:
- anchorMatchWholeWordMetadata
-
setAnchorMatchWholeWordMetadata
public void setAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
setAnchorMatchWholeWordMetadata.
-
getAnchorString
public String getAnchorString()
Anchor text information for a radio button..- Returns:
- anchorString
-
setAnchorString
public void setAnchorString(String anchorString)
setAnchorString.
-
anchorStringMetadata
public Radio anchorStringMetadata(PropertyMetadata anchorStringMetadata)
anchorStringMetadata.- Returns:
- Radio
-
getAnchorStringMetadata
public PropertyMetadata getAnchorStringMetadata()
Metadata that indicates whether the `anchorString` property is editable..- Returns:
- anchorStringMetadata
-
setAnchorStringMetadata
public void setAnchorStringMetadata(PropertyMetadata anchorStringMetadata)
setAnchorStringMetadata.
-
anchorTabProcessorVersion
public Radio anchorTabProcessorVersion(String anchorTabProcessorVersion)
anchorTabProcessorVersion.- Returns:
- Radio
-
getAnchorTabProcessorVersion
public String getAnchorTabProcessorVersion()
.- Returns:
- anchorTabProcessorVersion
-
setAnchorTabProcessorVersion
public void setAnchorTabProcessorVersion(String anchorTabProcessorVersion)
setAnchorTabProcessorVersion.
-
anchorTabProcessorVersionMetadata
public Radio anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
anchorTabProcessorVersionMetadata.- Returns:
- Radio
-
getAnchorTabProcessorVersionMetadata
public PropertyMetadata getAnchorTabProcessorVersionMetadata()
Reserved for DocuSign..- Returns:
- anchorTabProcessorVersionMetadata
-
setAnchorTabProcessorVersionMetadata
public void setAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
setAnchorTabProcessorVersionMetadata.
-
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.
-
anchorUnitsMetadata
public Radio anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
anchorUnitsMetadata.- Returns:
- Radio
-
getAnchorUnitsMetadata
public PropertyMetadata getAnchorUnitsMetadata()
Metadata that indicates whether the `anchorUnits` property is editable..- Returns:
- anchorUnitsMetadata
-
setAnchorUnitsMetadata
public void setAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
setAnchorUnitsMetadata.
-
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.
-
anchorXOffsetMetadata
public Radio anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
anchorXOffsetMetadata.- Returns:
- Radio
-
getAnchorXOffsetMetadata
public PropertyMetadata getAnchorXOffsetMetadata()
Metadata that indicates whether the `anchorXOffset` property is editable..- Returns:
- anchorXOffsetMetadata
-
setAnchorXOffsetMetadata
public void setAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
setAnchorXOffsetMetadata.
-
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.
-
anchorYOffsetMetadata
public Radio anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
anchorYOffsetMetadata.- Returns:
- Radio
-
getAnchorYOffsetMetadata
public PropertyMetadata getAnchorYOffsetMetadata()
Metadata that indicates whether the `anchorYOffset` property is editable..- Returns:
- anchorYOffsetMetadata
-
setAnchorYOffsetMetadata
public void setAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
setAnchorYOffsetMetadata.
-
getBold
public String getBold()
When set to **true**, the information in the tab is bold..- Returns:
- bold
-
setBold
public void setBold(String bold)
setBold.
-
boldMetadata
public Radio boldMetadata(PropertyMetadata boldMetadata)
boldMetadata.- Returns:
- Radio
-
getBoldMetadata
public PropertyMetadata getBoldMetadata()
Metadata that indicates whether the `bold` property is editable..- Returns:
- boldMetadata
-
setBoldMetadata
public void setBoldMetadata(PropertyMetadata boldMetadata)
setBoldMetadata.
-
getCaption
public String getCaption()
.- Returns:
- caption
-
setCaption
public void setCaption(String caption)
setCaption.
-
captionMetadata
public Radio captionMetadata(PropertyMetadata captionMetadata)
captionMetadata.- Returns:
- Radio
-
getCaptionMetadata
public PropertyMetadata getCaptionMetadata()
.- Returns:
- captionMetadata
-
setCaptionMetadata
public void setCaptionMetadata(PropertyMetadata captionMetadata)
setCaptionMetadata.
-
errorDetails
public Radio errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- Radio
-
getErrorDetails
public ErrorDetails getErrorDetails()
Array or errors..- Returns:
- errorDetails
-
setErrorDetails
public void setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.
-
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.
-
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.
-
fontColorMetadata
public Radio fontColorMetadata(PropertyMetadata fontColorMetadata)
fontColorMetadata.- Returns:
- Radio
-
getFontColorMetadata
public PropertyMetadata getFontColorMetadata()
Metadata that indicates whether the `fontColor` property is editable..- Returns:
- fontColorMetadata
-
setFontColorMetadata
public void setFontColorMetadata(PropertyMetadata fontColorMetadata)
setFontColorMetadata.
-
fontMetadata
public Radio fontMetadata(PropertyMetadata fontMetadata)
fontMetadata.- Returns:
- Radio
-
getFontMetadata
public PropertyMetadata getFontMetadata()
Metadata that indicates whether the `font` property is editable..- Returns:
- fontMetadata
-
setFontMetadata
public void setFontMetadata(PropertyMetadata fontMetadata)
setFontMetadata.
-
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.
-
fontSizeMetadata
public Radio fontSizeMetadata(PropertyMetadata fontSizeMetadata)
fontSizeMetadata.- Returns:
- Radio
-
getFontSizeMetadata
public PropertyMetadata getFontSizeMetadata()
Metadata that indicates whether the `fontSize` property is editable..- Returns:
- fontSizeMetadata
-
setFontSizeMetadata
public void setFontSizeMetadata(PropertyMetadata fontSizeMetadata)
setFontSizeMetadata.
-
getItalic
public String getItalic()
When set to **true**, the information in the tab is italic..- Returns:
- italic
-
setItalic
public void setItalic(String italic)
setItalic.
-
italicMetadata
public Radio italicMetadata(PropertyMetadata italicMetadata)
italicMetadata.- Returns:
- Radio
-
getItalicMetadata
public PropertyMetadata getItalicMetadata()
Metadata that indicates whether the `italic` property is editable..- Returns:
- italicMetadata
-
setItalicMetadata
public void setItalicMetadata(PropertyMetadata italicMetadata)
setItalicMetadata.
-
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.
-
lockedMetadata
public Radio lockedMetadata(PropertyMetadata lockedMetadata)
lockedMetadata.- Returns:
- Radio
-
getLockedMetadata
public PropertyMetadata getLockedMetadata()
Metadata that indicates whether the `locked` property is editable..- Returns:
- lockedMetadata
-
setLockedMetadata
public void setLockedMetadata(PropertyMetadata lockedMetadata)
setLockedMetadata.
-
getMergeFieldXml
public String getMergeFieldXml()
.- Returns:
- mergeFieldXml
-
setMergeFieldXml
public void setMergeFieldXml(String mergeFieldXml)
setMergeFieldXml.
-
getPageNumber
public String getPageNumber()
Specifies the page number on which the tab is located..- Returns:
- pageNumber
-
setPageNumber
public void setPageNumber(String pageNumber)
setPageNumber.
-
pageNumberMetadata
public Radio pageNumberMetadata(PropertyMetadata pageNumberMetadata)
pageNumberMetadata.- Returns:
- Radio
-
getPageNumberMetadata
public PropertyMetadata getPageNumberMetadata()
Metadata that indicates whether the `pageNumber` property is editable..- Returns:
- pageNumberMetadata
-
setPageNumberMetadata
public void setPageNumberMetadata(PropertyMetadata pageNumberMetadata)
setPageNumberMetadata.
-
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.
-
requiredMetadata
public Radio requiredMetadata(PropertyMetadata requiredMetadata)
requiredMetadata.- Returns:
- Radio
-
getRequiredMetadata
public PropertyMetadata getRequiredMetadata()
Metadata that indicates whether the `required` property is editable..- Returns:
- requiredMetadata
-
setRequiredMetadata
public void setRequiredMetadata(PropertyMetadata requiredMetadata)
setRequiredMetadata.
-
getSelected
public String getSelected()
When set to **true**, the radio button is selected..- Returns:
- selected
-
setSelected
public void setSelected(String selected)
setSelected.
-
selectedMetadata
public Radio selectedMetadata(PropertyMetadata selectedMetadata)
selectedMetadata.- Returns:
- Radio
-
getSelectedMetadata
public PropertyMetadata getSelectedMetadata()
Metadata that indicates whether the `selected` property is editable..- Returns:
- selectedMetadata
-
setSelectedMetadata
public void setSelectedMetadata(PropertyMetadata selectedMetadata)
setSelectedMetadata.
-
getStatus
public String getStatus()
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later..- Returns:
- status
-
setStatus
public void setStatus(String status)
setStatus.
-
statusMetadata
public Radio statusMetadata(PropertyMetadata statusMetadata)
statusMetadata.- Returns:
- Radio
-
getStatusMetadata
public PropertyMetadata getStatusMetadata()
Metadata that indicates whether the `status` property is editable..- Returns:
- statusMetadata
-
setStatusMetadata
public void setStatusMetadata(PropertyMetadata statusMetadata)
setStatusMetadata.
-
getTabId
public String getTabId()
The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. .- Returns:
- tabId
-
setTabId
public void setTabId(String tabId)
setTabId.
-
tabIdMetadata
public Radio tabIdMetadata(PropertyMetadata tabIdMetadata)
tabIdMetadata.- Returns:
- Radio
-
getTabIdMetadata
public PropertyMetadata getTabIdMetadata()
Metadata that indicates whether the `tabId` property is editable..- Returns:
- tabIdMetadata
-
setTabIdMetadata
public void setTabIdMetadata(PropertyMetadata tabIdMetadata)
setTabIdMetadata.
-
getTabOrder
public String getTabOrder()
.- Returns:
- tabOrder
-
setTabOrder
public void setTabOrder(String tabOrder)
setTabOrder.
-
tabOrderMetadata
public Radio tabOrderMetadata(PropertyMetadata tabOrderMetadata)
tabOrderMetadata.- Returns:
- Radio
-
getTabOrderMetadata
public PropertyMetadata getTabOrderMetadata()
Metadata that indicates whether the `tabOrder` property is editable..- Returns:
- tabOrderMetadata
-
setTabOrderMetadata
public void setTabOrderMetadata(PropertyMetadata tabOrderMetadata)
setTabOrderMetadata.
-
getUnderline
public String getUnderline()
When set to **true**, the information in the tab is underlined..- Returns:
- underline
-
setUnderline
public void setUnderline(String underline)
setUnderline.
-
underlineMetadata
public Radio underlineMetadata(PropertyMetadata underlineMetadata)
underlineMetadata.- Returns:
- Radio
-
getUnderlineMetadata
public PropertyMetadata getUnderlineMetadata()
Metadata that indicates whether the `underline` property is editable..- Returns:
- underlineMetadata
-
setUnderlineMetadata
public void setUnderlineMetadata(PropertyMetadata underlineMetadata)
setUnderlineMetadata.
-
getValue
public String getValue()
Specifies the value of the tab. .- Returns:
- value
-
setValue
public void setValue(String value)
setValue.
-
valueMetadata
public Radio valueMetadata(PropertyMetadata valueMetadata)
valueMetadata.- Returns:
- Radio
-
getValueMetadata
public PropertyMetadata getValueMetadata()
Metadata that indicates whether the `value` property is editable..- Returns:
- valueMetadata
-
setValueMetadata
public void setValueMetadata(PropertyMetadata valueMetadata)
setValueMetadata.
-
getXPosition
public String getXPosition()
This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position..- Returns:
- xPosition
-
setXPosition
public void setXPosition(String xPosition)
setXPosition.
-
xPositionMetadata
public Radio xPositionMetadata(PropertyMetadata xPositionMetadata)
xPositionMetadata.- Returns:
- Radio
-
getXPositionMetadata
public PropertyMetadata getXPositionMetadata()
Metadata that indicates whether the `xPosition` property is editable..- Returns:
- xPositionMetadata
-
setXPositionMetadata
public void setXPositionMetadata(PropertyMetadata xPositionMetadata)
setXPositionMetadata.
-
getYPosition
public String getYPosition()
This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position..- Returns:
- yPosition
-
setYPosition
public void setYPosition(String yPosition)
setYPosition.
-
yPositionMetadata
public Radio yPositionMetadata(PropertyMetadata yPositionMetadata)
yPositionMetadata.- Returns:
- Radio
-
getYPositionMetadata
public PropertyMetadata getYPositionMetadata()
Metadata that indicates whether the `yPosition` property is editable..- Returns:
- yPositionMetadata
-
setYPositionMetadata
public void setYPositionMetadata(PropertyMetadata yPositionMetadata)
setYPositionMetadata.
-
equals
public boolean equals(Object o)
Compares objects.
-
-