Checkbox (docusign-esign-java 2.0.1 API)

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

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

Constructor Summary

Constructors
Constructor and Description

Checkbox()

Constructors
Constructor and Description
`Checkbox()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Checkbox`	`anchorCaseSensitive(String anchorCaseSensitive)` When set to true, the anchor string does not consider case when matching strings in the document.
`Checkbox`	`anchorHorizontalAlignment(String anchorHorizontalAlignment)` Specifies the alignment of anchor tabs with anchor strings.
`Checkbox`	`anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)` When set to true, this tab is ignored if anchorString is not found in the document.
`Checkbox`	`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.
`Checkbox`	`anchorString(String anchorString)` Anchor text information for a radio button.
`Checkbox`	`anchorUnits(String anchorUnits)` Specifies units of the X and Y offset.
`Checkbox`	`anchorXOffset(String anchorXOffset)` Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`Checkbox`	`anchorYOffset(String anchorYOffset)` Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`Checkbox`	`conditionalParentLabel(String conditionalParentLabel)` For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`Checkbox`	`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
`Checkbox`	`customTabId(String customTabId)` The DocuSign generated custom tab ID for the custom tab to be applied.
`Checkbox`	`documentId(String documentId)` Specifies the document ID number that the tab is placed on.
`boolean`	`equals(Object o)`
`Checkbox`	`errorDetails(ErrorDetails errorDetails)`
`String`	`getAnchorCaseSensitive()`
`String`	`getAnchorHorizontalAlignment()`
`String`	`getAnchorIgnoreIfNotPresent()`
`String`	`getAnchorMatchWholeWord()`
`String`	`getAnchorString()`
`String`	`getAnchorUnits()`
`String`	`getAnchorXOffset()`
`String`	`getAnchorYOffset()`
`String`	`getConditionalParentLabel()`
`String`	`getConditionalParentValue()`
`String`	`getCustomTabId()`
`String`	`getDocumentId()`
`ErrorDetails`	`getErrorDetails()`
`String`	`getLocked()`
`MergeField`	`getMergeField()`
`String`	`getName()`
`String`	`getPageNumber()`
`String`	`getRecipientId()`
`String`	`getRequired()`
`String`	`getRequireInitialOnSharedChange()`
`String`	`getSelected()`
`String`	`getShared()`
`String`	`getStatus()`
`String`	`getTabId()`
`String`	`getTabLabel()`
`String`	`getTemplateLocked()`
`String`	`getTemplateRequired()`
`String`	`getXPosition()`
`String`	`getYPosition()`
`int`	`hashCode()`
`Checkbox`	`locked(String locked)` When set to true, the signer cannot change the data of the custom tab.
`Checkbox`	`mergeField(MergeField mergeField)`
`Checkbox`	`name(String name)` Specifies the tool tip text for the tab.
`Checkbox`	`pageNumber(String pageNumber)` Specifies the page number on which the tab is located.
`Checkbox`	`recipientId(String recipientId)` Unique for the recipient.
`Checkbox`	`required(String required)` When set to true, the signer is required to fill out this tab
`Checkbox`	`requireInitialOnSharedChange(String requireInitialOnSharedChange)` Optional element for field markup.
`Checkbox`	`selected(String selected)` When set to true, the checkbox is selected.
`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`	`setConditionalParentLabel(String conditionalParentLabel)`
`void`	`setConditionalParentValue(String conditionalParentValue)`
`void`	`setCustomTabId(String customTabId)`
`void`	`setDocumentId(String documentId)`
`void`	`setErrorDetails(ErrorDetails errorDetails)`
`void`	`setLocked(String locked)`
`void`	`setMergeField(MergeField mergeField)`
`void`	`setName(String name)`
`void`	`setPageNumber(String pageNumber)`
`void`	`setRecipientId(String recipientId)`
`void`	`setRequired(String required)`
`void`	`setRequireInitialOnSharedChange(String requireInitialOnSharedChange)`
`void`	`setSelected(String selected)`
`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`	`setXPosition(String xPosition)`
`void`	`setYPosition(String yPosition)`
`Checkbox`	`shared(String shared)` When set to true, this custom tab is shared.
`Checkbox`	`status(String status)` Indicates the envelope status.
`Checkbox`	`tabId(String tabId)` The unique identifier for the tab.
`Checkbox`	`tabLabel(String tabLabel)` The label string associated with the tab.
`Checkbox`	`templateLocked(String templateLocked)` When set to true, the sender cannot change any attributes of the recipient.
`Checkbox`	`templateRequired(String templateRequired)` When set to true, the sender may not remove the recipient.
`String`	`toString()`
`Checkbox`	`xPosition(String xPosition)` This indicates the horizontal offset of the object on the page.
`Checkbox`	`yPosition(String yPosition)` This indicates the vertical offset of the object on the page.

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

Constructor Detail
- Checkbox
```
public Checkbox()
```

Method Detail

name
```
public Checkbox name(String name)
```
Specifies the tool tip text for the tab.

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

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

tabLabel

public Checkbox tabLabel(String tabLabel)

The label string associated with the tab.

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

setTabLabel

public void setTabLabel(String tabLabel)

