Note (docusign-esign-java 2.0.1 API)

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

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

Constructor Summary

Constructors
Constructor and Description

Note()

Constructors
Constructor and Description
`Note()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Note`	`anchorCaseSensitive(String anchorCaseSensitive)` When set to true, the anchor string does not consider case when matching strings in the document.
`Note`	`anchorHorizontalAlignment(String anchorHorizontalAlignment)` Specifies the alignment of anchor tabs with anchor strings.
`Note`	`anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)` When set to true, this tab is ignored if anchorString is not found in the document.
`Note`	`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.
`Note`	`anchorString(String anchorString)` Anchor text information for a radio button.
`Note`	`anchorUnits(String anchorUnits)` Specifies units of the X and Y offset.
`Note`	`anchorXOffset(String anchorXOffset)` Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
`Note`	`anchorYOffset(String anchorYOffset)` Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`Note`	`bold(String bold)` When set to true, the information in the tab is bold.
`Note`	`conditionalParentLabel(String conditionalParentLabel)` For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`Note`	`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
`Note`	`customTabId(String customTabId)` The DocuSign generated custom tab ID for the custom tab to be applied.
`Note`	`documentId(String documentId)` Specifies the document ID number that the tab is placed on.
`boolean`	`equals(Object o)`
`Note`	`errorDetails(ErrorDetails errorDetails)`
`Note`	`font(String font)` The font to be used for the tab value.
`Note`	`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.
`Note`	`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`	`getAnchorCaseSensitive()`
`String`	`getAnchorHorizontalAlignment()`
`String`	`getAnchorIgnoreIfNotPresent()`
`String`	`getAnchorMatchWholeWord()`
`String`	`getAnchorString()`
`String`	`getAnchorUnits()`
`String`	`getAnchorXOffset()`
`String`	`getAnchorYOffset()`
`String`	`getBold()`
`String`	`getConditionalParentLabel()`
`String`	`getConditionalParentValue()`
`String`	`getCustomTabId()`
`String`	`getDocumentId()`
`ErrorDetails`	`getErrorDetails()`
`String`	`getFont()`
`String`	`getFontColor()`
`String`	`getFontSize()`
`Integer`	`getHeight()`
`String`	`getItalic()`
`MergeField`	`getMergeField()`
`String`	`getName()`
`String`	`getPageNumber()`
`String`	`getRecipientId()`
`String`	`getShared()`
`String`	`getStatus()`
`String`	`getTabId()`
`String`	`getTabLabel()`
`String`	`getTemplateLocked()`
`String`	`getTemplateRequired()`
`String`	`getUnderline()`
`String`	`getValue()`
`Integer`	`getWidth()`
`String`	`getXPosition()`
`String`	`getYPosition()`
`int`	`hashCode()`
`Note`	`height(Integer height)` Height of the tab in pixels.
`Note`	`italic(String italic)` When set to true, the information in the tab is italic.
`Note`	`mergeField(MergeField mergeField)`
`Note`	`name(String name)` Specifies the tool tip text for the tab.
`Note`	`pageNumber(String pageNumber)` Specifies the page number on which the tab is located.
`Note`	`recipientId(String recipientId)` Unique for the recipient.
`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`	`setConditionalParentLabel(String conditionalParentLabel)`
`void`	`setConditionalParentValue(String conditionalParentValue)`
`void`	`setCustomTabId(String customTabId)`
`void`	`setDocumentId(String documentId)`
`void`	`setErrorDetails(ErrorDetails errorDetails)`
`void`	`setFont(String font)`
`void`	`setFontColor(String fontColor)`
`void`	`setFontSize(String fontSize)`
`void`	`setHeight(Integer height)`
`void`	`setItalic(String italic)`
`void`	`setMergeField(MergeField mergeField)`
`void`	`setName(String name)`
`void`	`setPageNumber(String pageNumber)`
`void`	`setRecipientId(String recipientId)`
`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`	`setValue(String value)`
`void`	`setWidth(Integer width)`
`void`	`setXPosition(String xPosition)`
`void`	`setYPosition(String yPosition)`
`Note`	`shared(String shared)` When set to true, this custom tab is shared.
`Note`	`status(String status)` Indicates the envelope status.
`Note`	`tabId(String tabId)` The unique identifier for the tab.
`Note`	`tabLabel(String tabLabel)` The label string associated with the tab.
`Note`	`templateLocked(String templateLocked)` When set to true, the sender cannot change any attributes of the recipient.
`Note`	`templateRequired(String templateRequired)` When set to true, the sender may not remove the recipient.
`String`	`toString()`
`Note`	`underline(String underline)` When set to true, the information in the tab is underlined.
`Note`	`value(String value)` Specifies the value of the tab.
`Note`	`width(Integer width)` Width of the tab in pixels.
`Note`	`xPosition(String xPosition)` This indicates the horizontal offset of the object on the page.
`Note`	`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
- Note
```
public Note()
```

Method Detail

width
```
public Note width(Integer width)
```
Width of the tab in pixels.

getWidth
```
public Integer getWidth()
```

setWidth
```
public void setWidth(Integer width)
```

height
```
public Note height(Integer height)
```
Height of the tab in pixels.

getHeight
```
public Integer getHeight()
```

setHeight

public void setHeight(Integer height)

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

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

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

value
```
public Note value(String value)
```
Specifies the value of the tab.

getValue
```
public String getValue()
```

setValue
```
public void setValue(String value)
```

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

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

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

tabLabel
```
public Note tabLabel(String tabLabel)
```
The label string associated with the tab.

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

setTabLabel

public void setTabLabel(String tabLabel)

font
```
public Note 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 Note 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 Note 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 Note 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 Note 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 Note 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)

documentId
```
public Note 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 Note 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 Note 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 Note 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 Note 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 Note anchorString(String anchorString)
```
Anchor text information for a radio button.

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

setAnchorString

public void setAnchorString(String anchorString)

anchorXOffset
```
public Note 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 Note 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 Note 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 Note 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 Note 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 Note 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 Note 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 Note 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 Note 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 Note 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 Note 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 Note 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 Note 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 Note mergeField(MergeField mergeField)

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

setMergeField

public void setMergeField(MergeField mergeField)

status
```
public Note 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 Note 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 Note

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Note

Method Detail

width

getWidth

setWidth

height

getHeight

setHeight

shared

getShared

setShared

value

getValue

setValue

name

getName

setName

tabLabel

getTabLabel

setTabLabel

font

getFont

setFont

bold

getBold

setBold

italic

getItalic

setItalic

underline

getUnderline

setUnderline

fontColor

getFontColor

setFontColor

fontSize

getFontSize

setFontSize

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