java.lang.Object
- com.hellosign.openapi.model.SubFormFieldsPerDocumentBase
- - com.hellosign.openapi.model.SubFormFieldsPerDocumentText

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class SubFormFieldsPerDocumentText
extends SubFormFieldsPerDocumentBase

This class extends `SubFormFieldsPerDocumentBase`.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SubFormFieldsPerDocumentText.ValidationTypeEnum
Each text field may contain a `validation_type` parameter.

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`JSON_PROPERTY_AUTO_FILL_TYPE`
`static java.lang.String`	`JSON_PROPERTY_LINK_ID`
`static java.lang.String`	`JSON_PROPERTY_MASKED`
`static java.lang.String`	`JSON_PROPERTY_PLACEHOLDER`
`static java.lang.String`	`JSON_PROPERTY_TYPE`
`static java.lang.String`	`JSON_PROPERTY_VALIDATION_CUSTOM_REGEX`
`static java.lang.String`	`JSON_PROPERTY_VALIDATION_CUSTOM_REGEX_FORMAT_LABEL`
`static java.lang.String`	`JSON_PROPERTY_VALIDATION_TYPE`

Fields inherited from class com.hellosign.openapi.model.SubFormFieldsPerDocumentBase
JSON_PROPERTY_API_ID, JSON_PROPERTY_DOCUMENT_INDEX, JSON_PROPERTY_HEIGHT, JSON_PROPERTY_NAME, JSON_PROPERTY_PAGE, JSON_PROPERTY_REQUIRED, JSON_PROPERTY_SIGNER, JSON_PROPERTY_WIDTH, JSON_PROPERTY_X, JSON_PROPERTY_Y

Constructor Summary

Constructors
Constructor Description

SubFormFieldsPerDocumentText()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SubFormFieldsPerDocumentText`	`autoFillType(java.lang.String autoFillType)`
`java.util.Map<java.lang.String,java.lang.Object>`	`createFormData()`
`boolean`	`equals(java.lang.Object o)`	Return true if this SubFormFieldsPerDocumentText object is equal to o.
`java.lang.String`	`getAutoFillType()`	Auto fill type for populating fields automatically.
`java.lang.String`	`getLinkId()`	Link two or more text fields.
`java.lang.Boolean`	`getMasked()`	Masks entered data.
`java.lang.String`	`getPlaceholder()`	Placeholder value for text field.
`java.lang.String`	`getType()`	A text input field.
`java.lang.String`	`getValidationCustomRegex()`	Get validationCustomRegex
`java.lang.String`	`getValidationCustomRegexFormatLabel()`	Get validationCustomRegexFormatLabel
`SubFormFieldsPerDocumentText.ValidationTypeEnum`	`getValidationType()`	Each text field may contain a `validation_type` parameter.
`int`	`hashCode()`
`SubFormFieldsPerDocumentText`	`linkId(java.lang.String linkId)`
`SubFormFieldsPerDocumentText`	`masked(java.lang.Boolean masked)`
`SubFormFieldsPerDocumentText`	`placeholder(java.lang.String placeholder)`
`void`	`setAutoFillType(java.lang.String autoFillType)`
`void`	`setLinkId(java.lang.String linkId)`
`void`	`setMasked(java.lang.Boolean masked)`
`void`	`setPlaceholder(java.lang.String placeholder)`
`void`	`setType(java.lang.String type)`
`void`	`setValidationCustomRegex(java.lang.String validationCustomRegex)`
`void`	`setValidationCustomRegexFormatLabel(java.lang.String validationCustomRegexFormatLabel)`
`void`	`setValidationType(SubFormFieldsPerDocumentText.ValidationTypeEnum validationType)`
`java.lang.String`	`toString()`
`SubFormFieldsPerDocumentText`	`type(java.lang.String type)`
`SubFormFieldsPerDocumentText`	`validationCustomRegex(java.lang.String validationCustomRegex)`
`SubFormFieldsPerDocumentText`	`validationCustomRegexFormatLabel(java.lang.String validationCustomRegexFormatLabel)`
`SubFormFieldsPerDocumentText`	`validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum validationType)`

Methods inherited from class com.hellosign.openapi.model.SubFormFieldsPerDocumentBase
apiId, documentIndex, getApiId, getDocumentIndex, getHeight, getName, getPage, getRequired, getSigner, getWidth, getX, getY, height, name, page, required, setApiId, setDocumentIndex, setHeight, setName, setPage, setRequired, setSigner, setWidth, setX, setY, signer, width, x, y

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

- Field Detail
  - JSON_PROPERTY_TYPE
```
public static final java.lang.String JSON_PROPERTY_TYPE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PLACEHOLDER
```
public static final java.lang.String JSON_PROPERTY_PLACEHOLDER
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_AUTO_FILL_TYPE
```
public static final java.lang.String JSON_PROPERTY_AUTO_FILL_TYPE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_LINK_ID
```
public static final java.lang.String JSON_PROPERTY_LINK_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MASKED
```
public static final java.lang.String JSON_PROPERTY_MASKED
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_VALIDATION_TYPE
```
public static final java.lang.String JSON_PROPERTY_VALIDATION_TYPE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_VALIDATION_CUSTOM_REGEX
```
public static final java.lang.String JSON_PROPERTY_VALIDATION_CUSTOM_REGEX
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_VALIDATION_CUSTOM_REGEX_FORMAT_LABEL
```
public static final java.lang.String JSON_PROPERTY_VALIDATION_CUSTOM_REGEX_FORMAT_LABEL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SubFormFieldsPerDocumentText
```
public SubFormFieldsPerDocumentText()
```
- Method Detail
  - type
```
public SubFormFieldsPerDocumentText type(java.lang.String type)
```
    Overrides:
    
    type in class SubFormFieldsPerDocumentBase
  - getType
```
@Nonnull
public java.lang.String getType()
```
    A text input field. Use the `SubFormFieldsPerDocumentText` class.
    
    Overrides:
    
    getType in class SubFormFieldsPerDocumentBase
    
    Returns:
    
    type
  - setType
```
public void setType(java.lang.String type)
```
    Overrides:
    
    setType in class SubFormFieldsPerDocumentBase
  - placeholder
```
public SubFormFieldsPerDocumentText placeholder(java.lang.String placeholder)
```
  - getPlaceholder
```
@Nullable
public java.lang.String getPlaceholder()
```
    Placeholder value for text field.
    
    Returns:
    
    placeholder
  - setPlaceholder
```
public void setPlaceholder(java.lang.String placeholder)
```
  - autoFillType
```
public SubFormFieldsPerDocumentText autoFillType(java.lang.String autoFillType)
```
  - getAutoFillType
```
@Nullable
public java.lang.String getAutoFillType()
```
    Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values.
    
    Returns:
    
    autoFillType
  - setAutoFillType
```
public void setAutoFillType(java.lang.String autoFillType)
```
  - linkId
```
public SubFormFieldsPerDocumentText linkId(java.lang.String linkId)
```
  - getLinkId
```
@Nullable
public java.lang.String getLinkId()
```
    Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields.
    
    Returns:
    
    linkId
  - setLinkId
```
public void setLinkId(java.lang.String linkId)
```
  - masked
```
public SubFormFieldsPerDocumentText masked(java.lang.Boolean masked)
```
  - getMasked
```
@Nullable
public java.lang.Boolean getMasked()
```
    Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`.
    
    Returns:
    
    masked
  - setMasked