selected
```
public Checkbox selected(String selected)
```
When set to **true**, the checkbox is selected.

getSelected
```
public String getSelected()
```

setSelected

public void setSelected(String selected)

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

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

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

requireInitialOnSharedChange
```
public Checkbox requireInitialOnSharedChange(String requireInitialOnSharedChange)
```
Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.

getRequireInitialOnSharedChange

public String getRequireInitialOnSharedChange()

setRequireInitialOnSharedChange

public void setRequireInitialOnSharedChange(String requireInitialOnSharedChange)

required
```
public Checkbox 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)

locked
```
public Checkbox 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)
```

documentId
```
public Checkbox documentId(String documentId)
```
Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

getDocumentId
```
public String getDocumentId()
```

setDocumentId

public void setDocumentId(String documentId)

recipientId
```
public Checkbox recipientId(String recipientId)
```
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

getRecipientId
```
public String getRecipientId()
```

setRecipientId

public void setRecipientId(String recipientId)

pageNumber
```
public Checkbox pageNumber(String pageNumber)
```
Specifies the page number on which the tab is located.

getPageNumber
```
public String getPageNumber()
```

setPageNumber

public void setPageNumber(String pageNumber)

xPosition
```
public Checkbox xPosition(String xPosition)
```
This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.

getXPosition
```
public String getXPosition()
```

setXPosition

public void setXPosition(String xPosition)

yPosition
```
public Checkbox yPosition(String yPosition)
```
This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

getYPosition
```
public String getYPosition()
```

setYPosition

public void setYPosition(String yPosition)

anchorString

public Checkbox anchorString(String anchorString)

Anchor text information for a radio button.

getAnchorString
```
public String getAnchorString()
```

setAnchorString

public void setAnchorString(String anchorString)

anchorXOffset
```
public Checkbox 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 Checkbox 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 Checkbox 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 Checkbox 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)

anchorCaseSensitive
```
public Checkbox 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)

anchorMatchWholeWord
```
public Checkbox 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)

anchorHorizontalAlignment
```
public Checkbox 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)

tabId
```
public Checkbox tabId(String tabId)
```
The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. \n\n \n

getTabId
```
public String getTabId()
```

setTabId
```
public void setTabId(String tabId)
```

templateLocked
```
public Checkbox templateLocked(String templateLocked)
```
When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

getTemplateLocked
```
public String getTemplateLocked()
```

setTemplateLocked

public void setTemplateLocked(String templateLocked)

templateRequired
```
public Checkbox templateRequired(String templateRequired)
```
When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.

getTemplateRequired
```
public String getTemplateRequired()
```

setTemplateRequired

public void setTemplateRequired(String templateRequired)

conditionalParentLabel
```
public Checkbox conditionalParentLabel(String conditionalParentLabel)
```
For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

getConditionalParentLabel

public String getConditionalParentLabel()

setConditionalParentLabel

public void setConditionalParentLabel(String conditionalParentLabel)

conditionalParentValue
```
public Checkbox 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

getConditionalParentValue

public String getConditionalParentValue()

setConditionalParentValue

public void setConditionalParentValue(String conditionalParentValue)

customTabId
```
public Checkbox 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)

mergeField

public Checkbox mergeField(MergeField mergeField)

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

setMergeField

public void setMergeField(MergeField mergeField)

status
```
public Checkbox status(String status)
```
Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later.

getStatus
```
public String getStatus()
```

setStatus
```
public void setStatus(String status)
```

errorDetails

public Checkbox errorDetails(ErrorDetails errorDetails)

getErrorDetails
```
public ErrorDetails getErrorDetails()
```

setErrorDetails

public void setErrorDetails(ErrorDetails errorDetails)

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 Checkbox

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Checkbox

Method Detail

name

getName

setName

tabLabel

getTabLabel

setTabLabel

selected

getSelected

setSelected

shared

getShared

setShared

requireInitialOnSharedChange

getRequireInitialOnSharedChange

setRequireInitialOnSharedChange

required

getRequired

setRequired

locked

getLocked

setLocked

documentId

getDocumentId

setDocumentId

recipientId

getRecipientId

setRecipientId

pageNumber

getPageNumber

setPageNumber

xPosition

getXPosition

setXPosition

yPosition

getYPosition

setYPosition

anchorString

getAnchorString

setAnchorString

anchorXOffset

getAnchorXOffset

setAnchorXOffset

anchorYOffset

getAnchorYOffset

setAnchorYOffset

anchorUnits

getAnchorUnits

setAnchorUnits

anchorIgnoreIfNotPresent

getAnchorIgnoreIfNotPresent

setAnchorIgnoreIfNotPresent

anchorCaseSensitive

getAnchorCaseSensitive

setAnchorCaseSensitive

anchorMatchWholeWord

getAnchorMatchWholeWord

setAnchorMatchWholeWord

anchorHorizontalAlignment

getAnchorHorizontalAlignment

setAnchorHorizontalAlignment

tabId

getTabId

setTabId

templateLocked

getTemplateLocked

setTemplateLocked

templateRequired

getTemplateRequired

setTemplateRequired

conditionalParentLabel

getConditionalParentLabel

setConditionalParentLabel

conditionalParentValue