```
public void setMasked(java.lang.Boolean masked)
```
  - validationType
```
public SubFormFieldsPerDocumentText validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum validationType)
```
  - getValidationType
```
@Nullable
public SubFormFieldsPerDocumentText.ValidationTypeEnum getValidationType()
```
    Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. **NOTE**: When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value.
    
    Returns:
    
    validationType
  - setValidationType
```
public void setValidationType(SubFormFieldsPerDocumentText.ValidationTypeEnum validationType)
```
  - validationCustomRegex
```
public SubFormFieldsPerDocumentText validationCustomRegex(java.lang.String validationCustomRegex)
```
  - getValidationCustomRegex
```
@Nullable
public java.lang.String getValidationCustomRegex()
```
    Get validationCustomRegex
    
    Returns:
    
    validationCustomRegex
  - setValidationCustomRegex
```
public void setValidationCustomRegex(java.lang.String validationCustomRegex)
```
  - validationCustomRegexFormatLabel
```
public SubFormFieldsPerDocumentText validationCustomRegexFormatLabel(java.lang.String validationCustomRegexFormatLabel)
```
  - getValidationCustomRegexFormatLabel
```
@Nullable
public java.lang.String getValidationCustomRegexFormatLabel()
```
    Get validationCustomRegexFormatLabel
    
    Returns:
    
    validationCustomRegexFormatLabel
  - setValidationCustomRegexFormatLabel
```
public void setValidationCustomRegexFormatLabel(java.lang.String validationCustomRegexFormatLabel)
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Return true if this SubFormFieldsPerDocumentText object is equal to o.
    
    Overrides:
    
    equals in class SubFormFieldsPerDocumentBase
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class SubFormFieldsPerDocumentBase
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class SubFormFieldsPerDocumentBase
  - createFormData
```
public java.util.Map<java.lang.String,java.lang.Object> createFormData()
                                                                      throws ApiException
```
    Overrides:
    
    createFormData in class SubFormFieldsPerDocumentBase
    
    Throws:
    
    ApiException

Class SubFormFieldsPerDocumentText

Nested Class Summary

Field Summary

Fields inherited from class com.hellosign.openapi.model.SubFormFieldsPerDocumentBase

Constructor Summary

Method Summary

Methods inherited from class com.hellosign.openapi.model.SubFormFieldsPerDocumentBase

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_TYPE

JSON_PROPERTY_PLACEHOLDER

JSON_PROPERTY_AUTO_FILL_TYPE

JSON_PROPERTY_LINK_ID

JSON_PROPERTY_MASKED

JSON_PROPERTY_VALIDATION_TYPE

JSON_PROPERTY_VALIDATION_CUSTOM_REGEX

JSON_PROPERTY_VALIDATION_CUSTOM_REGEX_FORMAT_LABEL

Constructor Detail

SubFormFieldsPerDocumentText

Method Detail

type

getType

setType

placeholder

getPlaceholder

setPlaceholder

autoFillType

getAutoFillType

setAutoFillType

linkId

getLinkId

setLinkId

masked

getMasked

setMasked

validationType

getValidationType

setValidationType

validationCustomRegex

getValidationCustomRegex

setValidationCustomRegex

validationCustomRegexFormatLabel

getValidationCustomRegexFormatLabel

setValidationCustomRegexFormatLabel

equals

hashCode

toString

createFormData